spree_api_v2 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f51afd9a854980b7d847abef045328252894dab1
-  data.tar.gz: d50ea8d48e1bbb2c14b933462a945308e1c0a8d4
+  metadata.gz: 6167d39bbd3296a6f9dbd49aeadbfc0ae214d666
+  data.tar.gz: 751825724557654c768ffc926dc7c15a919e670b
 SHA512:
-  metadata.gz: 203d4c79428e91ec1a91cda9095cc893f50b360a6a85ed539a98c13a19b99a3de9339c8218bdd87920fa67cd01123e8bd26c497defe508955d59471a83ca2651
-  data.tar.gz: bf350c0d32a9aac8c763454455b8f8e84d42c72ed6e1017ac9c5867745ce23cf75127af59fad83b73be10fce0dc133dbb1a3e52774b377041f785d559bf65b9c
+  metadata.gz: 45718ff99ad6d9e838496f185879af58c4a082e9b17e7a573686407b5f43346fe3bbedce1767f5ccbedaa365db7b6e942f24d55980fa78d8f8cfba9d6f06eefd
+  data.tar.gz: c292c0460b65a95bbfb6cbbc61265355017e3433c78e6669ebda963b320ae18f35652753d40d9adbebe36effbae3d1e04b5ce44f153829f8713b70f934a3b576

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.2.2
+
+*   The parent serializer for `Spree::BaseSerializer` is now configurable.
+    In some instances, you may have an `ApplicationSerializer`.
+    To make the `Spree::BaseSerializer` use an `ApplicationSerializer` instead
+    of the `ActiveModel::Serializer`:
+
+    ```ruby
+    # config/initializers/spree_api_v2.rb; or
+    # config/initializers/solidus_api_v2.rb
+    SpreeApiV2.setup do |config|
+      config.parent_serializer = ApplicationSerializer
+    end
+
 ## 0.2.1
 
 *   Fixes a bug where the user serializer wasn't extending from the `Spree::BaseSerializer` this is now fixed.

data/README.md

@@ -91,8 +91,4 @@ bundle exec rake GEMNAME=spree_api_v2
 bundle exec rake GEMNAME=solidus_api_v2
 ```
 
-## Sponsored by:
-
-[![Kabuni](https://assets.kabuni.com/kabuni-secondary-logomark-xlarge.png)](https://kabuni.com?utm_source=SpreeApiV2&utm_medium=sponsor&utm_campaign=opensource)
-
 Copyright © 2015 Ben A. Morgan, released under the New BSD License

data/app/serializers/spree/base_serializer.rb

@@ -1,5 +1,5 @@
 module Spree
-  class BaseSerializer < ActiveModel::Serializer
+  class BaseSerializer < SpreeApiV2.parent_serializer
     def image_links(object)
       {
         original: object.url(:original),

data/docs/source/includes/_authentication.md

@@ -2,7 +2,7 @@
 
 ```shell
 # Specifying the token as a header.
-curl "https://kabuni.com/api/v1/endpoint"
+curl "https://example.com/api/v1/endpoint"
   -H "X-Spree-Token: abc123"
 
 # Specifying the token as a param.
@@ -20,7 +20,7 @@ Spree does not expect every request to require an API key (such as reading publi
 ## Authenticate a User (Login)
 
 ```shell
-curl "https://kabuni.com/api/v1/account/signin"
+curl "https://example.com/api/v1/account/signin"
   -X POST
   -d user[email]=spree@example.com
   -d user[password]=spree123

data/docs/source/includes/_countries.md

@@ -3,7 +3,7 @@
 ## List Countries
 
 ```shell
-curl "https://kabuni.com/api/v2/countries"
+curl "https://example.com/api/v2/countries"
 ```
 
 ```json
@@ -40,7 +40,7 @@ List all of the ~200 countries in the DB.
 ## Show Country
 
 ```shell
-curl "https://kabuni.com/api/v2/countries/1"
+curl "https://example.com/api/v2/countries/1"
 ```
 
 ```json
@@ -75,7 +75,7 @@ Select a country via its `id`.
 ## List States of a Country
 
 ```shell
-curl "https://kabuni.com/api/v2/countries/1/states"
+curl "https://example.com/api/v2/countries/1/states"
 ```
 
 ```json
@@ -106,7 +106,7 @@ See all of the states that a country owns via the country's `id`.
 ## Show State of a Country
 
 ```shell
-curl "https://kabuni.com/api/v2/countries/1/states/1"
+curl "https://example.com/api/v2/countries/1/states/1"
 ```
 
 ```json

data/docs/source/includes/_filtering.md

@@ -1,9 +1,9 @@
 # Filtering
 
 ```shell
-curl "https://kabuni.com/api/v2/kittens?filter[id]=1"
-curl "https://kabuni.com/api/v2/kittens?filter[id]=2,3,4"
-curl "https://kabuni.com/api/v2/kittens?filter[breed]=Persian,British%20Shorthair,Bengal"
+curl "https://example.com/api/v2/kittens?filter[id]=1"
+curl "https://example.com/api/v2/kittens?filter[id]=2,3,4"
+curl "https://example.com/api/v2/kittens?filter[breed]=Persian,British%20Shorthair,Bengal"
 ```
 
 This project supports the [JSON API's `filter` keyword](http://jsonapi.org/format/#fetching-filtering) with only the root object, not any of its relationships yet.

data/docs/source/includes/_images.md

@@ -3,7 +3,7 @@
 ## List Images
 
 ```shell
-curl "https://kabuni.com/api/v2/images"
+curl "https://example.com/api/v2/images"
 ```
 
 ```json
@@ -41,7 +41,7 @@ List all of the images stored in the database.
 ## Show Image
 
 ```shell
-curl "https://kabuni.com/api/v2/images/1"
+curl "https://example.com/api/v2/images/1"
 ```
 
 ```json
@@ -77,7 +77,7 @@ Fetch an image and its links via the image's `id`.
 ## Show Variant of an Image
 
 ```shell
-curl "https://kabuni.com/api/v2/images/1/variant"
+curl "https://example.com/api/v2/images/1/variant"
 ```
 
 ```json
@@ -138,7 +138,7 @@ Fetch the variant that an image belongs to via the variant's `id`.
 ## Show Product of an Image
 
 ```shell
-curl "https://kabuni.com/api/v2/images/1/product"
+curl "https://example.com/api/v2/images/1/product"
 ```
 
 ```json

data/docs/source/includes/_line_items.md

@@ -3,7 +3,7 @@
 ## Create Line Item
 
 ```shell
-curl "https://kabuni.com/api/v2/line_items"
+curl "https://example.com/api/v2/line_items"
   -X POST
   -d token=abc123
   -d line_item[order_id]=1
@@ -53,7 +53,7 @@ This endpoint allows you add a variant to a users order by creating a line item.
 > Quantity is out of range.
 
 ```shell
-curl "https://kabuni.com/api/v2/line_items"
+curl "https://example.com/api/v2/line_items"
   -X POST
   -d token=abc123
   -d line_item[order_id]=1
@@ -80,7 +80,7 @@ When requesting an insanely large amount of variants to be added to your order,
 > Order could not be found.
 
 ```shell
-curl "https://kabuni.com/api/v2/line_items"
+curl "https://example.com/api/v2/line_items"
   -X POST
   -d token=abc123
   -d line_item[order_id]=0
@@ -108,7 +108,7 @@ When this happens, you'll receive an error because of it.
 > Product is out of stock.
 
 ```shell
-curl "https://kabuni.com/api/v2/line_items"
+curl "https://example.com/api/v2/line_items"
   -X POST
   -d token=abc123
   -d line_item[order_id]=1

data/docs/source/includes/_option_types.md

@@ -3,7 +3,7 @@
 ## List Option Types
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types"
+curl "https://example.com/api/v2/option_types"
 ```
 
 ```json
@@ -45,7 +45,7 @@ List all of the option types in the database.
 ## Show Option Type
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types/1"
+curl "https://example.com/api/v2/option_types/1"
 ```
 
 ```json
@@ -85,7 +85,7 @@ Fetch an option type in the database.
 ## List Option Values of a Option Type
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types/1/option_values"
+curl "https://example.com/api/v2/option_types/1/option_values"
 ```
 
 ```json
@@ -117,7 +117,7 @@ See all of the option values that an option type owns.
 ## Show Option Values of a Option Type
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types/1/option_values/1"
+curl "https://example.com/api/v2/option_types/1/option_values/1"
 ```
 
 ```json
@@ -147,7 +147,7 @@ Fetch an option value that an option type owns.
 ## List Products of a Option Type
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types/1/products"
+curl "https://example.com/api/v2/option_types/1/products"
 ```
 
 ```json
@@ -209,7 +209,7 @@ See all of the products that an option type owns.
 ## Show Product of a Option Type
 
 ```shell
-curl "https://kabuni.com/api/v2/option_types/1/products/1"
+curl "https://example.com/api/v2/option_types/1/products/1"
 ```
 
 ```json

data/docs/source/includes/_option_values.md

@@ -3,7 +3,7 @@
 ## List Option Values
 
 ```shell
-curl "https://kabuni.com/api/v2/option_values"
+curl "https://example.com/api/v2/option_values"
 ```
 
 ```json
@@ -35,7 +35,7 @@ List all of the option values.
 ## Show Option Value
 
 ```shell
-curl "https://kabuni.com/api/v2/option_values/1"
+curl "https://example.com/api/v2/option_values/1"
 ```
 
 ```json
@@ -65,7 +65,7 @@ Find an option value by its `id`.
 ## Show Option Type of an Option Value
 
 ```shell
-curl "https://kabuni.com/api/v2/option_values/1/option_type"
+curl "https://example.com/api/v2/option_values/1/option_type"
 ```
 
 ```json
@@ -105,7 +105,7 @@ Find the option type of an option value by the option value's `id`.
 ## List Variants of an Option Value
 
 ```shell
-curl "https://kabuni.com/api/v2/option_values/1/variants"
+curl "https://example.com/api/v2/option_values/1/variants"
 ```
 
 ```json
@@ -168,7 +168,7 @@ List all of the variants that belong to an option value via the option value's `
 ## Show Variant of an Option Value
 
 ```shell
-curl "https://kabuni.com/api/v2/option_values/1/variants/1"
+curl "https://example.com/api/v2/option_values/1/variants/1"
 ```
 
 ```json

data/docs/source/includes/_orders.md

@@ -3,7 +3,7 @@
 ## Show Order
 
 ```shell
-curl "https://kabuni.com/api/v2/orders/:id"
+curl "https://example.com/api/v2/orders/:id"
   -d token=abc123
 ```
 

data/docs/source/includes/_pagination.md

@@ -1,7 +1,7 @@
 # Pagination
 
 ```shell
-curl "https://kabuni.com/api/v2/kitten?page[number]2&page[size]=20"
+curl "https://example.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).

data/docs/source/includes/_prices.md

@@ -3,7 +3,7 @@
 ## List Prices
 
 ```shell
-curl "https://kabuni.com/api/v2/prices"
+curl "https://example.com/api/v2/prices"
 ```
 
 ```json
@@ -37,7 +37,7 @@ List all of the prices in the database.
 ## Show Price
 
 ```shell
-curl "https://kabuni.com/api/v2/prices/1"
+curl "https://example.com/api/v2/prices/1"
 ```
 
 ```json
@@ -69,7 +69,7 @@ Fetch a price via its `id`.
 ## Show Variant of a Price
 
 ```shell
-curl "https://kabuni.com/api/v2/prices/1/variant"
+curl "https://example.com/api/v2/prices/1/variant"
 ```
 
 ```json
@@ -130,7 +130,7 @@ 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"
+curl "https://example.com/api/v2/prices/1/product"
 ```
 
 ```json

data/docs/source/includes/_products.md

@@ -3,7 +3,7 @@
 ## List Products
 
 ```shell
-curl "https://kabuni.com/api/v2/products"
+curl "https://example.com/api/v2/products"
 ```
 
 ```json
@@ -65,7 +65,7 @@ List all of the products in the database.
 ## Show Product
 
 ```shell
-curl "https://kabuni.com/api/v2/products/1"
+curl "https://example.com/api/v2/products/1"
 ```
 
 ```json
@@ -125,7 +125,7 @@ Select a product via it's `id`.
 ## List Option Types of a Product
 
 ```shell
-curl "https://kabuni.com/api/v2/products/1/option_types"
+curl "https://example.com/api/v2/products/1/option_types"
 ```
 
 ```json
@@ -167,7 +167,7 @@ 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"
+curl "https://example.com/api/v2/products/1/option_types/1"
 ```
 
 ```json
@@ -207,7 +207,7 @@ 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"
+curl "https://example.com/api/v2/products/1/variants"
 ```
 
 ```json
@@ -270,7 +270,7 @@ 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"
+curl "https://example.com/api/v2/products/1/variants/1"
 ```
 
 ```json
@@ -331,7 +331,7 @@ Fetch a variant or a product's master variant that a product owns by the product
 ## List Images of a Product
 
 ```shell
-curl "https://kabuni.com/api/v2/products/1/images"
+curl "https://example.com/api/v2/products/1/images"
 ```
 
 ```json
@@ -369,7 +369,7 @@ 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"
+curl "https://example.com/api/v2/products/1/images/21"
 ```
 
 ```json

data/docs/source/includes/_states.md

@@ -3,7 +3,7 @@
 ## List States
 
 ```shell
-curl "https://kabuni.com/api/v2/states"
+curl "https://example.com/api/v2/states"
 ```
 
 ```json
@@ -34,7 +34,7 @@ This will list all of the states.
 ## Show State
 
 ```shell
-curl "https://kabuni.com/api/v2/states/1"
+curl "https://example.com/api/v2/states/1"
 ```
 
 ```json
@@ -63,7 +63,7 @@ Select a state via its `id`.
 ## Show Country of a States
 
 ```shell
-curl "https://kabuni.com/api/v2/states/1/countries"
+curl "https://example.com/api/v2/states/1/countries"
 ```
 
 ```json

data/docs/source/includes/_taxonomies.md

@@ -3,7 +3,7 @@
 ## List Taxonomies
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies"
+curl "https://example.com/api/v2/taxonomies"
 ```
 
 ```json
@@ -48,7 +48,7 @@ List of the taxonomies in the database.
 ## Show Taxonomy
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies/1"
+curl "https://example.com/api/v2/taxonomies/1"
 ```
 
 ```json
@@ -91,7 +91,7 @@ Select a taxonomy via the `id`.
 ## List Taxons of a Taxonomy
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies/1/taxons"
+curl "https://example.com/api/v2/taxonomies/1/taxons"
 ```
 
 ```json
@@ -177,7 +177,7 @@ List all of the taxons that a taxonomy has a reference to.
 ## Show Taxon of a Taxonomy
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies/1/taxons/1"
+curl "https://example.com/api/v2/taxonomies/1/taxons/1"
 ```
 
 ```json
@@ -224,7 +224,7 @@ Find a taxon that the taxonomy owns via the taxonomy's `id` and the taxon's `id`
 ## List Children of a Taxonomy
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies/1/children"
+curl "https://example.com/api/v2/taxonomies/1/children"
 ```
 
 ```json
@@ -277,7 +277,7 @@ This does _not_ include the root taxon that would be included when listing all o
 ## Show Child of a Taxonomy
 
 ```shell
-curl "https://kabuni.com/api/v2/taxonomies/1/children/2"
+curl "https://example.com/api/v2/taxonomies/1/children/2"
 ```
 
 ```json

data/docs/source/includes/_taxons.md

@@ -3,7 +3,7 @@
 ## List Taxons
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons"
+curl "https://example.com/api/v2/taxons"
 ```
 
 ```json
@@ -55,7 +55,7 @@ List all the taxons in the database.
 ## Show Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1"
+curl "https://example.com/api/v2/taxons/1"
 ```
 
 ```json
@@ -102,7 +102,7 @@ Locate the taxon that you're looking for via its `id`.
 ## Show Taxonomy of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1/taxonomy"
+curl "https://example.com/api/v2/taxons/1/taxonomy"
 ```
 
 ```json
@@ -145,7 +145,7 @@ Display the taxonomy that a taxon belongs.
 ## Show Parent of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/2/parent"
+curl "https://example.com/api/v2/taxons/2/parent"
 ```
 
 ```json
@@ -192,7 +192,7 @@ Display the parent taxon that a taxon may belong to.
 ## List Children of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1/children"
+curl "https://example.com/api/v2/taxons/1/children"
 ```
 
 ```json
@@ -244,7 +244,7 @@ List all the children that a taxon has.
 ## Show Child of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1/children/2"
+curl "https://example.com/api/v2/taxons/1/children/2"
 ```
 
 ```json
@@ -294,7 +294,7 @@ Find a child via its `id` and its owners (taxon) `id`.
 ## List Products of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1/products"
+curl "https://example.com/api/v2/taxons/1/products"
 ```
 
 ```json
@@ -356,7 +356,7 @@ List all of the products that taxon owns via the taxons `id`.
 ## Show Product of a Taxon
 
 ```shell
-curl "https://kabuni.com/api/v2/taxons/1/products/10"
+curl "https://example.com/api/v2/taxons/1/products/10"
 ```
 
 ```json

data/docs/source/includes/_variants.md

@@ -3,7 +3,7 @@
 ## List Variants
 
 ```shell
-curl "https://kabuni.com/api/v2/variants"
+curl "https://example.com/api/v2/variants"
 ```
 
 ```json
@@ -70,7 +70,7 @@ List all variants in the DB including master variants.
 ## Show Variant
 
 ```shell
-curl "https://kabuni.com/api/v2/variants/1"
+curl "https://example.com/api/v2/variants/1"
 ```
 
 ```json
@@ -135,7 +135,7 @@ Fetch a variant by its `id`.
 ## List Prices of a Variant
 
 ```shell
-curl "https://kabuni.com/api/v2/variants/1/prices"
+curl "https://example.com/api/v2/variants/1/prices"
 ```
 
 ```json
@@ -188,7 +188,7 @@ List all of the prices for a variant.
 ## Show Price of a Variant
 
 ```shell
-curl "https://kabuni.com/api/v2/variants/1/prices/1"
+curl "https://example.com/api/v2/variants/1/prices/1"
 ```
 
 ```json
@@ -220,7 +220,7 @@ 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"
+curl "https://example.com/api/v2/variants/1/product"
 ```
 
 ```json
@@ -280,7 +280,7 @@ 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"
+curl "https://example.com/api/v2/variants/1/option_values"
 ```
 
 ```json
@@ -320,7 +320,7 @@ 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"
+curl "https://example.com/api/v2/variants/1/option_values/1"
 ```
 
 ```json
@@ -358,7 +358,7 @@ 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"
+curl "https://example.com/api/v2/variants/1/images"
 ```
 
 ```json
@@ -396,7 +396,7 @@ 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"
+curl "https://example.com/api/v2/variants/1/images/21"
 ```
 
 ```json

data/lib/solidus_api_v2.rb

@@ -2,4 +2,6 @@ require 'solidus_core'
 require 'active_model_serializers'
 
 ENV['SOLIDUS_API'] = 'true'
+
+require 'spree_api_v2/config'
 require 'spree_api_v2/engine'

data/lib/spree_api_v2.rb

@@ -1,4 +1,5 @@
 require 'spree_core'
 require 'active_model_serializers'
 
+require 'spree_api_v2/config'
 require 'spree_api_v2/engine'

data/lib/spree_api_v2/config.rb

@@ -0,0 +1,8 @@
+module SpreeApiV2
+  mattr_accessor :parent_serializer
+  @@parent_serializer = ActiveModel::Serializer
+
+  def self.setup
+    yield self
+  end
+end

data/solidus_api_v2.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'solidus_api_v2'
-  s.version     = '0.2.1'
+  s.version     = '0.2.2'
   s.summary     = 'The V2 API for Solidus.'
   s.description = 'Adds an assortment of new api endpoints that are JSON API compatible.'
   s.required_ruby_version = '>= 2.0.0'

data/spree_api_v2.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_api_v2'
-  s.version     = '0.2.1'
+  s.version     = '0.2.2'
   s.summary     = 'The V2 API for Spree.'
   s.description = 'Adds an assortment of new api endpoints that are JSON API compatible.'
   s.required_ruby_version = '>= 2.0.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ben A. Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_api
@@ -339,6 +339,7 @@ files:
 - docs/source/stylesheets/screen.css.scss
 - lib/solidus_api_v2.rb
 - lib/spree_api_v2.rb
+- lib/spree_api_v2/config.rb
 - lib/spree_api_v2/engine.rb
 - solidus_api_v2.gemspec
 - spec/controllers/spree/api/v2/children_controller_spec.rb