go_puff-tax_service 1.5.0

data/lib/go_puff/tax_service/actions/commit.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    module Actions
+      class Commit < GoPuff::TaxService::Tax
+        def call
+          return empty_products_response if products.empty?
+
+          super
+        end
+
+        private
+
+        def body_params
+          @body_params ||= {
+            locationId:      order.location_id,
+            userId:          user_identifier,
+            orderId:         order.id_obfuscated.to_s,
+            deliveryAddress: delivery_address,
+            products:        products
+          }
+        end
+
+        def serialize_purchase(purchase)
+          super(purchase).merge(isAlcohol: purchase.decorate.kind == 'alcohol')
+        end
+
+        def fees_line_items
+          super.each { |fee| fee[:isAlcohol] = (fee[:productId] == ALCOHOL_FEE_ID) }
+        end
+
+        def endpoint
+          '/api/taxes/commit'
+        end
+
+        def empty_products_response
+          Response::Commit.empty_response(error: 'Requested tax for empty products')
+        end
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/actions/get.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    module Actions
+      class Get < GoPuff::TaxService::Tax
+        def initialize(order, address: nil, purchases: nil, fees_kind: 'all')
+          super(order, address: address)
+
+          @purchases = purchases
+          @fees_kind = fees_kind
+        end
+
+        def call
+          return empty_products_response if products.empty?
+          return empty_address_response if delivery_address_empty?
+
+          super
+        end
+
+        private
+
+        def purchases_to_tax
+          return super unless @purchases
+
+          @purchases_to_tax ||= @purchases
+        end
+
+        def body_params
+          @body_params ||= {
+            products:        products,
+            locationId:      order.location_id,
+            deliveryAddress: delivery_address
+          }
+        end
+
+        def endpoint
+          '/api/taxes'
+        end
+
+        def empty_products_response
+          Response::Get.empty_response(error: 'Requested tax for empty products')
+        end
+
+        def empty_address_response
+          Response::Get.empty_response(error: 'Requested tax for empty address')
+        end
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/configuration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    class Configuration
+      attr_writer :base_url, :user_agent_header
+      attr_accessor :authentication, :logger, :requests
+
+      def initialize
+        @base_url = nil
+
+        @authentication = Struct.new(:token_provider, :on_unauthorized).new
+
+        @requests = Struct.new(
+          :max_retries,
+          :retry_wait_time,
+          :retryable_exceptions
+        ).new(3, 0.5, [EOFError, Errno::ECONNRESET])
+
+        @logger = ::Rails.logger if defined?(::Rails) && ::Rails&.logger
+      end
+
+      def user_agent_header
+        return @user_agent_header if @user_agent_header.present?
+
+        raise "Missing configuration 'user_agent_header' for TaxService gem"
+      end
+
+      def base_url
+        return @base_url if @base_url.present?
+
+        raise "Missing configuration 'base_url' for TaxService gem"
+      end
+
+      def token_provider
+        return @authentication.token_provider if @authentication.token_provider.is_a?(Proc)
+
+        raise "Missing configuration 'authentication.token_provider' for TaxService gem"
+      end
+
+      def on_unauthorized
+        return -> {} unless @authentication.on_unauthorized.is_a?(Proc)
+
+        @authentication.on_unauthorized
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/errors.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    module Errors
+      class Base < StandardError; end
+
+      class FeesKindInvalid < Base
+        def initialize(kind)
+          super("Invalid fees_kind attribute: #{kind}")
+        end
+      end
+
+      class Unauthorized < Base
+        def initialize(token = nil)
+          super("Authentication failed with token: #{token}")
+        end
+      end
+
+      class RequestFailed < Base
+        def initialize(error, attempts)
+          super("Request to tax service failed after #{attempts} attempts. Error: #{error&.class} #{error&.message}")
+        end
+      end
+
+      class ValidationFailed < Base
+        def initialize(response, params)
+          @response = response
+          @params = params
+
+          super(error_message)
+        end
+
+        def error_message
+          errors = extract_messages_from_error_response(@response)
+
+          "Tax service request failed: #{errors}. Sent params: #{@params}"
+        end
+
+        def extract_messages_from_error_response(error_hash)
+          return '' unless error_hash.is_a?(Hash)
+
+          messages = []
+
+          error_hash.each do |key, value|
+            if key.to_sym == :message
+              messages << value
+            elsif value.is_a?(Hash)
+              messages << extract_messages_from_error_response(value)
+            end
+          end
+
+          messages.flatten.join('; ')
+        end
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/response/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    module Response
+      class Base
+        def initialize(raw_response)
+          @raw_response = raw_response
+        end
+
+        def self.empty_response(**options)
+          new({ success: false, error: nil, data: {}, **options })
+        end
+
+        def [](key)
+          return data[key] unless data.is_a?(Hash)
+
+          data[possible_key_for(key)]
+        end
+
+        def success?
+          @raw_response[:success]
+        end
+
+        def error?
+          error.present?
+        end
+
+        def error
+          @raw_response[:error]
+        end
+
+        def data
+          @raw_response[:data]
+        end
+
+        private
+
+        def possible_key_for(key)
+          [key.to_sym, key.to_s.camelize(:lower).to_sym].find do |possible_key|
+            data&.key?(possible_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/response/cancel.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'go_puff/tax_service/response/base'
+
+module GoPuff
+  module TaxService
+    module Response
+      class Cancel < Base; end
+    end
+  end
+end

data/lib/go_puff/tax_service/response/commit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'go_puff/tax_service/response/get'
+
+module GoPuff
+  module TaxService
+    module Response
+      class Commit < Get; end
+    end
+  end
+end

data/lib/go_puff/tax_service/response/get.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'go_puff/tax_service/response/base'
+
+module GoPuff
+  module TaxService
+    module Response
+      class Get < Base
+        attr_reader :products_taxes
+
+        def initialize(*args)
+          super
+
+          parse_attributes!
+        end
+
+        def tax_for_product(product_id)
+          @products_taxes[product_id] || @products_taxes[product_id.to_s]
+        end
+
+        %w[totalTaxCollected taxToAddToTotal taxBreakdown].each do |attribute|
+          define_method(attribute.underscore.to_sym) { data[attribute.to_sym] }
+        end
+
+        private
+
+        def parse_attributes!
+          parse_products_taxes!
+        end
+
+        def parse_products_taxes!
+          return unless data.try(:[], :products).is_a?(Array)
+
+          @products_taxes = data[:products].each_with_object({}) do |product, products_hash|
+            products_hash[product[:productId]] = product[:taxAmount]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/tax.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'retryable'
+
+require 'go_puff/tax_service/errors'
+require 'go_puff/tax_service/response/get'
+require 'go_puff/tax_service/response/commit'
+require 'go_puff/tax_service/response/cancel'
+
+module GoPuff
+  module TaxService
+    class Tax
+      TIMEOUT = 5
+      FEES_KINDS = %w[all non_alcohol alcohol none].freeze
+      ALCOHOL_FEE_ID = 'ALCOHOL_FEE'
+
+      attr_reader :order
+
+      def initialize(order, address: nil)
+        @order = order
+        @address = address
+        @fees_kind = 'all'
+      end
+
+      def call
+        raise Errors::FeesKindInvalid, @fees_kind unless FEES_KINDS.include?(@fees_kind)
+
+        request_tax_service
+
+        return create_response_object(@response.body) if @response.success?
+
+        order.tax_service_validation_failed = true
+
+        response_for_error
+      end
+
+      private
+
+      def configuration
+        GoPuff::TaxService.configuration
+      end
+
+      def endpoint
+        raise NotImplementedError
+      end
+
+      def body_params
+        raise NotImplementedError
+      end
+
+      def request_tax_service
+        url = "#{configuration.base_url}#{endpoint}"
+
+        Retryable.retryable(**retryable_config) do
+          @response = GoPuff::Http::Client.new(url, timeout: TIMEOUT).post(headers: headers, params: body_params)
+        end
+      rescue *configuration.requests.retryable_exceptions => e
+        raise Errors::RequestFailed.new(e, retryable_config[:tries])
+      end
+
+      def retryable_config
+        {
+          on:    configuration.requests.retryable_exceptions,
+          tries: configuration.requests.max_retries,
+          sleep: configuration.requests.retry_wait_time
+        }
+      end
+
+      def headers
+        {
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{configuration.token_provider.call}"
+        }
+      end
+
+      def empty_response
+        { success: false, error: nil, data: {} }
+      end
+
+      def response_class_name
+        "GoPuff::TaxService::Response::#{self.class.name.demodulize}"
+      end
+
+      def create_response_object(response)
+        response_class_name.constantize.new(response)
+      rescue NameError
+        response
+      end
+
+      def response_for_error
+        case @response.status.to_i
+        when 401
+          configuration.on_unauthorized.call
+
+          raise Errors::Unauthorized
+        when 400
+          raise Errors::ValidationFailed.new(@response.body, body_params)
+        else
+          create_response_object(empty_response)
+        end
+      end
+
+      def serialize_purchase(purchase)
+        {
+          productId:        purchase.product_id,
+          quantity:         purchase.amount,
+          price:            purchase.price.to_f,
+          priceIncludesTax: price_includes_tax?
+        }
+      end
+
+      def purchases_to_tax
+        @purchases_to_tax ||= order.purchases
+      end
+
+      def products
+        @products ||= purchases_to_tax.map { |purchase| serialize_purchase(purchase) } + fees_line_items
+      end
+
+      def alcohol_fees
+        {
+          ALCOHOL_FEE_ID => order.alcohol_fee.to_f
+        }
+      end
+
+      def non_alcohol_fees
+        {
+          'DELIVERY_FEE' => order.delivery.to_f,
+          'SERVICE_FEE' => order.service_fee.to_f,
+          'SMALL_ORDER_FEE' => order.small_order_fee.to_f,
+          'PRIORITY_FEE' => order.priority_fee.to_f
+        }
+      end
+
+      def fees_line_items
+        case @fees_kind
+        when 'all'
+          non_alcohol_fees.merge(alcohol_fees)
+        when 'non_alcohol'
+          non_alcohol_fees
+        when 'alcohol'
+          alcohol_fees
+        else
+          {}
+        end.map do |key, value|
+          next unless value.positive?
+
+          {
+            productId:        key,
+            quantity:         1,
+            price:            value,
+            priceIncludesTax: price_includes_tax?
+          }
+        end.compact
+      end
+
+      def price_includes_tax?
+        !['us', :us].include?(order.country_code)
+      end
+
+      def delivery_zone_address
+        @delivery_zone_address ||= order&.delivery_zone&.delivery_zone_address
+      end
+
+      def delivery_address
+        return {} unless @address
+
+        get_address_for(@address, fallback: delivery_zone_address)
+      end
+
+      def delivery_address_empty?
+        delivery_address[:line1].blank?
+      end
+
+      def warehouse_address
+        return {} unless delivery_zone_address
+
+        get_address_for(delivery_zone_address, fallback: @address)
+      end
+
+      def get_address_for(resource, fallback:)
+        {
+          line1:      resource.address.presence || fallback&.address,
+          city:       resource.city.presence || fallback&.city,
+          state:      resource.state.presence || fallback&.state,
+          country:    order.country_code&.upcase,
+          postalCode: resource.zip.presence || fallback&.zip
+        }.compact
+      end
+
+      def user_identifier
+        return 'backoffice' if order.third_party?
+        return 'external' unless order.gopuff?
+
+        (order&.user&.gim_id.presence || order&.user_id).to_s
+      end
+    end
+  end
+end

data/lib/go_puff/tax_service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    VERSION = '1.5.0'
+  end
+end

data/lib/go_puff/tax_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/inflector'
+require 'active_support/core_ext/object'
+
+require 'go_puff/tax_service/tax'
+require 'go_puff/tax_service/errors'
+require 'go_puff/tax_service/configuration'
+
+require 'go_puff/tax_service/actions/get'
+require 'go_puff/tax_service/actions/commit'
+require 'go_puff/tax_service/actions/cancel'
+
+require 'go_puff/http/client'
+
+module GoPuff
+  module TaxService
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+
+      yield configuration if block_given?
+
+      GoPuff::Http.config.logger = configuration.logger
+      GoPuff::Http.config.user_agent_header = configuration.user_agent_header
+      GoPuff::Http.config.adapter = :net_http_persistent
+    end
+  end
+end