spree_api 4.2.3 → 4.3.0.rc1

data/lib/spree/api.rb

@@ -1,6 +1,7 @@
 require 'spree/core'
 
 require 'rabl'
+require 'responders'
 
 module Spree
   module Api

data/lib/spree/api/engine.rb

@@ -6,23 +6,6 @@ module Spree
       isolate_namespace Spree
       engine_name 'spree_api'
 
-      Rabl.configure do |config|
-        config.include_json_root = false
-        config.include_child_root = false
-
-        # Motivation here it make it call as_json when rendering timestamps
-        # and therefore display miliseconds. Otherwise it would fall to
-        # JSON.dump which doesn't display the miliseconds
-        config.json_engine = ActiveSupport::JSON
-      end
-
-      # sets the manifests / assets to be precompiled, even when initialize_on_precompile is false
-      initializer 'spree.assets.precompile', group: :all do |app|
-        app.config.assets.precompile += %w[
-          spree/api/all*
-        ]
-      end
-
       initializer 'spree.api.environment', before: :load_config_initializers do |_app|
         Spree::Api::Config = Spree::ApiConfiguration.new
         Spree::Api::Dependencies = Spree::ApiDependencies.new
@@ -32,6 +15,12 @@ module Spree
         Migrations.new(config, engine_name).check
       end
 
+      initializer 'spree.api.checking_deprecated_preferences' do
+        Spree::Api::Config.deprecated_preferences.each do |pref|
+          warn "[DEPRECATION] Spree::Api::Config[:#{pref[:name]}] is deprecated. #{pref[:message]}"
+        end
+      end
+
       def self.root
         @root ||= Pathname.new(File.expand_path('../../..', __dir__))
       end

data/lib/spree/api/testing_support/v2/base.rb

@@ -4,7 +4,7 @@ shared_context 'API v2 tokens' do
   let(:headers_order_token) { { 'X-Spree-Order-Token' => order.token } }
 end
 
-[200, 201, 400, 401, 404, 403, 422].each do |status_code|
+[200, 201, 204, 400, 401, 404, 403, 422].each do |status_code|
   shared_examples "returns #{status_code} HTTP status" do
     it "returns #{status_code}" do
       expect(response.status).to eq(status_code)

data/lib/spree/api/testing_support/v2/platform_contexts.rb

@@ -0,0 +1,214 @@
+class String
+  def articleize
+    %w(a e i o u).include?(self[0].downcase) ? "an #{self}" : "a #{self}"
+  end
+end
+
+shared_context 'Platform API v2' do
+  let(:store) { Spree::Store.default }
+  let(:admin_app) { Doorkeeper::Application.find_or_create_by!(name: 'Admin Panel', scopes: 'admin', redirect_uri: '') }
+  let(:read_app) { Doorkeeper::Application.find_or_create_by!(name: 'Read App', scopes: 'read', redirect_uri: '') }
+  let(:oauth_token) do
+    Doorkeeper::AccessToken.create!(
+      application_id: admin_app.id,
+      scopes: admin_app.scopes
+    )
+  end
+  let(:read_oauth_token) do
+    Doorkeeper::AccessToken.create!(
+      application_id: read_app.id,
+      scopes: read_app.scopes
+    )
+  end
+  let(:user_oauth_token) do
+    Doorkeeper::AccessToken.create!(
+      resource_owner_id: user.id,
+      application_id: admin_app.id,
+      scopes: admin_app.scopes
+    )
+  end
+
+  let(:valid_authorization) { "Bearer #{oauth_token.token}" }
+  let(:valid_read_authorization) { "Bearer #{read_oauth_token.token}" }
+  let(:valid_user_authorization) { "Bearer #{user_oauth_token.token}" }
+  let(:bogus_authorization) { "Bearer #{::Base64.strict_encode64('bogus:bogus')}" }
+
+  let(:Authorization) { valid_authorization }
+end
+
+shared_context 'jsonapi pagination' do
+  let(:page) { 1 }
+  let(:per_page) { '' }
+  parameter name: :page, in: :query, type: :integer, example: 1
+  parameter name: :per_page, in: :query, type: :integer, example: 50
+end
+
+JSON_API_INCLUDES_DESCRIPTION = 'Select which associated resources you would like to fetch'\
+                                ', see: <a href="https://jsonapi.org/format/#fetching-includes">'\
+                                'https://jsonapi.org/format/#fetching-includes</a>'.freeze
+JSON_API_FILTER_DESCRIPTION = ''
+
+def json_api_include_parameter(example = '')
+  let(:include) { nil }
+  parameter name: :include, in: :query, type: :string, descripton: JSON_API_INCLUDES_DESCRIPTION, example: example
+end
+
+def json_api_filter_parameter(example = '')
+  let(:filter) { nil }
+  parameter name: :filter, in: :query, type: :string, descripton: JSON_API_FILTER_DESCRIPTION, example: example
+end
+
+shared_examples 'authentication failed' do
+  response '401', 'Authentication Failed' do
+    let(:Authorization) { bogus_authorization }
+    schema '$ref' => '#/components/schemas/error'
+    run_test!
+  end
+end
+
+shared_examples 'record not found' do
+  response '404', 'Record not found' do
+    let(:id) { 'invalid' }
+    schema '$ref' => '#/components/schemas/error'
+    run_test!
+  end
+end
+
+shared_examples 'record found' do
+  response '200', 'Record found' do
+    schema '$ref' => '#/components/schemas/resource'
+    run_test!
+  end
+end
+
+shared_examples 'record deleted' do
+  response '204', 'Record deleted' do
+    run_test!
+  end
+end
+
+shared_examples 'records returned' do
+  response '200', 'Records returned' do
+    schema '$ref' => '#/components/schemas/resources_list'
+    run_test!
+  end
+end
+
+shared_examples 'record created' do
+  response '201', 'record created' do
+    schema '$ref' => '#/components/schemas/resource'
+    run_test!
+  end
+end
+
+shared_examples 'record updated' do
+  response '200', 'record updated' do
+    schema '$ref' => '#/components/schemas/resource'
+    run_test!
+  end
+end
+
+shared_examples 'invalid request' do |param_name|
+  response '422', 'invalid request' do
+    let(param_name) { invalid_param_value }
+    schema '$ref' => '#/components/schemas/validation_errors'
+    run_test!
+  end
+end
+
+# index action
+shared_examples 'GET records list' do |resource_name, include_example, filter_example|
+  get "Returns a list of #{resource_name.pluralize}" do
+    tags resource_name.pluralize
+    security [ bearer_auth: [] ]
+    include_context 'jsonapi pagination'
+    json_api_include_parameter(include_example)
+    json_api_filter_parameter(filter_example)
+
+    before { records_list }
+
+    it_behaves_like 'records returned'
+    it_behaves_like 'authentication failed'
+  end
+end
+
+# show
+shared_examples 'GET record' do |resource_name, include_example|
+  get "Returns #{resource_name.articleize}" do
+    tags resource_name.pluralize
+    security [ bearer_auth: [] ]
+    parameter name: :id, in: :path, type: :string
+    json_api_include_parameter(include_example)
+
+    it_behaves_like 'record found'
+    it_behaves_like 'record not found'
+    it_behaves_like 'authentication failed'
+  end
+end
+
+# create
+shared_examples 'POST create record' do |resource_name, include_example|
+  param_name = resource_name.parameterize.to_sym
+
+  post "Creates #{resource_name.articleize}" do
+    tags resource_name.pluralize
+    consumes 'application/json'
+    security [ bearer_auth: [] ]
+    parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
+    json_api_include_parameter(include_example)
+
+    let(param_name) { valid_create_param_value }
+
+    it_behaves_like 'record created'
+    it_behaves_like 'invalid request', param_name
+  end
+end
+
+# update
+shared_examples 'PUT update record' do |resource_name, include_example|
+  param_name = resource_name.parameterize.to_sym
+
+  put "Updates #{resource_name.articleize}" do
+    tags resource_name.pluralize
+    security [ bearer_auth: [] ]
+    consumes 'application/json'
+    parameter name: :id, in: :path, type: :string
+    parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
+    json_api_include_parameter(include_example)
+
+    let(param_name) { valid_update_param_value }
+
+    it_behaves_like 'record updated'
+    it_behaves_like 'invalid request', param_name
+    it_behaves_like 'record not found'
+    it_behaves_like 'authentication failed'
+  end
+end
+
+# destroy
+shared_examples 'DELETE record' do |resource_name|
+  delete "Deletes #{resource_name.articleize}" do
+    tags resource_name.pluralize
+    security [ bearer_auth: [] ]
+    parameter name: :id, in: :path, type: :string
+
+    it_behaves_like 'record deleted'
+    it_behaves_like 'record not found'
+    it_behaves_like 'authentication failed'
+  end
+end
+
+shared_examples 'CRUD examples' do |resource_name, include_example, filter_example|
+  resource_path = resource_name.pluralize.parameterize
+
+  path "/api/v2/platform/#{resource_path}" do
+    include_examples 'GET records list', resource_name, include_example, filter_example
+    include_examples 'POST create record', resource_name, include_example
+  end
+
+  path "/api/v2/platform/#{resource_path}/{id}" do
+    include_examples 'GET record', resource_name, include_example
+    include_examples 'PUT update record', resource_name, include_example
+    include_examples 'DELETE record', resource_name
+  end
+end

data/lib/spree/api/testing_support/v2/serializers_params.rb

@@ -0,0 +1,14 @@
+shared_context 'API v2 serializers params' do
+  let(:store) { Spree::Store.default || create(:store, default: true) }
+  let(:currency) { store.default_currency }
+  let(:locale) { store.default_locale }
+
+  let(:serializer_params) do
+    {
+      store: store,
+      currency: currency,
+      user: nil,
+      locale: locale
+    }
+  end
+end

data/spree_api.gemspec

@@ -18,16 +18,19 @@ Gem::Specification.new do |s|
     "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
   }
 
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = '>= 2.5'
 
   s.files         = `git ls-files`.split($\).reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'jsonapi-rspec'
+  s.add_development_dependency 'rswag-specs'
+  s.add_development_dependency 'multi_json'
 
   s.add_dependency 'spree_core', s.version
-  s.add_dependency 'rabl', '~> 0.14.2'
+  s.add_dependency 'rabl', '~> 0.14', '>= 0.14.2'
   s.add_dependency 'jsonapi-serializer', '~> 2.1'
   s.add_dependency 'doorkeeper', '~> 5.2', '>= 5.2.1'
+  s.add_dependency 'responders'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.3.0.rc1
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -24,25 +24,56 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rswag-specs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 4.3.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 4.3.0.rc1
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
   type: :runtime
@@ -50,6 +81,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
 - !ruby/object:Gem::Dependency
@@ -86,6 +120,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Spree's API
 email:
 - ryan@spreecommerce.com
@@ -97,8 +145,7 @@ files:
 - Gemfile
 - LICENSE
 - Rakefile
-- app/assets/javascripts/spree/api/main.js
-- app/assets/javascripts/spree/api/storefront/cart.js
+- app/controllers/concerns/spree/api/v2/product_list_includes.rb
 - app/controllers/concerns/spree/api/v2/storefront/order_concern.rb
 - app/controllers/spree/api/base_controller.rb
 - app/controllers/spree/api/errors_controller.rb
@@ -133,6 +180,19 @@ files:
 - app/controllers/spree/api/v1/variants_controller.rb
 - app/controllers/spree/api/v1/zones_controller.rb
 - app/controllers/spree/api/v2/base_controller.rb
+- app/controllers/spree/api/v2/platform/addresses_controller.rb
+- app/controllers/spree/api/v2/platform/classifications_controller.rb
+- app/controllers/spree/api/v2/platform/cms_pages_controller.rb
+- app/controllers/spree/api/v2/platform/cms_sections_controller.rb
+- app/controllers/spree/api/v2/platform/countries_controller.rb
+- app/controllers/spree/api/v2/platform/menu_items_controller.rb
+- app/controllers/spree/api/v2/platform/menus_controller.rb
+- app/controllers/spree/api/v2/platform/option_types_controller.rb
+- app/controllers/spree/api/v2/platform/option_values_controller.rb
+- app/controllers/spree/api/v2/platform/products_controller.rb
+- app/controllers/spree/api/v2/platform/resource_controller.rb
+- app/controllers/spree/api/v2/platform/taxons_controller.rb
+- app/controllers/spree/api/v2/platform/users_controller.rb
 - app/controllers/spree/api/v2/resource_controller.rb
 - app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
 - app/controllers/spree/api/v2/storefront/account/credit_cards_controller.rb
@@ -140,7 +200,9 @@ files:
 - app/controllers/spree/api/v2/storefront/account_controller.rb
 - app/controllers/spree/api/v2/storefront/cart_controller.rb
 - app/controllers/spree/api/v2/storefront/checkout_controller.rb
+- app/controllers/spree/api/v2/storefront/cms_pages_controller.rb
 - app/controllers/spree/api/v2/storefront/countries_controller.rb
+- app/controllers/spree/api/v2/storefront/menus_controller.rb
 - app/controllers/spree/api/v2/storefront/order_status_controller.rb
 - app/controllers/spree/api/v2/storefront/products_controller.rb
 - app/controllers/spree/api/v2/storefront/stores_controller.rb
@@ -152,14 +214,43 @@ files:
 - app/models/concerns/spree/user_api_methods.rb
 - app/models/spree/api_configuration.rb
 - app/models/spree/api_dependencies.rb
+- app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb
+- app/serializers/spree/api/v2/base_serializer.rb
+- app/serializers/spree/api/v2/platform/address_serializer.rb
+- app/serializers/spree/api/v2/platform/base_serializer.rb
+- app/serializers/spree/api/v2/platform/classification_serializer.rb
+- app/serializers/spree/api/v2/platform/cms_page_serializer.rb
+- app/serializers/spree/api/v2/platform/cms_section_serializer.rb
+- app/serializers/spree/api/v2/platform/country_serializer.rb
+- app/serializers/spree/api/v2/platform/image_serializer.rb
+- app/serializers/spree/api/v2/platform/menu_item_serializer.rb
+- app/serializers/spree/api/v2/platform/menu_serializer.rb
+- app/serializers/spree/api/v2/platform/option_type_serializer.rb
+- app/serializers/spree/api/v2/platform/option_value_serializer.rb
+- app/serializers/spree/api/v2/platform/product_property_serializer.rb
+- app/serializers/spree/api/v2/platform/product_serializer.rb
+- app/serializers/spree/api/v2/platform/state_serializer.rb
+- app/serializers/spree/api/v2/platform/stock_item_serializer.rb
+- app/serializers/spree/api/v2/platform/stock_location_serializer.rb
+- app/serializers/spree/api/v2/platform/store_serializer.rb
+- app/serializers/spree/api/v2/platform/tax_category_serializer.rb
+- app/serializers/spree/api/v2/platform/taxon_image_serializer.rb
+- app/serializers/spree/api/v2/platform/taxon_serializer.rb
+- app/serializers/spree/api/v2/platform/taxonomy_serializer.rb
+- app/serializers/spree/api/v2/platform/user_serializer.rb
+- app/serializers/spree/api/v2/platform/variant_serializer.rb
 - app/serializers/spree/v2/storefront/address_serializer.rb
 - app/serializers/spree/v2/storefront/base_serializer.rb
 - app/serializers/spree/v2/storefront/cart_serializer.rb
+- app/serializers/spree/v2/storefront/cms_page_serializer.rb
+- app/serializers/spree/v2/storefront/cms_section_serializer.rb
 - app/serializers/spree/v2/storefront/country_serializer.rb
 - app/serializers/spree/v2/storefront/credit_card_serializer.rb
 - app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
 - app/serializers/spree/v2/storefront/image_serializer.rb
 - app/serializers/spree/v2/storefront/line_item_serializer.rb
+- app/serializers/spree/v2/storefront/menu_item_serializer.rb
+- app/serializers/spree/v2/storefront/menu_serializer.rb
 - app/serializers/spree/v2/storefront/option_type_serializer.rb
 - app/serializers/spree/v2/storefront/option_value_serializer.rb
 - app/serializers/spree/v2/storefront/payment_method_serializer.rb
@@ -281,6 +372,7 @@ files:
 - app/views/spree/api/v1/zones/show.rabl
 - config/initializers/doorkeeper.rb
 - config/initializers/json_api_mime_types.rb
+- config/initializers/rabl.rb
 - config/initializers/user_class_extensions.rb
 - config/locales/en.yml
 - config/routes.rb
@@ -289,7 +381,9 @@ files:
 - db/migrate/20120530054546_rename_api_key_to_spree_api_key.rb
 - db/migrate/20131017162334_add_index_to_user_spree_api_key.rb
 - db/migrate/20180320110726_create_doorkeeper_tables.rb
+- db/migrate/20210727102516_change_integer_id_columns_type.rb
 - docs/oauth/index.yml
+- docs/v2/platform/index.yaml
 - docs/v2/storefront/index.yaml
 - lib/spree/api.rb
 - lib/spree/api/controller_setup.rb
@@ -301,6 +395,8 @@ files:
 - lib/spree/api/testing_support/setup.rb
 - lib/spree/api/testing_support/v2/base.rb
 - lib/spree/api/testing_support/v2/current_order.rb
+- lib/spree/api/testing_support/v2/platform_contexts.rb
+- lib/spree/api/testing_support/v2/serializers_params.rb
 - lib/spree_api.rb
 - script/rails
 - spec/fixtures/thinking-cat.jpg
@@ -310,9 +406,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.3
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.3.0.rc1
   documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.2.3
+  source_code_uri: https://github.com/spree/spree/tree/v4.3.0.rc1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -321,12 +417,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key: