spree_api_v2 0.2.0

data/docs/source/includes/_orders.md

@@ -0,0 +1,75 @@
+# Orders
+
+## Show Order
+
+```shell
+curl "https://kabuni.com/api/v2/orders/:id"
+  -d token=abc123
+```
+
+```json
+{
+  "data" : {
+    "attributes" : {
+      "additional_tax_total" : "0.0",
+      "adjustment_total" : "0.0",
+      "approved_at" : null,
+      "canceled_at" : null,
+      "channel" : "spree",
+      "completed_at" : "2015-09-08T04:04:01.162Z",
+      "confirmation_delivered" : false,
+      "considered_risky" : false,
+      "currency" : "CAD",
+      "display_additional_tax_total" : "$0.00 CAD",
+      "display_adjustment_total" : "$0.00 CAD",
+      "display_included_tax_total" : "$0.00 CAD",
+      "display_item_total" : "$10.00 CAD",
+      "display_promo_total" : "$0.00 CAD",
+      "display_shipment_total" : "$100.00 CAD",
+      "display_total" : "$110.00 CAD",
+      "email" : "spree@example.com",
+      "included_tax_total" : "0.0",
+      "item_count" : 0,
+      "item_total" : "10.0",
+      "number" : "#R123456789",
+      "payment_state" : null,
+      "payment_total" : "0.0",
+      "promo_total" : "0.0",
+      "shipment_state" : null,
+      "shipment_total" : "100.0",
+      "special_instructions" : null,
+      "state" : "complete",
+      "store_name" : "Example Store",
+      "total" : "110.0"
+    },
+    "relationships" : {
+      "bill_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "line_items" : {
+        "data" : [
+          {
+            "type" : "spree_line_items"
+          }
+        ]
+      },
+      "ship_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "user" : {
+        "data" : {
+          "type" : "spree_users"
+        }
+      }
+    },
+    "type" : "spree_orders"
+  }
+}
+```
+
+This will get an order via the id supplied.
+Please note that you can ony access the orders that you own.

data/docs/source/includes/_pagination.md

@@ -0,0 +1,10 @@
+# Pagination
+
+```shell
+curl "https://kabuni.com/api/v2/kitten?page[number]2&page[size]=20"
+```
+
+This projects supports the [JSON API's `page` keyword](http://jsonapi.org/format/#fetching-pagination).
+To specify the page number, set a `page[number]` value.
+To specify the page size (the amount of records returned), set a `page[size]` value; the default is 24.
+If you would like the links to the `self`, `next`, `prev`, `first`, and `last` it is not yet supported.

data/docs/source/includes/_prices.md

@@ -0,0 +1,188 @@
+# Prices
+
+## List Prices
+
+```shell
+curl "https://kabuni.com/api/v2/prices"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_prices",
+      "attributes": {
+        "amount": "15.99",
+        "price": "15.99",
+        "display_amount": "$15.99 CAD",
+        "display_price": "$15.99 CAD",
+        "currency": "CAD"
+      },
+      "relationships": {
+        "variant": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the prices in the database.
+
+## Show Price
+
+```shell
+curl "https://kabuni.com/api/v2/prices/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_prices",
+    "attributes": {
+      "amount": "15.99",
+      "price": "15.99",
+      "display_amount": "$15.99 CAD",
+      "display_price": "$15.99 CAD",
+      "currency": "CAD"
+    },
+    "relationships": {
+      "variant": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch a price via its `id`.
+
+## Show Variant of a Price
+
+```shell
+curl "https://kabuni.com/api/v2/prices/1/variant"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_variants",
+    "attributes": {
+      "sku": "ROR-00011",
+      "weight": "0.0",
+      "height": "1.0",
+      "width": "3.0",
+      "depth": "2.0",
+      "is_master": true,
+      "position": 1,
+      "name": "Ruby on Rails Tote",
+      "price": "15.99",
+      "display_price" : "$15.99 CAD"
+    },
+    "relationships": {
+      "prices": {
+        "data": [
+          {
+            "type": "spree_prices",
+            "id": "1"
+          }
+        ]
+      },
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      },
+      "product": {
+        "data": {
+          "type": "spree_products",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch the variant a price belongs to via the price's `id`.
+
+## Show Product of a Price
+
+```shell
+curl "https://kabuni.com/api/v2/prices/1/product"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_products",
+    "attributes": {
+      "name": "Ruby on Rails Tote",
+      "description": "Dolorem molestias sint maxime id at rem qui exercitationem. Neque voluptas corrupti magni suscipit iusto voluptatum. Ea quibusdam dolorem inventore praesentium sed dicta eveniet et. Rerum inventore laudantium quisquam earum consequatur dignissimos.",
+      "slug": "ruby-on-rails-tote",
+      "meta_description": null,
+      "meta_keywords": null,
+      "store_name": "Whole New Home"
+    },
+    "relationships": {
+      "master": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      },
+      "variants": {
+        "data": []
+      },
+      "taxons": {
+        "data": [
+          {
+            "type": "spree_taxons",
+            "id": "18"
+          }
+        ]
+      },
+      "option_types": {
+        "data": [
+          {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch the product a price belongs to via the price's `id`.

data/docs/source/includes/_products.md

@@ -0,0 +1,403 @@
+# Products
+
+## List Products
+
+```shell
+curl "https://kabuni.com/api/v2/products"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_products",
+      "attributes": {
+        "name": "Ruby on Rails Tote",
+        "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+        "slug": "ruby-on-rails-tote",
+        "meta_description": null,
+        "meta_keywords": null,
+        "store_name": "Whole New Home"
+      },
+      "relationships": {
+        "master": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        },
+        "variants": {
+          "data": []
+        },
+        "option_types": {
+          "data": [
+            {
+              "type": "spree_option_types",
+              "id": "1"
+            }
+          ]
+        },
+        "taxons": {
+          "data": [
+            {
+              "type": "spree_taxons",
+              "id": "1"
+            }
+          ]
+        }
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  ]
+}
+```
+
+List all of the products in the database.
+
+## Show Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_products",
+    "attributes": {
+      "name": "Ruby on Rails Tote",
+      "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+      "slug": "ruby-on-rails-tote",
+      "meta_description": null,
+      "meta_keywords": null,
+      "store_name": "Whole New Home"
+    },
+    "relationships": {
+      "master": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      },
+      "variants": {
+        "data": []
+      },
+      "taxons": {
+        "data": [
+          {
+            "type": "spree_taxons",
+            "id": "1"
+          }
+        ]
+      },
+      "option_types": {
+        "data": [
+          {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Select a product via it's `id`.
+
+## List Option Types of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/option_types"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_types",
+      "attributes": {
+        "name": "tshirt-size",
+        "presentation": "Size",
+        "position": 1
+      },
+      "relationships": {
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "products": {
+          "data": [
+            {
+              "type": "spree_products",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option types that a product owns via the product's `id`.
+
+## Show Option Type of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/option_types/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_types",
+    "attributes": {
+      "name": "tshirt-size",
+      "presentation": "Size",
+      "position": 1
+    },
+    "relationships": {
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "products": {
+        "data": [
+          {
+            "type": "spree_products",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch an option type of a product by both of their `id`s.
+
+## List Variants of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/variants"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_variants",
+      "attributes": {
+        "sku": "ROR-00011",
+        "weight": "0.0",
+        "height": "1.0",
+        "width": "3.0",
+        "depth": "2.0",
+        "is_master": true,
+        "position": 1,
+        "name": "Ruby on Rails Tote",
+        "price": "15.99",
+        "display_price" : "$15.99 CAD"
+      },
+      "relationships": {
+        "prices": {
+          "data": [
+            {
+              "type": "spree_prices",
+              "id": "1"
+            }
+          ]
+        },
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "images": {
+          "data": [
+            {
+              "type": "spree_images",
+              "id": "1"
+            }
+          ]
+        },
+        "product": {
+          "data": {
+            "type": "spree_products",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all variants including the master of a product by the products `id`.
+
+## Show Variant of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/variants/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_variants",
+    "attributes": {
+      "sku": "ROR-00011",
+      "weight": "0.0",
+      "height": "1.0",
+      "width": "3.0",
+      "depth": "2.0",
+      "is_master": true,
+      "position": 1,
+      "name": "Ruby on Rails Tote",
+      "price": "15.99",
+      "display_price" : "$15.99 CAD"
+    },
+    "relationships": {
+      "prices": {
+        "data": [
+          {
+            "type": "spree_prices",
+            "id": "1"
+          }
+        ]
+      },
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      },
+      "product": {
+        "data": {
+          "type": "spree_products",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch a variant or a product's master variant that a product owns by the products `id`.
+
+## List Images of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/images"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "21",
+      "type": "spree_images",
+      "attributes": {
+        "position": 1,
+        "alt": null,
+        "links": {
+          "original": "/spree/products/21/original/ror_tote.jpeg?1442035828",
+          "mini": "/spree/products/21/mini/ror_tote.jpeg?1442035828",
+          "small": "/spree/products/21/small/ror_tote.jpeg?1442035828",
+          "product": "/spree/products/21/product/ror_tote.jpeg?1442035828",
+          "large": "/spree/products/21/large/ror_tote.jpeg?1442035828"
+        }
+      },
+      "relationships": {
+        "viewable": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the images that belong to a product via the product's `id`.
+
+## Show Image of a Product
+
+```shell
+curl "https://kabuni.com/api/v2/products/1/images/21"
+```
+
+```json
+{
+  "data": {
+    "id": "21",
+    "type": "spree_images",
+    "attributes": {
+      "position": 1,
+      "alt": null,
+      "links": {
+        "original": "/spree/products/21/original/ror_tote.jpeg?1442035828",
+        "mini": "/spree/products/21/mini/ror_tote.jpeg?1442035828",
+        "small": "/spree/products/21/small/ror_tote.jpeg?1442035828",
+        "product": "/spree/products/21/product/ror_tote.jpeg?1442035828",
+        "large": "/spree/products/21/large/ror_tote.jpeg?1442035828"
+      }
+    },
+    "relationships": {
+      "viewable": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch an image of a product via the product and the images' `id`.