spree_api 2.2.14 → 2.3.0

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

@@ -24,6 +24,7 @@ module Spree
         :inventory_unit_attributes,
         :return_authorization_attributes,
         :creditcard_attributes,
+        :payment_source_attributes,
         :user_attributes,
         :property_attributes,
         :stock_location_attributes,
@@ -84,7 +85,7 @@ module Spree
 
       @@payment_attributes = [
         :id, :source_type, :source_id, :amount, :display_amount,
-        :payment_method_id, :state, :avs_response, :created_at,
+        :payment_method_id, :response_code, :state, :avs_response, :created_at,
         :updated_at
       ]
 
@@ -130,6 +131,10 @@ module Spree
         :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]

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

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

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

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

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

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

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

@@ -18,20 +18,26 @@ child :line_items => :line_items do
 end
 
 child :payments => :payments do
-  attributes :id, :amount, :state, :payment_method_id
+  attributes *payment_attributes
+
   child :payment_method => :payment_method do
     attributes :id, :name, :environment
   end
+
+  child :source => :source do
+    attributes *payment_source_attributes
+  end
 end
 
 child :shipments => :shipments do
-  extends "spree/api/shipments/show"
+  extends "spree/api/shipments/small"
 end
 
 child :adjustments => :adjustments do
   extends "spree/api/adjustments/show"
 end
 
-child :credit_cards => :credit_cards do
-  extends "spree/api/credit_cards/show"
+# Necessary for backend's order interface
+node :permissions do
+  { can_update: current_ability.can?(:update, root_object) }
 end

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

@@ -0,0 +1,33 @@
+object @shipment
+cache [I18n.locale, 'small_shipment', root_object]
+
+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
+  extends "spree/api/shipping_rates/show"
+end
+
+child :selected_shipping_rate => :selected_shipping_rate do
+  extends "spree/api/shipping_rates/show"
+end
+
+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 :manifest => :manifest do
+  glue(:variant) do
+    attribute :id => :variant_id
+  end
+  node(:quantity) { |m| m.quantity }
+  node(:states) { |m| m.states }
+end

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

@@ -1,7 +1,7 @@
 object @taxonomy
 
-if params[:set] == 'nested'
-  extends "spree/api/taxonomies/nested"
+if set = params[:set]
+  extends "spree/api/taxonomies/#{set}"
 else
   attributes *taxonomy_attributes
 

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

@@ -1,3 +1,10 @@
 object @user
 
 attributes *user_attributes
+child(:bill_address => :bill_address) do
+  extends "spree/api/addresses/show"
+end
+
+child(:ship_address => :ship_address) do
+  extends "spree/api/addresses/show"
+end

data/config/routes.rb

@@ -8,14 +8,14 @@ Spree::Core::Engine.add_routes do
     end
   end
 
-  namespace :api, :defaults => { :format => 'json' } do
+  namespace :api, defaults: { format: 'json' } do
     resources :products do
       resources :images
       resources :variants
       resources :product_properties
     end
 
-    order_routes = lambda {
+    concern :order_routes do
       member do
         put :cancel
         put :empty
@@ -32,17 +32,8 @@ Spree::Core::Engine.add_routes do
           put :credit
         end
       end
-      # TODO Remove after shipment api is no longer handled through order nesting.
-      resources :shipments, :only => [:create, :update] do
-        member do
-          put :ready
-          put :ship
-          put :add
-          put :remove
-        end
-      end
 
-      resources :addresses, :only => [:show, :update]
+      resources :addresses, only: [:show, :update]
 
       resources :return_authorizations do
         member do
@@ -51,17 +42,16 @@ Spree::Core::Engine.add_routes do
           put :receive
         end
       end
-    }
+    end
 
-    resources :checkouts do
+    resources :checkouts, only: [:update], concerns: :order_routes do
       member do
         put :next
         put :advance
       end
-      order_routes.call
     end
 
-    resources :variants, :only => [:index, :show] do
+    resources :variants, only: [:index, :show] do
       resources :images
     end
 
@@ -69,15 +59,16 @@ Spree::Core::Engine.add_routes do
       resources :option_values
     end
 
-    get '/orders/mine', :to => 'orders#mine', :as => 'my_orders'
+    get '/orders/mine', to: 'orders#mine', as: 'my_orders'
 
-    resources :orders, &order_routes
+    resources :orders, concerns: :order_routes
 
     resources :zones
-    resources :countries, :only => [:index, :show] do
-      resources :states, :only => [:index, :show]
+    resources :countries, only: [:index, :show] do
+      resources :states, only: [:index, :show]
     end
-    resources :shipments, :only => [:create, :update] do
+
+    resources :shipments, only: [:create, :update] do
       member do
         put :ready
         put :ship
@@ -85,7 +76,7 @@ Spree::Core::Engine.add_routes do
         put :remove
       end
     end
-    resources :states,    :only => [:index, :show]
+    resources :states, only: [:index, :show]
 
     resources :taxonomies do
       member do
@@ -98,9 +89,9 @@ Spree::Core::Engine.add_routes do
       end
     end
 
-    resources :taxons, :only => [:index]
+    resources :taxons, only: [:index]
 
-    resources :inventory_units, :only => [:show, :update]
+    resources :inventory_units, only: [:show, :update]
     resources :users
     resources :properties
     resources :stock_locations do
@@ -108,10 +99,10 @@ Spree::Core::Engine.add_routes do
       resources :stock_items
     end
 
-    get '/config/money', :to => 'config#money'
-    get '/config', :to => 'config#show'
+    get '/config/money', to: 'config#money'
+    get '/config', to: 'config#show'
 
-    put '/classifications', :to => 'classifications#update', :as => :classifications
-    get '/taxons/products', :to => 'taxons#products', :as => :taxon_products
+    put '/classifications', to: 'classifications#update', as: :classifications
+    get '/taxons/products', to: 'taxons#products', as: :taxon_products
   end
 end

data/lib/spree/api/engine.rb

@@ -10,9 +10,9 @@ module Spree
         config.include_json_root = false
         config.include_child_root = false
 
-        # Motivation here it make it call as_json when rendering. Otherwise it
-        # would fall to JSON and get errors like the one described here https://github.com/spree/spree/issues/4589
-        # where Float::INFINITY would resolve to Infinite (invalid json) istead of null
+        # Motivation here it make it call as_json when rendering timestamps
+        # and therefore display miliseconds. Otherwise it would fall to
+        # JSON.dump which doesn't display the miliseconds
         config.json_engine = ActiveSupport::JSON
       end
 

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

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

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

@@ -3,7 +3,12 @@ module Spree
     module TestingSupport
       module Helpers
         def json_response
-          JSON.parse(response.body)
+          case body = JSON.parse(response.body)
+          when Hash
+            body.with_indifferent_access
+          when Array
+            body
+          end
         end
 
         def assert_not_found!
@@ -17,7 +22,7 @@ module Spree
         end
 
         def stub_authentication!
-          allow(Spree.user_class).to receive(:find_by).with(hash_including(:spree_api_key)) { current_api_user }
+          Spree::LegacyUser.stub(:find_by).with(hash_including(:spree_api_key)) { current_api_user }
         end
 
         # This method can be overriden (with a let block) inside a context
@@ -31,7 +36,7 @@ module Spree
         end
 
         def upload_image(filename)
-          fixture_file_upload(image(filename).path)
+          fixture_file_upload(image(filename).path, 'image/jpg')
         end
       end
     end

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

@@ -8,9 +8,16 @@ describe Spree::Api::BaseController do
     end
   end
 
-  before do
-    @routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
-      r.draw { get 'index', to: 'spree/api/base#index' }
+  context "signed in as a user using an authentication extension" do
+    before do
+      controller.stub :try_spree_current_user => double(:email => "spree@example.com")
+      Spree::Api::Config[:requires_authentication] = true
+    end
+
+    it "can make a request" do
+      api_get :index
+      json_response.should == { "products" => [] }
+      response.status.should == 200
     end
   end
 
@@ -19,12 +26,12 @@ describe Spree::Api::BaseController do
 
     context "with a correct order token" do
       it "succeeds" do
-        api_get :index, order_token: order.token, order_id: order.number
+        api_get :index, order_token: order.guest_token, order_id: order.number
         response.status.should == 200
       end
 
       it "succeeds with an order_number parameter" do
-        api_get :index, order_token: order.token, order_number: order.number
+        api_get :index, order_token: order.guest_token, order_number: order.number
         response.status.should == 200
       end
     end
@@ -64,7 +71,7 @@ describe Spree::Api::BaseController do
     json_response.should == { "exception" => "no joy" }
   end
 
-  it "maps semantic keys to nested_attributes keys" do
+  it "maps symantec keys to nested_attributes keys" do
     klass = double(:nested_attributes_options => { :line_items => {},
                                                   :bill_address => {} })
     attributes = { 'line_items' => { :id => 1 },
@@ -72,11 +79,7 @@ describe Spree::Api::BaseController do
                    'name' => 'test order' }
 
     mapped = subject.map_nested_attributes_keys(klass, attributes)
-    mapped.has_key?('line_items_attributes').should be true
-    mapped.has_key?('name').should be true
-  end
-
-  it "lets a subclass override the product associations that are eager-loaded" do
-    controller.respond_to?(:product_includes, true).should be
+    mapped.has_key?('line_items_attributes').should be_true
+    mapped.has_key?('name').should be_true
   end
 end