spree_api_v1 4.5.0

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,
+        :tag_attributes,
+        :customer_return_attributes,
+        :reimbursement_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, :meta_title, :meta_description
+      ]
+
+      @@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,
+        :label, :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, :customer_support_email, :default_currency,
+        :code, :default, :facebook, :twitter, :instagram,
+        :supported_currencies, :default_locale, :supported_locales
+      ]
+
+      @@tag_attributes = [:id, :name]
+
+      @@customer_return_attributes = [
+        :id, :number, :order_id, :fully_reimbursed?, :pre_tax_total,
+        :created_at, :updated_at
+      ]
+
+      @@reimbursement_attributes = [
+        :id, :reimbursement_status, :customer_return_id, :order_id,
+        :number, :total, :created_at, :updated_at
+      ]
+
+      def variant_attributes
+        if @current_user_roles&.include?('admin')
+          @@variant_attributes + [:cost_price]
+        else
+          @@variant_attributes
+        end
+      end
+    end
+  end
+end

data/app/models/spree/api_v1_configuration.rb

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

data/app/views/spree/api/errors/gateway_error.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.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.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.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.rabl

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

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+object @image
+attributes *image_attributes
+attributes :viewable_type, :viewable_id
+Spree::Image.styles.each do |k, _v|
+  node("#{k}_url") { |i| main_app.url_for(i.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.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.rabl

@@ -0,0 +1,14 @@
+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, &:total)
+child :variant do
+  extends 'spree/api/v1/variants/small'
+  attributes :product_id
+end
+
+child adjustments: :adjustments do
+  extends 'spree/api/v1/adjustments/show'
+end

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

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

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

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

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

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

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

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

data/app/views/spree/api/v1/orders/could_not_transition.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.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/insufficient_quantity.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { Spree.t(:insufficient_quantity, scope: [:api, :order]) }

data/app/views/spree/api/v1/orders/invalid_shipping_method.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.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.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, &:display_ship_total)
+node(:display_tax_total, &:display_tax_total)
+node(:display_adjustment_total, &:display_adjustment_total)
+node(:token, &:token)
+node(:checkout_steps, &:checkout_steps)

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+object @product_property
+attributes *product_property_attributes

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

@@ -0,0 +1,9 @@
+object false
+node(:count) { @products.count }
+node(:total_count) { @products.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) { @products.total_pages }
+child(@products => :products) do
+  extends 'spree/api/v1/products/show'
+end

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

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

data/app/views/spree/api/v1/products/product.rabl

@@ -0,0 +1 @@
+attributes *product_attributes

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

@@ -0,0 +1,36 @@
+object @product
+cache [I18n.locale, @current_user_roles.include?('admin'), current_currency, root_object]
+
+attributes *product_attributes
+
+node(:display_price) { |p| p.display_price.to_s }
+node(:has_variants, &:has_variants?)
+node(:taxon_ids, &:taxon_ids)
+node(:display_current_currency_price) do |product|
+  price = product.price_in(current_currency)
+  Spree::Money.new(price.amount, currency: current_currency).to_s
+end
+
+child master: :master do
+  extends 'spree/api/v1/variants/small'
+end
+
+child variants: :variants do
+  extends 'spree/api/v1/variants/small'
+end
+
+child option_types: :option_types do
+  attributes *option_type_attributes
+end
+
+child product_properties: :product_properties do
+  attributes *product_property_attributes
+end
+
+child classifications: :classifications do
+  attributes :taxon_id, :position
+
+  child(:taxon) do
+    extends 'spree/api/v1/taxons/show'
+  end
+end

data/app/views/spree/api/v1/promotions/handler.rabl

@@ -0,0 +1,5 @@
+object false
+node(:success) { @handler.success }
+node(:error) { @handler.error }
+node(:successful) { @handler.successful? }
+node(:status_code) { @handler.status_code }

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

@@ -0,0 +1,2 @@
+object @promotion
+attributes *promotion_attributes

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

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

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

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

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

@@ -0,0 +1,2 @@
+object @property
+attributes *property_attributes

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

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+object @return_authorization
+attributes *return_authorization_attributes

data/app/views/spree/api/v1/shared/stock_location_required.rabl

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