This is a repo for the form3 technical interivew.

How to make this work:

• Use virtualenv
• Have mongo running on local
• type python run.py

for testing Purposes, I made a token that expires in 2019: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTm91cmkgTk9VUkkiLCJhdWQiOiJhZG1pbiIsImlzcyI6ImZvcm0zIiwic3ViIjoiZmFrZSIsImlhdCI6MTUzMzAyNTEzNiwiZXhwIjoxNTc2MjI1MTM2fQ.CoXC68VkpoJjS7SyUjTsU7RaZIhpqpwfmaXGZbGB_yw

REST API Documentation:

The endpoint /payments acceptes: ['GET', 'POST']
The endpoint /payments/:id acceptes: ['GET', 'PATCH', 'PUT', 'DELETE']

Request all Payment

Get All Payments.

• URL

  /payments/

• Method:

  GET

• URL Params

  Required:

  None

• Data Params

  None

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

  OR

  • Code: 400 BAD REQUEST
    

• Sample Call:

    requests.get("/api/payments/")

---

Request Payment with ID

Get a Payments with its ID.

• URL

  /payments/:id

• Method:

  GET

• URL Params

  Required:

  id=[uuid]

• Data Params

  None

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

• Sample Call:

    requests.get("/api/payments/743d5b63-8e6f-432e-a8fa-c5d8d2ee5fcb")

---

Create a Payment

Create a Payment object.

• URL

  /payments/

• Method:

  POST

• URL Params

  Required:

  None

• Data Params

  type:
      # This can be hardcoded because it is payment endpoin, or droped
      type: string
      required: true
  id:
      type: uuid
      required: true
      # This shoulw be the unique key
      # Because of the version, the unique key should be the (id, versuon)
      # for the sake of simplicity I will use this as the unique key
      unique: true
  version:
      # This can be hardcoded because it is good practice to keep
      # all versions in source control (git) as seperat files
      type: number
      required: true
  organisation_id:
      type: uuid
      required: true
  attributes:
      type: dict
      # This is because I am not detailing all of the fields here
      allow_unknown: true
      required: true

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

• Sample Call:

    requests.post("/api/payments/", body)

---

Delete a Payment

Delete a Paymentwith its uuid.

• URL

  /payments/:id

• Method:

  DELETE

• URL Params

  Required:

  id=[uuid]

• Data Params

  None

• Success Response:

  • Code: 204

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

• Sample Call:

    requests.delete("/api/payments/743d5b63-8e6f-432e-a8fa-c5d8d2ee5fcb")

---

Update a Payment

Update a Payment object with its UID. About the Update, the Patch method can be requested with one of the feilds, all of them are not required together, only the direred field have to be sent with the new value to be updated.

• URL

  /payments/:id

• Method:

  PATCH

• URL Params

  Required:

  id=[uuid]

• Data Params

  type:
      # This can be hardcoded because it is payment endpoin, or droped
      type: string
      required: false
  organisation_id:
      type: uuid
      required: false
  attributes:
      type: dict
      # This is because I am not detailing all of the fields here
      allow_unknown: true
      required: false

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

• Sample Call:

    requests.patch("/api/payments/", body)

---

Replace a Payment

Replace a Payment object. NB: We can use upsert here, if the ID does not exist, this will be like a POST on the endpoint /payments/

• URL

  /payments/:id

• Method:

  PUT

• URL Params

  Required:

  id=[uuid]

• Data Params

  type:
      # This can be hardcoded because it is payment endpoin, or droped
      type: string
      required: true
  version:
      # This can be hardcoded because it is good practice to keep
      # all versions in source control (git) as seperat files
      type: number
      required: true
  organisation_id:
      type: uuid
      required: true
  attributes:
      type: dict
      # This is because I am not detailing all of the fields here
      allow_unknown: true
      required: true

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 404 NOT FOUND
    Content: {"_error": {"message": "The requested URL was not found on the server.", "code": 404} }

  OR

  • Code: 401 UNAUTHORIZED
    Content: { "_error" : "Please provide proper credentials" }

• Sample Call:

    requests.put("/api/payments/", body)