solidus_api 2.9.6 → 2.11.0

data/solidus_api.gemspec

@@ -2,27 +2,27 @@
 
 require_relative '../core/lib/spree/core/version.rb'
 
-Gem::Specification.new do |gem|
-  gem.author        = 'Solidus Team'
-  gem.email         = 'contact@solidus.io'
-  gem.homepage      = 'http://solidus.io/'
-  gem.license       = 'BSD-3-Clause'
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "solidus_api"
+  s.version     = Spree.solidus_version
+  s.summary     = 'REST API for the Solidus e-commerce framework.'
+  s.description = s.summary
 
-  gem.summary       = 'REST API for the Solidus e-commerce framework.'
-  gem.description   = gem.summary
+  s.author      = 'Solidus Team'
+  s.email       = 'contact@solidus.io'
+  s.homepage    = 'http://solidus.io'
+  s.license     = 'BSD-3-Clause'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "solidus_api"
-  gem.require_paths = ["lib"]
-  gem.version = Spree.solidus_version
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|script)/})
+  end
 
-  gem.required_ruby_version = '>= 2.2.2'
-  gem.required_rubygems_version = '>= 1.8.23'
+  s.required_ruby_version = '>= 2.5.0'
+  s.required_rubygems_version = '>= 1.8.23'
 
-  gem.add_dependency 'jbuilder', '~> 2.8'
-  gem.add_dependency 'kaminari-activerecord', '~> 1.1'
-  gem.add_dependency 'responders'
-  gem.add_dependency 'solidus_core', gem.version
+  s.add_dependency 'jbuilder', '~> 2.8'
+  s.add_dependency 'kaminari-activerecord', '~> 1.1'
+  s.add_dependency 'responders'
+  s.add_dependency 'solidus_core', s.version
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_api
 version: !ruby/object:Gem::Version
-  version: 2.9.6
+  version: 2.11.0
 platform: ruby
 authors:
 - Solidus Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.6
+        version: 2.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.6
+        version: 2.11.0
 description: REST API for the Solidus e-commerce framework.
 email: contact@solidus.io
 executables: []
@@ -85,6 +85,7 @@ files:
 - app/controllers/spree/api/countries_controller.rb
 - app/controllers/spree/api/coupon_codes_controller.rb
 - app/controllers/spree/api/credit_cards_controller.rb
+- app/controllers/spree/api/customer_returns_controller.rb
 - app/controllers/spree/api/images_controller.rb
 - app/controllers/spree/api/inventory_units_controller.rb
 - app/controllers/spree/api/line_items_controller.rb
@@ -111,7 +112,6 @@ files:
 - app/controllers/spree/api/variants_controller.rb
 - app/controllers/spree/api/zones_controller.rb
 - app/helpers/spree/api/api_helpers.rb
-- app/models/spree/api_configuration.rb
 - app/views/.rubocop.yml
 - app/views/spree/api/address_books/show.json.jbuilder
 - app/views/spree/api/addresses/_address.json.jbuilder
@@ -124,6 +124,10 @@ files:
 - app/views/spree/api/credit_cards/_credit_card.json.jbuilder
 - app/views/spree/api/credit_cards/index.json.jbuilder
 - app/views/spree/api/credit_cards/show.json.jbuilder
+- app/views/spree/api/customer_returns/index.json.jbuilder
+- app/views/spree/api/customer_returns/new.json.jbuilder
+- app/views/spree/api/customer_returns/show.json.jbuilder
+- app/views/spree/api/errors/could_not_transition.json.jbuilder
 - app/views/spree/api/errors/delete_restriction.json.jbuilder
 - app/views/spree/api/errors/gateway_error.json.jbuilder
 - app/views/spree/api/errors/invalid_api_key.json.jbuilder
@@ -230,71 +234,30 @@ files:
 - db/migrate/20131017162334_add_index_to_user_spree_api_key.rb
 - lib/solidus_api.rb
 - lib/spree/api.rb
+- lib/spree/api/config.rb
 - lib/spree/api/engine.rb
 - lib/spree/api/responders.rb
-- lib/spree/api/responders/rabl_template.rb
+- lib/spree/api/responders/jbuilder_template.rb
 - lib/spree/api/testing_support/caching.rb
 - lib/spree/api/testing_support/helpers.rb
 - lib/spree/api/testing_support/setup.rb
+- lib/spree/api_configuration.rb
 - lib/spree_api.rb
-- script/rails
+- openapi/.stoplight.yml
+- openapi/authentication.md
+- openapi/checkout-flow.md
+- openapi/errors.md
+- openapi/lint.yml
+- openapi/main.hub.yml
+- openapi/pagination.md
+- openapi/solidus-api.oas.yml
+- openapi/theme.css
 - solidus_api.gemspec
-- spec/controllers/spree/api/base_controller_spec.rb
-- spec/controllers/spree/api/resource_controller_spec.rb
-- spec/features/checkout_spec.rb
-- spec/fixtures/thinking-cat.jpg
-- spec/models/spree/legacy_user_spec.rb
-- spec/requests/api/address_books_spec.rb
-- spec/requests/rabl_cache_spec.rb
-- spec/requests/ransackable_attributes_spec.rb
-- spec/requests/spree/api/addresses_controller_spec.rb
-- spec/requests/spree/api/checkouts_controller_spec.rb
-- spec/requests/spree/api/classifications_controller_spec.rb
-- spec/requests/spree/api/config_controller_spec.rb
-- spec/requests/spree/api/countries_controller_spec.rb
-- spec/requests/spree/api/coupon_codes_controller_spec.rb
-- spec/requests/spree/api/credit_cards_controller_spec.rb
-- spec/requests/spree/api/images_controller_spec.rb
-- spec/requests/spree/api/inventory_units_controller_spec.rb
-- spec/requests/spree/api/line_items_controller_spec.rb
-- spec/requests/spree/api/option_types_controller_spec.rb
-- spec/requests/spree/api/option_values_controller_spec.rb
-- spec/requests/spree/api/orders_controller_spec.rb
-- spec/requests/spree/api/payments_controller_spec.rb
-- spec/requests/spree/api/product_properties_controller_spec.rb
-- spec/requests/spree/api/products_controller_spec.rb
-- spec/requests/spree/api/promotion_application_spec.rb
-- spec/requests/spree/api/promotions_controller_spec.rb
-- spec/requests/spree/api/properties_controller_spec.rb
-- spec/requests/spree/api/return_authorizations_controller_spec.rb
-- spec/requests/spree/api/shipments_controller_spec.rb
-- spec/requests/spree/api/states_controller_spec.rb
-- spec/requests/spree/api/stock_items_controller_spec.rb
-- spec/requests/spree/api/stock_locations_controller_spec.rb
-- spec/requests/spree/api/stock_movements_controller_spec.rb
-- spec/requests/spree/api/store_credit_events_controller_spec.rb
-- spec/requests/spree/api/stores_controller_spec.rb
-- spec/requests/spree/api/taxonomies_controller_spec.rb
-- spec/requests/spree/api/taxons_controller_spec.rb
-- spec/requests/spree/api/unauthenticated_products_controller_spec.rb
-- spec/requests/spree/api/users_controller_spec.rb
-- spec/requests/spree/api/variants_controller_spec.rb
-- spec/requests/spree/api/zones_controller_spec.rb
-- spec/shared_examples/protect_product_actions.rb
-- spec/spec_helper.rb
-- spec/support/be_paginated_matcher.rb
-- spec/support/controller_hacks.rb
-- spec/support/database_cleaner.rb
-- spec/support/have_attributes_matcher.rb
-- spec/test_views/spree/api/widgets/_widget.json.jbuilder
-- spec/test_views/spree/api/widgets/index.json.jbuilder
-- spec/test_views/spree/api/widgets/new.json.jbuilder
-- spec/test_views/spree/api/widgets/show.json.jbuilder
-homepage: http://solidus.io/
+homepage: http://solidus.io
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -302,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -310,58 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.23
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: REST API for the Solidus e-commerce framework.
-test_files:
-- spec/controllers/spree/api/base_controller_spec.rb
-- spec/controllers/spree/api/resource_controller_spec.rb
-- spec/features/checkout_spec.rb
-- spec/fixtures/thinking-cat.jpg
-- spec/models/spree/legacy_user_spec.rb
-- spec/requests/api/address_books_spec.rb
-- spec/requests/rabl_cache_spec.rb
-- spec/requests/ransackable_attributes_spec.rb
-- spec/requests/spree/api/addresses_controller_spec.rb
-- spec/requests/spree/api/checkouts_controller_spec.rb
-- spec/requests/spree/api/classifications_controller_spec.rb
-- spec/requests/spree/api/config_controller_spec.rb
-- spec/requests/spree/api/countries_controller_spec.rb
-- spec/requests/spree/api/coupon_codes_controller_spec.rb
-- spec/requests/spree/api/credit_cards_controller_spec.rb
-- spec/requests/spree/api/images_controller_spec.rb
-- spec/requests/spree/api/inventory_units_controller_spec.rb
-- spec/requests/spree/api/line_items_controller_spec.rb
-- spec/requests/spree/api/option_types_controller_spec.rb
-- spec/requests/spree/api/option_values_controller_spec.rb
-- spec/requests/spree/api/orders_controller_spec.rb
-- spec/requests/spree/api/payments_controller_spec.rb
-- spec/requests/spree/api/product_properties_controller_spec.rb
-- spec/requests/spree/api/products_controller_spec.rb
-- spec/requests/spree/api/promotion_application_spec.rb
-- spec/requests/spree/api/promotions_controller_spec.rb
-- spec/requests/spree/api/properties_controller_spec.rb
-- spec/requests/spree/api/return_authorizations_controller_spec.rb
-- spec/requests/spree/api/shipments_controller_spec.rb
-- spec/requests/spree/api/states_controller_spec.rb
-- spec/requests/spree/api/stock_items_controller_spec.rb
-- spec/requests/spree/api/stock_locations_controller_spec.rb
-- spec/requests/spree/api/stock_movements_controller_spec.rb
-- spec/requests/spree/api/store_credit_events_controller_spec.rb
-- spec/requests/spree/api/stores_controller_spec.rb
-- spec/requests/spree/api/taxonomies_controller_spec.rb
-- spec/requests/spree/api/taxons_controller_spec.rb
-- spec/requests/spree/api/unauthenticated_products_controller_spec.rb
-- spec/requests/spree/api/users_controller_spec.rb
-- spec/requests/spree/api/variants_controller_spec.rb
-- spec/requests/spree/api/zones_controller_spec.rb
-- spec/shared_examples/protect_product_actions.rb
-- spec/spec_helper.rb
-- spec/support/be_paginated_matcher.rb
-- spec/support/controller_hacks.rb
-- spec/support/database_cleaner.rb
-- spec/support/have_attributes_matcher.rb
-- spec/test_views/spree/api/widgets/_widget.json.jbuilder
-- spec/test_views/spree/api/widgets/index.json.jbuilder
-- spec/test_views/spree/api/widgets/new.json.jbuilder
-- spec/test_views/spree/api/widgets/show.json.jbuilder
+test_files: []

data/script/rails

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
-
-ENGINE_ROOT = File.expand_path('..', __dir__)
-ENGINE_PATH = File.expand_path('../lib/spree/api/engine', __dir__)
-
-require 'rails/all'
-require 'rails/engine/commands'

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

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-class FakesController < Spree::Api::BaseController
-end
-
-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 json: { "products" => [] }
-    end
-  end
-
-  before do
-    @routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
-      r.draw { get 'index', to: 'spree/api/base#index' }
-    end
-  end
-
-  context "when validating based on an order token" do
-    let!(:order) { create :order }
-
-    context "with a correct order token" do
-      it "succeeds" do
-        get :index, params: { order_token: order.guest_token, order_id: order.number }
-        expect(response.status).to eq(200)
-      end
-
-      it "succeeds with an order_number parameter" do
-        get :index, params: { order_token: order.guest_token, order_number: order.number }
-        expect(response.status).to eq(200)
-      end
-    end
-
-    context "with an incorrect order token" do
-      it "returns unauthorized" do
-        get :index, params: { order_token: "NOT_A_TOKEN", order_id: order.number }
-        expect(response.status).to eq(401)
-      end
-    end
-  end
-
-  context "cannot make a request to the API" do
-    it "without an API key" do
-      get :index
-      expect(json_response).to eq({ "error" => "You must specify an API key." })
-      expect(response.status).to eq(401)
-    end
-
-    it "with an invalid API key" do
-      request.headers["Authorization"] = "Bearer fake_key"
-      get :index, params: {}
-      expect(json_response).to eq({ "error" => "Invalid API key (fake_key) specified." })
-      expect(response.status).to eq(401)
-    end
-
-    it "using an invalid token param" do
-      get :index, params: { token: "fake_key" }
-      expect(json_response).to eq({ "error" => "Invalid API key (fake_key) specified." })
-    end
-  end
-
-  it "lets a subclass override the product associations that are eager-loaded" do
-    expect(controller.respond_to?(:product_includes, true)).to be
-  end
-
-  context 'insufficient stock' do
-    before do
-      expect(subject).to receive(:authenticate_user).and_return(true)
-      expect(subject).to receive(:index).and_raise(Spree::Order::InsufficientStock)
-      get :index, params: { token: "fake_key" }
-    end
-
-    it "should return a 422" do
-      expect(response.status).to eq(422)
-    end
-
-    it "returns an error message" do
-      expect(json_response).to eq(
-        { "errors" => ["Quantity is not available for items in your order"], "type" => "insufficient_stock" }
-      )
-    end
-  end
-
-  context 'lock_order' do
-    let!(:order) { create :order }
-
-    controller(Spree::Api::BaseController) do
-      around_action :lock_order
-
-      def index
-        render json: { "products" => [] }
-      end
-    end
-
-    context 'without an existing lock' do
-      it 'succeeds' do
-        get :index, params: { order_token: order.guest_token, order_id: order.number }
-        expect(response.status).to eq(200)
-      end
-    end
-
-    context 'with an existing lock' do
-      around do |example|
-        Spree::OrderMutex.with_lock!(order) { example.run }
-      end
-
-      it 'returns a 409 conflict' do
-        get :index, params: { order_token: order.guest_token, order_id: order.number }
-        expect(response.status).to eq(409)
-      end
-    end
-  end
-end

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

@@ -1,190 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Spree
-  module Api
-    class WidgetsController < Spree::Api::ResourceController
-      prepend_view_path('spec/test_views')
-
-      def model_class
-        Widget
-      end
-
-      def permitted_widget_attributes
-        [:name]
-      end
-    end
-  end
-
-  describe Api::WidgetsController, type: :controller do
-    render_views
-
-    after(:all) do
-      Rails.application.reload_routes!
-    end
-
-    with_model 'Widget', scope: :all do
-      table do |t|
-        t.string :name
-        t.integer :position
-        t.timestamps null: false
-      end
-
-      model do
-        acts_as_list
-        validates :name, presence: true
-      end
-    end
-
-    before do
-      Spree::Core::Engine.routes.draw do
-        namespace :api do
-          resources :widgets
-        end
-      end
-    end
-
-    let(:user) { create(:user, :with_api_key) }
-    let(:admin_user) { create(:admin_user, :with_api_key) }
-
-    describe "#index" do
-      let!(:widget) { Widget.create!(name: "a widget") }
-
-      it "returns no widgets" do
-        get :index, params: { token: user.spree_api_key }, as: :json
-        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_successful
-          expect(json_response['widgets']).to include(
-            hash_including(
-              'name' => 'a widget',
-              'position' => 1
-            )
-          )
-        end
-
-        context "specifying ids" do
-          let!(:widget2) { Widget.create!(name: "a widget") }
-
-          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_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_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_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_successful
-            expect(json_response['widgets']).to be_empty
-          end
-        end
-      end
-    end
-
-    describe "#show" do
-      let(:widget) { Widget.create!(name: "a widget") }
-
-      it "returns not found" do
-        get :show, params: { id: widget.to_param, token: user.spree_api_key }, as: :json
-        assert_not_found!
-      end
-
-      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_successful
-          expect(json_response['name']).to eq 'a widget'
-        end
-      end
-    end
-
-    describe "#new" do
-      it "returns unauthorized" do
-        get :new, params: { token: user.spree_api_key }, as: :json
-        expect(response).to be_unauthorized
-      end
-
-      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_successful
-          expect(json_response["attributes"]).to eq(['name'])
-        end
-      end
-    end
-
-    describe "#create" do
-      it "returns unauthorized" do
-        expect {
-          post :create, params: { widget: { name: "a widget" }, token: user.spree_api_key }, as: :json
-        }.not_to change(Widget, :count)
-        expect(response).to be_unauthorized
-      end
-
-      context "it is authorized to create widgets" do
-        it "can create a widget" do
-          expect {
-            post :create, params: { widget: { name: "a widget" }, token: admin_user.spree_api_key }, as: :json
-          }.to change(Widget, :count).by(1)
-          expect(response).to be_created
-          expect(json_response['name']).to eq 'a widget'
-          expect(Widget.last.name).to eq 'a widget'
-        end
-      end
-    end
-
-    describe "#update" do
-      let!(:widget) { Widget.create!(name: "a widget") }
-      it "returns unauthorized" do
-        put :update, params: { id: widget.to_param, widget: { name: "another widget" }, token: user.spree_api_key }, as: :json
-        assert_not_found!
-        expect(widget.reload.name).to eq 'a widget'
-      end
-
-      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_successful
-          expect(json_response['name']).to eq 'another widget'
-          expect(widget.reload.name).to eq 'another widget'
-        end
-      end
-    end
-
-    describe "#destroy" do
-      let!(:widget) { Widget.create!(name: "a widget") }
-      it "returns unauthorized" do
-        delete :destroy, params: { id: widget.to_param, token: user.spree_api_key }, as: :json
-        assert_not_found!
-        expect { widget.reload }.not_to raise_error
-      end
-
-      context "it is authorized to destroy widgets" do
-        it "can destroy a widget" do
-          delete :destroy, params: { id: widget.to_param, token: admin_user.spree_api_key }, as: :json
-          expect(response.status).to eq 204
-          expect { widget.reload }.to raise_error(ActiveRecord::RecordNotFound)
-        end
-      end
-    end
-  end
-end