atkhayar-spree-dev-api 0.0.0

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

@@ -0,0 +1,29 @@
+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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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
+      end
+    end
+  end
+end

data/app/services/spree/api/error_handler.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    class ErrorHandler
+      prepend ::Spree::ServiceModule::Base
+
+      def call(exception:, opts: {})
+        run :format_message
+        run :log_error
+        run :report_error
+      end
+
+      protected
+
+      def format_message(exception:, opts:)
+        message = if exception.respond_to?(:original_message)
+                    exception.original_message
+                  else
+                    exception.message
+                  end
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def log_error(exception:, message:, opts:)
+        Rails.logger.error message
+        Rails.logger.error "User ID: #{opts[:user]&.id}" if opts[:user]
+        Rails.logger.error exception.backtrace.join("\n")
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def report_error(exception:, message:, opts:)
+        # overwrite this method in your application to support different error handlers
+        # eg. Sentry, Rollbar, etc
+
+        success(exception: exception, message: message)
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/handle_request.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class HandleRequest
+        def initialize(event_name:, subscriber:, webhook_payload_body:)
+          @event_name = event_name
+          @subscriber = subscriber
+          @webhook_payload_body = JSON.parse(webhook_payload_body)
+        end
+
+        def call
+          Rails.logger.debug(msg("sending to '#{url}'"))
+          Rails.logger.debug(msg("webhook_payload_body: #{body_with_event_metadata}"))
+
+          if request.unprocessable_uri?
+            return process(:warn, msg("can not make a request to '#{url}'"))
+          end
+          return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
+
+          process(:debug, msg("success for URL '#{url}'"))
+        end
+
+        private
+
+        attr_reader :webhook_payload_body, :event_name, :subscriber
+
+        delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?, to: :request
+        delegate :id, :url, to: :subscriber
+        delegate :created_at, :id, to: :event, prefix: true
+
+        def process(log_level, msg)
+          Rails.logger.public_send(log_level, msg)
+          make_request
+          update_event(msg)
+          nil
+        end
+
+        def request
+          @request ||=
+            Spree::Webhooks::Subscribers::MakeRequest.new(webhook_payload_body: body_with_event_metadata, url: url)
+        end
+        alias make_request request
+
+        def body_with_event_metadata
+          webhook_payload_body.
+            merge(event_created_at: event_created_at, event_id: event_id, event_type: event.name).
+            to_json
+        end
+
+        def event
+          @event ||= Spree::Webhooks::Event.create!(
+            name: event_name, subscriber_id: subscriber.id, url: url
+          )
+        end
+
+        def update_event(msg)
+          event.update(
+            execution_time: execution_time,
+            request_errors: msg,
+            response_code: response_code,
+            success: success?
+          )
+        end
+
+        def msg(msg)
+          "[SPREE WEBHOOKS] '#{event_name}' #{msg}"
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/make_request.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class MakeRequest
+        def initialize(url:, webhook_payload_body:)
+          @execution_time_in_milliseconds = 0
+          @url = url
+          @webhook_payload_body = webhook_payload_body
+          @webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
+        end
+
+        def execution_time
+          request
+          @execution_time_in_milliseconds
+        end
+
+        def failed_request?
+          (200...300).exclude?(response_code)
+        end
+
+        def response_code
+          request.code.to_i
+        end
+
+        def success?
+          !unprocessable_uri? && !failed_request?
+        end
+
+        def unprocessable_uri?
+          uri_path == '' && uri_host.nil? && uri_port.nil?
+        end
+
+        private
+
+        attr_reader :execution_time_in_milliseconds, :url, :webhook_payload_body, :webhooks_timeout
+
+        HEADERS = { 'Content-Type' => 'application/json' }.freeze
+        private_constant :HEADERS
+
+        delegate :host, :path, :port, to: :uri, prefix: true
+
+        def http
+          http = Net::HTTP.new(uri_host, uri_port)
+          http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
+          http.use_ssl = true if use_ssl?
+          http
+        end
+
+        def request
+          req = Net::HTTP::Post.new(uri_path, HEADERS)
+          req.body = webhook_payload_body
+          @request ||= begin
+            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            request_result = http.request(req)
+            @execution_time_in_milliseconds = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).in_milliseconds
+            request_result
+          end
+        rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
+          Class.new do
+            def self.code
+              '0'
+            end
+          end
+        end
+
+        def custom_read_timeout?
+          webhooks_timeout.present?
+        end
+
+        def use_ssl?
+          !(Rails.env.development? || Rails.env.test?)
+        end
+
+        def uri
+          URI(url)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/queue_requests.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Webhooks
+    module Subscribers
+      class QueueRequests
+        prepend Spree::ServiceModule::Base
+
+        def call(event_name:, webhook_payload_body:, **options)
+          filtered_subscribers(event_name, webhook_payload_body, options).each do |subscriber|
+            Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
+              webhook_payload_body, event_name, subscriber
+            )
+          end
+        end
+
+        private
+
+        def filtered_subscribers(event_name, _, _)
+          Spree::Webhooks::Subscriber.active.with_urls_for(event_name)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Webhooks
+    def self.disable_webhooks
+      webhooks_disabled_previously = ENV['DISABLE_SPREE_WEBHOOKS']
+      begin
+        ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+        yield
+      ensure
+        ENV['DISABLE_SPREE_WEBHOOKS'] = webhooks_disabled_previously
+      end
+    end
+  end
+end

data/config/i18n-tasks.yml

@@ -0,0 +1,40 @@
+base_locale: en
+data:
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+# Find translate calls
+search:
+  paths:
+    - '../api/app'
+    - '../api/lib'
+
+#### For API v1 only, START ####
+  exclude:
+    - '../api/app/controllers/spree/api/v1/*'
+    - '../api/app/views/*'
+
+ignore_unused:
+  - 'spree.api.gateway_error'
+  - 'spree.api.invalid_api_key'
+  - 'spree.api.invalid_resource'
+  - 'spree.api.invalid_taxonomy_id'
+  - 'spree.api.must_specify_api_key'
+  - 'spree.api.negative_quantity'
+  - 'spree.api.order.could_not_transition'
+  - 'spree.api.order.insufficient_quantity'
+  - 'spree.api.order.invalid_shipping_method'
+  - 'spree.api.payment.credit_over_limit'
+  - 'spree.api.payment.update_forbidden'
+  - 'spree.api.shipment.cannot_ready'
+  - 'spree.api.shipment_transfer_errors_occurred'
+  - 'spree.api.shipment_transfer_success'
+  - 'spree.api.stock_location_required'
+  - 'spree.api.unauthorized'
+  - 'spree.api.wrong_shipment_target'
+#### For API v1 only, END ####
+
+# The PatternMapper for Spree.t
+<% I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper', patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>

data/config/initializers/doorkeeper.rb

@@ -0,0 +1,48 @@
+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? || 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'
+end

data/config/initializers/json_api_mime_types.rb

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,7 @@
+# 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/config/locales/en.yml

@@ -0,0 +1,38 @@
+---
+en:
+  spree:
+    api:
+      gateway_error: 'There was a problem with the payment gateway: %{text}'
+      invalid_api_key: Invalid API key (%{key}) specified.
+      invalid_resource: Invalid resource. Please fix errors and try again.
+      invalid_taxonomy_id: Invalid taxonomy id.
+      must_specify_api_key: You must specify an API key.
+      negative_quantity: quantity is negative
+      order:
+        could_not_transition: The order could not be transitioned. Please fix the errors and try again.
+        insufficient_quantity: An item in your cart has become unavailable.
+        invalid_shipping_method: Invalid shipping method specified.
+      payment:
+        credit_over_limit: This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number.
+        update_forbidden: This payment cannot be updated because it is %{state}.
+      resource_not_found: The resource you were looking for could not be found.
+      shipment:
+        cannot_ready: Cannot ready shipment.
+      shipment_transfer_errors_occurred: 'Following errors occurred while attempting this action:'
+      shipment_transfer_success: Variants successfully transferred
+      stock_location_required: A stock_location_id parameter must be provided in order to retrieve stock movements.
+      unauthorized: You are not authorized to perform that action.
+      v2:
+        cart:
+          no_coupon_code: No coupon code provided and the Order doesn't have any coupon code promotions applied
+          wrong_quantity: Quantity has to be greater than 0
+        digitals:
+          missing_file: 'Missing Digital Item: attachment'
+          unauthorized: Error, you are not authorized to access this asset
+        metadata:
+          invalid_params: Public and private metadata parameters should be objects
+        wishlist:
+          errors:
+            the_wishlist_could_not_be_destroyed: The wishlist could not be destroyed.
+          wrong_quantity: Quantity has to be greater than 0
+      wrong_shipment_target: target shipment is the same as original shipment

data/config/routes.rb

@@ -0,0 +1,214 @@
+spree_path = Rails.application.routes.url_helpers.try(:spree_path, trailing_slash: true) || '/'
+
+Rails.application.routes.draw do
+  use_doorkeeper scope: "#{spree_path}/spree_oauth"
+end
+
+Spree::Core::Engine.add_routes do
+  namespace :api, defaults: { format: 'json' } do
+    namespace :v2 do
+      namespace :storefront do
+        resource :cart, controller: :cart, only: %i[show create destroy] do
+          post   :add_item
+          patch  :empty
+          delete 'remove_line_item/:line_item_id', to: 'cart#remove_line_item', as: :cart_remove_line_item
+          patch  :set_quantity
+          patch  :apply_coupon_code
+          delete 'remove_coupon_code/:coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code
+          delete 'remove_coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code_without_code
+          get :estimate_shipping_rates
+          patch :associate
+          patch :change_currency
+        end
+
+        resource :checkout, controller: :checkout, only: %i[update] do
+          patch :next
+          patch :advance
+          patch :complete
+          post :create_payment
+          post :add_store_credit
+          post :remove_store_credit
+          get :payment_methods
+          get :shipping_rates
+          patch :select_shipping_method
+        end
+
+        resource :account, controller: :account, only: %i[show create update]
+
+        namespace :account do
+          resources :addresses, controller: :addresses
+          resources :credit_cards, controller: :credit_cards, only: %i[index show destroy]
+          resources :orders, controller: :orders, only: %i[index show]
+        end
+
+        resources :countries, only: %i[index]
+        get '/countries/:iso', to: 'countries#show', as: :country
+        get '/order_status/:number', to: 'order_status#show', as: :order_status
+        resources :products, only: %i[index show]
+        resources :taxons,   only: %i[index show], id: /.+/
+        get '/stores/:code', to: 'stores#show', as: :store
+        get '/store', to: 'stores#current', as: :current_store
+
+        resources :menus, only: %i[index show]
+        resources :cms_pages, only: %i[index show]
+
+        resources :wishlists do
+          get :default, on: :collection
+
+          member do
+            post :add_item
+            patch 'set_item_quantity/:item_id', to: 'wishlists#set_item_quantity', as: :set_item_quantity
+            delete 'remove_item/:item_id', to: 'wishlists#remove_item', as: :remove_item
+          end
+        end
+
+        get '/digitals/:token', to: 'digitals#download', as: 'digital'
+      end
+
+      namespace :platform do
+        # Promotions API
+        resources :promotions
+        resources :promotion_actions
+        resources :promotion_categories
+        resources :promotion_rules
+
+        # Returns API
+        resources :customer_returns
+        resources :reimbursements
+        resources :return_authorizations do
+          member do
+            patch :add
+            patch :cancel
+            patch :receive
+          end
+        end
+
+        # Product Catalog API
+        resources :products
+        resources :taxonomies
+        resources :taxons do
+          member do
+            patch :reposition
+          end
+        end
+        resources :classifications
+        resources :images
+        resources :variants
+        resources :properties
+        resources :product_properties
+        resources :option_types
+        resources :option_values
+
+        # Order API
+        resources :orders do
+          member do
+            patch :next
+            patch :advance
+            patch :approve
+            patch :cancel
+            patch :empty
+            patch :apply_coupon_code
+            patch :complete
+            patch :use_store_credit
+            patch :cancel
+            patch :approve
+          end
+        end
+        resources :line_items
+        resources :adjustments
+
+        # Payments API
+        resources :payments do
+          # TODO: support custom actions
+          # member do
+          #   patch :authorize
+          #   patch :capture
+          #   patch :purchase
+          #   patch :void
+          #   patch :credit
+          # end
+        end
+
+        # Store Credit API
+        resources :store_credits
+        resources :store_credit_categories
+        resources :store_credit_types
+
+        # Geo API
+        resources :zones
+        resources :countries, only: [:index, :show]
+        resources :states, only: [:index, :show]
+
+        # Shipment API
+        resources :shipments do
+          member do
+            %w[ready ship cancel resume pend].each do |state|
+              patch state.to_sym
+            end
+            patch :add_item
+            patch :remove_item
+            patch :transfer_to_location
+            patch :transfer_to_shipment
+          end
+        end
+
+        # Tax API
+        resources :tax_rates
+        resources :tax_categories
+
+        # Inventory API
+        resources :inventory_units
+        resources :stock_items
+        resources :stock_locations
+        resources :stock_movements
+
+        # User API
+        resources :users
+        resources :credit_cards
+        resources :addresses
+
+        resources :roles
+
+        # Menu API
+        resources :menus
+        resources :menu_items do
+          member do
+            patch :reposition
+          end
+        end
+
+        # CMS
+        resources :cms_pages
+        resources :cms_sections
+
+        # Wishlists API
+        resources :wishlists
+        resources :wished_items
+
+        # Digitals API
+        resources :digitals
+        resources :digital_links do
+          member do
+            patch :reset
+          end
+        end
+
+        # Store API
+        resources :stores
+
+        # Configurations API
+        resources :payment_methods
+        resources :shipping_categories
+        resources :shipping_methods
+
+        # Webhooks API
+        namespace :webhooks do
+          resources :events, only: :index
+          resources :subscribers
+        end
+
+        post "/firebase", to: "firebase#firebase_login"
+      end
+    end
+  end
+end

data/db/migrate/20100107141738_add_api_key_to_spree_users.rb

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,7 @@
+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

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