https://github.com/aturingmachine/solstice-challenge

Backend Java Challenge for Solstice
https://github.com/aturingmachine/solstice-challenge

Last synced: 11 months ago
JSON representation

Backend Java Challenge for Solstice

Host: GitHub
URL: https://github.com/aturingmachine/solstice-challenge
Owner: aturingmachine
Created: 2017-11-06T20:59:05.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2017-11-08T04:22:56.000Z (over 8 years ago)
Last Synced: 2025-02-04T00:36:44.136Z (about 1 year ago)
Language: Java
Size: 43.9 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Solstice Backend Coding Challenge - Java

[![Build Status](https://travis-ci.com/aturingmachine/solstice-challenge.svg?token=WJQ6vS1Y53eUoWsvJTkh&branch=master)](https://travis-ci.com/aturingmachine/solstice-challenge)

## Description
This project is intended to be a solution to the Solstice Java Backend Developer Challenge. It uses Maven to manage depencies, and Spring Boot as a Java Framework. It is a simple REST API with a single resource.

## Deployment
This project is currently deployed [here](https://solstice-backend-java.herokuapp.com/api/contacts) on Heroku. It uses [Travis CI](https://travis-ci.org/) to automatically test and redeploy the application.

It should be noted that the first requests made to the Application may be slow as Heroku puts free tier dynos to sleep after some time. The contact `id`s will also increment by odd amounts due to how [ClearDB](http://w2.cleardb.net/) does their incrementing.

## Assumptions
I have made the following assumptions based on the document provided:

* Profile images will be stored in a separate location. Storing them locally could cause issues with migrating the server, because of this the `profileImage` should be a URL pointing to a image.

* The `email` data field should be unique. Errors this may cause in data creation are properly handled and responses contain proper error messages.

## Running
To run this project:

1. Download the Zip and extract it.
2. `cd `
3. Make sure you have a mysql server running.
4. `mvn test `
- To test the project. More info on tests provided below
5. `mvn spring-boot:run`
- Will compile and run the project.
6. `mvn package`
- Will build a .jar file

You can then start hitting endpoints using Postman or whatever HTTP client you like.
***

## Resources

There is a single resource in this API, the `contact`. Who's model is as follows:

JSON for a `contact` resource would appear as follows:
```
{
"id": 1,
"name": "Daffy Duck",
"company": "Acme Inc.",
"profileImage": "https://i.imgur.com/16ta98z.gif",
"email": "daffy@acme.com",
"workPhone": "555-123-7890",
"personalPhone": "098-732-1555",
"address": "123 Looney Lane",
"city": "Los Angeles",
"state": "CA",
"birthdate": "1937-04-17"
}
```
***

## Endpoints
The API has the following endpoints exposed, all of which are behind /api. All requests and responses are done using JSON format.

#### `GET /contacts`
##### Request Parameters:
* None
##### Response:
###### Codes:
* `200 OK`
###### Data:
An Array of all contacts.
###### Example Request:
```
GET /api/contacts HTTP/1.1
Host: localhost:8080
Content-Type: application/json
```
###### Example Response
```
[
{
"id": 1,
"name": "Daffy Duck",
"company": "Acme Inc.",
...
},
{
"id": 2,
"name": "Bugs Bunny",
"company": "Acme Inc.",
...
}
]
```
***

### `GET /contacts/{id}`
##### Request Parameters:
* `id` of a contact resource being requested.
##### Response:
###### Codes:
* `200 OK`

* `404 Not Found`
###### Data:
The single contact resource being requested.
###### Example Request:
```
GET /api/contacts/2 HTTP/1.1
Host: localhost:8080
```
###### Example Response:
```
{
"id": 2,
"name": "Bugs Bunny",
"company": "Acme Inc.",
"profileImage": "https://i.imgur.com/Cava6CL.jpg",
"email": "bugs@acme.com",
"workPhone": "555-999-1234",
"personalPhone": "123-987-6574",
"address": "1456 Bugs Boulevard",
"city": "Los Angeles",
"state": "CA",
"birthdate": "1938-04-30"
}
```
***

### `POST /contacts`
##### Request Parameters:
* Contact data in a request body to be saved
##### Response:
###### Codes:
* `201 Created`

* `409 Conflict` if the `email` field is not unique
###### Data:
Returns the newly created contact resource
###### Example Request:
```
POST /api/contacts HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
"name": "Daffy Duck",
"company": "Acme Inc.",
"email": "daffy@acme.com",
"profileImage": "https://i.imgur.com/16ta98z.gif",
"workPhone": "555-123-7890",
"personalPhone": "098-732-1555",
"address": "123 Looney Lane",
"city": "Los Angeles",
"state": "CA",
"birthdate": "1937-04-17"
}
```
###### Example Response:
```
{
"id": 1,
"name": "Daffy Duck",
"company": "Acme Inc.",
...
}
```
***

### `DELETE /contacts/{id}`
##### Request Parameters:
* `id` of a contact resource being deleted.
##### Response:
###### Codes:
* `204 No Content`

* `404 Not Found`
###### Data:
Empty
###### Ecample Request:
```
DELETE /api/contacts/2 HTTP/1.1
Host: localhost:8080
```
###### Example Response:
```
Status: 204 No-Content
[]
```
***

### `PUT /contacts/{id}`
##### Request Parameters:
* `id` of a contact resource being updated.
* Contact data in the Request Body to be updated
##### Response:
###### Codes:
* `200 OK`

* `409 Conflict` if the `email` field is not unique
###### Data:
The updated contact resource.
###### Notes:
* A `PUT` request to an `id` not in use will result in the creation of a new resource.
###### Example Request:
```
PUT /api/contacts/2 HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
"name": "Bugs Bunny",
"company": "Acme Incorporated", //This field was changed
"email": "bugs@acme.com",
...
}
```
###### Example Response:
```
{
"id": 2,
"name": "Bugs Bunny",
"company": "Acme Incorporated",
...
}
```
***

### `GET /contacts/search/{query}?value={param}`
##### Request Parameters:
* `query` - the type of query being run available queries include `[phone, email, state, city]`.
* `param` - the value to be searched against.
##### Response:
###### Codes:
* `200 OK`

* `400 Bad Request` if the value of `query` is not supported.
###### Data:
Any resources matching the search.
###### Notes:
* `GET /api/contacts/search/phone?value=5550123` will return contacts whos work **OR** personal phone number matches the value.
###### Example Request:
```
GET /api/contacts/search/email?value=bugs@acme.com HTTP/1.1
Host: localhost:8080
```
###### Example Response:
```
[
{
"id": 2,
"name": "Bugs Bunny",
"company": "Acme Inc.",
"profileImage": "https://i.imgur.com/Cava6CL.jpg",
"email": "bugs@acme.com",
...
}
]
```

## Testing
You can run the tests including with this project by running `mvn test`. The tests run over 3 endpoints in the following manner:

1. Mock a `contact` resource
2. Send the `contact` to the server via `POST` expecting a `201 Created` response.
3. Then `GET` the `contact` resource from `/api/contacts/1` and check that all of its returned values are the same as the mock `contact`
4. Then `DELETE` the contact resource at `/api/contacts/1` expecting a `204 No Content` response.
5. Then `GET` the (now deleted) `contact` resource from `/api/contacts/1` and expect a `404 Not Found` response.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/aturingmachine/solstice-challenge

Awesome Lists containing this project

README