megroth2 / rails_engine Goto Github PK

This endpoints will follow the same rules as the “find” endpoint.

The JSON response will always be an array of items, even if zero matches or only one match is found.

It should not return a 404 if no matches are found.

Example JSON response for GET /api/v1/merchants/find_all?name=ring:

{
  "data": [
    {
      "id": "4",
      "type": "merchant",
      "attributes": {
        "name": "Ring World"
      }
    },
    {
      "id": "1",
      "type": "merchant",
      "attributes": {
        "name": "Turing School"
      }
    }
  ]
}

This endpoint should:

• 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
• should ignore any attributes sent by the user which are not allowed

Example JSON response for the Item resource:

{
  "data": {
    "id": "16",
    "type": "item",
    "attributes": {
      "name": "Widget",
      "description": "High quality widget",
      "unit_price": 100.99,
      "merchant_id": 14
    }
  }
}

get the merchant data for a given item ID

The relationship endpoint you should expose is: GET /api/v1/items/:id/merchant

• return the merchant associated with an item
• return a 404 if the item is not found

This endpoint should:

• render a JSON representation of the corresponding record, if found
• follow this pattern: GET /api/v1/<resource>/:id

Example JSON response for the Item resource:

{
  "data": {
    "id": "1",
    "type": "item",
    "attributes": {
      "name": "Super Widget",
      "description": "A most excellent widget of the finest crafting",
      "unit_price": 109.99
    }
  }
}

Note that the unit_price is sent as numeric data, and not string data.

This endpoint should:

• render a JSON representation of the corresponding record, if found
• follow this pattern: GET /api/v1/<resource>/:id

Example JSON response for the Item resource:

{
  "data": {
    "id": "1",
    "type": "item",
    "attributes": {
      "name": "Super Widget",
      "description": "A most excellent widget of the finest crafting",
      "unit_price": 109.99
    }
  }
}

Note that the unit_price is sent as numeric data, and not string data.

This “index” endpoint should:

• render a JSON representation of all records of the requested resource
• always return an array of data, even if one or zero resources are found
• NOT include dependent data of the resource (e.g., if you’re fetching merchants, do not send any data about merchant’s items or invoices)
• follow this pattern: GET /api/v1/<resource>

Example JSON response for the Merchant resource:

{
  "data": [
    {
      "id": "1",
        "type": "merchant",
        "attributes": {
          "name": "Mike's Awesome Store",
        }
    },
    {
      "id": "2",
      "type": "merchant",
      "attributes": {
        "name": "Store of Fate",
      }
    },
    {
      "id": "3",
      "type": "merchant",
      "attributes": {
        "name": "This is the limit of my creativity",
      }
    }
  ]
}

Install SimpleCov, rspec-rails, pry, etc.

get all items for a given merchant ID

The relationship endpoint you should expose is: GET /api/v1/merchants/:id/items

• return all items associated with a merchant.
• return a 404 if merchant is not found

This endpoint should:

• 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
  }

  (Note that the unit price is to be sent as a numeric value, not a string.)

Example JSON response for the Item resource:

{
  "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
    }
  }
}

This endpoint should:

• 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)

This endpoint should:

• return a single merchant, if found
• return the first merchant in the database in case-insensitive alphabetical order if multiple matches are found
  • e.g., if “Ring World” and “Turing” exist as merchant names, “Ring World” would be returned, even if “Turing” was created first
• allow the user to specify a ‘name’ query parameter:
  • for merchants, the user can send ?name=ring and it will search the name field in the database table
  • the search data in the name query parameter should require the database to do a case-insensitive search for text fields
    • e.g., searching for ‘ring’ should find ‘Turing’ and ‘Ring World’

Valid examples:

• GET /api/v1/merchants/find?name=Mart
• GET /api/v1/items/find?name=ring
• GET /api/v1/items/find?min_price=50
• GET /api/v1/items/find?max_price=150
• GET /api/v1/items/find?max_price=150&min_price=50

Invalid examples:

• GET /api/v1/<resource>/find - parameter cannot be missing
• GET /api/v1/<resource>/find?name= - parameter cannot be empty
• GET /api/v1/items/find?name=ring&min_price=50 - cannot send both name and min_price
• GET /api/v1/items/find?name=ring&max_price=50 - cannot send both name and max_price
• GET /api/v1/items/find?name=ring&min_price=50&max_price=250 - cannot send both name and min_price and max_price

Example JSON response for GET /api/v1/merchants/find?name=ring:

{
  "data": {
    "id": 4,
    "type": "merchant",
    "attributes": {
      "name": "Ring World"
    }
  }
}

This "index” endpoint should:

• render a JSON representation of all records of the requested resource
• always return an array of data, even if one or zero resources are found
• NOT include dependent data of the resource (e.g., if you’re fetching merchants, do not send any data about merchant’s items or invoices)
• follow this pattern: GET /api/v1/<resource>

Example JSON response for the Merchant resource:

{
  "data": [
    {
      "id": "1",
        "type": "merchant",
        "attributes": {
          "name": "Mike's Awesome Store",
        }
    },
    {
      "id": "2",
      "type": "merchant",
      "attributes": {
        "name": "Store of Fate",
      }
    },
    {
      "id": "3",
      "type": "merchant",
      "attributes": {
        "name": "This is the limit of my creativity",
      }
    }
  ]
}