solidus_json_api 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fbe78a78d8359475015cbfa74cfe9499ec41f73
+  data.tar.gz: 170c03853cf34ed402ad9b34696273351cbc1b4b
+SHA512:
+  metadata.gz: 08ea9cfa3e8e47208b3278806d57e8155a39a3f48e64f27c0d8775684cb72ba28acdf131ef0a9b0cb0369693b6a1657a10b6af7be07698037838b9a020eb5025
+  data.tar.gz: 36e642a9ddc3c7e8433aa976235f40d5ce87f8e5a8b089c265d7472b4949d64ba8a07c84f43fee8a4f1e038d5321ccdcd3be579d0278f86b9278836f9c979836

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+build

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,224 @@
+# Changelog
+
+## 0.3.0
+
+*   Support `status` and `code` for Error Objects
+
+    When an error is handed back to the user, we now provide the status and the
+    code keys. This adds another feature to the API that is supported by the
+    JSON API specification.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   Add Friendly ID Support for `Spree::Product`
+
+    When a request came in for `/api/v2/products/example-product` and there was
+    a product in the DB with a corresponding slug, it would return a 404. The
+    controller now calls `Spree::Product.friendly` before rendering any
+    instance.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   Drop Spree Support
+
+    After trying to get the spree support working, I’ve concluded that its just
+    not worth it. I know there’s a lot of you out there that really want this.
+    If you truly need to keep using Spree, please fork this repo and make the
+    necessary changes.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   The project has been renamed from `spree_api_v2` to `solidus_json_api`.
+    Since the Spree project is no longer maintained, then there's no reason to
+    give Spree a second API version. This means that you need to update the
+    following code:
+
+    ```ruby
+    ### Before ###
+
+    # Gemfile
+    gem 'spree_api_v2'
+
+    # config/initializers/spree_api_v2.rb
+    SolidusApiV2.setup do |config|
+      config.parent_serializer = ApplicationSerializer
+    end
+
+    ### After ###
+
+    # Gemfile
+    gem 'solidus_json_api'
+
+    # config/initializers/solidus_json_api.rb
+    SolidusJsonApi.setup do |config|
+      config.parent_serializer = ApplicationSerializer
+    end
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   In Spree, you will receive an error if the stock is not sufficient when
+    updating a line item. This is done in this project since the API requires
+    it. However, when transition to Solidus, we discovered that this feature was
+    constrained to the complete state. We've added a validation check before
+    saving a line item. Please open an issue if you believe this to be an
+    anti-pattern.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   Removed `Spree::Order#considered_risky` from the JSON response since Solidus
+    doesn't support this anymore.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   `Spree::Variant#depth`, `Spree::Variant#width`, and `Spree::Variant#height`
+    now return `null` instead of `""` when empty.
+
+    ```json
+    // Before
+    {
+      "type" : "spree_variant",
+      "data" : {
+        "attributes" : {
+          "depth" : "",
+          "width" : "",
+          "height" : "",
+          ...
+        }
+      }
+    }
+
+    // After
+    {
+      "type" : "spree_variant",
+      "data" : {
+        "attributes" : {
+          "depth" : null,
+          "width" : null,
+          "height" : null,
+          ...
+        }
+      }
+    }
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   `Spree::LineItem#additional_tax_total` and `Spree::LineItem#adjustment_total`
+    now return as strings instead of floats in the api:
+
+    ```json
+    // Before
+    {
+      "type" : "spree_line_item",
+      "data" : {
+        "attributes" : {
+          "additional_tax_total" : 0,
+          "adjustment_total" : 0.0,
+          ...
+        }
+      }
+    }
+
+    // After
+    {
+      "type" : "spree_line_item",
+      "data" : {
+        "attributes" : {
+          "additional_tax_total" : "0",
+          "adjustment_total" : "0.0",
+          ...
+        }
+      }
+    }
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   For Orders, you can now list them. A user can only view their own orders.
+    If the user is an admin, they can view all of the orders.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   POST `/api/v2/line_items` now requires JSON API format instead of the rails
+    format.
+
+    ```shell
+    # Before
+    curl "https://example.com/api/v2/line_items"
+      -X POST
+      -d token=abc123
+      -d line_item[order_id]=1
+      -d line_item[variant_id]=1
+      -d line_item[quantity]=1
+
+    # After
+    curl "https://example.com/api/v2/line_items"
+      -X POST
+      -d token=abc123
+      -d data[attributes][order_id]=1
+      -d data[attributes][variant_id]=1
+      -d data[attributes][quantity]=1
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+## 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
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+## 0.2.1
+
+*   Fixes a bug where the user serializer wasn't extending from the `Spree::BaseSerializer` this is now fixed.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+## 0.2.0
+
+*   Calling `super` inside fo `#index` and `#show` actions is now deprecated.
+    Since these are methods that are meant to be called, they have been renamed to `#render_collection` and `#render_instance`.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   Added support for [Solidus](https://github.com/solidusio/solidus).
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+*   In some instances, you would like to use the helper methods provided by the Spree V2 API, but unable to extend from the controller.
+    The render methods have been moved to a concern.
+    If you would like to include them in a controller without having to extend from the `Spree::Api::V2::BaseController`, then:
+
+    ```ruby
+    module Api
+      class MyController < Api::BaseController
+        # include the concern
+        include Spree::Api::V2::Renderable
+
+        # example usage of rendering all products without calling
+        # +render_instance+ but providing page detail information that conforms
+        # to the JSON API spec.
+        def index
+          render json: @products, meta: { page: page_details(@products) }
+        end
+      end
+    end
+    ```
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
+## 0.1.0
+
+Initial Release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'solidus_api', github: 'solidusio/solidus'
+gem 'solidus_auth_devise', github: 'solidusio/solidus_auth_devise'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2015 Ben A. Morgan
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,94 @@
+# Solidus JSON API
+
+[![Circle CI](https://circleci.com/gh/wildcardlabs/solidus_json_api.svg?style=shield&circle-token=e2f6283b074ca9febcafab729d466ded2334300c)](https://circleci.com/gh/wildcardlabs/solidus_json_api)
+[![Coverage Status](https://coveralls.io/repos/github/wildcardlabs/solidus_json_api/badge.svg?branch=master)](https://coveralls.io/github/wildcardlabs/solidus_json_api?branch=master)
+
+A JSON API for Solidus.
+
+Documentation: [http://solidusapi.wildcardlabs.com](http://solidusapi.wildcardlabs.com)
+
+## Installation
+
+Add solidus_json_api to your Gemfile:
+
+```ruby
+gem 'solidus_json_api', github: 'wildcardlabs/solidus_json_api'
+```
+
+## Road to 1.0
+
+***
+Please note that there actually has been a _lot_ of work done.
+The lack of checked off boxes doesn't give this gem the respect it deserves.
+***
+
+There's several things blocking 1.0.
+Below, you'll see a bullet list of requirements that are both specific to the app, the JSON API spec, and third parties.
+
+- [ ] Manage permissions with CanCanCan.
+- [ ] Add support for XML.
+- [ ] Add support for pagination.
+  - [x] `page` keyword support for pagination.
+  - [ ] `links` document at the root for `self`, `next`, `prev`, `last`, and `first`.
+- [ ] Add support for filtration.
+  - [x] Be able to filter onto the main data object.
+  - [ ] Be able to filter the included relationships.
+- [ ] Provide JSON API specific error objects. Provide support for:
+  - [ ] `id`
+  - [ ] `links`
+     - [ ] `about`
+  - [x] `status`
+  - [x] `code`
+  - [x] `title`
+  - [x] `detail`
+  - [ ] `source`
+    - [x] `pointer`
+    - [ ] `parameter`
+  - [x] `meta`
+- [ ] Only accept data in the JSON API format.
+- [ ] Respond with header `Content-Type: application/vnd.api+json`.
+- [ ] Add support for sparse fieldsets.
+- [ ] Add support for sorting.
+
+| Resource         |  index  | create  |  show   | update  | destroy |
+|------------------|:-------:|:-------:|:-------:|:-------:|:-------:|
+| Adjustment       |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Address          |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Checkout         |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Country          |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Image            |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Line Item        |   [ ]   |   [x]   |   [ ]   |   [ ]   |   [ ]   |
+| Option Type      |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Option Value     |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Order            |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Payment          |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Price            |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Product          |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Product Property |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Return Auth      |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Shipment         |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| State            |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Stock Location   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Stock Movement   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Stock Item       |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Store            |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Store Credit     |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Tax Category     |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Tax Rate         |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+| Taxon            |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Taxonomy         |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| User             |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Variant          |   [x]   |   [ ]   |   [x]   |   [ ]   |   [ ]   |
+| Zone             |   [ ]   |   [ ]   |   [ ]   |   [ ]   |   [ ]   |
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run the specs.
+The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+Copyright © 2015 Ben A. Morgan, released under the New BSD License

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+require 'generators/spree/dummy/dummy_generator'
+require 'generators/spree/install/install_generator'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV["RAILS_ENV"] = 'test'
+
+  Spree::DummyGeneratorHelper.inject_extension_requirements = true
+  Spree::DummyGenerator.start %w(--lib_name=solidus_json_api --quiet)
+
+  Spree::InstallGenerator.class_eval do
+    def config_spree_yml() end
+  end
+
+  Spree::InstallGenerator.start %w(
+    --lib_name=solidus_json_api --auto-accept --migrate=false --seed=false
+    --sample=false --quiet --user_class=Spree::LegacyUser
+  )
+
+  puts 'Setting up dummy database...'
+  system "bundle exec rake db:drop db:create db:migrate > #{File::NULL}"
+end

data/app/controllers/concerns/spree/api/v2/renderable.rb

@@ -0,0 +1,63 @@
+module Spree
+  module Api
+    module V2
+      module Renderable
+        extend ActiveSupport::Concern
+
+        protected
+
+        def render_collection(collection = [])
+          collection = collection.where(filter_params).paginate(page_params)
+          render json: collection, include: params[:include],
+                 meta: { page: page_details(collection) }
+        end
+
+        def render_instance(object = {})
+          render json: object, include: params[:include]
+        end
+
+        def filter_params
+          params.fetch(:filter, {}).permit(*filter_attributes).transform_values do |value|
+            value.respond_to?(:each) ? value : value.split(',')
+          end
+        end
+
+        private
+
+        def render_error(resource, options = {})
+          response.status = options.delete(:status) || 400
+          options[:response] = response
+          render json: error_response(resource, options)
+        end
+
+        def error_response(resource, options = {})
+          Spree::ErrorSerializer.new(resource, options).as_json
+        end
+
+        def filter_attributes
+          attributes = serializer_attributes
+          attributes << :id unless attributes.include?(:id)
+          attributes.map { |a| [{ a => [] }, a] }.flatten
+        end
+
+        def page_details(collection)
+          {
+            total_items: collection.total_count,
+            total_pages: collection.total_pages,
+            number: (page_params[:number] || 1).to_i,
+            size: (page_params[:size] || Kaminari.config.default_per_page).to_i
+          }
+        end
+
+        def page_params
+          params.fetch(:page, {}).permit(:number, :size)
+        end
+
+        def serializer_attributes
+          serializer = "Spree::#{controller_name.camelize.singularize}Serializer"
+          serializer.constantize._attributes
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/base_controller.rb

@@ -0,0 +1,9 @@
+module Spree
+  module Api
+    module V2
+      class BaseController < Spree::Api::BaseController
+        include Spree::Api::V2::Renderable
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/children_controller.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V2
+      class ChildrenController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection children.includes(:products, :taxonomy, :children, :parent)
+        end
+
+        def show
+          render_instance children.find(params[:id])
+        end
+
+        private
+
+        def children
+          if params[:taxon_id]
+            Spree::Taxon.find(params[:taxon_id])
+          end.children
+        end
+
+        def filter_attributes
+          Spree::TaxonSerializer._attributes
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/countries_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      class CountriesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection Spree::Country.includes(:states)
+        end
+
+        def show
+          if params[:state_id].present?
+            render_instance Spree::State.find_country(params[:state_id])
+          else
+            render_instance Spree::Country.find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/images_controller.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V2
+      class ImagesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection images.includes(:viewable)
+        end
+
+        def show
+          render_instance images.find(params[:id])
+        end
+
+        private
+
+        def images
+          if params[:product_id]
+            Spree::Product.find(params[:product_id]).images
+          elsif params[:variant_id]
+            Spree::Variant.find(params[:variant_id]).images
+          else
+            Spree::Image
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/line_items_controller.rb

@@ -0,0 +1,36 @@
+module Spree
+  module Api
+    module V2
+      class LineItemsController < Spree::Api::V2::BaseController
+        rescue_from ActiveRecord::RecordNotFound, with: :render_record_not_found_error
+        rescue_from Spree::Order::InsufficientStock, with: :render_insufficient_stock_error
+        rescue_from RangeError, with: :render_range_error
+
+        def create
+          variant = Spree::Variant.find(line_item_params[:variant_id])
+          order = @current_api_user.orders.find(line_item_params[:order_id])
+          line_item = order.contents.add(variant, line_item_params[:quantity])
+          render_instance line_item
+        end
+
+        private
+
+        def line_item_params
+          params.require(:data).require(:attributes).permit(:variant_id, :order_id, :quantity)
+        end
+
+        def render_range_error
+          render_error :quantity_too_high
+        end
+
+        def render_insufficient_stock_error
+          render_error :product_out_of_stock
+        end
+
+        def render_record_not_found_error
+          render_error :record_not_found
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/option_types_controller.rb

@@ -0,0 +1,31 @@
+module Spree
+  module Api
+    module V2
+      class OptionTypesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection option_types.includes(:option_values, :products)
+        end
+
+        def show
+          if params[:option_value_id]
+            render_instance Spree::OptionValue.find(params[:option_value_id]).option_type
+          else
+            render_instance option_types.find(params[:id])
+          end
+        end
+
+        private
+
+        def option_types
+          if params[:product_id]
+            Spree::Product.find(params[:product_id]).option_types
+          else
+            Spree::OptionType
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/option_values_controller.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V2
+      class OptionValuesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection option_values.includes(:option_type, :variants)
+        end
+
+        def show
+          render_instance option_values.find(params[:id])
+        end
+
+        private
+
+        def option_values
+          if params[:option_type_id]
+            Spree::OptionType.find(params[:option_type_id]).option_values
+          elsif params[:variant_id]
+            Spree::Variant.find(params[:variant_id]).option_values
+          else
+            Spree::OptionValue
+          end
+        end
+      end
+    end
+  end
+end