Module: Spree::Api::ApiHelpers

Defined in:: app/helpers/spree/api/api_helpers.rb

Constant Summary collapse

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,
  :customer_return_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,
  :variant_property_attributes
]

@@product_attributes =

[
  :id, :name, :description, :available_on,
  :slug, :meta_description, :meta_keywords, :shipping_category_id,
  :taxon_ids, :total_on_hand, :meta_title
]

@@product_property_attributes =

[
  :id, :product_id, :property_id, :value, :property_name
]

@@variant_attributes =

[
  :id, :name, :sku, :weight, :height, :width, :depth, :is_master,
  :slug, :description, :track_inventory
]

@@variant_property_attributes =

[
  :id, :property_id, :value, :property_name
]

@@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, :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
]

@@payment_method_attributes =

[:id, :name, :description]

@@shipment_attributes =

[:id, :tracking, :tracking_url, :number, :cost, :shipped_at, :state]

@@taxonomy_attributes =

[:id, :name]

@@taxon_attributes =

[
  :id, :name, :pretty_name, :permalink, :parent_id,
  :taxonomy_id
]

@@inventory_unit_attributes =

[
  :id, :state, :variant_id, :shipment_id
]

@@customer_return_attributes =

[
  :id, :number, :stock_location_id, :created_at, :updated_at
]

@@return_authorization_attributes =

[
  :id, :number, :state, :order_id, :memo, :created_at, :updated_at
]

@@address_attributes =

[
  :id, :name, :address1, :address2, :city, :zipcode, :phone, :company,
  :alternative_phone, :country_id, :country_iso, :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,
  :amount, :label, :promotion_code_id,
  :finalized, :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, :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, :available_locales,
  :bcc_email
]

@@store_credit_history_attributes =

[
  :display_amount, :display_user_total_amount, :display_action,
  :display_event_date, :display_remaining_amount
]

Instance Method Summary collapse

Instance Method Details

#required_fields_for(model) ⇒ `Object`

# File 'app/helpers/spree/api/api_helpers.rb', line 42

def required_fields_for(model)
  required_fields = model._validators.select do |_field, validations|
    validations.any? { |validation| validation.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

#total_on_hand_for(object) ⇒ `Object`



193
194
195

# File 'app/helpers/spree/api/api_helpers.rb', line 193

def total_on_hand_for(object)
  object.total_on_hand.finite? ? object.total_on_hand : nil
end

#variant_attributes ⇒ `Object`

# File 'app/helpers/spree/api/api_helpers.rb', line 185

def variant_attributes
  if @current_user_roles&.include?("admin")
    @@variant_attributes + [:cost_price]
  else
    @@variant_attributes
  end
end