spree_api 2.0.13 → 2.1.0

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

@@ -12,7 +12,7 @@ module Spree
       end
 
       def product_attributes
-        [:id, :name, :description, :price, :available_on, :permalink, :meta_description, :meta_keywords, :shipping_category_id, :taxon_ids]
+        [:id, :name, :description, :price, :display_price, :available_on, :permalink, :meta_description, :meta_keywords, :shipping_category_id, :taxon_ids]
       end
 
       def product_property_attributes
@@ -20,7 +20,7 @@ module Spree
       end
 
       def variant_attributes
-        [:id, :name, :sku, :price, :weight, :height, :width, :depth, :is_master, :cost_price, :permalink]
+        [:id, :name, :sku, :price, :weight, :height, :width, :depth, :is_master, :cost_price, :permalink, :description]
       end
 
       def image_attributes
@@ -28,11 +28,11 @@ module Spree
       end
 
       def option_value_attributes
-        [:id, :name, :presentation, :option_type_name, :option_type_id, :option_type_presentation]
+        [:id, :name, :presentation, :option_type_name, :option_type_id]
       end
 
       def 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, :token, :channel, :currency]
+        [:id, :number, :item_total, :total, :state, :adjustment_total, :user_id, :created_at, :updated_at, :completed_at, :payment_total, :shipment_state, :payment_state, :email, :special_instructions]
       end
 
       def line_item_attributes
@@ -44,7 +44,7 @@ module Spree
       end
 
       def payment_attributes
-        [:id, :source_type, :source_id, :amount, :display_amount, :payment_method_id, :response_code, :state, :avs_response, :created_at, :updated_at]
+        [:id, :source_type, :source_id, :amount, :payment_method_id, :response_code, :state, :avs_response, :created_at, :updated_at]
       end
 
       def payment_method_attributes
@@ -60,7 +60,7 @@ module Spree
       end
 
       def taxon_attributes
-        [:id, :name, :pretty_name, :permalink, :parent_id, :taxonomy_id]
+        [:id, :name, :pretty_name, :permalink, :position, :parent_id, :taxonomy_id]
       end
 
       def inventory_unit_attributes
@@ -113,3 +113,4 @@ module Spree
     end
   end
 end
+

data/app/models/spree/option_value_decorator.rb

@@ -2,8 +2,4 @@ Spree::OptionValue.class_eval do
   def option_type_name
     option_type.name
   end
-
-  def option_type_presentation
-    option_type.presentation
-  end
 end

data/app/models/spree/order_decorator.rb

@@ -1,41 +1,28 @@
 Spree::Order.class_eval do
-  attr_accessible :channel, :as => :api_admin
-
   def self.build_from_api(user, params)
-    begin
-      ensure_country_id_from_api params[:ship_address_attributes]
-      ensure_state_id_from_api params[:ship_address_attributes]
-      ensure_country_id_from_api params[:bill_address_attributes]
-      ensure_state_id_from_api params[:bill_address_attributes]
-
-      order = create!
-      order.associate_user!(user)
-
-      order.create_shipments_from_api params.delete(:shipments_attributes) || []
-      order.create_line_items_from_api params.delete(:line_items_attributes) || {}
-      order.create_adjustments_from_api params.delete(:adjustments_attributes) || []
-      order.create_payments_from_api params.delete(:payments_attributes) || []
-      order.complete_from_api params.delete(:completed_at)
-
-      destroy_automatic_taxes_on_import(order, params)
-
-      if user.has_spree_role? "admin"
-        order.update_attributes!(params, as: :api_admin)
-      else
-        order.update_attributes!(params)
-      end
+    completed_at = params.delete(:completed_at)
+    line_items = params.delete(:line_items_attributes) || {}
+    shipments = params.delete(:shipments_attributes) || []
+    payments = params.delete(:payments_attributes) || []
+    adjustments = params.delete(:adjustments_attributes) || []
 
-      order.reload
-    rescue Exception => e
-      order.destroy if order && order.persisted?
-      raise e.message
-    end
-  end
+    ensure_country_id_from_api params[:ship_address_attributes]
+    ensure_state_id_from_api params[:ship_address_attributes]
 
-  def self.destroy_automatic_taxes_on_import(order, params)
-    if params.delete :import
-      order.adjustments.tax.destroy_all
-    end
+    ensure_country_id_from_api params[:bill_address_attributes]
+    ensure_state_id_from_api params[:bill_address_attributes]
+
+    order = create!(params)
+    order.associate_user!(user)
+
+    order.create_shipments_from_api(shipments)
+    order.create_line_items_from_api(line_items)
+    order.create_adjustments_from_api(adjustments)
+    order.create_payments_from_api(payments)
+    order.complete_from_api(completed_at)
+
+    order.save!
+    order.reload
   end
 
   def complete_from_api(completed_at)
@@ -50,7 +37,6 @@ Spree::Order.class_eval do
       begin
         shipment = shipments.build
         shipment.tracking = s[:tracking]
-        shipment.stock_location = Spree::StockLocation.find_by_name!(s[:stock_location])
 
         inventory_units = s[:inventory_units] || []
         inventory_units.each do |iu|
@@ -64,11 +50,10 @@ Spree::Order.class_eval do
         shipment.save!
 
         shipping_method = Spree::ShippingMethod.find_by_name!(s[:shipping_method])
-        rate = shipment.shipping_rates.create!(:shipping_method => shipping_method,
-                                               :cost => s[:cost])
-        shipment.selected_shipping_rate_id = rate.id
+        shipment.shipping_rates.create!(:shipping_method => shipping_method,
+                                        :cost => s[:cost])
       rescue Exception => e
-        raise "Order import shipments: #{e.message} #{s}"
+        raise "#{e.message} #{s}"
       end
     end
   end
@@ -82,7 +67,7 @@ Spree::Order.class_eval do
         payment.payment_method = Spree::PaymentMethod.find_by_name!(p[:payment_method])
         payment.save!
       rescue Exception => e
-        raise "Order import payments: #{e.message} #{p}"
+        raise "#{e.message} #{p}"
       end
     end
   end
@@ -95,9 +80,9 @@ Spree::Order.class_eval do
 
         extra_params = line_item.except(:variant_id, :quantity)
         line_item = self.contents.add(Spree::Variant.find(line_item[:variant_id]), line_item[:quantity])
-        line_item.update_attributes(extra_params, as: :api) unless extra_params.empty?
+        line_item.update_attributes(extra_params) unless extra_params.empty?
       rescue Exception => e
-        raise "Order import line items: #{e.message} #{line_item}"
+        raise "#{e.message} #{line_item}"
       end
     end
   end
@@ -110,7 +95,7 @@ Spree::Order.class_eval do
         adjustment.save!
         adjustment.finalize!
       rescue Exception => e
-        raise "Order import adjustments: #{e.message} #{a}"
+        raise "#{e.message} #{a}"
       end
     end
   end
@@ -122,7 +107,7 @@ Spree::Order.class_eval do
         hash.delete(:sku)
       end
     rescue Exception => e
-      raise "Ensure order import variant: #{e.message} #{hash}"
+      raise "#{e.message} #{hash}"
     end
   end
 
@@ -145,7 +130,7 @@ Spree::Order.class_eval do
       address[:country_id] = Spree::Country.where(search).first!.id
 
     rescue Exception => e
-      raise "Ensure order import address country: #{e.message} #{search}"
+      raise "#{e.message} #{search}"
     end
   end
 
@@ -161,22 +146,16 @@ Spree::Order.class_eval do
       end
 
       address.delete(:state)
-      search[:country_id] = address[:country_id]
-
-      if state = Spree::State.where(search).first
-        address[:state_id] = state.id
-      else
-        address[:state_name] = search[:name] || search[:abbr]
-      end
+      address[:state_id] = Spree::State.where(search).first!.id
     rescue Exception => e
-      raise "Ensure order import address state: #{e.message} #{search}"
+      raise "#{e.message} #{search}"
     end
   end
 
   def update_line_items(line_item_params)
     return if line_item_params.blank?
     line_item_params.each do |id, attributes|
-      self.line_items.find(id).update_attributes!(attributes, :as => :api)
+      self.line_items.find(id).update_attributes!(attributes)
     end
     self.ensure_updated_shipments
   end

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

@@ -1,2 +1,3 @@
 object @adjustment
-attributes *adjustment_attributes
+attributes *adjustment_attributes
+node(:display_amount) { |a| a.display_amount.to_s }

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

@@ -0,0 +1,6 @@
+object false
+node(:symbol) { ::Money.new(1, Spree::Config[:currency]).symbol }
+node(:symbol_position) { Spree::Config[:currency_symbol_position] }
+node(:no_cents) { Spree::Config[:hide_cents] }
+node(:decimal_mark) { Spree::Config[:currency_decimal_mark] }
+node(:thousands_separator) { Spree::Config[:currency_thousands_separator] }

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/images/show.v1.rabl

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

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

@@ -1,5 +1,8 @@
 object @line_item
 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/variant"
   attributes :product_id

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

@@ -1,6 +1,6 @@
 object false
 child(@orders => :orders) do
-  attributes *order_attributes
+  extends "spree/api/orders/order"
 end
 node(:count) { @orders.count }
 node(:current_page) { params[:page] || 1 }

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

@@ -0,0 +1,6 @@
+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(:token) { |o| o.token }
+node(:checkout_steps) { |o| o.checkout_steps }

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

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

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

@@ -1,5 +1,5 @@
 object @order
-attributes *order_attributes
+extends "spree/api/orders/order"
 
 if lookup_context.find_all("spree/api/orders/#{@order.state}").present?
   extends "spree/api/orders/#{@order.state}"

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

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

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

@@ -3,3 +3,4 @@ node(:attributes) { [*payment_attributes] }
 child @payment_methods => :payment_methods do
   attributes *payment_method_attributes
 end
+

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

@@ -2,8 +2,8 @@ object false
 node(:count) { @products.count }
 node(:total_count) { @products.total_count }
 node(:current_page) { params[:page] ? params[:page].to_i : 1 }
-node(:pages) { @products.num_pages }
 node(:per_page) { params[:per_page] || Kaminari.config.default_per_page }
-child(@products => :products) do
+node(:pages) { @products.num_pages }
+child(@products) do
   extends "spree/api/products/show"
 end

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

@@ -1,5 +1,6 @@
 object @product
 attributes *product_attributes
+node(:display_price) { |p| p.display_price.to_s }
 child :variants_including_master => :variants do
   attributes *variant_attributes
 

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

@@ -2,13 +2,30 @@ object @shipment
 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
-  attributes  :id, :cost, :selected, :shipment_id, :shipping_method_id
+  extends "spree/api/shipping_rates/show"
+end
+
+child :selected_shipping_rate => :selected_shipping_rate do
+  extends "spree/api/shipping_rates/show"
 end
-child :shipping_method => :shipping_method do
-  attributes :name, :zone_id, :shipping_category_id
+
+child :shipping_methods => :shipping_methods do
+  attributes :id, :name
+  child :zones => :zones do
+    attributes :id, :name, :description
+  end
+
+  child :shipping_categories => :shipping_categories do
+    attributes :id, :name
+  end
 end
 
-child :inventory_units => :inventory_units do
-  attribute *inventory_unit_attributes
+child :manifest => :manifest do
+  child :variant => :variant do
+    extends "spree/api/variants/show"
+  end
+  node(:quantity) { |m| m.quantity }
+  node(:states) { |m| m.states }
 end

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

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

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

@@ -4,9 +4,7 @@ node(:total_count) { @taxons.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) { @taxons.num_pages }
-child @taxons => :taxons do
+child(@taxons) do
   attributes *taxon_attributes
-  unless params[:without_children]
-    extends "spree/api/taxons/taxons"
-  end
+  extends "spree/api/taxons/taxons"
 end

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

@@ -14,7 +14,7 @@ child(@variants => :variants) do
     end
   end
 
-  child(:stock_items => :stock_items) do
+  child(:stock_items) do
     attributes :id, :count_on_hand, :stock_location_id, :backorderable
     attribute :available? => :available
 

data/config/locales/en.yml

@@ -7,6 +7,7 @@ en:
       invalid_resource: "Invalid resource. Please fix errors and try again."
       resource_not_found: "The resource you were looking for could not be found."
       gateway_error: "There was a problem with the payment gateway: %{text}"
+      credit_over_limit: "This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number."
       access: "API Access"
       key: "Key"
       clear_key: "Clear key"
@@ -18,9 +19,6 @@ en:
       order:
         could_not_transition: "The order could not be transitioned. Please fix the errors and try again."
         invalid_shipping_method: "Invalid shipping method specified."
-      payment:
-        credit_over_limit: "This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number."
-        update_forbidden: "This payment cannot be updated because it is %{state}."
       shipment:
         cannot_ready: "Cannot ready shipment."
       stock_location_required: "A stock_location_id parameter must be provided in order to retrieve stock movements."

data/config/routes.rb

@@ -22,7 +22,7 @@ Spree::Core::Engine.routes.draw do
       end
     end
 
-    resources :variants, :only => [:index, :show]
+    resources :variants, :only => [:index]
 
     resources :option_types do
       resources :option_values
@@ -86,5 +86,8 @@ Spree::Core::Engine.routes.draw do
       resources :stock_movements
       resources :stock_items
     end
+
+    get '/config/money', :to => 'config#money'
+    get '/config', :to => 'config#show'
   end
 end

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

@@ -14,7 +14,7 @@ module Spree
         end
 
         def template
-          request.headers['X-Spree-Template'] || controller.params[:template] || options[:default_template]
+          request.headers.env['X-Spree-Template'] || controller.params[:template] || options[:default_template]
         end
       end
     end

data/lib/spree/api/testing_support/helpers.rb

@@ -6,6 +6,11 @@ module Spree
           JSON.parse(response.body)
         end
 
+        def assert_not_found!
+          json_response.should == { "error" => "The resource you were looking for could not be found." }
+          response.status.should == 404
+        end
+
         def assert_unauthorized!
           json_response.should == { "error" => "You are not authorized to perform that action." }
           response.status.should == 401

data/spec/controllers/spree/api/addresses_controller_spec.rb

@@ -25,11 +25,11 @@ module Spree
                          :address => { :address1 => "123 Test Lane" }
         json_response['address1'].should eq '123 Test Lane'
       end
-      
+
       it "receives the errors object if address is invalid" do
         api_put :update, :id => @address.id, :order_id => @order.number,
                          :address => { :address1 => "" }
-                         
+
         json_response['error'].should_not be_nil
         json_response['errors'].should_not be_nil
         json_response['errors']['address1'].first.should eq "can't be blank"

data/spec/controllers/spree/api/checkouts_controller_spec.rb

@@ -22,16 +22,6 @@ module Spree
       Spree::Config[:track_inventory_levels] = true
     end
 
-    context "GET 'show'" do
-      let(:order) { create(:order) }
-
-      it "redirects to Orders#show" do
-        api_get :show, :id => order.number
-        response.status.should == 301
-        response.should redirect_to("/api/orders/#{order.number}")
-      end
-    end
-
     context "POST 'create'" do
       it "creates a new order when no parameters are passed" do
         api_post :create
@@ -49,9 +39,14 @@ module Spree
         Order.any_instance.stub(:payment_required? => true)
       end
 
-      it "cannot update without a token" do
-        api_put :update, :id => order.to_param
-        assert_unauthorized!
+      it "will return an error if the recently created order cannot transition from cart to address" do
+        order.state.should eq "cart"
+        order.update_column(:email, nil) # email is necessary to transition from cart to address
+
+        api_put :update, :id => order.to_param, :order_token => order.token
+
+        # Order has not transitioned
+        json_response['state'].should == 'cart'
       end
 
       it "should transition a recently created order from cart to address" do
@@ -66,6 +61,7 @@ module Spree
         api_put :update, :id => order.to_param, :order_token => order.token,
                          :order => { :line_items_attributes => { line_item.id => { :quantity => 1 } } }
         response.status.should == 200
+        order.reload.state.should eq "address"
       end
 
       it "can take line_items as a parameter" do
@@ -73,13 +69,16 @@ module Spree
         api_put :update, :id => order.to_param, :order_token => order.token,
                          :order => { :line_items => { line_item.id => { :quantity => 1 } } }
         response.status.should == 200
+        order.reload.state.should eq "address"
       end
 
       it "will return an error if the order cannot transition" do
+        pending "not sure if this test is valid"
         order.bill_address = nil
         order.save
         order.update_column(:state, "address")
         api_put :update, :id => order.to_param, :order_token => order.token
+        # Order has not transitioned
         response.status.should == 422
       end
 
@@ -107,18 +106,28 @@ module Spree
       it "can update shipping method and transition from delivery to payment" do
         order.update_column(:state, "delivery")
         shipment = create(:shipment, :order => order)
-        shipping_rate = shipment.shipping_rates.first
-        api_put :update, :id => order.to_param, :order_token => order.token, :order => { :shipments_attributes => { "0" => { :selected_shipping_rate_id => shipping_rate.id, :id => shipment.id } } }
-        json_response['shipments'][0]['shipping_method']['name'].should == @shipping_method.name
-        json_response['state'].should == 'payment'
+        shipment.refresh_rates
+        shipping_rate = shipment.shipping_rates.where(:selected => false).first
+        api_put :update, :id => order.to_param, :order_token => order.token,
+          :order => { :shipments_attributes => { "0" => { :selected_shipping_rate_id => shipping_rate.id, :id => shipment.id } } }
         response.status.should == 200
+        # Find the correct shipment...
+        json_shipment = json_response['shipments'].detect { |s| s["id"] == shipment.id }
+        # Find the correct shipping rate for that shipment...
+        json_shipping_rate = json_shipment['shipping_rates'].detect { |sr| sr["id"] == shipping_rate.id }
+        # ... And finally ensure that it's selected
+        json_shipping_rate['selected'].should be_true
+        # Order should automatically transfer to payment because all criteria are met
+        json_response['state'].should == 'payment'
       end
 
       it "can update payment method and transition from payment to confirm" do
         order.update_column(:state, "payment")
-        api_put :update, :id => order.to_param, :order_token => order.token, :order => { :payments_attributes => [{ :payment_method_id => @payment_method.id }] }
+        api_put :update, :id => order.to_param, :order_token => order.token,
+          :order => { :payments_attributes => [{ :payment_method_id => @payment_method.id }] }
         json_response['state'].should == 'confirm'
         json_response['payments'][0]['payment_method']['name'].should == @payment_method.name
+        json_response['payments'][0]['amount'].should == order.total.to_s
         response.status.should == 200
       end
 
@@ -172,14 +181,16 @@ module Spree
         it "can assign a user to the order" do
           user = create(:user)
           # Need to pass email as well so that validations succeed
-          api_put :update, :id => order.to_param, :order => { :user_id => user.id, :email => "guest@spreecommerce.com" }
+          api_put :update, :id => order.to_param, :order_token => order.token,
+            :order => { :user_id => user.id, :email => "guest@spreecommerce.com" }
           response.status.should == 200
           json_response['user_id'].should == user.id
         end
       end
 
       it "can assign an email to the order" do
-        api_put :update, :id => order.to_param, :order => { :email => "guest@spreecommerce.com" }, :order_token => order.token
+        api_put :update, :id => order.to_param, :order_token => order.token,
+          :order => { :email => "guest@spreecommerce.com" }
         json_response['email'].should == "guest@spreecommerce.com"
         response.status.should == 200
       end
@@ -188,7 +199,7 @@ module Spree
         order.update_column(:state, "payment")
         Spree::Promo::CouponApplicator.should_receive(:new).with(order).and_call_original
         Spree::Promo::CouponApplicator.any_instance.should_receive(:apply).and_return({:coupon_applied? => true})
-        api_put :update, :id => order.to_param, :order => { :coupon_code => "foobar" }, :order_token => order.token
+        api_put :update, :id => order.to_param, :order_token => order.token, :order => { :coupon_code => "foobar" }
       end
 
       it "can apply a coupon code to an order" do
@@ -220,7 +231,6 @@ module Spree
 
       it "cannot transition if order email is blank" do
         order.update_column(:email, nil)
-        order.update_column(:state, 'address')
 
         api_put :next, :id => order.to_param, :order_token => order.token
         response.status.should == 422

data/spec/controllers/spree/api/config_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::ConfigController do
+    render_views
+
+    before do
+      stub_authentication!
+    end
+
+    it "returns Spree::Money settings" do
+      api_get :money
+      response.should be_success
+      json_response["symbol"].should == "$"
+      json_response["symbol_position"].should == "before"
+      json_response["no_cents"].should == false
+      json_response["decimal_mark"].should == "."
+      json_response["thousands_separator"].should == ","
+    end
+
+    it "returns some configuration settings" do
+      api_get :show
+      response.should be_success
+      json_response["default_country_id"].should == Spree::Config[:default_country_id]
+    end
+  end
+end

data/spec/controllers/spree/api/images_controller_spec.rb

@@ -54,12 +54,12 @@ module Spree
 
       it "cannot update an image" do
         api_put :update, :id => 1
-        assert_unauthorized!
+        assert_not_found!
       end
 
       it "cannot delete an image" do
         api_delete :destroy, :id => 1
-        assert_unauthorized!
+        assert_not_found!
       end
     end
   end