Merge pull request #10 from spree-contrib/serializer-parent

Be able to set serializer parent and remove sponsor

Author: BenMorganIO

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.

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

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

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][email protected]
   -d user[password]=spree123

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

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.

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

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

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

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