spree_api 1.2.2 → 1.2.3

data/app/controllers/spree/api/v1/base_controller.rb

@@ -10,6 +10,7 @@ module Spree
         before_filter :check_for_api_key, :if => :requires_authentication?
         before_filter :authenticate_user
 
+        rescue_from Exception, :with => :error_during_processing
         rescue_from CanCan::AccessDenied, :with => :unauthorized
         rescue_from ActiveRecord::RecordNotFound, :with => :not_found
 
@@ -63,6 +64,11 @@ module Spree
           render "spree/api/v1/errors/not_found", :status => 404 and return
         end
 
+        def error_during_processing(exception)
+          render :text => { :exception => exception.message }.to_json,
+                 :status => 422 and return
+        end
+
         def current_ability
           Spree::Ability.new(current_api_user)
         end

data/app/controllers/spree/api/v1/inventory_units_controller.rb

@@ -0,0 +1,50 @@
+module Spree
+  module Api
+    module V1
+      class InventoryUnitsController < Spree::Api::V1::BaseController
+        before_filter :prepare_event, :only => :update
+
+        def show
+          @inventory_unit = inventory_unit
+        end
+
+        def update
+          authorize! :update, Order
+
+          inventory_unit.transaction do
+            if inventory_unit.update_attributes(params[:inventory_unit])
+              fire
+              render :show, :status => 200
+            else
+              invalid_resource!(inventory_unit)
+            end
+          end
+        end
+
+        private
+
+        def inventory_unit
+          @inventory_unit ||= InventoryUnit.find(params[:id])
+        end
+
+        def prepare_event
+          return unless @event = params[:fire]
+
+          can_event = "can_#{@event}?"
+
+          unless inventory_unit.respond_to?(can_event) &&
+                 inventory_unit.send(can_event)
+            render :text => { exception: "cannot transition to #{@event}" }.to_json,
+                    :status => 200
+            false
+          end
+        end
+
+        def fire
+          inventory_unit.send("#{@event}!") if @event
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v1/product_properties_controller.rb

@@ -7,8 +7,8 @@ module Spree
 
         def index
           @product_properties = @product.product_properties.
-                                ransack(params[:q]).result
-                                .page(params[:page]).per(params[:per_page])
+                                ransack(params[:q]).result.
+                                page(params[:page]).per(params[:per_page])
         end
 
         def show

data/app/controllers/spree/api/v1/shipments_controller.rb

@@ -8,7 +8,11 @@ module Spree
         def ready
           authorize! :read, Shipment
           unless @shipment.ready?
-            @shipment.ready!
+            if @shipment.can_ready?
+              @shipment.ready!
+            else
+              render "spree/api/v1/shipments/cannot_ready_shipment", :status => 422 and return
+            end
           end
           render :show
         end

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

@@ -64,6 +64,11 @@ module Spree
         [:id, :name, :permalink, :position, :parent_id, :taxonomy_id]
       end
 
+      def inventory_unit_attributes
+        [:id, :lock_version, :state, :variant_id, :order_id,
+         :shipment_id, :return_authorization_id]
+      end
+
       def return_authorization_attributes
         [:id, :number, :state, :amount, :order_id, :reason, :created_at, :updated_at]
       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/shipments/cannot_ready_shipment.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:cannot_ready, :scope => "spree.api.shipment") }

data/config/locales/en.yml

@@ -19,3 +19,5 @@ 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."
+      shipment:
+        cannot_ready: "Cannot ready shipment."

data/config/routes.rb

@@ -53,6 +53,7 @@ Spree::Core::Engine.routes.prepend do
       resources :taxonomies do
         resources :taxons
       end
+      resources :inventory_units, :only => [:show, :update]
     end
   end
 end

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

@@ -28,6 +28,13 @@ describe Spree::Api::V1::BaseController do
     end
   end
 
+  it 'handles exceptions' do
+    subject.should_receive(:authenticate_user).and_return(true)
+    subject.should_receive(:index).and_raise(Exception.new("no joy"))
+    get :index, :token => "fake_key"
+    json_response.should == { "exception" => "no joy" }
+  end
+
   it "maps symantec keys to nested_attributes keys" do
     klass = stub(:nested_attributes_options => { :line_items => {},
                                                   :bill_address => {} })

data/spec/controllers/spree/api/v1/inventory_units_controller_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::V1::InventoryUnitsController do
+    render_views
+
+    before do
+      stub_authentication!
+      @inventory_unit = create(:inventory_unit)
+    end
+
+    it "gets an inventory unit" do
+      api_get :show, :id => @inventory_unit.id
+      json_response['inventory_unit']['state'].should eq @inventory_unit.state
+    end
+
+    it "updates an inventory unit (only shipment is accessable by default)" do
+      api_put :update, :id => @inventory_unit.id,
+                       :inventory_unit => { :shipment => nil }
+      json_response['inventory_unit']['shipment_id'].should be_nil
+    end
+
+    context 'fires state event' do
+      it 'if supplied with :fire param' do
+        api_put :update, :id => @inventory_unit.id,
+                         :fire => 'ship',
+                         :inventory_unit => { :shipment => nil }
+
+        json_response['inventory_unit']['state'].should eq 'shipped'
+      end
+
+      it 'and returns exception if cannot fire' do
+        api_put :update, :id => @inventory_unit.id,
+                         :fire => 'return'
+        json_response['exception'].should match /cannot transition to return/
+      end
+
+      it 'and returns exception bad state' do
+        api_put :update, :id => @inventory_unit.id,
+                         :fire => 'bad'
+        json_response['exception'].should match /cannot transition to bad/
+      end
+    end
+
+  end
+end

data/spec/controllers/spree/api/v1/payments_controller_spec.rb

@@ -126,7 +126,7 @@ module Spree
           json_response["error"].should == "There was a problem with the payment gateway: Insufficient funds"
 
           payment.reload
-          payment.state.should == "pending"
+          payment.state.should == "failed"
         end
 
         it "can purchase" do

data/spec/controllers/spree/api/v1/return_authorizations_controller_spec.rb

@@ -9,8 +9,8 @@ module Spree
      order.line_items << create(:line_item)
      order.shipments << create(:shipment, :state => 'shipped')
      order.finalize!
-     order.shipments.each(&:ready!)
-     order.shipments.each(&:ship!)
+     order.shipments.update_all(:state => 'shipped')
+     order.inventory_units.update_all(:state => 'shipped')
      order
     end
 
@@ -62,18 +62,18 @@ module Spree
       sign_in_as_admin!
 
       it "can show return authorization" do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         return_authorization = order.return_authorizations.first
-        api_get :show, :order_id => order.id, :id => return_authorization.id
+        api_get :show, :order_id => order.number, :id => return_authorization.id
         response.status.should == 200
         json_response.should have_attributes(attributes)
         json_response["return_authorization"]["state"].should_not be_blank
       end
 
       it "can get a list of return authorizations" do
-        order.return_authorizations << create(:return_authorization)
-        order.return_authorizations << create(:return_authorization)
-        api_get :index, { :order_id => order.id }
+        FactoryGirl.create(:return_authorization, :order => order)
+        FactoryGirl.create(:return_authorization, :order => order)
+        api_get :index, { :order_id => order.number }
         response.status.should == 200
         return_authorizations = json_response["return_authorizations"]
         return_authorizations.first.should have_attributes(attributes)
@@ -81,16 +81,16 @@ module Spree
       end
 
       it 'can control the page size through a parameter' do
-        order.return_authorizations << create(:return_authorization)
-        order.return_authorizations << create(:return_authorization)
-        api_get :index, :order_id => order.id, :per_page => 1
+        FactoryGirl.create(:return_authorization, :order => order)
+        FactoryGirl.create(:return_authorization, :order => order)
+        api_get :index, :order_id => order.number, :per_page => 1
         json_response['count'].should == 1
         json_response['current_page'].should == 1
         json_response['pages'].should == 2
       end
 
       it 'can query the results through a paramter' do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         expected_result = create(:return_authorization, :reason => 'damaged')
         order.return_authorizations << expected_result
         api_get :index, :q => { :reason_cont => 'damage' }
@@ -106,7 +106,7 @@ module Spree
       end
 
       it "can update a return authorization on the order" do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         return_authorization = order.return_authorizations.first
         api_put :update, :id => return_authorization.id, :return_authorization => { :amount => 19.99 }
         response.status.should == 200
@@ -114,7 +114,7 @@ module Spree
       end
 
       it "can delete a return authorization on the order" do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         return_authorization = order.return_authorizations.first
         api_delete :destroy, :id => return_authorization.id
         response.status.should == 204
@@ -122,7 +122,7 @@ module Spree
       end
 
       it "can add a new return authorization to an existing order" do
-        api_post :create, :return_autorization => { :order_id => order.id, :amount => 14.22, :reason => "Defective" }
+        api_post :create, :return_autorization => { :order_id => order.number, :amount => 14.22, :reason => "Defective" }
         response.status.should == 201
         json_response.should have_attributes(attributes)
         json_response["return_authorization"]["state"].should_not be_blank
@@ -131,12 +131,12 @@ module Spree
 
     context "as just another user" do
       it "cannot add a return authorization to the order" do
-        api_post :create, :return_autorization => { :order_id => order.id, :amount => 14.22, :reason => "Defective" }
+        api_post :create, :return_autorization => { :order_id => order.number, :amount => 14.22, :reason => "Defective" }
         assert_unauthorized!
       end
 
       it "cannot update a return authorization on the order" do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         return_authorization = order.return_authorizations.first
         api_put :update, :id => return_authorization.id, :return_authorization => { :amount => 19.99 }
         assert_unauthorized!
@@ -144,7 +144,7 @@ module Spree
       end
 
       it "cannot delete a return authorization on the order" do
-        order.return_authorizations << create(:return_authorization)
+        FactoryGirl.create(:return_authorization, :order => order)
         return_authorization = order.return_authorizations.first
         api_delete :destroy, :id => return_authorization.id
         assert_unauthorized!

data/spec/controllers/spree/api/v1/shipments_controller_spec.rb

@@ -6,7 +6,6 @@ describe Spree::Api::V1::ShipmentsController do
   let!(:attributes) { [:id, :tracking, :number, :cost, :shipped_at] }
 
   before do
-    Spree::Order.any_instance.stub(:paid? => true, :complete? => true)
     stub_authentication!
   end
 
@@ -28,14 +27,22 @@ describe Spree::Api::V1::ShipmentsController do
     sign_in_as_admin!
 
     it "can make a shipment ready" do
+      Spree::Order.any_instance.stub(:paid? => true, :complete? => true)
       api_put :ready
       json_response.should have_attributes(attributes)
       json_response["shipment"]["state"].should == "ready"
       shipment.reload.state.should == "ready"
     end
 
+    it "cannot make a shipment ready if the order is unpaid" do
+      Spree::Order.any_instance.stub(:paid? => false)
+      api_put :ready
+      json_response["error"].should == "Cannot ready shipment."
+    end
+
     context "can transition a shipment from ready to ship" do
       before do
+        Spree::Order.any_instance.stub(:paid? => true, :complete? => true)
         shipment.update!(shipment.order)
         shipment.state.should == "ready"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
-  requirement: &70185208786720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *70185208786720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70185208785040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70185208785040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70185208804960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70185208804960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Spree's API
 email:
 - ryan@spreecommerce.com
@@ -59,6 +74,7 @@ files:
 - app/controllers/spree/api/v1/base_controller.rb
 - app/controllers/spree/api/v1/countries_controller.rb
 - app/controllers/spree/api/v1/images_controller.rb
+- app/controllers/spree/api/v1/inventory_units_controller.rb
 - app/controllers/spree/api/v1/line_items_controller.rb
 - app/controllers/spree/api/v1/orders_controller.rb
 - app/controllers/spree/api/v1/payments_controller.rb
@@ -88,6 +104,7 @@ files:
 - app/views/spree/api/v1/errors/not_found.rabl
 - app/views/spree/api/v1/errors/unauthorized.rabl
 - app/views/spree/api/v1/images/show.rabl
+- app/views/spree/api/v1/inventory_units/show.rabl
 - app/views/spree/api/v1/line_items/new.rabl
 - app/views/spree/api/v1/line_items/show.rabl
 - app/views/spree/api/v1/orders/address.rabl
@@ -114,6 +131,7 @@ files:
 - app/views/spree/api/v1/return_authorizations/index.rabl
 - app/views/spree/api/v1/return_authorizations/new.rabl
 - app/views/spree/api/v1/return_authorizations/show.rabl
+- app/views/spree/api/v1/shipments/cannot_ready_shipment.rabl
 - app/views/spree/api/v1/shipments/show.rabl
 - app/views/spree/api/v1/taxonomies/index.rabl
 - app/views/spree/api/v1/taxonomies/nested.rabl
@@ -147,6 +165,7 @@ files:
 - spec/controllers/spree/api/v1/base_controller_spec.rb
 - spec/controllers/spree/api/v1/countries_controller_spec.rb
 - spec/controllers/spree/api/v1/images_controller_spec.rb
+- spec/controllers/spree/api/v1/inventory_units_controller_spec.rb
 - spec/controllers/spree/api/v1/line_items_controller_spec.rb
 - spec/controllers/spree/api/v1/orders_controller_spec.rb
 - spec/controllers/spree/api/v1/payments_controller_spec.rb
@@ -182,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2313245839499120062
+      hash: 4196845361076740967
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,10 +210,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2313245839499120062
+      hash: 4196845361076740967
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Spree's API
@@ -203,6 +222,7 @@ test_files:
 - spec/controllers/spree/api/v1/base_controller_spec.rb
 - spec/controllers/spree/api/v1/countries_controller_spec.rb
 - spec/controllers/spree/api/v1/images_controller_spec.rb
+- spec/controllers/spree/api/v1/inventory_units_controller_spec.rb
 - spec/controllers/spree/api/v1/line_items_controller_spec.rb
 - spec/controllers/spree/api/v1/orders_controller_spec.rb
 - spec/controllers/spree/api/v1/payments_controller_spec.rb