image-lookup-challenge

Image Lookup Challenge for Agile Engine Interview

Project description

SpringBoot app to load images info from specific endpoint

and provide search of imagies by tags/author or some other metadata via endpoint GET /search/${searchTerm}

Run

Run as a springboot app from IDE, main class is ImageLookupApplication

Search endpoint: http://localhost:8081/api/search/${searchTerm}

Model

Image, PageOfImages - are used as abstractions for image information got from /images/${id} and /images?page=${number} endpoints respectively

Search by term

Implemented in SearchImagesController - a controller providing /search/${searchTerm} endpoint

Search Algorithm

As I had only 2 hours for implementation I decided not to use any databases including in-menory as I know it will take a lot much time to implement search. Thus I used just a java hash map (which can be changed to HazelCast impl) which is ok for the 2-hrs pet project.

To search images I created hashmap with IMAGE DIGEST information as a key and image id as a value.

Image digest is just a string with all image metadata : author + camera + tags + id.

Thus when user searchs by search term, keys are filtered (ignorecase) by this search term and then mapped to original image info. That's it. I know that for searches like that companies like booking com and etc implement precomputed searches/n-grams and so on.

Example

GET http://localhost:8081/api/search/c221b4ac0be418f65728

returns

[
   {
      "id":"c221b4ac0be418f65728",
      "author":"Aged Stress",
      "camera":"Leica M10",
      "tags":"#nature #natureisbeautiful ",
      "cropped_picture":"http://interview.agileengine.com/pictures/cropped/26008.JPG",
      "full_picture":"http://interview.agileengine.com/pictures/full_size/26008.JPG"
   }
]

GET http://localhost:8081/api/search/Deafening%20Grandfather returns

[
   {
      "id":"60a07c821a33520a4832",
      "author":"Deafening Grandfather",
      "camera":"Canon EOS Rebel SL3 / EOS 250D",
      "tags":"#whataview #today #nature #photo #photooftheday #wonderfullife ",
      "cropped_picture":"http://interview.agileengine.com/pictures/cropped/708033.jpg",
      "full_picture":"http://interview.agileengine.com/pictures/full_size/708033.jpg"
   }
]

and GET http://localhost:8081/api/search/nature returns a lot.

What's not implemented

Obviously, timer for images storage to be updated, auth key request on expiration, search by multiple terms could be added, more logging, specific exceptions handling, moving images fetching to separate class and more, and it'll be just cool to get feedback on that.

Thanks for the challenge and Have a nice day!

joraclista/image-lookup-challenge