gvieve / rails-engine Goto Github PK

• get all merchants
• a maximum of 20 at a time when no per_page limit is provided
• page, an integer value of a “page” of resources to skip before returning data; defaults to 1 if not specified by the user

Create the DB and migrations
Add models, tests, and associations
Add gems and create factories

• get one item GET '/api/v1/items/:id'

This endpoint should return the total revenue for a single merchant.

• The URI should follow this pattern: GET /api/v1/revenue/merchants/:id
• Revenue is defined as invoice status = shipped, transaction = success, sum(invoice_item quantity * unit price)

example json

{
  "data": {
    "id": "42",
    "type": "merchant_revenue",
    "attributes": {
      "revenue"  : 532613.9800000001
    }
  }
}

• get all items
• a maximum of 20 at a time when no per_page limit is provided
• page, an integer value of a “page” of resources to skip before returning data; defaults to 1 if not specified by the user

The endpoint will return a quantity of items ranked by descending revenue.

• The URI should follow this pattern: GET /api/v1/revenue/items?quantity=x
• where ‘x’ is the maximum count of results to return.
• quantity should default to 10 if not provided
• endpoint should return an error if it is not an integer greater than 0

example json

{
  "data": [
    {
      "id": 4,
      "type": "item_revenue",
      "attributes": {
        "name": "Men's Titanium Ring",
        "description": "Fine titanium ring",
        "unit_price": 299.99,
        "merchant_id": 54,
        "revenue": 19823.12985
      }
    }
  ]
}

Create initial README draft

This endpoint should return a variable number of merchants ranked by total revenue.

• The URI should follow this pattern: GET /api/v1/merchants/most_revenue?quantity=x
• where x is the number of merchants to be returned. The quantity parameter is required, and should return an error if it is missing or if it is not an integer greater than 0.

example JSON

{
  "data": [
    {
      "id": "1",
      "type": "merchant_name_revenue",
      "attributes": {
        "name": "Turing School",
        "revenue": 512.256128
      }
    },
    {
      "id": "4",
      "type": "merchant_name_revenue",
      "attributes": {
        "name": "Ring World",
        "revenue": 245.130001
      }
    }
  ]
}

• get all items for a given merchant ID
• GET /api/v1/merchants/:id/items - return all items associated with a merchant.
• return a 404 if merchant is not found

Build a endpoint of the orders which have not yet shipped

• The URI should follow this pattern: GET /api/v1/revenue/unshipped?quantity=x
• ‘x’ is the maximum count of results to return.
• quantity should default to 10 if not provided
• should return an error if it is not an integer greater than 0.
• order by 'potential revenue'

Example JSON response for GET /api/v1/revenue/unshipped?quantity=2

{
  "data": [
    {
      "id": 834,
      "type": "unshipped_order",
      "attributes": {
        "potential_revenue": 5923.78
      }
    },
    {
      "id": 28,
      "type": "unshipped_order",
      "attributes": {
        "potential_revenue": 3298.63
      }
    }
  ]
}

• get one merchant GET '/api/v1/merchants/:id'

• destroy the corresponding record (if found) and any associated data
• destroy any invoice if this was the only item on an invoice
• NOT return any JSON body at all, and should return a 204 HTTP status code
• NOT utilize a Serializer (Rails will handle sending a 204 on its own if you just .destroy the object)

• return the merchant associated with an item
• GET /api/v1/items/:id/merchant -
• return a 404 if the item is not found

• find one ITEM based on search criteria AND find all MERCHANTS based on search criteria
• find a single item which matches a search term
  - return a single object, if found
  - return the first object in the database in case-sensitive alphabetical order if multiple matches are found
  - allow the user to specify a ‘name’ query parameter
  - search data in the name query parameter should require the database to do a case-insensitive search for text fields
  - allow the user to send one or more price-related query parameters, applicable to items only
  - for items, the user will send EITHER the name parameter OR either/both of the price parameters
  - users should get an error if name and either/both of the price parameters are sent
• find all merchants which match a search term
  - The JSON response will always be an array of objects, even if zero matches or only one match is found
  - It should not return a 404 if no matches are found
  - follow the same rules as the “find_one” endpoints

• create a record and render a JSON representation of the new Item record.
• follow this pattern: POST /api/v1/items
• accept the following JSON body with only the following fields

{
  "name": "value1",
  "description": "value2",
  "unit_price": 100.99,
  "merchant_id": 14
}

• Note that the unit price is to be sent as a numeric value, not a string.)
• return an error if any attribute is missing
• ignore any attributes sent by the user which are not allowed

• update the corresponding Item (if found) with whichever details are provided by the user
• render a JSON representation of the updated record.
• follow this pattern: PATCH /api/v1/items/:id
• accept the following JSON body with one or more of the following fields: The body should follow this pattern:

{
  "name": "value1",
  "description": "value2",
  "unit_price": 100.99,
  "merchant_id": 7
}

• response

{
  "data": {
    "id": "1",
    "type": "item",
    "attributes": {
      "name": "New Widget Name",
      "description": "High quality widget, now with more widgety-ness",
      "unit_price": 299.99,
      "merchant_id": 7
    }
  }
}