devalexsales/car-advert

car-advert

Tech Stack

• Scala 2.11
• Play 2.4
• AWS Dynamo DB

How to run

1. Clone the source code
2. Download local dynamo db and run it
3. Run source code sbt run on the root folder of this project
4. Test the APIs using a HttpRequester(Mozilla plugin) or any REST client that will work.

Run your local dynamo db

• We're using Amazon Dynamo DB, but feel free to use different storage as long as we will be able to run it without doing excessive configuration work.
• If you decide to use local Amazon Dynamo DB, which could be downloaded from Amazon as a tar.gz or zip archive or installed with homebrew if you're using MacOS: brew install dynamodb-local, try to not store data in Dynamo DB as a string blob, try to either use a Dynamo DB document model or store every field as a separate attribute.

java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -inMemory

http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html

REST APIs

• View all car adverts ( optional sorting by any field specified by query parameter, default sorting - by id; )

    method - GET
    url - http://localhost:9000/carAdverts[?sort='<fieldnames>']
    returns list of car adverts in JSON format

• Field names

guid
title
fuel
price
isNew
mileage
firstRegistration

• View car advert by id

    method - GET
    url - http://localhost:9000/carAdverts/<id>
    returns a car advert in JSON format or  `{"status":"KO","message":"<info>"}`

• Create a new car advert

    method - POST
    url - http://localhost:9000/carAdverts
    content-type - application/json
    param:     param: {
                   "guid":"",
                   "title":"alex",
                   "fuel":"<gasoline or diesel>",
                   "price":10,
                   "isNew":false,
                    ["firstRegistration": "2012-04-23T18:25:43.511Z", //JSON standard date or unix-timestamp
                    "mileage":10]
                    }
    returns `{"status":"<OK or KO>","message":"<info>"}`

• Update a car advert

    method - PUT
    url - http://localhost:9000/carAdverts
    content-type - application/json
    param: {
        "guid":"",
        "title":"alex",
        "fuel":"<gasoline or diesel>",
        "price":10,
        "isNew":false,
         ["firstRegistration": "2012-04-23T18:25:43.511Z", //JSON standard date or unix-timestamp
         "mileage":10]
         }
    returns `{"status":"<OK or KO>","message":"<info>"}`

• Remove a car advert by id

    method - DELETE
    url - http://localhost:9000/carAdverts/<id>
    returns `{"status":"<OK or KO>","message":"<info>"}`

CORS testing

• In cmd type - $ curl -H "Origin: http://www.example.com" -X GET --verbose http://10.0.25.55:9000/carAdverts