spree_api_v1 4.5.0

data/app/views/spree/api/v1/shipments/big.rabl

@@ -0,0 +1,48 @@
+object @shipment
+cache @shipment
+attributes *shipment_attributes
+
+child selected_shipping_rate: :selected_shipping_rate do
+  extends 'spree/api/v1/shipping_rates/show'
+end
+
+child inventory_units: :inventory_units do
+  object @inventory_unit
+  attributes *inventory_unit_attributes
+
+  child :variant do
+    extends 'spree/api/v1/variants/small'
+    attributes :product_id
+    child(images: :images) { extends 'spree/api/v1/images/show' }
+  end
+
+  child :line_item do
+    attributes *line_item_attributes
+    node(:single_display_amount) { |li| li.single_display_amount.to_s }
+    node(:display_amount) { |li| li.display_amount.to_s }
+    node(:total, &:total)
+  end
+end
+
+child order: :order do
+  extends 'spree/api/v1/orders/order'
+
+  child billing_address: :bill_address do
+    extends 'spree/api/v1/addresses/show'
+  end
+
+  child shipping_address: :ship_address do
+    extends 'spree/api/v1/addresses/show'
+  end
+
+  child adjustments: :adjustments do
+    extends 'spree/api/v1/adjustments/show'
+  end
+
+  child payments: :payments do
+    attributes :id, :amount, :display_amount, :state
+    child payment_method: :payment_method do
+      attributes :id, :name
+    end
+  end
+end

data/app/views/spree/api/v1/shipments/cannot_ready_shipment.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:cannot_ready, scope: 'spree.api.shipment') }

data/app/views/spree/api/v1/shipments/mine.rabl

@@ -0,0 +1,9 @@
+object false
+
+node(:count) { @shipments.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @shipments.total_pages }
+
+child(@shipments => :shipments) do
+  extends 'spree/api/v1/shipments/big'
+end

data/app/views/spree/api/v1/shipments/show.rabl

@@ -0,0 +1,32 @@
+object @shipment
+cache [I18n.locale, root_object]
+attributes *shipment_attributes
+node(:order_id) { |shipment| shipment.order.number }
+node(:stock_location_name) { |shipment| shipment.stock_location.name }
+
+child shipping_rates: :shipping_rates do
+  extends 'spree/api/v1/shipping_rates/show'
+end
+
+child selected_shipping_rate: :selected_shipping_rate do
+  extends 'spree/api/v1/shipping_rates/show'
+end
+
+child shipping_methods: :shipping_methods do
+  attributes :id, :name, :tracking_url
+  child zones: :zones do
+    attributes :id, :name, :description
+  end
+
+  child shipping_categories: :shipping_categories do
+    attributes :id, :name
+  end
+end
+
+child manifest: :manifest do
+  child variant: :variant do
+    extends 'spree/api/v1/variants/small'
+  end
+  node(:quantity, &:quantity)
+  node(:states, &:states)
+end

data/app/views/spree/api/v1/shipments/small.rabl

@@ -0,0 +1,37 @@
+object @shipment
+cache [I18n.locale, 'small_shipment', root_object]
+
+attributes *shipment_attributes
+node(:order_id) { |shipment| shipment.order.number }
+node(:stock_location_name) { |shipment| shipment.stock_location.name }
+
+child shipping_rates: :shipping_rates do
+  extends 'spree/api/v1/shipping_rates/show'
+end
+
+child selected_shipping_rate: :selected_shipping_rate do
+  extends 'spree/api/v1/shipping_rates/show'
+end
+
+child shipping_methods: :shipping_methods do
+  attributes :id, :code, :name
+  child zones: :zones do
+    attributes :id, :name, :description
+  end
+
+  child shipping_categories: :shipping_categories do
+    attributes :id, :name
+  end
+end
+
+child manifest: :manifest do
+  glue(:variant) do
+    attribute id: :variant_id
+  end
+  node(:quantity, &:quantity)
+  node(:states, &:states)
+end
+
+child adjustments: :adjustments do
+  extends 'spree/api/v1/adjustments/show'
+end

data/app/views/spree/api/v1/shipping_rates/show.rabl

@@ -0,0 +1,2 @@
+attributes :id, :name, :cost, :selected, :shipping_method_id, :shipping_method_code
+node(:display_cost) { |sr| sr.display_cost.to_s }

data/app/views/spree/api/v1/states/index.rabl

@@ -0,0 +1,12 @@
+object false
+node(:states_required) { @country.states_required } if @country
+
+child(@states => :states) do
+  attributes *state_attributes
+end
+
+if @states.respond_to?(:total_pages)
+  node(:count) { @states.count }
+  node(:current_page) { params[:page].try(:to_i) || 1 }
+  node(:pages) { @states.total_pages }
+end

data/app/views/spree/api/v1/states/show.rabl

@@ -0,0 +1,2 @@
+object @state
+attributes *state_attributes

data/app/views/spree/api/v1/stock_items/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@stock_items => :stock_items) do
+  extends 'spree/api/v1/stock_items/show'
+end
+node(:count) { @stock_items.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @stock_items.total_pages }

data/app/views/spree/api/v1/stock_items/show.rabl

@@ -0,0 +1,5 @@
+object @stock_item
+attributes *stock_item_attributes
+child(:variant) do
+  extends 'spree/api/v1/variants/small'
+end

data/app/views/spree/api/v1/stock_locations/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@stock_locations => :stock_locations) do
+  extends 'spree/api/v1/stock_locations/show'
+end
+node(:count) { @stock_locations.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @stock_locations.total_pages }

data/app/views/spree/api/v1/stock_locations/show.rabl

@@ -0,0 +1,8 @@
+object @stock_location
+attributes *stock_location_attributes
+child(:country) do |_address|
+  attributes *country_attributes
+end
+child(:state) do |_address|
+  attributes *state_attributes
+end

data/app/views/spree/api/v1/stock_movements/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@stock_movements => :stock_movements) do
+  extends 'spree/api/v1/stock_movements/show'
+end
+node(:count) { @stock_movements.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @stock_movements.total_pages }

data/app/views/spree/api/v1/stock_movements/show.rabl

@@ -0,0 +1,5 @@
+object @stock_movement
+attributes *stock_movement_attributes
+child :stock_item do
+  extends 'spree/api/v1/stock_items/show'
+end

data/app/views/spree/api/v1/stores/index.rabl

@@ -0,0 +1,4 @@
+object false
+child(@stores => :stores) do
+  attributes *store_attributes
+end

data/app/views/spree/api/v1/stores/show.rabl

@@ -0,0 +1,2 @@
+object @store
+attributes *store_attributes

data/app/views/spree/api/v1/tags/index.rabl

@@ -0,0 +1,9 @@
+object false
+node(:count) { @tags.count }
+node(:total_count) { @tags.total_count }
+node(:current_page) { params[:page] ? params[:page].to_i : 1 }
+node(:per_page) { params[:per_page] || Kaminari.config.default_per_page }
+node(:pages) { @tags.total_pages }
+child(@tags => :tags) do
+  attributes :name, :id
+end

data/app/views/spree/api/v1/taxonomies/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@taxonomies => :taxonomies) do
+  extends 'spree/api/v1/taxonomies/show'
+end
+node(:count) { @taxonomies.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @taxonomies.total_pages }

data/app/views/spree/api/v1/taxonomies/jstree.rabl

@@ -0,0 +1,7 @@
+object false
+node(:data) { @taxonomy.root.name }
+node(:attr) do
+  { id: @taxonomy.root.id,
+    name: @taxonomy.root.name }
+end
+node(:state) { 'closed' }

data/app/views/spree/api/v1/taxonomies/nested.rabl

@@ -0,0 +1,11 @@
+attributes *taxonomy_attributes
+
+child root: :root do
+  attributes *taxon_attributes
+
+  child children: :taxons do
+    attributes *taxon_attributes
+
+    extends 'spree/api/v1/taxons/taxons'
+  end
+end

data/app/views/spree/api/v1/taxonomies/new.rabl

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*taxonomy_attributes] }
+node(:required_attributes) { required_fields_for(Spree::Taxonomy) }

data/app/views/spree/api/v1/taxonomies/show.rabl

@@ -0,0 +1,15 @@
+object @taxonomy
+
+if params[:set] == 'nested'
+  extends 'spree/api/v1/taxonomies/nested'
+else
+  attributes *taxonomy_attributes
+
+  child root: :root do
+    attributes *taxon_attributes
+
+    child children: :taxons do
+      attributes *taxon_attributes
+    end
+  end
+end

data/app/views/spree/api/v1/taxons/index.rabl

@@ -0,0 +1,10 @@
+object false
+node(:count) { @taxons.count }
+node(:total_count) { @taxons.total_count }
+node(:current_page) { params[:page] ? params[:page].to_i : 1 }
+node(:per_page) { params[:per_page].try(:to_i) || Kaminari.config.default_per_page }
+node(:pages) { @taxons.total_pages }
+child @taxons => :taxons do
+  attributes *taxon_attributes
+  extends 'spree/api/v1/taxons/taxons' unless params[:without_children]
+end

data/app/views/spree/api/v1/taxons/jstree.rabl

@@ -0,0 +1,7 @@
+collection @taxon.children, object_root: false
+node(:data, &:name)
+node(:attr) do |taxon|
+  { id: taxon.id,
+    name: taxon.name }
+end
+node(:state) { 'closed' }

data/app/views/spree/api/v1/taxons/new.rabl

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*taxon_attributes] }
+node(:required_attributes) { required_fields_for(Spree::Taxon) }

data/app/views/spree/api/v1/taxons/show.rabl

@@ -0,0 +1,6 @@
+object @taxon
+attributes *taxon_attributes
+
+child children: :taxons do
+  attributes *taxon_attributes
+end

data/app/views/spree/api/v1/taxons/taxons.rabl

@@ -0,0 +1,5 @@
+attributes *taxon_attributes
+
+node :taxons do |t|
+  t.children.map { |c| partial('spree/api/v1/taxons/taxons', object: c) }
+end

data/app/views/spree/api/v1/users/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@users => :users) do
+  extends 'spree/api/v1/users/show'
+end
+node(:count) { @users.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @users.total_pages }

data/app/views/spree/api/v1/users/new.rabl

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*user_attributes] }
+node(:required_attributes) { required_fields_for(Spree.user_class) }

data/app/views/spree/api/v1/users/show.rabl

@@ -0,0 +1,11 @@
+object @user
+cache [I18n.locale, root_object]
+
+attributes *user_attributes
+child(bill_address: :bill_address) do
+  extends 'spree/api/v1/addresses/show'
+end
+
+child(ship_address: :ship_address) do
+  extends 'spree/api/v1/addresses/show'
+end

data/app/views/spree/api/v1/variants/big.rabl

@@ -0,0 +1,14 @@
+object @variant
+
+cache [I18n.locale, @current_user_roles.include?('admin'), 'big_variant', root_object]
+
+extends 'spree/api/v1/variants/small'
+
+child(stock_items: :stock_items) do
+  attributes :id, :count_on_hand, :stock_location_id, :backorderable
+  attribute available?: :available
+
+  glue(:stock_location) do
+    attribute name: :stock_location_name
+  end
+end

data/app/views/spree/api/v1/variants/index.rabl

@@ -0,0 +1,9 @@
+object false
+node(:count) { @variants.count }
+node(:total_count) { @variants.total_count }
+node(:current_page) { params[:page] ? params[:page].to_i : 1 }
+node(:pages) { @variants.total_pages }
+
+child(@variants => :variants) do
+  extends 'spree/api/v1/variants/big'
+end

data/app/views/spree/api/v1/variants/new.rabl

@@ -0,0 +1,2 @@
+node(:attributes) { [*variant_attributes] }
+node(:required_attributes) { [] }

data/app/views/spree/api/v1/variants/show.rabl

@@ -0,0 +1,3 @@
+object @variant
+cache [I18n.locale, @current_user_roles.include?('admin'), 'show', root_object]
+extends 'spree/api/v1/variants/big'

data/app/views/spree/api/v1/variants/small.rabl

@@ -0,0 +1,18 @@
+cache [I18n.locale, @current_user_roles.include?('admin'), 'small_variant', root_object]
+
+attributes *variant_attributes
+
+node(:display_price) { |p| p.display_price.to_s }
+node(:options_text, &:options_text)
+node(:track_inventory, &:should_track_inventory?)
+node(:in_stock, &:in_stock?)
+node(:is_backorderable, &:is_backorderable?)
+node(:is_orderable) { |v| v.is_backorderable? || v.in_stock? }
+node(:total_on_hand, &:total_on_hand)
+node(:is_destroyed, &:destroyed?)
+
+child option_values: :option_values do
+  attributes *option_value_attributes
+end
+
+child(images: :images) { extends 'spree/api/v1/images/show' }

data/app/views/spree/api/v1/zones/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@zones => :zones) do
+  extends 'spree/api/v1/zones/show'
+end
+node(:count) { @zones.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @zones.total_pages }

data/app/views/spree/api/v1/zones/show.rabl

@@ -0,0 +1,6 @@
+object @zone
+attributes :id, :name, :description
+
+child zone_members: :zone_members do
+  attributes :id, :name, :zoneable_type, :zoneable_id
+end

data/config/initializers/rabl.rb

@@ -0,0 +1,9 @@
+Rabl.configure do |config|
+  config.include_json_root = false
+  config.include_child_root = false
+
+  # Motivation here it make it call as_json when rendering timestamps
+  # and therefore display milliseconds. Otherwise it would fall to
+  # JSON.dump which doesn't display the milliseconds
+  config.json_engine = ActiveSupport::JSON
+end

data/config/routes.rb

@@ -0,0 +1,123 @@
+Spree::Core::Engine.add_routes do
+  namespace :api, defaults: { format: 'json' } do
+    namespace :v1 do
+      resources :promotions, only: [:show]
+
+      resources :customer_returns, only: [:index]
+      resources :reimbursements, only: [:index]
+
+      resources :products do
+        resources :images
+        resources :variants
+        resources :product_properties
+      end
+
+      concern :order_routes do
+        member do
+          put :approve
+          put :cancel
+          put :empty
+          put :apply_coupon_code
+        end
+
+        resources :line_items
+        resources :payments do
+          member do
+            put :authorize
+            put :capture
+            put :purchase
+            put :void
+            put :credit
+          end
+        end
+
+        resources :addresses, only: [:show, :update]
+
+        resources :return_authorizations do
+          member do
+            put :add
+            put :cancel
+            put :receive
+          end
+        end
+      end
+
+      resources :checkouts, only: [:update], concerns: :order_routes do
+        member do
+          put :next
+          put :advance
+        end
+      end
+
+      resources :variants do
+        resources :images
+      end
+
+      resources :option_types do
+        resources :option_values
+      end
+      resources :option_values
+
+      resources :option_values, only: :index
+
+      get '/orders/mine', to: 'orders#mine', as: 'my_orders'
+      get '/orders/current', to: 'orders#current', as: 'current_order'
+
+      resources :orders, concerns: :order_routes do
+        put :remove_coupon_code, on: :member
+      end
+
+      resources :zones
+      resources :countries, only: [:index, :show] do
+        resources :states, only: [:index, :show]
+      end
+
+      resources :shipments, only: [:create, :update] do
+        collection do
+          post 'transfer_to_location'
+          post 'transfer_to_shipment'
+          get :mine
+        end
+
+        member do
+          put :ready
+          put :ship
+          put :add
+          put :remove
+        end
+      end
+      resources :states, only: [:index, :show]
+
+      resources :taxonomies do
+        member do
+          get :jstree
+        end
+        resources :taxons do
+          member do
+            get :jstree
+          end
+        end
+      end
+
+      resources :taxons, only: [:index]
+
+      resources :inventory_units, only: [:show, :update]
+
+      resources :users do
+        resources :credit_cards, only: [:index]
+      end
+
+      resources :properties
+      resources :stock_locations do
+        resources :stock_movements
+        resources :stock_items
+      end
+
+      resources :stock_items, only: [:index, :update, :destroy]
+      resources :stores
+
+      put '/classifications', to: 'classifications#update', as: :classifications
+      get '/taxons/products', to: 'taxons#products', as: :taxon_products
+    end
+  end
+end

data/lib/spree/api_v1/controller_setup.rb

@@ -0,0 +1,19 @@
+require 'spree/api_v1/responders'
+
+module Spree
+  module ApiV1
+    module ControllerSetup
+      def self.included(klass)
+        klass.class_eval do
+          include CanCan::ControllerAdditions
+
+          prepend_view_path Rails.root + 'app/views'
+          append_view_path File.expand_path('../../../app/views', File.dirname(__FILE__))
+
+          self.responder = Spree::ApiV1::Responders::AppResponder
+          respond_to :json
+        end
+      end
+    end
+  end
+end

data/lib/spree/api_v1/engine.rb

@@ -0,0 +1,27 @@
+require 'rails/engine'
+
+module Spree
+  module ApiV1
+    class Engine < Rails::Engine
+      isolate_namespace Spree
+      engine_name 'spree_api_v1'
+
+      # use rspec for tests
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+
+      config.after_initialize do |_app|
+        Spree::ApiV1::Config = Spree::ApiV1Configuration.new
+      end
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+
+      config.to_prepare(&method(:activate).to_proc)
+    end
+  end
+end

data/lib/spree/api_v1/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_api_v1/factories'
+end

data/lib/spree/api_v1/responders/rabl_template.rb

@@ -0,0 +1,28 @@
+module Spree
+  module ApiV1
+    module Responders
+      module RablTemplate
+        def to_format
+          if template
+            render template, status: options[:status] || 200
+          else
+            super
+          end
+        rescue ActionView::MissingTemplate => e
+          api_behavior
+        end
+
+        def template
+          options[:default_template]
+        end
+
+        def api_behavior
+          if controller.params[:action] == 'destroy'
+            # Render a blank template
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/api_v1/responders.rb

@@ -0,0 +1,11 @@
+require 'spree/api_v1/responders/rabl_template'
+
+module Spree
+  module ApiV1
+    module Responders
+      class AppResponder < ActionController::Responder
+        include RablTemplate
+      end
+    end
+  end
+end