solidus_api 1.0.0.pre

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

@@ -0,0 +1,93 @@
+module Spree
+  module Api
+    class TaxonsController < Spree::Api::BaseController
+      def index
+        if taxonomy
+          @taxons = taxonomy.root.children
+        else
+          if params[:ids]
+            @taxons = Spree::Taxon.accessible_by(current_ability, :read).where(id: params[:ids].split(','))
+          else
+            @taxons = Spree::Taxon.accessible_by(current_ability, :read).order(:taxonomy_id, :lft).ransack(params[:q]).result
+          end
+        end
+
+        @taxons = @taxons.page(params[:page]).per(params[:per_page])
+        respond_with(@taxons)
+      end
+
+      def show
+        @taxon = taxon
+        respond_with(@taxon)
+      end
+
+      def jstree
+        show
+      end
+
+      def create
+        authorize! :create, Taxon
+        @taxon = Spree::Taxon.new(taxon_params)
+        @taxon.taxonomy_id = params[:taxonomy_id]
+        taxonomy = Spree::Taxonomy.find_by(id: params[:taxonomy_id])
+
+        if taxonomy.nil?
+          @taxon.errors[:taxonomy_id] = I18n.t(:invalid_taxonomy_id, scope: 'spree.api')
+          invalid_resource!(@taxon) and return
+        end
+
+        @taxon.parent_id = taxonomy.root.id unless params[:taxon][:parent_id]
+
+        if @taxon.save
+          respond_with(@taxon, status: 201, default_template: :show)
+        else
+          invalid_resource!(@taxon)
+        end
+      end
+
+      def update
+        authorize! :update, taxon
+        if taxon.update_attributes(taxon_params)
+          respond_with(taxon, status: 200, default_template: :show)
+        else
+          invalid_resource!(taxon)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, taxon
+        taxon.destroy
+        respond_with(taxon, status: 204)
+      end
+
+      def products
+        # Returns the products sorted by their position with the classification
+        # Products#index does not do the sorting.
+        taxon = Spree::Taxon.find(params[:id])
+        @products = taxon.products.ransack(params[:q]).result
+        @products = @products.page(params[:page]).per(params[:per_page] || 500)
+        render "spree/api/products/index"
+      end
+
+      private
+
+        def taxonomy
+          if params[:taxonomy_id].present?
+            @taxonomy ||= Spree::Taxonomy.accessible_by(current_ability, :read).find(params[:taxonomy_id])
+          end
+        end
+
+        def taxon
+          @taxon ||= taxonomy.taxons.accessible_by(current_ability, :read).find(params[:id])
+        end
+
+        def taxon_params
+          if params[:taxon] && !params[:taxon].empty?
+            params.require(:taxon).permit(permitted_taxon_attributes)
+          else
+            {}
+          end
+        end
+    end
+  end
+end

data/app/controllers/spree/api/transfer_items_controller.rb

@@ -0,0 +1,42 @@
+module Spree
+  module Api
+    class TransferItemsController < Spree::Api::BaseController
+      def create
+        authorize! :create, TransferItem
+        stock_transfer = StockTransfer.accessible_by(current_ability, :update).find_by(number: params[:stock_transfer_id])
+        @transfer_item = stock_transfer.transfer_items.build(transfer_item_params)
+        if @transfer_item.save
+          respond_with(@transfer_item, status: 201, default_template: :show)
+        else
+          invalid_resource!(@transfer_item)
+        end
+      end
+
+      def update
+        authorize! :update, TransferItem
+        @transfer_item = TransferItem.accessible_by(current_ability, :update).find(params[:id])
+        if @transfer_item.update_attributes(transfer_item_params)
+          respond_with(@transfer_item, status: 200, default_template: :show)
+        else
+          invalid_resource!(@transfer_item)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, TransferItem
+        @transfer_item = TransferItem.accessible_by(current_ability, :destroy).find(params[:id])
+        if @transfer_item.destroy
+          respond_with(@transfer_item, status: 200, default_template: :show)
+        else
+          invalid_resource!(@transfer_item)
+        end
+      end
+
+      private
+
+      def transfer_item_params
+        params.require(:transfer_item).permit(permitted_transfer_item_attributes)
+      end
+    end
+  end
+end

data/app/controllers/spree/api/users_controller.rb

@@ -0,0 +1,56 @@
+module Spree
+  module Api
+    class UsersController < Spree::Api::BaseController
+
+      def index
+        @users = Spree.user_class.accessible_by(current_ability,:read).ransack(params[:q]).result.page(params[:page]).per(params[:per_page])
+        respond_with(@users)
+      end
+
+      def show
+        respond_with(user)
+      end
+
+      def new
+      end
+
+      def create
+        authorize! :create, Spree.user_class
+        @user = Spree.user_class.new(user_params)
+        if @user.save
+          respond_with(@user, :status => 201, :default_template => :show)
+        else
+          invalid_resource!(@user)
+        end
+      end
+
+      def update
+        authorize! :update, user
+        if user.update_attributes(user_params)
+          respond_with(user, :status => 200, :default_template => :show)
+        else
+          invalid_resource!(user)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, user
+        user.destroy
+        respond_with(user, :status => 204)
+      end
+
+      private
+
+      def user
+        @user ||= Spree.user_class.accessible_by(current_ability, :read).find(params[:id])
+      end
+
+      def user_params
+        params.require(:user).permit(permitted_user_attributes |
+                                       [bill_address_attributes: permitted_address_attributes,
+                                        ship_address_attributes: permitted_address_attributes])
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module Spree
+  module Api
+    class VariantsController < Spree::Api::BaseController
+      before_action :product
+
+      def create
+        authorize! :create, Variant
+        @variant = scope.new(variant_params)
+        if @variant.save
+          respond_with(@variant, status: 201, default_template: :show)
+        else
+          invalid_resource!(@variant)
+        end
+      end
+
+      def destroy
+        @variant = scope.accessible_by(current_ability, :destroy).find(params[:id])
+        @variant.destroy
+        respond_with(@variant, status: 204)
+      end
+
+      # The lazyloaded associations here are pretty much attached to which nodes
+      # we render on the view so we better update it any time a node is included
+      # or removed from the views.
+      def index
+        @variants = scope.includes({ option_values: :option_type }, :product, :default_price, :images, { stock_items: :stock_location })
+          .ransack(params[:q]).result.page(params[:page]).per(params[:per_page])
+        respond_with(@variants)
+      end
+
+      def new
+      end
+
+      def show
+        @variant = scope.includes({ option_values: :option_type }, :option_values, :product, :default_price, :images, { stock_items: :stock_location })
+          .find(params[:id])
+        respond_with(@variant)
+      end
+
+      def update
+        @variant = scope.accessible_by(current_ability, :update).find(params[:id])
+        if @variant.update_attributes(variant_params)
+          respond_with(@variant, status: 200, default_template: :show)
+        else
+          invalid_resource!(@product)
+        end
+      end
+
+      private
+        def product
+          @product ||= Spree::Product.accessible_by(current_ability, :read).friendly.find(params[:product_id]) if params[:product_id]
+        end
+
+        def scope
+          if @product
+            variants = @product.variants_including_master
+          else
+            variants = Variant
+          end
+
+          if current_ability.can?(:manage, Variant) && params[:show_deleted]
+            variants = variants.with_deleted
+          end
+
+          variants = variants.accessible_by(current_ability, :read)
+          variants = variants.in_stock if params[:in_stock_only] || cannot?(:view_out_of_stock, Spree::Variant)
+          variants
+        end
+
+        def variant_params
+          params.require(:variant).permit(permitted_variant_attributes)
+        end
+    end
+  end
+end

data/app/controllers/spree/api/zones_controller.rb

@@ -0,0 +1,50 @@
+module Spree
+  module Api
+    class ZonesController < Spree::Api::BaseController
+
+      def create
+        authorize! :create, Zone
+        @zone = Zone.new(map_nested_attributes_keys(Spree::Zone, zone_params))
+        if @zone.save
+          respond_with(@zone, :status => 201, :default_template => :show)
+        else
+          invalid_resource!(@zone)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, zone
+        zone.destroy
+        respond_with(zone, :status => 204)
+      end
+
+      def index
+        @zones = Zone.accessible_by(current_ability, :read).order('name ASC').ransack(params[:q]).result.page(params[:page]).per(params[:per_page])
+        respond_with(@zones)
+      end
+
+      def show
+        respond_with(zone)
+      end
+
+      def update
+        authorize! :update, zone
+        if zone.update_attributes(map_nested_attributes_keys(Spree::Zone, zone_params))
+          respond_with(zone, :status => 200, :default_template => :show)
+        else
+          invalid_resource!(zone)
+        end
+      end
+
+      private
+
+      def zone_params
+        params.require(:zone).permit!
+      end
+
+      def zone
+        @zone ||= Spree::Zone.accessible_by(current_ability, :read).find(params[:id])
+      end
+    end
+  end
+end

data/app/helpers/spree/api/api_helpers.rb

@@ -0,0 +1,190 @@
+module Spree
+  module Api
+    module ApiHelpers
+      ATTRIBUTES = [
+        :product_attributes,
+        :product_property_attributes,
+        :variant_attributes,
+        :image_attributes,
+        :option_value_attributes,
+        :order_attributes,
+        :line_item_attributes,
+        :option_type_attributes,
+        :payment_attributes,
+        :payment_method_attributes,
+        :shipment_attributes,
+        :taxonomy_attributes,
+        :taxon_attributes,
+        :address_attributes,
+        :country_attributes,
+        :state_attributes,
+        :adjustment_attributes,
+        :inventory_unit_attributes,
+        :return_authorization_attributes,
+        :creditcard_attributes,
+        :payment_source_attributes,
+        :user_attributes,
+        :property_attributes,
+        :stock_location_attributes,
+        :stock_movement_attributes,
+        :stock_item_attributes,
+        :promotion_attributes,
+        :store_attributes,
+        :store_credit_history_attributes,
+        :stock_transfer_attributes,
+        :transfer_item_attributes,
+        :transfer_item_variant_attributes
+      ]
+
+      mattr_reader *ATTRIBUTES
+
+      def required_fields_for(model)
+        required_fields = model._validators.select do |field, validations|
+          validations.any? { |v| v.is_a?(ActiveModel::Validations::PresenceValidator) }
+        end.map(&:first) # get fields that are invalid
+        # Permalinks presence is validated, but are really automatically generated
+        # Therefore we shouldn't tell API clients that they MUST send one through
+        required_fields.map!(&:to_s).delete("permalink")
+        # Do not require slugs, either
+        required_fields.delete("slug")
+        required_fields
+      end
+
+      @@product_attributes = [
+        :id, :name, :description, :price, :display_price, :available_on,
+        :slug, :meta_description, :meta_keywords, :shipping_category_id,
+        :taxon_ids, :total_on_hand
+      ]
+
+      @@product_property_attributes = [
+        :id, :product_id, :property_id, :value, :property_name
+      ]
+
+      @@variant_attributes = [
+        :id, :name, :sku, :price, :weight, :height, :width, :depth, :is_master,
+        :slug, :description, :track_inventory
+      ]
+
+      @@image_attributes = [
+        :id, :position, :attachment_content_type, :attachment_file_name, :type,
+        :attachment_updated_at, :attachment_width, :attachment_height, :alt
+      ]
+
+      @@option_value_attributes = [
+        :id, :name, :presentation, :option_type_name, :option_type_id,
+        :option_type_presentation
+      ]
+
+      @@order_attributes = [
+        :id, :number, :item_total, :total, :ship_total, :state, :adjustment_total,
+        :user_id, :created_at, :updated_at, :completed_at, :payment_total,
+        :shipment_state, :payment_state, :email, :special_instructions, :channel,
+        :included_tax_total, :additional_tax_total, :display_included_tax_total,
+        :display_additional_tax_total, :tax_total, :currency,
+        :covered_by_store_credit, :display_total_applicable_store_credit,
+        :order_total_after_store_credit, :display_order_total_after_store_credit,
+        :total_applicable_store_credit, :display_total_available_store_credit, :display_store_credit_remaining_after_capture
+
+      ]
+
+      @@line_item_attributes = [:id, :quantity, :price, :variant_id]
+
+      @@option_type_attributes = [:id, :name, :presentation, :position]
+
+      @@payment_attributes = [
+        :id, :source_type, :source_id, :amount, :display_amount,
+        :payment_method_id, :response_code, :state, :avs_response, :created_at,
+        :updated_at
+      ]
+
+      @@payment_method_attributes = [:id, :name, :description]
+
+      @@shipment_attributes = [:id, :tracking, :number, :cost, :shipped_at, :state]
+
+      @@taxonomy_attributes = [:id, :name]
+
+      @@taxon_attributes = [
+        :id, :name, :pretty_name, :permalink, :parent_id,
+        :taxonomy_id
+      ]
+
+      @@inventory_unit_attributes = [
+        :id, :lock_version, :state, :variant_id, :shipment_id,
+        :return_authorization_id
+      ]
+
+      @@return_authorization_attributes = [
+        :id, :number, :state, :order_id, :memo, :created_at, :updated_at
+      ]
+
+      @@address_attributes = [
+        :id, :firstname, :lastname, :full_name, :address1, :address2, :city,
+        :zipcode, :phone, :company, :alternative_phone, :country_id, :state_id,
+        :state_name, :state_text
+      ]
+
+      @@country_attributes = [:id, :iso_name, :iso, :iso3, :name, :numcode]
+
+      @@state_attributes = [:id, :name, :abbr, :country_id]
+
+      @@adjustment_attributes = [
+        :id, :source_type, :source_id, :adjustable_type, :adjustable_id,
+        :originator_type, :originator_id, :amount, :label, :mandatory, :promotion_code,
+        :locked, :eligible,  :created_at, :updated_at
+      ]
+
+      @@creditcard_attributes = [
+        :id, :month, :year, :cc_type, :last_digits, :name,
+      ]
+
+      @@payment_source_attributes = [
+        :id, :month, :year, :cc_type, :last_digits, :name
+      ]
+
+      @@user_attributes = [:id, :email, :created_at, :updated_at]
+
+      @@property_attributes = [:id, :name, :presentation]
+
+      @@stock_location_attributes = [
+        :id, :name, :address1, :address2, :city, :state_id, :state_name,
+        :country_id, :zipcode, :phone, :active
+      ]
+
+      @@stock_movement_attributes = [:id, :quantity, :stock_item_id]
+
+      @@stock_item_attributes = [
+        :id, :count_on_hand, :backorderable, :lock_version, :stock_location_id,
+        :variant_id
+      ]
+
+      @@promotion_attributes = [
+        :id, :name, :description, :expires_at, :starts_at, :type, :usage_limit,
+        :match_policy, :advertise, :path
+      ]
+
+      @@store_attributes = [
+        :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
+        :mail_from_address, :default_currency, :code, :default
+      ]
+
+      @@store_credit_history_attributes = [
+        :display_amount, :display_user_total_amount, :display_action,
+        :display_event_date
+      ]
+
+      @@stock_transfer_attributes = [:id, :number]
+
+      @@transfer_item_attributes = [:id, :expected_quantity, :received_quantity]
+
+      @@transfer_item_variant_attributes = []
+
+      def variant_attributes
+        if @current_user_roles && @current_user_roles.include?("admin")
+          @@variant_attributes + [:cost_price]
+        else
+          @@variant_attributes
+        end
+      end
+    end
+  end
+end

data/app/models/spree/api_configuration.rb

@@ -0,0 +1,5 @@
+module Spree
+  class ApiConfiguration < Preferences::Configuration
+    preference :requires_authentication, :boolean, :default => true
+  end
+end

data/app/models/spree/option_value_decorator.rb

@@ -0,0 +1,9 @@
+Spree::OptionValue.class_eval do
+  def option_type_name
+    option_type.name
+  end
+
+  def option_type_presentation
+    option_type.presentation
+  end
+end

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

@@ -0,0 +1,10 @@
+object @address
+cache [I18n.locale, root_object]
+attributes *address_attributes
+
+child(:country) do |address|
+  attributes *country_attributes
+end
+child(:state) do |address|
+  attributes *state_attributes
+end

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

@@ -0,0 +1,4 @@
+object @adjustment
+cache [I18n.locale, root_object]
+attributes *adjustment_attributes
+node(:display_amount) { |a| a.display_amount.to_s }

data/app/views/spree/api/config/money.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:symbol) { ::Money.new(1, Spree::Config[:currency]).symbol }

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

@@ -0,0 +1,2 @@
+object false
+node(:default_country_id) { Spree::Config[:default_country_id] }

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

@@ -0,0 +1,7 @@
+object false
+child(@countries => :countries) do
+  attributes *country_attributes
+end
+node(:count) { @countries.count }
+node(:current_page) { params[:page] || 1 }
+node(:pages) { @countries.num_pages }

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

@@ -0,0 +1,5 @@
+object @country
+attributes *country_attributes
+child :states => :states do
+  attributes :id, :name, :abbr, :country_id
+end

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

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

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

@@ -0,0 +1,3 @@
+object @credit_card
+cache [I18n.locale, root_object]
+attributes *creditcard_attributes

data/app/views/spree/api/errors/gateway_error.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:gateway_error, scope: "spree.api", text: @error) }

data/app/views/spree/api/errors/invalid_api_key.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:invalid_api_key, :key => api_key, :scope => "spree.api") }

data/app/views/spree/api/errors/invalid_resource.v1.rabl

@@ -0,0 +1,3 @@
+object false
+node(:error) { I18n.t(:invalid_resource, :scope => "spree.api") }
+node(:errors) { @resource.errors.to_hash }

data/app/views/spree/api/errors/must_specify_api_key.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:must_specify_api_key, :scope => "spree.api") }

data/app/views/spree/api/errors/not_found.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:resource_not_found, :scope => "spree.api") }

data/app/views/spree/api/errors/unauthorized.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:unauthorized, :scope => "spree.api") }

data/app/views/spree/api/errors/variant_not_in_stock_transfer.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { Spree.t(:item_not_in_stock_transfer) }

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

@@ -0,0 +1,4 @@
+object false
+child(@images => :images) do
+  extends "spree/api/images/show"
+end

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

@@ -0,0 +1,6 @@
+object @image
+attributes *image_attributes
+attributes :viewable_type, :viewable_id
+Spree::Image.attachment_definitions[:attachment][:styles].each do |k,v|
+  node("#{k}_url") { |i| i.attachment.url(k) }
+end

data/app/views/spree/api/inventory_units/show.rabl

@@ -0,0 +1,2 @@
+object @inventory_unit
+attributes *inventory_unit_attributes

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

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*line_item_attributes] - [:id] }
+node(:required_attributes) { [:variant_id, :quantity] }

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

@@ -0,0 +1,15 @@
+object @line_item
+cache [I18n.locale, root_object]
+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) { |li| li.total }
+child :variant do
+  extends "spree/api/variants/small"
+  attributes :product_id
+  child(:images => :images) { extends "spree/api/images/show" }
+end
+
+child :adjustments => :adjustments do
+  extends "spree/api/adjustments/show"
+end

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

@@ -0,0 +1,3 @@
+collection @option_types
+
+extends "spree/api/option_types/show"

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

@@ -0,0 +1,5 @@
+object @option_type
+attributes *option_type_attributes
+child :option_values => :option_values do
+  attributes *option_value_attributes
+end

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

@@ -0,0 +1,3 @@
+collection @option_values
+
+extends "spree/api/option_values/show"

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

@@ -0,0 +1,2 @@
+object @option_value
+attributes *option_value_attributes