solidus_api 2.4.2 → 2.5.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1607236a51ff9585fc6da7df65ee8f1230e4d7c
-  data.tar.gz: 2915ff0611fa3783baff26cc541e955abd4fc9cc
+SHA256:
+  metadata.gz: 0f786be0873e048ce3be477e79b3e77fea2edc7b831abddcff8910b353ec8180
+  data.tar.gz: 78a37e6abfb77386b5fac0c0465c590337bb23d6ba930fc146583e8bad473195
 SHA512:
-  metadata.gz: 249fb7e605274bd293e05a2614f5f3a7722a8f44f4c023a1bee1bd18460afaba31f0c88f5756b67eba44136db1cefc6161695726686b19eb50fd5dedd666693a
-  data.tar.gz: c190543d4c098ef28c8993521e7f0cd3dcd85eba925504326ae2a37dfeb9a3c1b22c3c4b2b69d4673e414b3c8a72b304bd298c414dcb37a75284a9333ee35928
+  metadata.gz: 6ba8a8df12bdb893791882ab855ca8912163ce0c9bf750effe7d1b46ab6ff1b0bff0ee64f787fa317c9047db2db89f4d92fa3ef6c403f4c1e1bb989123770d0c
+  data.tar.gz: 6c2f3890c3dfa009f3d1607b648d3109b26be3a52209a492b7162ca985633e79ff6ad0b3189c72dbcbf3d5ae62cfefcfabfddfb15b39235a637fca596eb7b765

data/README.md

@@ -4,10 +4,6 @@ API contains controllers and rabl views implementing the REST API of solidus.
 
 ## Testing
 
-Create the test site
-
-    bundle exec rake test_app
-
 Run the tests
 
-    bundle exec rake spec
+    bundle exec rspec

data/Rakefile

@@ -2,15 +2,14 @@ require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 require 'rspec/core/rake_task'
-require 'spree/testing_support/common_rake'
-require 'rails/all'
+require 'spree/testing_support/dummy_app/rake_tasks'
 
 RSpec::Core::RakeTask.new
-
 task default: :spec
 
-desc "Generates a dummy app for testing"
-task :test_app do
-  ENV['LIB_NAME'] = 'spree/api'
-  Rake::Task['common:test_app'].invoke
-end
+DummyApp::RakeTasks.new(
+  gem_root: File.expand_path('../', __FILE__),
+  lib_name: 'solidus_api'
+)
+
+task test_app: 'db:reset'

data/app/controllers/spree/api/line_items_controller.rb

@@ -12,9 +12,7 @@ module Spree
         @line_item = @order.contents.add(
           variant,
           params[:line_item][:quantity] || 1,
-          {
-            stock_location_quantities: params[:line_item][:stock_location_quantities]
-          }.merge({ options: line_item_params[:options].to_h })
+          options: line_item_params[:options].to_h
         )
 
         if @line_item.errors.empty?

data/app/controllers/spree/api/orders_controller.rb

@@ -10,7 +10,7 @@ module Spree
       skip_before_action :authenticate_user, only: :apply_coupon_code
 
       before_action :find_order, except: [:create, :mine, :current, :index]
-      around_action :lock_order, except: [:create, :mine, :current, :index]
+      around_action :lock_order, except: [:create, :mine, :current, :index, :show]
 
       # Dynamically defines our stores checkout steps to ensure we check authorization on each step.
       Spree::Order.checkout_steps.keys.each do |step|

data/app/controllers/spree/api/products_controller.rb

@@ -91,7 +91,7 @@ module Spree
       def destroy
         @product = find_product(params[:id])
         authorize! :destroy, @product
-        @product.destroy
+        @product.discard
         respond_with(@product, status: 204)
       end
 

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

@@ -2,9 +2,9 @@ module Spree
   module Api
     class ShipmentsController < Spree::Api::BaseController
       before_action :find_order_on_create, only: :create
-      before_action :find_shipment, only: [:update, :ship, :ready, :add, :remove]
+      before_action :find_shipment, only: [:update, :ship, :ready, :add, :remove, :estimated_rates, :select_shipping_method]
       before_action :load_transfer_params, only: [:transfer_to_location, :transfer_to_shipment]
-      around_action :lock_order, except: [:mine]
+      around_action :lock_order, except: [:mine, :estimated_rates]
       before_action :update_shipment, only: [:ship, :ready, :add, :remove]
 
       def mine
@@ -22,6 +22,20 @@ module Spree
         end
       end
 
+      def estimated_rates
+        authorize! :update, @shipment
+        estimator = Spree::Config.stock.estimator_class.new
+        @shipping_rates = estimator.shipping_rates(@shipment.to_package, false)
+      end
+
+      def select_shipping_method
+        authorize! :update, @shipment
+        shipping_method = Spree::ShippingMethod.find(params.require(:shipping_method_id))
+        @shipment.select_shipping_method(shipping_method)
+        @order.recalculate
+        respond_with(@shipment, default_template: :show)
+      end
+
       def create
         authorize! :create, Shipment
         quantity = params[:quantity].to_i
@@ -70,13 +84,13 @@ module Spree
       def remove
         quantity = params[:quantity].to_i
 
-        if @shipment.pending?
+        if @shipment.shipped? || @shipment.canceled?
+          @shipment.errors.add(:base, :cannot_remove_items_shipment_state, state: @shipment.state)
+          invalid_resource!(@shipment)
+        else
           @shipment.order.contents.remove(variant, quantity, { shipment: @shipment })
           @shipment.reload if @shipment.persisted?
           respond_with(@shipment, default_template: :show)
-        else
-          @shipment.errors.add(:base, :cannot_remove_items_shipment_state, state: @shipment.state)
-          invalid_resource!(@shipment)
         end
       end
 
@@ -97,7 +111,7 @@ module Spree
         )
 
         if fulfilment_changer.run!
-          render json: { success: true, message: Spree.t(:shipment_transfer_success) }, status: :accepted
+          render json: { success: true, message: t('spree.shipment_transfer_success') }, status: :accepted
         else
           render json: { success: false, message: fulfilment_changer.errors.full_messages.to_sentence }, status: :accepted
         end

data/app/controllers/spree/api/stock_items_controller.rb

@@ -3,7 +3,7 @@ module Spree
     class StockItemsController < Spree::Api::BaseController
       before_action :load_stock_location, only: [:index, :show, :create]
 
-      rescue_from StockLocation::InvalidMovementError, with: :render_stock_items_error
+      rescue_from Spree::StockLocation::InvalidMovementError, with: :render_stock_items_error
 
       def index
         @stock_items = paginate(scope.ransack(params[:q]).result)
@@ -49,7 +49,7 @@ module Spree
 
       def destroy
         @stock_item = Spree::StockItem.accessible_by(current_ability, :destroy).find(params[:id])
-        @stock_item.destroy
+        @stock_item.discard
         respond_with(@stock_item, status: 204)
       end
 
@@ -75,14 +75,14 @@ module Spree
 
       def adjust_stock_item_count_on_hand(count_on_hand_adjustment)
         if @stock_item.count_on_hand + count_on_hand_adjustment < 0
-          raise StockLocation::InvalidMovementError.new(Spree.t(:stock_not_below_zero))
+          raise StockLocation::InvalidMovementError.new(t('spree.stock_not_below_zero'))
         end
         @stock_movement = @stock_location.move(@stock_item.variant, count_on_hand_adjustment, current_api_user)
         @stock_item = @stock_movement.stock_item
       end
 
       def render_stock_items_error
-        render json: { error: Spree.t(:stock_not_below_zero) }, status: 422
+        render json: { error: t('spree.stock_not_below_zero') }, status: 422
       end
     end
   end

data/app/controllers/spree/api/taxonomies_controller.rb

@@ -15,6 +15,7 @@ module Spree
 
       # Because JSTree wants parameters in a *slightly* different format
       def jstree
+        Spree::Deprecation.warn("Please don't use `/api/taxonomies/:taxonomy_id/jstree` endpoint. It is deprecated and will be removed in the next future.", caller)
         show
       end
 

data/app/controllers/spree/api/taxons_controller.rb

@@ -23,6 +23,7 @@ module Spree
       end
 
       def jstree
+        Spree::Deprecation.warn("Please don't use `/api/taxonomies/:taxonomy_id/taxons/:taxon_id/jstree` endpoint. It is deprecated and will be removed in the next future.", caller)
         show
       end
 

data/app/controllers/spree/api/variants_controller.rb

@@ -15,7 +15,7 @@ module Spree
 
       def destroy
         @variant = scope.accessible_by(current_ability, :destroy).find(params[:id])
-        @variant.destroy
+        @variant.discard
         respond_with(@variant, status: 204)
       end
 
@@ -23,7 +23,7 @@ module Spree
       # we render on the view so we better update it any time a node is included
       # or removed from the views.
       def index
-        @variants = scope.includes({ option_values: :option_type }, :product, :default_price, :images, { stock_items: :stock_location })
+        @variants = scope.includes(include_list)
           .ransack(params[:q]).result
 
         @variants = paginate(@variants)
@@ -34,7 +34,7 @@ module Spree
       end
 
       def show
-        @variant = scope.includes({ option_values: :option_type }, :option_values, :product, :default_price, :images, { stock_items: :stock_location })
+        @variant = scope.includes(include_list)
           .find(params[:id])
         respond_with(@variant)
       end
@@ -66,14 +66,23 @@ module Spree
         end
 
         in_stock_only = ActiveRecord::Type::Boolean.new.cast(params[:in_stock_only])
+        suppliable_only = ActiveRecord::Type::Boolean.new.cast(params[:suppliable_only])
         variants = variants.accessible_by(current_ability, :read)
-        variants = variants.in_stock if in_stock_only || cannot?(:view_out_of_stock, Spree::Variant)
+        if in_stock_only || cannot?(:view_out_of_stock, Spree::Variant)
+          variants = variants.in_stock
+        elsif suppliable_only
+          variants = variants.suppliable
+        end
         variants
       end
 
       def variant_params
         params.require(:variant).permit(permitted_variant_attributes)
       end
+
+      def include_list
+        [{ option_values: :option_type }, :product, :default_price, :images, { stock_items: :stock_location }]
+      end
     end
   end
 end

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

@@ -31,9 +31,6 @@ module Spree
         :promotion_attributes,
         :store_attributes,
         :store_credit_history_attributes,
-        :stock_transfer_attributes,
-        :transfer_item_attributes,
-        :transfer_item_variant_attributes,
         :variant_property_attributes
       ]
 
@@ -177,12 +174,6 @@ module Spree
         :display_event_date
       ]
 
-      @@stock_transfer_attributes = [:id, :number]
-
-      @@transfer_item_attributes = [:id, :expected_quantity, :received_quantity]
-
-      @@transfer_item_variant_attributes = []
-
       def variant_attributes
         if @current_user_roles && @current_user_roles.include?("admin")
           @@variant_attributes + [:cost_price]

data/app/views/spree/api/shared/_pagination.json.jbuilder

@@ -2,4 +2,4 @@ json.count        pagination.count
 json.total_count  pagination.total_count
 json.current_page pagination.current_page
 json.pages        pagination.total_pages
-json.per_page     pagination.limit_value
+json.per_page     pagination.current_per_page

data/app/views/spree/api/shipments/estimated_rates.json.jbuilder

@@ -0,0 +1,4 @@
+json.shipping_rates @shipping_rates do |shipping_rate|
+  json.(shipping_rate, :name, :cost, :shipping_method_id, :shipping_method_code)
+  json.display_cost(shipping_rate.display_cost.to_s)
+end

data/app/views/spree/api/variants/_big.json.jbuilder

@@ -1,7 +1,6 @@
 json.cache! [I18n.locale, Spree::StockLocation.accessible_by(current_ability), variant] do
   json.(variant, *variant_attributes)
   json.partial!("spree/api/variants/small", variant: variant)
-  json.total_on_hand(variant.total_on_hand)
   json.variant_properties(variant.variant_properties) do |variant_property|
     json.(variant_property, *variant_property_attributes)
   end

data/app/views/spree/api/variants/_small.json.jbuilder

@@ -5,7 +5,12 @@ json.cache! [I18n.locale, variant] do
   json.track_inventory(variant.should_track_inventory?)
   json.in_stock(variant.in_stock?)
   json.is_backorderable(variant.is_backorderable?)
-  json.total_on_hand(variant.total_on_hand)
+
+  # We can't represent Float::INFINITY in JSON
+  # Under JSON this woulb be NULL
+  # Under oj this would error
+  json.total_on_hand(variant.should_track_inventory? ? variant.total_on_hand : nil)
+
   json.is_destroyed(variant.destroyed?)
   json.option_values(variant.option_values) do |option_value|
     json.(option_value, *option_value_attributes)

data/config/locales/en.yml

@@ -8,12 +8,6 @@ en:
       resource_not_found: "The resource you were looking for could not be found."
       gateway_error: "There was a problem with the payment gateway: %{text}"
       delete_restriction_error: "Cannot delete record."
-      access: "API Access"
-      key: "Key"
-      clear_key: "Clear key"
-      regenerate_key: "Regenerate Key"
-      no_key: "No key"
-      generate_key: "Generate API key"
       key_generated: "Key generated"
       key_cleared: "Key cleared"
       order:

data/config/routes.rb

@@ -82,6 +82,9 @@ Spree::Core::Engine.routes.draw do
       end
 
       member do
+        get :estimated_rates
+        put :select_shipping_method
+
         put :ready
         put :ship
         put :add
@@ -120,13 +123,6 @@ Spree::Core::Engine.routes.draw do
 
     resources :stock_items, only: [:index, :update, :destroy]
 
-    resources :stock_transfers, only: [] do
-      member do
-        post :receive
-      end
-      resources :transfer_items, only: [:create, :update, :destroy]
-    end
-
     resources :stores
 
     resources :store_credit_events, only: [] do

data/lib/spree/api/engine.rb

@@ -9,16 +9,6 @@ module Spree
       initializer "spree.api.environment", before: :load_config_initializers do |_app|
         Spree::Api::Config = Spree::ApiConfiguration.new
       end
-
-      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
     end
   end
 end

data/lib/spree_api.rb

@@ -1,4 +1,3 @@
 require 'spree/api'
 require 'spree/api/responders'
-require 'versioncake'
 require 'jbuilder'

data/solidus_api.gemspec

@@ -21,8 +21,7 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = '>= 1.8.23'
 
   gem.add_dependency 'solidus_core', gem.version
-  gem.add_dependency 'versioncake', '~> 3.0'
   gem.add_dependency 'responders'
   gem.add_dependency 'jbuilder', '~> 2.6'
-  gem.add_dependency 'kaminari', '>= 0.17', '< 2.0'
+  gem.add_dependency 'kaminari-activerecord', '~> 1.1'
 end

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

@@ -51,14 +51,14 @@ module Spree
 
       it "returns no widgets" do
         get :index, params: { token: user.spree_api_key }, as: :json
-        expect(response).to be_success
+        expect(response).to be_successful
         expect(json_response['widgets']).to be_blank
       end
 
       context "it has authorization to read widgets" do
         it "returns widgets" do
           get :index, params: { token: admin_user.spree_api_key }, as: :json
-          expect(response).to be_success
+          expect(response).to be_successful
           expect(json_response['widgets']).to include(hash_including(
             'name' => 'a widget',
             'position' => 1
@@ -70,26 +70,26 @@ module Spree
 
           it "returns both widgets from comma separated string" do
             get :index, params: { ids: [widget.id, widget2.id].join(','), token: admin_user.spree_api_key }, as: :json
-            expect(response).to be_success
+            expect(response).to be_successful
             expect(json_response['widgets'].size).to eq 2
           end
 
           it "returns both widgets from multiple arguments" do
             get :index, params: { ids: [widget.id, widget2.id], token: admin_user.spree_api_key }, as: :json
-            expect(response).to be_success
+            expect(response).to be_successful
             expect(json_response['widgets'].size).to eq 2
           end
 
           it "returns one requested widgets" do
             get :index, params: { ids: widget2.id.to_s, token: admin_user.spree_api_key }, as: :json
-            expect(response).to be_success
+            expect(response).to be_successful
             expect(json_response['widgets'].size).to eq 1
             expect(json_response['widgets'][0]['id']).to eq widget2.id
           end
 
           it "returns no widgets if empty" do
             get :index, params: { ids: '', token: admin_user.spree_api_key }, as: :json
-            expect(response).to be_success
+            expect(response).to be_successful
             expect(json_response['widgets']).to be_empty
           end
         end
@@ -107,7 +107,7 @@ module Spree
       context "it has authorization read widgets" do
         it "returns widget details" do
           get :show, params: { id: widget.to_param, token: admin_user.spree_api_key }, as: :json
-          expect(response).to be_success
+          expect(response).to be_successful
           expect(json_response['name']).to eq 'a widget'
         end
       end
@@ -122,7 +122,7 @@ module Spree
       context "it is allowed to view a new widget" do
         it "can learn how to create a new widget" do
           get :new, params: { token: admin_user.spree_api_key }, as: :json
-          expect(response).to be_success
+          expect(response).to be_successful
           expect(json_response["attributes"]).to eq(['name'])
         end
       end
@@ -159,7 +159,7 @@ module Spree
       context "it is authorized to update widgets" do
         it "can update a widget" do
           put :update, params: { id: widget.to_param, widget: { name: "another widget" }, token: admin_user.spree_api_key }, as: :json
-          expect(response).to be_success
+          expect(response).to be_successful
           expect(json_response['name']).to eq 'another widget'
           expect(widget.reload.name).to eq 'another widget'
         end

data/spec/features/checkout_spec.rb

@@ -3,16 +3,16 @@ require 'spec_helper'
 module Spree
   describe 'Api Feature Specs', type: :request do
     before { Spree::Api::Config[:requires_authentication] = false }
-    let!(:promotion) { FactoryGirl.create(:promotion, :with_order_adjustment, code: 'foo', weighted_order_adjustment_amount: 10) }
+    let!(:promotion) { FactoryBot.create(:promotion, :with_order_adjustment, code: 'foo', weighted_order_adjustment_amount: 10) }
     let(:promotion_code) { promotion.codes.first }
-    let!(:store) { FactoryGirl.create(:store) }
-    let(:bill_address) { FactoryGirl.create(:address) }
-    let(:ship_address) { FactoryGirl.create(:address) }
-    let(:variant_1) { FactoryGirl.create(:variant, price: 100.00) }
-    let(:variant_2) { FactoryGirl.create(:variant, price: 200.00) }
-    let(:payment_method) { FactoryGirl.create(:check_payment_method) }
+    let!(:store) { FactoryBot.create(:store) }
+    let(:bill_address) { FactoryBot.create(:address) }
+    let(:ship_address) { FactoryBot.create(:address) }
+    let(:variant_1) { FactoryBot.create(:variant, price: 100.00) }
+    let(:variant_2) { FactoryBot.create(:variant, price: 200.00) }
+    let(:payment_method) { FactoryBot.create(:check_payment_method) }
     let!(:shipping_method) do
-      FactoryGirl.create(:shipping_method).tap do |shipping_method|
+      FactoryBot.create(:shipping_method).tap do |shipping_method|
         shipping_method.zones.first.zone_members.create!(zoneable: ship_address.country)
         shipping_method.calculator.set_preference(:amount, 10.0)
       end

data/spec/requests/api/address_books_spec.rb

@@ -119,9 +119,7 @@ module Spree
     context 'on behalf of address book owner' do
       context 'with ability' do
         before do
-          Spree::RoleConfiguration.configure do |config|
-            config.assign_permissions 'Prefect', [Spree::PermissionSets::UserManagement]
-          end
+          Spree::Config.roles.assign_permissions 'Prefect', [Spree::PermissionSets::UserManagement]
           create(:user, spree_api_key: 'galleon', spree_roles: [build(:role, name: 'Prefect')])
         end
 

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

@@ -103,7 +103,7 @@ module Spree
 
         # Regression Spec for https://github.com/spree/spree/issues/5389 and https://github.com/spree/spree/issues/5880
         it "can update addresses but not transition to delivery w/o shipping setup" do
-          Spree::ShippingMethod.destroy_all
+          Spree::ShippingMethod.all.each(&:really_destroy!)
           put spree.api_checkout_path(order),
             params: { order_token: order.guest_token, order: {
               bill_address_attributes: address,
@@ -166,7 +166,6 @@ module Spree
         end
       end
 
-
       it "returns errors when source is required and missing" do
         order.update_column(:state, "payment")
         put spree.api_checkout_path(order.to_param), params: { order_token: order.guest_token, order: { payments_attributes: [{ payment_method_id: @payment_method.id }] } }
@@ -380,7 +379,7 @@ module Spree
         order.update_column(:email, "spree@example.com")
         put spree.next_api_checkout_path(order), params: { order_token: order.guest_token }
         expect(response.status).to eq(422)
-        expect(json_response["errors"]["base"]).to include(Spree.t(:there_are_no_items_for_this_order))
+        expect(json_response["errors"]["base"]).to include(I18n.t('spree.there_are_no_items_for_this_order'))
       end
 
       it "can transition an order to the next state" do
@@ -426,7 +425,7 @@ module Spree
         it "returns a sensible error when no payment method is specified" do
           # put :complete, id: order.to_param, order_token: order.token, order: {}
           subject
-          expect(json_response["errors"]["base"]).to include(Spree.t(:no_payment_found))
+          expect(json_response["errors"]["base"]).to include(I18n.t('spree.no_payment_found'))
         end
 
         context "with mismatched expected_total" do
@@ -436,7 +435,7 @@ module Spree
             # 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(I18n.t('spree.api.order.expected_total_mismatch'))
           end
         end
       end

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

@@ -10,13 +10,13 @@ module Spree
 
     it "returns Spree::Money settings" do
       get '/api/config/money'
-      expect(response).to be_success
+      expect(response).to be_successful
       expect(json_response["symbol"]).to eq("$")
     end
 
     it "returns some configuration settings" do
       get '/api/config'
-      expect(response).to be_success
+      expect(response).to be_successful
       expect(json_response["default_country_iso"]).to eq("US")
       expect(json_response["default_country_id"]).to eq(default_country.id)
     end