solidus_api_v2 0.2.0

data/docs/source/includes/_variants.md

@@ -0,0 +1,430 @@
+# Variants
+
+## List Variants
+
+```shell
+curl "https://kabuni.com/api/v2/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"
+            },
+            {
+              "type": "spree_prices",
+              "id": "2"
+            }
+          ]
+        },
+        "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 in the DB including master variants.
+
+## Show Variant
+
+```shell
+curl "https://kabuni.com/api/v2/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"
+          },
+          {
+            "type": "spree_prices",
+            "id": "2"
+          }
+        ]
+      },
+      "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 by its `id`.
+
+## List Prices of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/1/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"
+          }
+        }
+      }
+    },
+    {
+      "id": "2",
+      "type": "spree_prices",
+      "attributes": {
+        "amount": "14.0",
+        "price": "14.0",
+        "display_amount": "€14,00 EUR",
+        "display_price": "€14,00 EUR",
+        "currency": "EUR"
+      },
+      "relationships": {
+        "variant": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the prices for a variant.
+
+## Show Price of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/1/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 for a variant by the price and variants `id`.
+
+## Show Product of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/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 the a variant belongs to by the variant's `id`.
+
+## List Option Values of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/1/option_values"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_values",
+      "attributes": {
+        "name": "Small",
+        "presentation": "S",
+        "position": 1
+      },
+      "relationships": {
+        "option_type": {
+          "data": {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        },
+        "variants": {
+          "data": [
+            {
+              "type": "spree_variants",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option values that belong to a variant via the variant's `id`.
+
+## Show Option Value of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/1/option_values/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_values",
+    "attributes": {
+      "name": "Small",
+      "presentation": "S",
+      "position": 1
+    },
+    "relationships": {
+      "option_type": {
+        "data": {
+          "type": "spree_option_types",
+          "id": "1"
+        }
+      },
+      "variants": {
+        "data": [
+          {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch an option value via the option value's `id` and the variant's `id`.
+
+## List Images of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/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/tot_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 of a variant via the variant's `id`.
+
+## Show Image of a Variant
+
+```shell
+curl "https://kabuni.com/api/v2/variants/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/tot_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 variant via the image and the variant's `id`s.

data/docs/source/index.md

@@ -0,0 +1,53 @@
+---
+title: Spree API V2 Reference
+
+language_tabs:
+  - shell
+
+toc_footers:
+  - <a href="https://github.com/spree-contrib/spree_api_v2"> Source Code </a>
+  - <a href="https://guides.spreecommerce.com/api/" target="_blank"> Spree API Documentation </a>
+  - <a href="http://jsonapi.org/" target="_blank"> JSON API Documentation </a>
+  - <a href="https://github.com/tripit/slate" target="_blank"> Documentation Powered by Slate </a>
+  - <a href="https://kabuni.com?utm_source=SpreeApiV2Docs&utm_medium=sponsor&utm_campaign=opensource"> Kabuni, Proud Sponsor </a>
+
+includes:
+  - authentication
+  - errors
+  - pagination
+  - filtering
+  - countries
+  - images
+  - line_items
+  - option_types
+  - option_values
+  - orders
+  - prices
+  - products
+  - states
+  - taxonomies
+  - taxons
+  - variants
+
+search: true
+---
+
+# Introduction
+
+Welcome to the Spree API V2 API!
+You can use our API to grab data from our database and make updates.
+
+We currently only have a language binding in Shell.
+You can view code examples in the dark area to the right.
+
+This example API documentation page was created with [Slate](http://github.com/tripit/slate).
+Feel free to edit it and use it as a base for your own API's documentation.
+
+This JSON API is formatted after the [JSON API spec](http://jsonapi.org).
+Please follow its guidelines to learn about:
+
+- Pagination
+- Including Relationships
+- Sorting
+- Error Objects
+- The Document Structure

data/docs/source/javascripts/all.js

@@ -0,0 +1,4 @@
+//= require ./lib/_energize
+//= require ./app/_lang
+//= require ./app/_search
+//= require ./app/_toc

data/docs/source/javascripts/all_nosearch.js

@@ -0,0 +1,3 @@
+//= require ./lib/_energize
+//= require ./app/_lang
+//= require ./app/_toc

data/docs/source/javascripts/app/_lang.js

@@ -0,0 +1,162 @@
+/*
+Copyright 2008-2013 Concur Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+*/
+(function (global) {
+  'use strict';
+
+  var languages = [];
+
+  global.setupLanguages = setupLanguages;
+  global.activateLanguage = activateLanguage;
+
+  function activateLanguage(language) {
+    if (!language) return;
+    if (language === "") return;
+
+    $(".lang-selector a").removeClass('active');
+    $(".lang-selector a[data-language-name='" + language + "']").addClass('active');
+    for (var i=0; i < languages.length; i++) {
+      $(".highlight." + languages[i]).hide();
+    }
+    $(".highlight." + language).show();
+
+    global.toc.calculateHeights();
+
+    // scroll to the new location of the position
+    if ($(window.location.hash).get(0)) {
+      $(window.location.hash).get(0).scrollIntoView(true);
+    }
+  }
+
+  // parseURL and stringifyURL are from https://github.com/sindresorhus/query-string
+  // MIT licensed
+  // https://github.com/sindresorhus/query-string/blob/7bee64c16f2da1a326579e96977b9227bf6da9e6/license
+  function parseURL(str) {
+    if (typeof str !== 'string') {
+      return {};
+    }
+
+    str = str.trim().replace(/^(\?|#|&)/, '');
+
+    if (!str) {
+      return {};
+    }
+
+    return str.split('&').reduce(function (ret, param) {
+      var parts = param.replace(/\+/g, ' ').split('=');
+      var key = parts[0];
+      var val = parts[1];
+
+      key = decodeURIComponent(key);
+      // missing `=` should be `null`:
+      // http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
+      val = val === undefined ? null : decodeURIComponent(val);
+
+      if (!ret.hasOwnProperty(key)) {
+        ret[key] = val;
+      } else if (Array.isArray(ret[key])) {
+        ret[key].push(val);
+      } else {
+        ret[key] = [ret[key], val];
+      }
+
+      return ret;
+    }, {});
+  };
+
+  function stringifyURL(obj) {
+    return obj ? Object.keys(obj).sort().map(function (key) {
+      var val = obj[key];
+
+      if (Array.isArray(val)) {
+        return val.sort().map(function (val2) {
+          return encodeURIComponent(key) + '=' + encodeURIComponent(val2);
+        }).join('&');
+      }
+
+      return encodeURIComponent(key) + '=' + encodeURIComponent(val);
+    }).join('&') : '';
+  };
+
+  // gets the language set in the query string
+  function getLanguageFromQueryString() {
+    if (location.search.length >= 1) {
+      var language = parseURL(location.search).language
+      if (language) {
+        return language;
+      } else if (jQuery.inArray(location.search.substr(1), languages) != -1) {
+        return location.search.substr(1);
+      }
+    }
+
+    return false;
+  }
+
+  // returns a new query string with the new language in it
+  function generateNewQueryString(language) {
+    var url = parseURL(location.search);
+    if (url.language) {
+      url.language = language;
+      return stringifyURL(url);
+    }
+    return language;
+  }
+
+  // if a button is clicked, add the state to the history
+  function pushURL(language) {
+    if (!history) { return; }
+    var hash = window.location.hash;
+    if (hash) {
+      hash = hash.replace(/^#+/, '');
+    }
+    history.pushState({}, '', '?' + generateNewQueryString(language) + '#' + hash);
+
+    // save language as next default
+    localStorage.setItem("language", language);
+  }
+
+  function setupLanguages(l) {
+    var defaultLanguage = localStorage.getItem("language");
+
+    languages = l;
+
+    var presetLanguage = getLanguageFromQueryString();
+    if (presetLanguage) {
+      // the language is in the URL, so use that language!
+      activateLanguage(presetLanguage);
+
+      localStorage.setItem("language", presetLanguage);
+    } else if ((defaultLanguage !== null) && (jQuery.inArray(defaultLanguage, languages) != -1)) {
+      // the language was the last selected one saved in localstorage, so use that language!
+      activateLanguage(defaultLanguage);
+    } else {
+      // no language selected, so use the default
+      activateLanguage(languages[0]);
+    }
+  }
+
+  // if we click on a language tab, activate that language
+  $(function() {
+    $(".lang-selector a").on("click", function() {
+      var language = $(this).data("language-name");
+      pushURL(language);
+      activateLanguage(language);
+      return false;
+    });
+    window.onpopstate = function() {
+      activateLanguage(getLanguageFromQueryString());
+    };
+  });
+})(window);