spree_api 2.3.13 → 2.4.0.rc1

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

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

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

@@ -0,0 +1,48 @@
+object @shipment
+cache @shipment
+attributes *shipment_attributes
+
+child selected_shipping_rate: :selected_shipping_rate do
+  extends "spree/api/shipping_rates/show"
+end
+
+child inventory_units: :inventory_units do
+  object @inventory_unit
+  attributes *inventory_unit_attributes
+
+  child :variant do
+    extends "spree/api/variants/small"
+    attributes :product_id
+    child(images: :images) { extends "spree/api/images/show" }
+  end
+
+  child :line_item do
+    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 }
+  end
+end
+
+child order: :order do
+  extends "spree/api/orders/order"
+
+  child billing_address: :bill_address do
+    extends "spree/api/addresses/show"
+  end
+
+  child shipping_address: :ship_address do
+    extends "spree/api/addresses/show"
+  end
+
+  child adjustments: :adjustments do
+    extends "spree/api/adjustments/show"
+  end
+
+  child payments: :payments do
+    attributes :id, :amount, :display_amount, :state
+    child payment_method: :payment_method do
+      attributes :id, :name
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+object false
+
+node(:count) { @shipments.count }
+node(:current_page) { params[:page] || 1 }
+node(:pages) { @shipments.num_pages }
+
+child(@shipments => :shipments) do
+  extends "spree/api/shipments/big"
+end

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

@@ -14,7 +14,7 @@ child :selected_shipping_rate => :selected_shipping_rate do
 end
 
 child :shipping_methods => :shipping_methods do
-  attributes :id, :name
+  attributes :id, :code, :name
   child :zones => :zones do
     attributes :id, :name, :description
   end
@@ -31,7 +31,3 @@ child :manifest => :manifest do
   node(:quantity) { |m| m.quantity }
   node(:states) { |m| m.states }
 end
-
-child :adjustments => :adjustments do
-  extends "spree/api/adjustments/show"
-end

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

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

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/variants/big.v1.rabl

@@ -1,10 +1,15 @@
 object @variant
 attributes *variant_attributes
 
-cache [I18n.locale, 'big_variant', root_object]
+cache [I18n.locale, @current_user_roles.include?('admin'), 'big_variant', root_object]
 
 extends "spree/api/variants/small"
 
+node :total_on_hand do
+  root_object.total_on_hand
+end
+
+
 child(:stock_items => :stock_items) do
   attributes :id, :count_on_hand, :stock_location_id, :backorderable
   attribute :available? => :available

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

@@ -1,3 +1,3 @@
 object @variant
-cache [I18n.locale, 'show', root_object]
+cache [I18n.locale, @current_user_roles.include?('admin'), 'show', root_object]
 extends "spree/api/variants/big"

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

@@ -1,11 +1,10 @@
+cache [I18n.locale, @current_user_roles.include?('admin'), 'small_variant', root_object]
+
 attributes *variant_attributes
-cache [I18n.locale, 'small_variant', root_object]
 
 node(:display_price) { |p| p.display_price.to_s }
 node(:options_text) { |v| v.options_text }
 node(:in_stock) { |v| v.in_stock? }
-node(:is_backorderable) { |v| v.is_backorderable? }
-node(:total_on_hand) { |v| v.total_on_hand }
 
 child :option_values => :option_values do
   attributes *option_value_attributes

data/config/routes.rb

@@ -9,6 +9,8 @@ Spree::Core::Engine.add_routes do
   end
 
   namespace :api, defaults: { format: 'json' } do
+    resources :promotions, only: [:show]
+
     resources :products do
       resources :images
       resources :variants
@@ -60,6 +62,7 @@ Spree::Core::Engine.add_routes do
     end
 
     get '/orders/mine', to: 'orders#mine', as: 'my_orders'
+    get "/orders/current", to: "orders#current", to: "orders#current", as: "current_order"
 
     resources :orders, concerns: :order_routes
 
@@ -69,6 +72,12 @@ Spree::Core::Engine.add_routes do
     end
 
     resources :shipments, only: [:create, :update] do
+      collection do
+        post 'transfer_to_location'
+        post 'transfer_to_shipment'
+        get :mine
+      end
+
       member do
         put :ready
         put :ship

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

@@ -12,23 +12,23 @@ module Spree
         end
 
         def assert_not_found!
-          expect(json_response).to eq({ "error" => "The resource you were looking for could not be found." })
-          expect(response.status).to eq 404
+          json_response.should == { "error" => "The resource you were looking for could not be found." }
+          response.status.should == 404
         end
 
         def assert_unauthorized!
-          expect(json_response).to eq({ "error" => "You are not authorized to perform that action." })
-          expect(response.status).to eq 401
+          json_response.should == { "error" => "You are not authorized to perform that action." }
+          response.status.should == 401
         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
         # For instance, if you wanted to have an admin user instead.
         def current_api_user
-          @current_api_user ||= stub_model(Spree::LegacyUser, email: "spree@example.com")
+          @current_api_user ||= stub_model(Spree::LegacyUser, :email => "spree@example.com")
         end
 
         def image(filename)

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

@@ -5,8 +5,8 @@ module Spree
         def sign_in_as_admin!
           let!(:current_api_user) do
             user = stub_model(Spree::LegacyUser)
-            allow(user).to receive_message_chain(:spree_roles, :pluck).and_return(["admin"])
-            allow(user).to receive(:has_spree_role?).with("admin").and_return(true)
+            user.stub_chain(:spree_roles, :pluck).and_return(["admin"])
+            user.stub(:has_spree_role?).with("admin").and_return(true)
             user
           end
         end

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module Spree
-  describe Api::AddressesController, :type => :controller do
+  describe Api::AddressesController do
     render_views
 
     before do
@@ -12,27 +12,27 @@ module Spree
 
     context "with their own address" do
       before do
-        allow_any_instance_of(Order).to receive_messages :user => current_api_user
+        Order.any_instance.stub :user => current_api_user
       end
 
       it "gets an address" do
         api_get :show, :id => @address.id, :order_id => @order.number
-        expect(json_response['address1']).to eq @address.address1
+        json_response['address1'].should eq @address.address1
       end
 
       it "updates an address" do
         api_put :update, :id => @address.id, :order_id => @order.number,
                          :address => { :address1 => "123 Test Lane" }
-        expect(json_response['address1']).to eq '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 => "" }
 
-        expect(json_response['error']).not_to be_nil
-        expect(json_response['errors']).not_to be_nil
-        expect(json_response['errors']['address1'].first).to eq "can't be blank"
+        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"
       end
     end
 

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

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
-describe Spree::Api::BaseController, :type => :controller do
+class FakesController < Spree::Api::BaseController
+end
+
+describe Spree::Api::BaseController do
   render_views
   controller(Spree::Api::BaseController) do
     def index
@@ -8,9 +11,17 @@ describe Spree::Api::BaseController, :type => :controller 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
+      user = double(:email => "spree@example.com")
+      user.stub_chain :spree_roles, pluck: []
+      controller.stub :try_spree_current_user => user
+    end
+
+    it "can make a request" do
+      api_get :index
+      json_response.should == { "products" => [] }
+      response.status.should == 200
     end
   end
 
@@ -20,19 +31,19 @@ describe Spree::Api::BaseController, :type => :controller do
     context "with a correct order token" do
       it "succeeds" do
         api_get :index, order_token: order.guest_token, order_id: order.number
-        expect(response.status).to eq(200)
+        response.status.should == 200
       end
 
       it "succeeds with an order_number parameter" do
         api_get :index, order_token: order.guest_token, order_number: order.number
-        expect(response.status).to eq(200)
+        response.status.should == 200
       end
     end
 
     context "with an incorrect order token" do
       it "returns unauthorized" do
         api_get :index, order_token: "NOT_A_TOKEN", order_id: order.number
-        expect(response.status).to eq(401)
+        response.status.should == 401
       end
     end
   end
@@ -40,29 +51,29 @@ describe Spree::Api::BaseController, :type => :controller do
   context "cannot make a request to the API" do
     it "without an API key" do
       api_get :index
-      expect(json_response).to eq({ "error" => "You must specify an API key." })
-      expect(response.status).to eq(401)
+      json_response.should == { "error" => "You must specify an API key." }
+      response.status.should == 401
     end
 
     it "with an invalid API key" do
       request.headers["X-Spree-Token"] = "fake_key"
       get :index, {}
-      expect(json_response).to eq({ "error" => "Invalid API key (fake_key) specified." })
-      expect(response.status).to eq(401)
+      json_response.should == { "error" => "Invalid API key (fake_key) specified." }
+      response.status.should == 401
     end
 
     it "using an invalid token param" do
       get :index, :token => "fake_key"
-      expect(json_response).to eq({ "error" => "Invalid API key (fake_key) specified." })
+      json_response.should == { "error" => "Invalid API key (fake_key) specified." }
     end
   end
 
   it 'handles exceptions' do
-    expect(subject).to receive(:authenticate_user).and_return(true)
-    expect(subject).to receive(:load_user_roles).and_return(true)
-    expect(subject).to receive(:index).and_raise(Exception.new("no joy"))
+    subject.should_receive(:authenticate_user).and_return(true)
+    subject.should_receive(:load_user_roles).and_return(true)
+    subject.should_receive(:index).and_raise(Exception.new("no joy"))
     get :index, :token => "fake_key"
-    expect(json_response).to eq({ "exception" => "no joy" })
+    json_response.should == { "exception" => "no joy" }
   end
 
   it "maps semantic keys to nested_attributes keys" do
@@ -73,11 +84,47 @@ describe Spree::Api::BaseController, :type => :controller do
                    'name' => 'test order' }
 
     mapped = subject.map_nested_attributes_keys(klass, attributes)
-    expect(mapped.has_key?('line_items_attributes')).to be true
-    expect(mapped.has_key?('name')).to be true
+    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
-    expect(controller.respond_to?(:product_includes, true)).to be
+    controller.respond_to?(:product_includes, true).should be
+  end
+
+  describe '#error_during_processing' do
+    controller(FakesController) do
+      # GET /foo
+      # Simulates a failed API call.
+      def foo
+        raise StandardError
+      end
+    end
+
+    # What would be placed in config/initializers/spree.rb
+    Spree::Api::BaseController.error_notifier = Proc.new do |e, controller|
+      MockHoneybadger.notify_or_ignore(e, rack_env: controller.request.env)
+    end
+
+    ##
+    # Fake HB alert class
+    class MockHoneybadger
+      # https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger.rb#L136
+      def self.notify_or_ignore(exception, opts = {})
+      end
+    end
+
+    before do
+      user = double(email: "spree@example.com")
+      user.stub_chain :spree_roles, pluck: []
+      controller.stub try_spree_current_user: user
+      routes.draw { get 'foo' => 'fakes#foo' }
+    end
+
+    it 'should notify notify_error_during_processing' do
+      expect(MockHoneybadger).to receive(:notify_or_ignore).once.with(kind_of(Exception), rack_env: kind_of(Hash))
+      api_get :foo
+      expect(response.status).to eq(422)
+    end
   end
 end