spree_api 5.3.5 → 5.4.0.beta

data/app/serializers/spree/v2/storefront/taxonomy_serializer.rb

@@ -1,13 +0,0 @@
-module Spree
-  module V2
-    module Storefront
-      class TaxonomySerializer < BaseSerializer
-        include Spree::Api::V2::PublicMetafieldsConcern
-
-        set_type   :taxonomy
-
-        attributes :name, :position, :public_metadata
-      end
-    end
-  end
-end

data/app/serializers/spree/v2/storefront/user_serializer.rb

@@ -1,33 +0,0 @@
-module Spree
-  module V2
-    module Storefront
-      class UserSerializer < BaseSerializer
-        set_type :user
-
-        attributes :email, :first_name, :selected_locale, :last_name, :public_metadata
-
-        attribute :tags, &:tag_list
-
-        attribute :store_credits do |user|
-          user.total_available_store_credit
-        end
-
-        attribute :completed_orders do |object|
-          object.orders.complete.count
-        end
-
-        has_one :default_billing_address,
-                id_method_name: :bill_address_id,
-                object_method_name: :bill_address,
-                record_type: :address,
-                serializer: Spree.api.storefront_address_serializer
-
-        has_one :default_shipping_address,
-                id_method_name: :ship_address_id,
-                object_method_name: :ship_address,
-                record_type: :address,
-                serializer: Spree.api.storefront_address_serializer
-      end
-    end
-  end
-end

data/app/serializers/spree/v2/storefront/variant_serializer.rb

@@ -1,58 +0,0 @@
-module Spree
-  module V2
-    module Storefront
-      class VariantSerializer < BaseSerializer
-        include ::Spree::Api::V2::DisplayMoneyHelper
-        include Spree::Api::V2::PublicMetafieldsConcern
-
-        set_type :variant
-
-        attributes :sku, :barcode, :weight, :height, :width, :depth, :is_master, :options_text, :options, :public_metadata
-
-        attribute :purchasable do |variant|
-          variant.purchasable?
-        end
-
-        attribute :in_stock do |variant|
-          variant.in_stock?
-        end
-
-        attribute :backorderable do |variant|
-          variant.backorderable?
-        end
-
-        attribute :currency do |_product, params|
-          params[:currency]
-        end
-
-        attribute :price do |product, params|
-          price(product, params[:currency], pricing_context_options(params))
-        end
-
-        attribute :display_price do |product, params|
-          display_price(product, params[:currency], pricing_context_options(params))
-        end
-
-        attribute :compare_at_price do |product, params|
-          compare_at_price(product, params[:currency], pricing_context_options(params))
-        end
-
-        attribute :display_compare_at_price do |product, params|
-          display_compare_at_price(product, params[:currency], pricing_context_options(params))
-        end
-
-        def self.pricing_context_options(params)
-          {
-            store: params[:store],
-            user: params[:user],
-            tax_zone: params.dig(:price_options, :tax_zone)
-          }
-        end
-
-        belongs_to :product, serializer: Spree.api.storefront_product_serializer
-        has_many :images, serializer: Spree.api.storefront_image_serializer
-        has_many :option_values, serializer: Spree.api.storefront_option_value_serializer
-      end
-    end
-  end
-end

data/app/serializers/spree/v2/storefront/wished_item_serializer.rb

@@ -1,29 +0,0 @@
-module Spree
-  module V2
-    module Storefront
-      class WishedItemSerializer < BaseSerializer
-        set_type :wished_item
-
-        attributes :quantity
-
-        attribute :price do |wished_item, params|
-          wished_item.price(currency: params[:currency])
-        end
-
-        attribute :total do |wished_item, params|
-          wished_item.total(currency: params[:currency])
-        end
-
-        attribute :display_price do |wished_item, params|
-          wished_item.display_price(currency: params[:currency]).to_s
-        end
-
-        attribute :display_total do |wished_item, params|
-          wished_item.display_total(currency: params[:currency]).to_s
-        end
-
-        belongs_to :variant, serializer: Spree.api.storefront_variant_serializer
-      end
-    end
-  end
-end

data/app/serializers/spree/v2/storefront/wishlist_serializer.rb

@@ -1,17 +0,0 @@
-module Spree
-  module V2
-    module Storefront
-      class WishlistSerializer < BaseSerializer
-        set_type :wishlist
-
-        attributes :token, :name, :is_private, :is_default
-
-        attribute :variant_included do |wishlist, params|
-          wishlist.include?(params[:is_variant_included])
-        end
-
-        has_many :wished_items, serializer: Spree.api.storefront_wished_item_serializer
-      end
-    end
-  end
-end

data/config/initializers/doorkeeper.rb

@@ -1,50 +0,0 @@
-Doorkeeper.configure do
-  orm :active_record
-  use_refresh_token
-  api_only
-  base_controller 'Spree::Api::V2::BaseController'
-  base_metal_controller 'Spree::Api::V2::BaseController'
-
-  # FIXME: we should only skip this for Storefront API until v5
-  # we should not skip this for Platform API
-  skip_client_authentication_for_password_grant { true } if defined?(skip_client_authentication_for_password_grant)
-
-  resource_owner_authenticator { current_spree_user }
-  use_polymorphic_resource_owner
-
-  resource_owner_from_credentials do
-    user = Spree.user_class.find_for_database_authentication(email: params[:username])
-
-    next if user.nil?
-
-    if defined?(Spree::Auth::Config) && Spree::Auth::Config[:confirmable] == true
-      user if user.active_for_authentication? && user.valid_for_authentication? { user.valid_password?(params[:password]) }
-    elsif user&.valid_for_authentication? { user.valid_password?(params[:password]) }
-      user
-    end
-  end
-
-  admin_authenticator do |routes|
-    current_spree_user&.spree_admin?(Spree::Store.current) || redirect_to(routes.root_url)
-  end
-
-  grant_flows %w[password client_credentials]
-
-  allow_blank_redirect_uri true
-
-  handle_auth_errors :raise
-
-  access_token_methods :from_bearer_authorization, :from_access_token_param
-
-  optional_scopes :admin, :write, :read
-
-  access_token_class 'Spree::OauthAccessToken'
-  access_grant_class 'Spree::OauthAccessGrant'
-  application_class 'Spree::OauthApplication'
-
-  # using Bcrupt for token secrets is currently not supported by Doorkeeper
-  hash_token_secrets fallback: :plain
-  hash_application_secrets fallback: :plain, using: '::Doorkeeper::SecretStoring::BCrypt'
-
-  access_token_expires_in 1.month
-end

data/config/initializers/json_api_mime_types.rb

@@ -1,8 +0,0 @@
-api_mime_types = %w(
-  application/vnd.api+json
-  text/x-json
-  application/json
-)
-
-Mime::Type.unregister :json
-Mime::Type.register 'application/json', :json, api_mime_types

data/config/initializers/user_class_extensions.rb

@@ -1,7 +0,0 @@
-# Ensure that Spree.user_class includes the UserApiMethods concern
-
-Spree::Core::Engine.config.to_prepare do
-  if Spree.user_class && !Spree.user_class.included_modules.include?(Spree::UserApiMethods)
-    Spree.user_class.include Spree::UserApiMethods
-  end
-end

data/db/migrate/20100107141738_add_api_key_to_spree_users.rb

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

data/db/migrate/20120411123334_resize_api_key_field.rb

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

data/db/migrate/20120530054546_rename_api_key_to_spree_api_key.rb

@@ -1,7 +0,0 @@
-class RenameApiKeyToSpreeApiKey < ActiveRecord::Migration[4.2]
-  def change
-    unless defined?(User)
-      rename_column :spree_users, :api_key, :spree_api_key
-    end
-  end
-end

data/db/migrate/20131017162334_add_index_to_user_spree_api_key.rb

@@ -1,7 +0,0 @@
-class AddIndexToUserSpreeApiKey < ActiveRecord::Migration[4.2]
-  def change
-    unless defined?(User)
-      add_index :spree_users, :spree_api_key
-    end
-  end
-end

data/db/migrate/20180320110726_create_doorkeeper_tables.rb

@@ -1,69 +0,0 @@
-class CreateDoorkeeperTables < ActiveRecord::Migration[5.1]
-  def change
-    create_table :spree_oauth_applications do |t|
-      t.string  :name,         null: false
-      t.string  :uid,          null: false
-      t.string  :secret,       null: false
-      t.text    :redirect_uri, null: false
-      t.string  :scopes,       null: false, default: ''
-      t.boolean :confidential, null: false, default: true
-      t.timestamps             null: false
-    end
-
-    add_index :spree_oauth_applications, :uid, unique: true
-
-    create_table :spree_oauth_access_grants do |t|
-      t.integer  :resource_owner_id, null: false
-      t.references :application,     null: false
-      t.string   :token,             null: false
-      t.integer  :expires_in,        null: false
-      t.text     :redirect_uri,      null: false
-      t.datetime :created_at,        null: false
-      t.datetime :revoked_at
-      t.string   :scopes
-    end
-
-    add_index :spree_oauth_access_grants, :token, unique: true
-    add_foreign_key(
-      :spree_oauth_access_grants,
-      :spree_oauth_applications,
-      column: :application_id
-    )
-
-    create_table :spree_oauth_access_tokens do |t|
-      t.integer  :resource_owner_id
-      t.references :application
-
-      # If you use a custom token generator you may need to change this column
-      # from string to text, so that it accepts tokens larger than 255
-      # characters. More info on custom token generators in:
-      # https://github.com/doorkeeper-gem/doorkeeper/tree/v3.0.0.rc1#custom-access-token-generator
-      #
-      # t.text     :token,             null: false
-      t.string   :token,                  null: false
-
-      t.string   :refresh_token
-      t.integer  :expires_in
-      t.datetime :revoked_at
-      t.datetime :created_at,             null: false
-      t.string   :scopes
-
-      # If there is a previous_refresh_token column,
-      # refresh tokens will be revoked after a related access token is used.
-      # If there is no previous_refresh_token column,
-      # previous tokens are revoked as soon as a new access token is created.
-      # Comment out this line if you'd rather have refresh tokens
-      # instantly revoked.
-      t.string   :previous_refresh_token, null: false, default: ""
-    end
-
-    add_index :spree_oauth_access_tokens, :token, unique: true
-    add_index :spree_oauth_access_tokens, :resource_owner_id
-    add_index :spree_oauth_access_tokens, :refresh_token, unique: true
-    add_foreign_key(
-      :spree_oauth_access_tokens,
-      :spree_oauth_applications,
-      column: :application_id
-    )
-  end
-end

data/db/migrate/20210727102516_change_integer_id_columns_type.rb

@@ -1,9 +0,0 @@
-class ChangeIntegerIdColumnsType < ActiveRecord::Migration[5.2]
-  def change
-    change_column :spree_oauth_access_grants, :resource_owner_id, :bigint
-    change_column :spree_oauth_access_grants, :application_id, :bigint
-
-    change_column :spree_oauth_access_tokens, :resource_owner_id, :bigint
-    change_column :spree_oauth_access_tokens, :application_id, :bigint
-  end
-end

data/db/migrate/20210919183228_enable_polymorphic_resource_owner.rb

@@ -1,21 +0,0 @@
-class EnablePolymorphicResourceOwner < ActiveRecord::Migration[5.2]
-  def change
-    add_column :spree_oauth_access_tokens, :resource_owner_type, :string
-    add_column :spree_oauth_access_grants, :resource_owner_type, :string
-    change_column_null :spree_oauth_access_grants, :resource_owner_type, false
-
-    add_index :spree_oauth_access_tokens,
-              [:resource_owner_id, :resource_owner_type],
-              name: 'polymorphic_owner_oauth_access_tokens'
-
-    add_index :spree_oauth_access_grants,
-              [:resource_owner_id, :resource_owner_type],
-              name: 'polymorphic_owner_oauth_access_grants'
-
-    Spree::OauthAccessToken.reset_column_information
-    Spree::OauthAccessToken.update_all(resource_owner_type: Spree.user_class)
-
-    Spree::OauthAccessGrant.reset_column_information
-    Spree::OauthAccessGrant.update_all(resource_owner_type: Spree.user_class)
-  end
-end

data/lib/generators/spree/api/install/install_generator.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module Api
-    module Generators
-      class InstallGenerator < Rails::Generators::Base
-        class_option :migrate, type: :boolean, default: true
-
-        def add_migrations
-          run 'bundle exec rake railties:install:migrations FROM=spree_api'
-        end
-
-        def run_migrations
-          run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
-          if run_migrations
-            run 'bin/rails db:migrate'
-          else
-            puts 'Skipping rails db:migrate, don\'t forget to run it!'
-          end
-        end
-      end
-    end
-  end
-end

data/lib/spree/api/testing_support/factories/oauth_application_factory.rb

@@ -1,6 +0,0 @@
-FactoryBot.define do
-  factory :oauth_application, class: Spree::OauthApplication do
-    name { "Admin Panel" }
-    scopes { "admin" }
-  end
-end

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

@@ -1,15 +0,0 @@
-module Spree
-  class TestArgumentsJob < Spree::BaseJob
-    def perform(serializer); end
-  end
-end
-
-shared_examples 'an ActiveJob serializable hash' do
-  it 'can be serialized by ActiveJob' do
-    # It should fail if subject contains any custom instance (e.g Spree::Money)
-    expect { Spree::TestArgumentsJob.perform_later(subject) }.not_to raise_error
-    expect { Spree::TestArgumentsJob.perform_later(subject.merge(price: Spree::Money.new(0))) }.to(
-      raise_error(ActiveJob::SerializationError)
-    )
-  end
-end

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

@@ -1,13 +0,0 @@
-shared_context 'API v2 tokens' do
-  let(:token) { Spree::OauthAccessToken.create!(resource_owner: user, expires_in: nil) }
-  let(:headers_bearer) { { 'Authorization' => "Bearer #{token.token}" } }
-  let(:headers_order_token) { { 'X-Spree-Order-Token' => order.token } }
-end
-
-[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)
-    end
-  end
-end

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

@@ -1,116 +0,0 @@
-def ensure_order_totals
-  order.update_with_updater!
-end
-
-shared_context 'creates order with line item' do
-  let!(:line_item) { create(:line_item, order: order, currency: currency) }
-  let!(:headers)   { headers_bearer }
-
-  before do
-    order.reload
-    ensure_order_totals
-  end
-end
-
-shared_context 'order with a physical line item' do
-  include_context 'creates order with line item'
-end
-
-shared_context 'order with a digital line item' do
-  let(:digital_shipping_method) { create(:digital_shipping_method) }
-  let(:digital_product) { create(:product, shipping_category: digital_shipping_method.shipping_categories.first) }
-  let(:variant_digital) { create(:variant, product: digital_product) }
-  let!(:digital) { create(:digital, variant: variant_digital) }
-  let!(:line_item) { create(:line_item, variant: variant_digital, order: order, currency: currency) }
-  let!(:headers) { headers_bearer }
-
-  before do
-    order.reload
-    ensure_order_totals
-  end
-end
-
-shared_context 'order with a physical and digital line item' do
-  let(:digital_shipping_method) { create(:digital_shipping_method) }
-  let(:product_digital) { create(:product, shipping_category: digital_shipping_method.shipping_categories.first) }
-  let(:variant_digital) { create(:variant, product: product_digital) }
-  let!(:digital) { create(:digital, variant: variant_digital) }
-  let!(:digital_line_item) { create(:line_item, variant: variant_digital, order: order, currency: currency) }
-  let!(:physical_line_item) { create(:line_item, order: order, currency: currency) }
-
-  let!(:headers) { headers_bearer }
-
-  before do
-    order.reload
-    ensure_order_totals
-  end
-end
-
-shared_context 'creates guest order with guest token' do
-  let(:guest_token) { 'guest_token' }
-  let!(:order)      { create(:order, token: guest_token, store: store, currency: currency) }
-  let!(:line_item)  { create(:line_item, order: order, currency: currency) }
-  let!(:headers)    { headers_order_token }
-
-  before { ensure_order_totals }
-end
-
-shared_examples 'returns valid cart JSON' do
-  it 'returns a valid cart JSON response' do
-    order.reload
-    expect(json_response['data']).to be_present
-    expect(json_response['data']).to have_id(order.id.to_s)
-    expect(json_response['data']).to have_type('cart')
-    expect(json_response['data']).to have_attribute(:number).with_value(order.number)
-    expect(json_response['data']).to have_attribute(:state).with_value(order.state)
-    expect(json_response['data']).to have_attribute(:payment_state).with_value(order.payment_state)
-    expect(json_response['data']).to have_attribute(:shipment_state).with_value(order.shipment_state)
-    expect(json_response['data']).to have_attribute(:token).with_value(order.token)
-    expect(json_response['data']).to have_attribute(:total).with_value(order.total.to_s)
-    expect(json_response['data']).to have_attribute(:item_total).with_value(order.item_total.to_s)
-    expect(json_response['data']).to have_attribute(:ship_total).with_value(order.ship_total.to_s)
-    expect(json_response['data']).to have_attribute(:adjustment_total).with_value(order.adjustment_total.to_s)
-    expect(json_response['data']).to have_attribute(:included_tax_total).with_value(order.included_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:additional_tax_total).with_value(order.additional_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_additional_tax_total).with_value(order.display_additional_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_included_tax_total).with_value(order.display_included_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:tax_total).with_value(order.tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:currency).with_value(order.currency.to_s)
-    expect(json_response['data']).to have_attribute(:email).with_value(order.email)
-    expect(json_response['data']).to have_attribute(:display_item_total).with_value(order.display_item_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_ship_total).with_value(order.display_ship_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_adjustment_total).with_value(order.display_adjustment_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_tax_total).with_value(order.display_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:item_count).with_value(order.item_count)
-    expect(json_response['data']).to have_attribute(:special_instructions).with_value(order.special_instructions)
-    expect(json_response['data']).to have_attribute(:promo_total).with_value(order.promo_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_promo_total).with_value(order.display_promo_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_total).with_value(order.display_total.to_s)
-    expect(json_response['data']).to have_attribute(:pre_tax_item_amount).with_value(order.pre_tax_item_amount.to_s)
-    expect(json_response['data']).to have_attribute(:display_pre_tax_item_amount).with_value(order.display_pre_tax_item_amount.to_s)
-    expect(json_response['data']).to have_attribute(:pre_tax_total).with_value(order.pre_tax_total.to_s)
-    expect(json_response['data']).to have_attribute(:display_pre_tax_total).with_value(order.display_pre_tax_total.to_s)
-    expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments,
-                                                        :promotions)
-  end
-end
-
-shared_examples 'no current order' do
-  context "order doesn't exist" do
-    before do
-      order.destroy
-      execute
-    end
-
-    it_behaves_like 'returns 404 HTTP status'
-  end
-
-  context 'already completed order' do
-    before do
-      order.update_column(:completed_at, Time.current)
-      execute
-    end
-
-    it_behaves_like 'returns 404 HTTP status'
-  end
-end