solidus_api 1.2.3 → 1.3.0.beta1

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

@@ -37,10 +37,10 @@ module Spree
         :variant_property_attributes
       ]
 
-      mattr_reader *ATTRIBUTES
+      mattr_reader(*ATTRIBUTES)
 
       def required_fields_for(model)
-        required_fields = model._validators.select do |field, validations|
+        required_fields = model._validators.select do |_field, validations|
           validations.any? { |v| v.is_a?(ActiveModel::Validations::PresenceValidator) }
         end.map(&:first) # get fields that are invalid
         # Permalinks presence is validated, but are really automatically generated
@@ -88,7 +88,8 @@ module Spree
         :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
+        :total_applicable_store_credit, :display_total_available_store_credit,
+        :display_store_credit_remaining_after_capture, :canceler_id
 
       ]
 
@@ -104,7 +105,7 @@ module Spree
 
       @@payment_method_attributes = [:id, :name, :description]
 
-      @@shipment_attributes = [:id, :tracking, :number, :cost, :shipped_at, :state]
+      @@shipment_attributes = [:id, :tracking, :tracking_url, :number, :cost, :shipped_at, :state]
 
       @@taxonomy_attributes = [:id, :name]
 
@@ -135,11 +136,11 @@ module Spree
       @@adjustment_attributes = [
         :id, :source_type, :source_id, :adjustable_type, :adjustable_id,
         :originator_type, :originator_id, :amount, :label, :promotion_code,
-        :locked, :eligible,  :created_at, :updated_at
+        :locked, :eligible, :created_at, :updated_at
       ]
 
       @@creditcard_attributes = [
-        :id, :month, :year, :cc_type, :last_digits, :name,
+        :id, :month, :year, :cc_type, :last_digits, :name
       ]
 
       @@payment_source_attributes = [

data/app/models/spree/api_configuration.rb

@@ -1,5 +1,5 @@
 module Spree
   class ApiConfiguration < Preferences::Configuration
-    preference :requires_authentication, :boolean, :default => true
+    preference :requires_authentication, :boolean, default: true
   end
 end

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

@@ -1,2 +1,3 @@
 object false
-node(:default_country_id) { Spree::Config[:default_country_id] }
+node(:default_country_id) { Spree::Country.default.id }
+node(:default_country_iso) { Spree::Config[:default_country_iso] }

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

@@ -1,5 +1,5 @@
 object @product
-cache [I18n.locale, @current_user_roles.include?('admin'), current_currency, root_object]
+cache [I18n.locale, @current_user_roles.include?('admin'), current_pricing_options, root_object]
 
 attributes *product_attributes
 

data/db/migrate/20100107141738_add_api_key_to_spree_users.rb

@@ -1,7 +1,7 @@
 class AddApiKeyToSpreeUsers < ActiveRecord::Migration
   def change
     unless defined?(User)
-      add_column :spree_users, :api_key, :string, :limit => 40
+      add_column :spree_users, :api_key, :string, limit: 40
     end
   end
 end

data/db/migrate/20120411123334_resize_api_key_field.rb

@@ -1,7 +1,7 @@
 class ResizeApiKeyField < ActiveRecord::Migration
   def change
     unless defined?(User)
-      change_column :spree_users, :api_key, :string, :limit => 48
+      change_column :spree_users, :api_key, :string, limit: 48
     end
   end
 end

data/lib/spree/api/engine.rb

@@ -16,19 +16,19 @@ module Spree
         config.json_engine = ActiveSupport::JSON
       end
 
-      config.view_versions = [1]
-      config.view_version_extraction_strategy = :http_header
-
-      initializer "spree.api.environment", :before => :load_config_initializers do |app|
+      initializer "spree.api.environment", before: :load_config_initializers do |_app|
         Spree::Api::Config = Spree::ApiConfiguration.new
       end
 
-      def self.activate
-        Dir.glob(File.join(File.dirname(__FILE__), "../../../app/**/*_decorator*.rb")) do |c|
-          Rails.configuration.cache_classes ? require(c) : load(c)
+      initializer "spree.api.versioncake" do |_app|
+        VersionCake.setup do |config|
+          config.resources do |r|
+            r.resource %r{.*}, [], [], [1]
+          end
+          config.missing_version = 1
+          config.extraction_strategy = :http_header
         end
       end
-      config.to_prepare &method(:activate).to_proc
 
       def self.root
         @root ||= Pathname.new(File.expand_path('../../../../', __FILE__))

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

@@ -4,7 +4,7 @@ module Spree
       module RablTemplate
         def to_format
           if template
-            render template, :status => options[:status] || 200
+            render template, status: options[:status] || 200
           else
             super
           end

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

@@ -1,10 +1,10 @@
 RSpec.configure do |config|
-  config.before(:each, :caching => true) do 
+  config.before(:each, caching: true) do
     ActionController::Base.perform_caching = true
   end
-  
-  config.after(:each, :caching => true) do
+
+  config.after(:each, caching: true) do
     ActionController::Base.perform_caching = false
     Rails.cache.clear
   end
-end
+end

data/script/rails

@@ -6,4 +6,3 @@ ENGINE_PATH = File.expand_path('../../lib/spree/api/engine', __FILE__)
 
 require 'rails/all'
 require 'rails/engine/commands'
-

data/solidus_api.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = 'contact@solidus.io'
   gem.homepage      = 'http://solidus.io/'
 
-  gem.summary       = %q{REST API for the Solidus e-commerce framework.}
+  gem.summary       = 'REST API for the Solidus e-commerce framework.'
   gem.description   = gem.summary
 
   gem.files         = `git ls-files`.split($\)
@@ -14,9 +14,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "solidus_api"
   gem.require_paths = ["lib"]
-  gem.version         = Spree.solidus_version
+  gem.version = Spree.solidus_version
 
   gem.add_dependency 'solidus_core', gem.version
   gem.add_dependency 'rabl', ['>= 0.9.4.pre1', '< 0.12.0']
-  gem.add_dependency 'versioncake', '~> 2.3.1'
+  gem.add_dependency 'versioncake', '~> 3.0'
 end

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

@@ -1,37 +1,36 @@
 require 'spec_helper'
 
 module Spree
-  describe Api::AddressesController, :type => :controller do
+  describe Api::AddressesController, type: :controller do
     render_views
 
     before do
       stub_authentication!
       @address = create(:address)
-      @order = create(:order, :bill_address => @address)
+      @order = create(:order, bill_address: @address)
     end
 
     context "with order" do
       before do
-        allow_any_instance_of(Order).to receive_messages :user => current_api_user
+        allow_any_instance_of(Order).to receive_messages user: current_api_user
       end
 
       context "with their own address" do
-
         it "gets an address" do
-          api_get :show, :id => @address.id, :order_id => @order.number
+          api_get :show, id: @address.id, order_id: @order.number
           expect(json_response['address1']).to eq @address.address1
         end
 
         it "update replaces the readonly Address associated to the Order" do
-          api_put :update, :id => @address.id, :order_id => @order.number,
-                           :address => { :address1 => "123 Test Lane" }
+          api_put :update, id: @address.id, order_id: @order.number,
+                           address: { address1: "123 Test Lane" }
           expect(Order.find(@order.id).bill_address_id).not_to eq @address.id
           expect(json_response['address1']).to 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 => "" }
+          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
@@ -40,8 +39,8 @@ module Spree
       end
 
       it "receives the errors object if address is invalid" do
-        api_put :update, :id => @address.id, :order_id => @order.number,
-                         :address => { :address1 => "" }
+        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
@@ -56,12 +55,12 @@ module Spree
       end
 
       it "cannot retrieve address information" do
-        api_get :show, :id => @address.id, :order_id => @order.number
+        api_get :show, id: @address.id, order_id: @order.number
         assert_unauthorized!
       end
 
       it "cannot update address information" do
-        api_get :update, :id => @address.id, :order_id => @order.number
+        api_get :update, id: @address.id, order_id: @order.number
         assert_unauthorized!
       end
     end

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

@@ -3,13 +3,13 @@ require 'spec_helper'
 class FakesController < Spree::Api::BaseController
 end
 
-describe Spree::Api::BaseController, :type => :controller do
+describe Spree::Api::BaseController, type: :controller do
   render_views
   controller(Spree::Api::BaseController) do
     rescue_from Spree::Order::InsufficientStock, with: :insufficient_stock_error
 
     def index
-      render :text => { "products" => [] }.to_json
+      render text: { "products" => [] }.to_json
     end
   end
 
@@ -57,7 +57,7 @@ describe Spree::Api::BaseController, :type => :controller do
     end
 
     it "using an invalid token param" do
-      get :index, :token => "fake_key"
+      get :index, token: "fake_key"
       expect(json_response).to eq({ "error" => "Invalid API key (fake_key) specified." })
     end
   end
@@ -66,7 +66,7 @@ describe Spree::Api::BaseController, :type => :controller 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("no joy")
-    get :index, :token => "fake_key"
+    get :index, token: "fake_key"
     expect(json_response).to eq({ "exception" => "no joy" })
   end
 
@@ -75,7 +75,7 @@ describe Spree::Api::BaseController, :type => :controller do
     expect(subject).to receive(:load_user_roles).and_return(true)
     expect(subject).to receive(:index).and_raise(Exception.new("no joy"))
     expect {
-      get :index, :token => "fake_key"
+      get :index, token: "fake_key"
     }.to raise_error(Exception, "no joy")
   end
 
@@ -93,7 +93,7 @@ describe Spree::Api::BaseController, :type => :controller do
     end
 
     # What would be placed in config/initializers/spree.rb
-    Spree::Api::BaseController.error_notifier = Proc.new do |e, controller|
+    Spree::Api::BaseController.error_notifier = proc do |e, controller|
       MockHoneybadger.notify_or_ignore(e, rack_env: controller.request.env)
     end
 
@@ -101,7 +101,7 @@ describe Spree::Api::BaseController, :type => :controller do
     # 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 = {})
+      def self.notify_or_ignore(_exception, _opts = {})
       end
     end
 
@@ -125,7 +125,7 @@ describe Spree::Api::BaseController, :type => :controller do
     before do
       expect(subject).to receive(:authenticate_user).and_return(true)
       expect(subject).to receive(:index).and_raise(Spree::Order::InsufficientStock)
-      get :index, :token => "fake_key"
+      get :index, token: "fake_key"
     end
 
     it "should return a 422" do
@@ -134,7 +134,7 @@ describe Spree::Api::BaseController, :type => :controller do
 
     it "returns an error message" do
       expect(json_response).to eq(
-        {"errors" => ["Quantity is not available for items in your order"], "type" => "insufficient_stock"}
+        { "errors" => ["Quantity is not available for items in your order"], "type" => "insufficient_stock" }
       )
     end
   end
@@ -146,7 +146,7 @@ describe Spree::Api::BaseController, :type => :controller do
       around_filter :lock_order
 
       def index
-        render :text => { "products" => [] }.to_json
+        render text: { "products" => [] }.to_json
       end
     end
 
@@ -168,5 +168,4 @@ describe Spree::Api::BaseController, :type => :controller do
       end
     end
   end
-
 end

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

@@ -45,7 +45,7 @@ module Spree
         expect(order.state).to eq "cart"
         expect(order.email).not_to be_nil
         request.headers["X-Spree-Order-Token"] = order.guest_token
-        api_put :update, :id => order.to_param
+        api_put :update, id: order.to_param
         expect(order.reload.state).to eq "address"
       end
 
@@ -136,7 +136,7 @@ module Spree
 
       it "can update shipping method and transition from delivery to payment" do
         order.update_column(:state, "delivery")
-        shipment = create(:shipment, order: order)
+        shipment = create(:shipment, order: order, address: order.ship_address)
         shipment.refresh_rates
         shipping_rate = shipment.shipping_rates.where(selected: false).first
         api_put :update, id: order.to_param, order_token: order.guest_token,
@@ -163,23 +163,10 @@ module Spree
         expect(response.status).to eq(200)
       end
 
-      context "with disallowed payment method" do
-        it "returns not found" do
-          order.update_column(:state, "payment")
-          allow_any_instance_of(Spree::Gateway::Bogus).to receive(:source_required?).and_return(false)
-          @payment_method.update!(display_on: "back_end")
-          expect {
-            api_put :update, id: order.to_param, order_token: order.guest_token, order: { payments_attributes: [{ payment_method_id: @payment_method.id }] }
-          }.not_to change { Spree::Payment.count }
-          expect(response.status).to eq(404)
-        end
-      end
-
-
       it "returns errors when source is required and missing" do
         order.update_column(:state, "payment")
-        api_put :update, :id => order.to_param, :order_token => order.guest_token,
-          :order => { :payments_attributes => [{ :payment_method_id => @payment_method.id }] }
+        api_put :update, id: order.to_param, order_token: order.guest_token,
+          order: { payments_attributes: [{ payment_method_id: @payment_method.id }] }
         expect(response.status).to eq(422)
         source_errors = json_response['errors']['payments.source']
         expect(source_errors).to include("can't be blank")
@@ -194,10 +181,10 @@ module Spree
               payments_attributes: [
                 {
                   payment_method_id: @payment_method.id.to_s,
-                  source_attributes: attributes_for(:credit_card),
-                },
-              ],
-            },
+                  source_attributes: attributes_for(:credit_card)
+                }
+              ]
+            }
           }
         end
 
@@ -221,10 +208,10 @@ module Spree
               payments_attributes: [
                 {
                   payment_method_id: @payment_method.id.to_s,
-                  source_attributes: attributes_for(:credit_card),
-                },
-              ],
-            },
+                  source_attributes: attributes_for(:credit_card)
+                }
+              ]
+            }
           }
         end
 
@@ -242,10 +229,10 @@ module Spree
               order_token: order.guest_token,
               order: {
                 payments_attributes: [
-                  { payment_method_id: @payment_method.id.to_s },
-                ],
+                  { payment_method_id: @payment_method.id.to_s }
+                ]
               },
-              payment_source: { @payment_method.id.to_s => attributes_for(:credit_card) },
+              payment_source: { @payment_method.id.to_s => attributes_for(:credit_card) }
             }
           end
 
@@ -273,10 +260,10 @@ module Spree
               payments_attributes: [
                 {
                   payment_method_id: @payment_method.id.to_s,
-                  source_attributes: {name: "Spree"},
-                },
-              ],
-            },
+                  source_attributes: { name: "Spree" }
+                }
+              ]
+            }
           }
         end
 
@@ -285,7 +272,7 @@ module Spree
 
           expect(response.status).to eq(422)
           cc_errors = json_response['errors']['payments.Credit Card']
-          expect(cc_errors).to include("Number can't be blank")
+          expect(cc_errors).to include("Card Number can't be blank")
           expect(cc_errors).to include("Month is not a number")
           expect(cc_errors).to include("Year is not a number")
           expect(cc_errors).to include("Verification Value can't be blank")
@@ -298,12 +285,12 @@ module Spree
               order_token: order.guest_token,
               order: {
                 payments_attributes: [
-                  {payment_method_id: @payment_method.id.to_s},
-                ],
+                  { payment_method_id: @payment_method.id.to_s }
+                ]
               },
               payment_source: {
-                @payment_method.id.to_s => {name: "Spree"},
-              },
+                @payment_method.id.to_s => { name: "Spree" }
+              }
             }
           end
 
@@ -314,7 +301,7 @@ module Spree
 
             expect(response.status).to eq(422)
             cc_errors = json_response['errors']['payments.Credit Card']
-            expect(cc_errors).to include("Number can't be blank")
+            expect(cc_errors).to include("Card Number can't be blank")
             expect(cc_errors).to include("Month is not a number")
             expect(cc_errors).to include("Year is not a number")
             expect(cc_errors).to include("Verification Value can't be blank")
@@ -336,11 +323,11 @@ module Spree
                 {
                   source_attributes: {
                     existing_card_id: credit_card.id.to_s,
-                    verification_value: '456',
+                    verification_value: '456'
                   }
-                },
-              ],
-            },
+                }
+              ]
+            }
           }
         end
 
@@ -368,9 +355,9 @@ module Spree
               id: order.to_param,
               order_token: order.guest_token,
               order: {
-                existing_card: credit_card.id.to_s,
+                existing_card: credit_card.id.to_s
               },
-              cvc_confirm: '456',
+              cvc_confirm: '456'
             }
           end
 
@@ -392,14 +379,6 @@ module Spree
         end
       end
 
-      it "can transition from confirm to complete" do
-        order.update_columns(completed_at: Time.current, state: 'complete')
-        allow_any_instance_of(Spree::Order).to receive_messages(payment_required?: false)
-        api_put :update, id: order.to_param, order_token: order.guest_token
-        expect(json_response['state']).to eq('complete')
-        expect(response.status).to eq(200)
-      end
-
       it "returns the order if the order is already complete" do
         order.update_columns(completed_at: Time.current, state: 'complete')
         api_put :update, id: order.to_param, order_token: order.guest_token
@@ -438,7 +417,7 @@ module Spree
         order.update_column(:state, "payment")
         expect(PromotionHandler::Coupon).to receive(:new).with(order).and_call_original
         expect_any_instance_of(PromotionHandler::Coupon).to receive(:apply).and_return({ coupon_applied?: true })
-        api_put :update, :id => order.to_param, order_token: order.guest_token, order: { coupon_code: "foobar" }
+        api_put :update, id: order.to_param, order_token: order.guest_token, order: { coupon_code: "foobar" }
       end
     end
 
@@ -466,7 +445,7 @@ module Spree
           email: nil
         )
 
-        api_put :next, :id => order.to_param, :order_token => order.guest_token
+        api_put :next, id: order.to_param, order_token: order.guest_token
         expect(response.status).to eq(422)
         expect(json_response['error']).to match(/could not be transitioned/)
       end
@@ -475,7 +454,7 @@ module Spree
     # NOTE: Temporarily making "next" behave just like "complete" when order is in confirm state
     #       Using "next" this way is deprecated.
     [:next, :complete].each do |action|
-      context "#{action}" do
+      context action.to_s do
         context "with order in confirm state" do
           subject do
             if action == :next
@@ -487,7 +466,7 @@ module Spree
             end
           end
 
-          let(:params) { {id: order.to_param, order_token: order.guest_token} }
+          let(:params) { { id: order.to_param, order_token: order.guest_token } }
           let(:order) { create(:order_with_line_items) }
 
           before do
@@ -495,7 +474,7 @@ module Spree
           end
 
           it "can transition from confirm to complete" do
-            allow_any_instance_of(Spree::Order).to receive_messages(:payment_required? => false)
+            allow_any_instance_of(Spree::Order).to receive_messages(payment_required?: false)
             subject
             expect(json_response['state']).to eq('complete')
             expect(response.status).to eq(200)
@@ -514,7 +493,7 @@ module Spree
               # api_put :complete, :id => order.to_param, :order_token => order.token, :expected_total => order.total + 1
               subject
               expect(response.status).to eq(400)
-              expect(json_response['errors']['expected_total']).to include(Spree.t(:expected_total_mismatch, :scope => 'api.order'))
+              expect(json_response['errors']['expected_total']).to include(Spree.t(:expected_total_mismatch, scope: 'api.order'))
             end
           end
         end
@@ -524,7 +503,7 @@ module Spree
     context "PUT 'advance'" do
       let!(:order) { create(:order_with_line_items) }
 
-      it 'continues to advance advances an order while it can move forward' do
+      it 'continues to advance an order while it can move forward' do
         expect_any_instance_of(Spree::Order).to receive(:next).exactly(3).times.and_return(true, true, false)
         api_put :advance, id: order.to_param, order_token: order.guest_token
       end

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

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 module Spree
-  describe Api::ConfigController, :type => :controller do
+  describe Api::ConfigController, type: :controller do
+    let!(:default_country) { create :country, iso: "US"}
     render_views
 
     before do
@@ -17,7 +18,8 @@ module Spree
     it "returns some configuration settings" do
       api_get :show
       expect(response).to be_success
-      expect(json_response["default_country_id"]).to eq(Spree::Config[:default_country_id])
+      expect(json_response["default_country_iso"]).to eq("US")
+      expect(json_response["default_country_id"]).to eq(default_country.id)
     end
   end
 end

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module Spree
-  describe Api::CountriesController, :type => :controller do
+  describe Api::CountriesController, type: :controller do
     render_views
 
     before do
@@ -16,7 +16,7 @@ module Spree
     end
 
     context "with two countries" do
-      before { @zambia = create(:country, :name => "Zambia") }
+      before { @zambia = create(:country, name: "Zambia") }
 
       it "can view all countries" do
         api_get :index
@@ -26,13 +26,13 @@ module Spree
       end
 
       it 'can query the results through a paramter' do
-        api_get :index, :q => { :name_cont => 'zam' }
+        api_get :index, q: { name_cont: 'zam' }
         expect(json_response['count']).to eq(1)
         expect(json_response['countries'].first['name']).to eq @zambia.name
       end
 
       it 'can control the page size through a parameter' do
-        api_get :index, :per_page => 1
+        api_get :index, per_page: 1
         expect(json_response['count']).to eq(1)
         expect(json_response['current_page']).to eq(1)
         expect(json_response['pages']).to eq(2)
@@ -40,7 +40,7 @@ module Spree
     end
 
     it "includes states" do
-      api_get :show, :id => @country.id
+      api_get :show, id: @country.id
       states = json_response['states']
       expect(states.first['name']).to eq @state.name
     end