goca-spree-api 3.1.14.rails.5.0

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

@@ -0,0 +1,60 @@
+module Spree
+  module Api
+    module V1
+      class UsersController < Spree::Api::BaseController
+
+        rescue_from Spree::Core::DestroyWithOrdersError, with: :error_during_processing
+
+        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
+end

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

@@ -0,0 +1,75 @@
+module Spree
+  module Api
+    module V1
+      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.accessible_by(current_ability, :read)
+          end
+
+          def variant_params
+            params.require(:variant).permit(permitted_variant_attributes)
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Spree
+  module Api
+    module V1
+      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
+end

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

@@ -0,0 +1,173 @@
+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
+      ]
+
+      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, :considered_risky,
+        :canceler_id
+      ]
+
+      @@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, :state, :avs_response, :created_at,
+        :updated_at, :number
+      ]
+
+      @@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,
+        :locked, :eligible,  :created_at, :updated_at
+      ]
+
+      @@creditcard_attributes = [
+        :id, :month, :year, :cc_type, :last_digits, :name,
+        :gateway_customer_profile_id, :gateway_payment_profile_id
+      ]
+
+      @@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, :code, :advertise, :path
+      ]
+
+      @@store_attributes = [
+        :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
+        :mail_from_address, :default_currency, :code, :default
+      ]
+
+      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/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/v1/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/v1/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/v1/config/money.v1.rabl

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

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

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

data/app/views/spree/api/v1/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].try(:to_i) || 1 }
+node(:pages) { @countries.total_pages }

data/app/views/spree/api/v1/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/v1/credit_cards/index.v1.rabl

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

data/app/views/spree/api/v1/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/v1/images/index.v1.rabl

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

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

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

data/app/views/spree/api/v1/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/v1/inventory_units/show.rabl

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

data/app/views/spree/api/v1/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/v1/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/v1/variants/small"
+  attributes :product_id
+  child(:images => :images) { extends "spree/api/v1/images/show" }
+end
+
+child :adjustments => :adjustments do
+  extends "spree/api/v1/adjustments/show"
+end

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

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

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

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

data/app/views/spree/api/v1/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/v1/option_values/index.v1.rabl

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

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

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

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

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

data/app/views/spree/api/v1/orders/could_not_apply_coupon.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { @coupon_message }

data/app/views/spree/api/v1/orders/could_not_transition.v1.rabl

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

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

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

data/app/views/spree/api/v1/orders/invalid_shipping_method.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:errors) { [I18n.t(:invalid_shipping_method, :scope => "spree.api.order")] }

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

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

data/app/views/spree/api/v1/orders/order.v1.rabl

@@ -0,0 +1,10 @@
+cache [I18n.locale, root_object]
+attributes *order_attributes
+node(:display_item_total) { |o| o.display_item_total.to_s }
+node(:total_quantity) { |o| o.line_items.sum(:quantity) }
+node(:display_total) { |o| o.display_total.to_s }
+node(:display_ship_total) { |o| o.display_ship_total }
+node(:display_tax_total) { |o| o.display_tax_total }
+node(:display_adjustment_total) { |o| o.display_adjustment_total }
+node(:token) { |o| o.guest_token }
+node(:checkout_steps) { |o| o.checkout_steps }

data/app/views/spree/api/v1/orders/payment.v1.rabl

@@ -0,0 +1,3 @@
+child :available_payment_methods => :payment_methods do
+  attributes :id, :name, :method_type
+end

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

@@ -0,0 +1,51 @@
+object @order
+extends "spree/api/v1/orders/order"
+
+if lookup_context.find_all("spree/api/v1/orders/#{root_object.state}").present?
+  extends "spree/api/v1/orders/#{root_object.state}"
+end
+
+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 :line_items => :line_items do
+  extends "spree/api/v1/line_items/show"
+end
+
+child :payments => :payments do
+  attributes *payment_attributes
+
+  child :payment_method => :payment_method do
+    attributes :id, :name
+  end
+
+  child :source => :source do
+    if @current_user_roles.include?('admin')
+      attributes *payment_source_attributes + [:gateway_customer_profile_id, :gateway_payment_profile_id]
+    else
+      attributes *payment_source_attributes
+    end
+  end
+end
+
+child :shipments => :shipments do
+  extends "spree/api/v1/shipments/small"
+end
+
+child :adjustments => :adjustments do
+  extends "spree/api/v1/adjustments/show"
+end
+
+# Necessary for backend's order interface
+node :permissions do
+  { can_update: current_ability.can?(:update, root_object) }
+end
+
+child :valid_credit_cards => :credit_cards do
+  extends "spree/api/v1/credit_cards/show"
+end

data/app/views/spree/api/v1/payments/credit_over_limit.v1.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:credit_over_limit, :limit => @payment.credit_allowed, :scope => 'spree.api.payment') }

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

@@ -0,0 +1,7 @@
+object false
+child(@payments => :payments) do
+  attributes *payment_attributes
+end
+node(:count) { @payments.count }
+node(:current_page) { params[:page].try(:to_i) || 1 }
+node(:pages) { @payments.total_pages }

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

@@ -0,0 +1,5 @@
+object false
+node(:attributes) { [*payment_attributes] }
+child @payment_methods => :payment_methods do
+  attributes *payment_method_attributes
+end

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

@@ -0,0 +1,2 @@
+object @payment
+attributes *payment_attributes

data/app/views/spree/api/v1/payments/update_forbidden.v1.rabl

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