solidus_json_api 0.3.0

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      class OrdersController < Spree::Api::V2::BaseController
+        def index
+          render_collection orders
+        end
+
+        def show
+          render_instance orders.find(params[:id])
+        end
+
+        private
+
+        def orders
+          @current_api_user.admin? ? Spree::Order : @current_api_user.orders
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module V2
+      class PricesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user
+
+        def index
+          render_collection params[:variant_id] ? prices : prices.includes(:variant)
+        end
+
+        def show
+          render_instance prices.find(params[:id])
+        end
+
+        private
+
+        def prices
+          if params[:variant_id]
+            Spree::Variant.find(params[:variant_id]).prices
+          else
+            Spree::Price
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Spree
+  module Api
+    module V2
+      class ProductsController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection products.includes :variants, :master, :taxons, :option_types, master: :images
+        end
+
+        def show
+          if params[:price_id]
+            render_instance Spree::Price.find(params[:price_id]).product
+          elsif params[:variant_id]
+            render_instance Spree::Variant.find(params[:variant_id]).product
+          elsif params[:image_id]
+            render_instance Spree::Image.variants.find(params[:image_id]).viewable.product
+          else
+            render_instance products.friendly.find(params[:id])
+          end
+        end
+
+        private
+
+        def products
+          if params[:taxon_id].present?
+            Spree::Taxon.find(params[:taxon_id]).products
+          elsif params[:option_type_id]
+            Spree::OptionType.find(params[:option_type_id]).products
+          else
+            Spree::Product
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V2
+      class StatesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user
+
+        def index
+          render_collection states
+        end
+
+        def show
+          render_instance states.find(params[:id])
+        end
+
+        private
+
+        def states
+          @states ||= begin
+            if params[:country_id].present?
+              Spree::Country.find(params[:country_id]).states.includes(:country)
+            else
+              Spree::State.includes(:country)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      class TaxonomiesController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection Spree::Taxonomy.includes(:taxons)
+        end
+
+        def show
+          if params[:taxon_id].present?
+            render_instance Spree::Taxon.find(params[:taxon_id]).taxonomy
+          else
+            render_instance Spree::Taxonomy.find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    module V2
+      class TaxonsController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user, only: [:index, :show]
+
+        def index
+          render_collection taxons
+        end
+
+        def show
+          render_instance taxon
+        end
+
+        private
+
+        def taxon
+          if params[:taxon_id].present?
+            taxons.includes(parent: taxon_associations).find(params[:taxon_id]).parent
+          else
+            taxons.find(params[:id])
+          end
+        end
+
+        def taxons
+          if params[:taxonomy_id].present?
+            Spree::Taxonomy.find(params[:taxonomy_id]).taxons
+              .includes(*taxon_associations.-([:taxonomy]))
+          else
+            Spree::Taxon.includes(*taxon_associations)
+          end
+        end
+
+        def taxon_associations
+          [:products, :taxonomy, :parent]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V2
+      class VariantsController < Spree::Api::V2::BaseController
+        skip_before_action :authenticate_user
+
+        def index
+          render_collection variants.includes(:default_price, :prices, :option_values, :product, :images)
+        end
+
+        def show
+          if params[:price_id]
+            render_instance Spree::Price.find(params[:price_id]).variant
+          elsif params[:image_id]
+            render_instance Spree::Image.variants.find(params[:image_id]).viewable
+          else
+            render_instance variants.find(params[:id])
+          end
+        end
+
+        private
+
+        def variants
+          if params[:product_id]
+            Spree::Product.find(params[:product_id]).variants_including_master
+          elsif params[:option_value_id]
+            Spree::OptionValue.find(params[:option_value_id]).variants
+          else
+            Spree::Variant
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/base_decorator.rb

@@ -0,0 +1,5 @@
+Spree::Base.class_eval do
+  def self.paginate(page_attrs)
+    page(page_attrs[:number]).per(page_attrs[:size])
+  end
+end

data/app/models/spree/image_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Image.class_eval do
+  scope :variants, -> { where(viewable_type: 'Spree::Variant') }
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,3 @@
+Spree::LineItem.class_eval do
+  before_save -> { order.send :validate_line_item_availability }
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Order.class_eval do
+  money_methods :promo_total
+end

data/app/models/spree/price_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Price.class_eval do
+  delegate :product, to: :variant
+end

data/app/models/spree/state_decorator.rb

@@ -0,0 +1,3 @@
+Spree::State.class_eval do
+  scope :find_country, -> (id) { includes(:country).find(id).country }
+end

data/app/serializers/spree/address_serializer.rb

@@ -0,0 +1,9 @@
+module Spree
+  class AddressSerializer < Spree::BaseSerializer
+    attributes :first_name, :last_name, :address1, :address2, :city, :zipcode,
+               :phone
+
+    belongs_to :state
+    belongs_to :country
+  end
+end

data/app/serializers/spree/base_serializer.rb

@@ -0,0 +1,13 @@
+module Spree
+  class BaseSerializer < SolidusJsonApi.parent_serializer
+    def image_links(object)
+      {
+        original: object.url(:original),
+        mini: object.url(:mini),
+        small: object.url(:small),
+        product: object.url(:product),
+        large: object.url(:large)
+      }
+    end
+  end
+end

data/app/serializers/spree/country_serializer.rb

@@ -0,0 +1,7 @@
+module Spree
+  class CountrySerializer < Spree::BaseSerializer
+    attributes :iso_name, :iso, :iso3, :name, :numcode, :states_required
+
+    has_many :states
+  end
+end

data/app/serializers/spree/error_serializer.rb

@@ -0,0 +1,55 @@
+module Spree
+  class ErrorSerializer
+    attr_accessor :resource, :options, :response
+
+    def initialize(resource, options = {})
+      @resource = resource
+      @response = options.delete(:response)
+      @options = options
+    end
+
+    def as_json
+      { errors: error_messages }.to_json
+    end
+
+    private
+
+    def resource_error_objects(messages)
+      messages.map do |title, detail|
+        pointer = "data/attributes/#{title.to_s.split('.').join('/')}"
+        error_object title.to_s.gsub('.', ' '), detail.to_sentence, pointer: pointer
+      end
+    end
+
+    def error_messages
+      case resource
+      when Symbol
+        title_translation = Spree.t("api.errors.#{resource}.title")
+        detail_translation = Spree.t("api.errors.#{resource}.detail")
+        [error_object(title_translation, detail_translation)]
+      when Array
+        resource.map { |errors| resource_error_objects errors }.flatten
+      else
+        resource_error_objects resource.errors.messages
+      end
+    end
+
+    def error_object(title, detail, pointer: '')
+      error = {
+        detail: detail.gsub("\n", ' ').strip,
+        meta: options,
+        title: title.to_s.titleize
+      }
+
+      error.merge!(response_attributes) if response.present?
+      pointer.present? ? error.merge(pointer: pointer) : error
+    end
+
+    def response_attributes
+      {
+        status: response.status_message,
+        code: response.code
+      }
+    end
+  end
+end

data/app/serializers/spree/image_serializer.rb

@@ -0,0 +1,13 @@
+module Spree
+  class ImageSerializer < Spree::BaseSerializer
+    attributes :position, :alt, :links
+
+    belongs_to :viewable
+
+    private
+
+    def links
+      image_links object.attachment
+    end
+  end
+end

data/app/serializers/spree/line_item_serializer.rb

@@ -0,0 +1,13 @@
+module Spree
+  class LineItemSerializer < Spree::BaseSerializer
+    attributes :id, :quantity, :variant_id, :order_id, :currency, :cost_price,
+               :adjustment_total, :additional_tax_total, :price
+
+    %w(amount total).each do |money_method|
+      attributes money_method, "display_#{money_method}"
+    end
+
+    belongs_to :order
+    belongs_to :variant
+  end
+end

data/app/serializers/spree/option_type_serializer.rb

@@ -0,0 +1,8 @@
+module Spree
+  class OptionTypeSerializer < Spree::BaseSerializer
+    attributes :name, :presentation, :position
+
+    has_many :option_values
+    has_many :products
+  end
+end

data/app/serializers/spree/option_value_serializer.rb

@@ -0,0 +1,8 @@
+module Spree
+  class OptionValueSerializer < Spree::BaseSerializer
+    attributes :name, :presentation, :position
+
+    belongs_to :option_type
+    has_many :variants
+  end
+end

data/app/serializers/spree/order_serializer.rb

@@ -0,0 +1,20 @@
+module Spree
+  class OrderSerializer < Spree::BaseSerializer
+    attributes :email, :number, :state, :completed_at, :shipment_state,
+               :payment_state, :special_instructions, :currency, :channel,
+               :item_count, :approved_at, :confirmation_delivered, :canceled_at,
+               :payment_total, :total, :display_total
+
+    %w(
+      item adjustment shipment promo additional_tax included_tax
+    ).each do |money_method|
+      attributes "#{money_method}_total", "display_#{money_method}_total"
+    end
+
+    has_one :user
+    has_one :bill_address
+    has_one :ship_address
+
+    has_many :line_items
+  end
+end

data/app/serializers/spree/price_serializer.rb

@@ -0,0 +1,7 @@
+module Spree
+  class PriceSerializer < Spree::BaseSerializer
+    attributes :amount, :price, :display_amount, :display_price, :currency
+
+    belongs_to :variant
+  end
+end

data/app/serializers/spree/product_serializer.rb

@@ -0,0 +1,12 @@
+module Spree
+  class ProductSerializer < Spree::BaseSerializer
+    attributes :name, :description, :slug, :meta_description, :meta_keywords
+
+    has_one :master
+
+    has_many :variants
+    has_many :taxons
+    has_many :option_types
+    has_many :images
+  end
+end

data/app/serializers/spree/role_serializer.rb

@@ -0,0 +1,5 @@
+module Spree
+  class RoleSerializer < Spree::BaseSerializer
+    attributes :name
+  end
+end

data/app/serializers/spree/state_serializer.rb

@@ -0,0 +1,7 @@
+module Spree
+  class StateSerializer < Spree::BaseSerializer
+    attributes :name, :abbr
+
+    belongs_to :country
+  end
+end

data/app/serializers/spree/store_serializer.rb

@@ -0,0 +1,6 @@
+module Spree
+  class StoreSerializer < Spree::BaseSerializer
+    attributes :name, :url, :meta_description, :meta_keywords, :seo_title,
+               :mail_from_address, :default_currency, :code, :default
+  end
+end

data/app/serializers/spree/taxon_serializer.rb

@@ -0,0 +1,16 @@
+module Spree
+  class TaxonSerializer < Spree::BaseSerializer
+    attributes :name, :permalink, :position, :description, :meta_title, :links,
+               :meta_description, :meta_keywords, :depth
+
+    belongs_to :taxonomy
+    belongs_to :parent, serializer: TaxonSerializer
+    has_many :children, serializer: TaxonSerializer
+
+    private
+
+    def links
+      image_links object.icon
+    end
+  end
+end

data/app/serializers/spree/taxonomy_serializer.rb

@@ -0,0 +1,7 @@
+module Spree
+  class TaxonomySerializer < Spree::BaseSerializer
+    attributes :name, :position
+
+    has_many :taxons
+  end
+end

data/app/serializers/spree/user_serializer.rb

@@ -0,0 +1,5 @@
+module Spree
+  class UserSerializer < Spree::BaseSerializer
+    attributes :id, :email
+  end
+end

data/app/serializers/spree/variant_serializer.rb

@@ -0,0 +1,12 @@
+module Spree
+  class VariantSerializer < Spree::BaseSerializer
+    attributes :sku, :weight, :height, :width, :depth, :is_master, :position,
+               :name, :price, :display_price
+
+    has_many :prices
+    has_many :option_values
+    has_many :images
+
+    belongs_to :product
+  end
+end

data/circle.yml

@@ -0,0 +1,12 @@
+---
+machine:
+  environment:
+    DB: postgres
+  services:
+    - postgresql
+  ruby:
+    version: 2.3.0
+
+test:
+  override:
+    - bundle exec rake

data/config/locales/en.yml

@@ -0,0 +1,25 @@
+en:
+  spree:
+    api:
+      errors:
+        invalid_token:
+          detail: 'Your token is invalid, please use a different one.'
+          title: Invalid Token
+        order_complete:
+          detail: This order has been completed.
+          title: Order Complete
+        product_out_of_stock:
+          title: Product is out of Stock
+          detail: >
+            This product is out of stock for the selected quantity.
+        record_not_found:
+          title: Record Not Found
+          detail: >
+            One of the records that you were looking for could not be found.
+            Please check to see if the record exists or if you're permitted to
+            read it.
+        quantity_too_high:
+          title: Quantity is too High
+          detail: >
+            The quantity that you have submitted is astronomically high, please
+            tone it down a bit.

data/config/routes.rb

@@ -0,0 +1,53 @@
+Spree::Core::Engine.routes.draw do
+  namespace :api, defaults: { format: :json } do
+    namespace :v2 do
+      resources :countries, only: [:index, :show] do
+        resources :states, only: [:index, :show]
+      end
+
+      resources :images, only: [:index, :show] do
+        resource :product, :variant, only: :show
+      end
+
+      resources :line_items, only: :create
+
+      resources :option_types, only: [:index, :show] do
+        resources :option_values, :products, only: [:index, :show]
+      end
+
+      resources :option_values, only: [:index, :show] do
+        resource :option_type, only: :show
+        resources :variants, only: [:index, :show]
+      end
+
+      resources :orders, only: [:index, :show]
+
+      resources :prices, only: [:index, :show] do
+        resource :variant, :product, only: :show
+      end
+
+      resources :products, only: [:index, :show] do
+        resources :option_types, :variants, :images, only: [:index, :show]
+      end
+
+      resources :states, only: [:index, :show] do
+        resource :country, only: :show
+      end
+
+      resources :taxonomies, only: [:index, :show] do
+        resources :taxons, only: [:index, :show]
+      end
+
+      resources :taxons, only: [:index, :show] do
+        resources :children, :products, only: [:index, :show]
+        resource :parent, only: :show, controller: 'taxons'
+        resource :taxonomy, only: :show
+      end
+
+      resources :variants, only: [:index, :show] do
+        resources :prices, :option_values, :images, only: [:index, :show]
+        resource :product, only: :show
+      end
+    end
+  end
+end

data/docs/Dockerfile

@@ -0,0 +1,12 @@
+FROM ubuntu:trusty
+
+RUN apt-get update
+RUN apt-get install -yq ruby ruby-dev build-essential git
+RUN gem install --no-ri --no-rdoc bundler
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN cd /app; bundle install
+ADD . /app
+EXPOSE 4567
+WORKDIR /app
+CMD ["bundle", "exec", "middleman", "server"]

data/docs/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+ruby '2.2.3'
+
+# Middleman
+gem 'middleman', '~> 3.3.10'
+gem 'middleman-gh-pages', '~> 0.0.3'
+gem 'middleman-syntax', '~> 2.0.0'
+gem 'middleman-autoprefixer', '~> 2.4.4'
+
+gem 'rouge', '~> 1.9.0'
+gem 'redcarpet', '~> 3.3.2'
+
+gem 'rake', '~> 10.4.2'
+gem 'therubyracer', '~> 0.12.2', platforms: :ruby

data/docs/README.md

@@ -0,0 +1,12 @@
+# Documentation for the Solidus JSON API
+
+The documentation is hand written and forked from [Slate](https://github.com/tripit/slate).
+Please update these docs when you make a contribution.
+
+## Setup
+
+```shell
+cd docs
+bundle
+middleman server
+```

data/docs/Rakefile

@@ -0,0 +1,9 @@
+ENV['MM_ROOT'] = File.expand_path '.'
+ENV['BUNDLE_GEMFILE'] = File.expand_path './Gemfile'
+
+require 'middleman-gh-pages'
+require 'rake/clean'
+
+CLOBBER.include('build')
+
+task default: [:build]