freight_kit 0.1.15 → 0.1.16

data/lib/freight_kit/carriers/sefl.rb

@@ -0,0 +1,342 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class SEFL < FreightKit::Carrier
+    class << self
+      def find_rates_with_declared_value?
+        true
+      end
+
+      def maximum_height
+        Measured::Length.new(105, :inches)
+      end
+
+      def maximum_weight
+        Measured::Weight.new(10_000, :pounds)
+      end
+
+      def minimum_length_for_overlength_fees
+        Measured::Length.new(8, :feet)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+
+      def required_credential_types
+        %i[api]
+      end
+
+      def requirements
+        %i[credentials]
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'Southeastern Freight Lines'
+    @scac = 'SEFL'
+
+    JSON_HEADERS = {
+                     Accept: 'application/json',
+                     charset: 'utf-8',
+                     'Content-Type' => 'application/x-www-form-urlencoded'
+                   }.freeze
+
+    # Documents
+
+    # Rates
+    def find_rates(shipment:)
+      begin
+        validate_packages(shipment.packages)
+      rescue UnserviceableError => e
+        return RateResponse.new(error: e)
+      end
+
+      request = build_rate_request(shipment:)
+      parse_rate_response(shipment:, response: commit(request))
+    end
+
+    # Tracking
+
+    protected
+
+    def build_url(action)
+      "#{base_url}#{@conf.dig(:api, :endpoints, action)}"
+    end
+
+    def base_url
+      "https://#{@conf.dig(:api, :domain)}"
+    end
+
+    def auth_header
+      api_credentials = fetch_credential(:api)
+      auth = Base64.strict_encode64("#{api_credentials.username}:#{api_credentials.password}")
+
+      { Authorization: "Basic #{auth}" }
+    end
+
+    def build_request(action, options = {})
+      headers = JSON_HEADERS
+      headers = headers.merge(auth_header)
+      headers = headers.merge(options[:headers]) if options[:headers].present?
+      body = URI.encode_www_form(options[:body]) if options[:body].present?
+
+      request = {
+                  url: options[:url].presence || build_url(action),
+                  headers:,
+                  method: @conf.dig(:api, :methods, action),
+                  body:
+                }
+
+      save_request(request)
+      request
+    end
+
+    def commit(request)
+      url = request[:url]
+      headers = request[:headers]
+      method = request[:method]
+      body = request[:body]
+
+      case method
+      when :post
+        HTTParty.post(url, headers:, body:)
+      else
+        HTTParty.get(url, headers:)
+      end
+    end
+
+    # Documents
+
+    # Rates
+    def build_rate_request(shipment:)
+      accessorials = []
+
+      if shipment.accessorials.any?
+        serviceable_accessorials?(shipment.accessorials)
+
+        shipment
+        .accessorials
+        .reject { |accessorial| conf.dig(:accessorials, :unquotable).include?(accessorial) }
+        .each do |shipment_accessorial|
+          conf_accessorial = conf.dig(:accessorials, :mappable, shipment_accessorial)
+
+          case conf_accessorial
+          when Array then accessorials += conf_accessorial
+          when String then accessorials << conf_accessorial
+          end
+        end
+      end
+
+      longest_dimension = shipment.packages.map { |p| [p.width(:inches), p.length(:inches)].max }.max.ceil
+      accessorials << 'chkOD' if longest_dimension >= 96
+
+      accessorials.uniq!
+
+      pickup_on = Date.current
+      shipment_description = shipment.packages.map(&:description).reject(&:blank?).uniq.join(', ')
+      shipment_description = 'Freight All Kinds' if shipment_description.blank?
+
+      api_credentials = fetch_credential(:api)
+
+      body = {
+               allowSpot: longest_dimension >= 120 ? 'Y' : 'N',
+               CustomerAccount: api_credentials.account.to_i.to_s.rjust(9, '0'),
+               CustomerCity: customer_location.city,
+               CustomerName: customer_location.contact.company_name,
+               CustomerState: customer_location.province,
+               CustomerStreet: customer_location.address1,
+               CustomerZip: customer_location.postal_code,
+               Description: shipment_description,
+               DestCountry: 'U',
+               DestinationCity: shipment.destination.city,
+               DestinationState: shipment.destination.province,
+               DestinationZip: shipment.destination.postal_code,
+               DimsOption: 'I',
+               EmailAddress: customer_location.contact.email,
+               Option: 'T',
+               OrigCountry: 'U',
+               OriginCity: shipment.origin.city,
+               OriginState: shipment.origin.province,
+               OriginZip: shipment.origin.postal_code,
+               PickupDay: pickup_on.strftime('%_d'),
+               PickupMonth: pickup_on.strftime('%_m'),
+               PickupYear: pickup_on.strftime('%Y'),
+               rateXML: 'Y',
+               returnX: 'Y',
+               Terms: 'P'
+             }
+
+      declared_value = if shipment.declared_value_cents.blank?
+                         0
+                       else
+                         (shipment.declared_value_cents.to_f / 100).ceil
+                       end
+
+      if declared_value.positive?
+        body.deep_merge!({
+                           chkIN: 'on',
+                           FVInsuranceAmount: format('%.2f', declared_value)
+                         })
+      end
+      body.deep_merge!({ ODLength: longest_dimension, ODLengthUnit: 'I' }) if longest_dimension >= 96
+
+      cubic_ft_required = shipment.destination.province.upcase == 'PR'
+
+      i = 0
+      shipment.packages.each do |package|
+        package.quantity.times do
+          i += 1
+
+          body = body.deep_merge({ "Class#{i}": package.freight_class.to_s.sub('.', '').to_i })
+          body = body.deep_merge({ "Description#{i}": package.description || 'Freight' })
+          body = body.deep_merge({ "PieceLength#{i}": package.length(:in).ceil })
+          body = body.deep_merge({ "PieceWidth#{i}": package.width(:in).ceil })
+          body = body.deep_merge({ "PieceHeight#{i}": package.height(:in).ceil })
+          body = body.deep_merge({ "Weight#{i}": package.pounds(:each).ceil })
+
+          body = body.deep_merge({ "CubicFt#{i}": package.cubic_ft(:each) }) if cubic_ft_required
+        end
+      end
+
+      if accessorials.any?
+        body[:accessorial] = 'on'
+
+        accessorials.each { |accessorial| body[accessorial] = 'on' }
+      end
+
+      request = build_request(:rates, body:)
+      save_request(request)
+      request
+    end
+
+    def parse_rate_response(shipment:, response:, tries: 0)
+      rate_response = RateResponse.new(request: last_request, response:)
+
+      # Used begin rescue block's retry instead.
+      # if tries > 10
+      #   rate_response.error = ResponseError.new("Timeout after #{tries * 5} seconds")
+      #   return rate_response
+      # end
+
+      if response.body.blank?
+        rate_response.error = InvalidCredentialsError if response.code == 401
+
+        rate_response.error = ResponseError.new('Unknown response') if rate_response.error.blank?
+        return rate_response
+      end
+
+      begin
+        response = JSON.parse(response.body)
+      rescue JSON::ParserError
+        sleep(5)
+        if tries > 10
+          rate_response.error = ResponseError.new("Timeout after #{tries * 5} seconds")
+          return rate_response
+        end
+
+        tries += 1
+        retry
+      end
+
+      error = response['errorMessage']
+
+      if error.present?
+        if error.include?('one point must be directly serviced')
+          rate_response.error = UnserviceableError.new(error.sub(' by SEFL.', ''))
+        end
+
+        rate_response.error = ResponseError.new(error) if rate_response.error.blank?
+        return rate_response
+      end
+
+      url = response['detailQuoteLocation'].gsub('\\', '')
+      request = build_request(:get_rate, url:)
+
+      tries = 0
+
+      until tries > 10
+        save_request(request)
+        response = commit(request)
+
+        if response.body.blank?
+          rate_response.error = InvalidCredentialsError if response.code == 401
+
+          rate_response.error = ResponseError.new('Unknown response') if rate_response.error.blank?
+          return rate_response
+        end
+
+        response = JSON.parse(response.body)
+
+        if response.blank?
+          rate_response.error = ResponseError.new('Unknown response')
+          return rate_response
+        end
+
+        error = response['errorMessage']
+
+        if error.present?
+          if error.downcase.include?('not yet been processed')
+            sleep(5)
+            tries += 1
+            next
+          else
+            rate_response.error = ResponseError.new(error)
+            return rate_response
+          end
+        end
+
+        tries = 50
+      end
+
+      if response['rateQuote'].blank?
+        rate_response.error = ResponseError.new('Cost is empty')
+        return rate_response
+      end
+
+      estimate_reference = response['quoteNumber']
+      transit_days = response['transitTime'].to_i
+
+      details = response['details']
+      prices = []
+
+      # return details
+
+      details.each do |detail|
+        next if detail['typeCharge'].include?('TTL') || detail['typeCharge'].include?('NFC')
+
+        cents = detail['charges'].squish
+        cents = cents.blank? ? 0 : (cents.to_f * 100).to_i
+        next if cents.zero?
+
+        description = detail['description'].squish
+
+        cents *= -1 if detail['description'].include?('DISCOUNT')
+
+        prices << Price.new(blame: :api, cents:, description:)
+      end
+
+      rate = Rate.new(
+        carrier: self,
+        carrier_name: self.class.name,
+        currency: 'USD',
+        estimate_reference:,
+        scac: self.class.scac.upcase,
+        service_name: :standard,
+        shipment:,
+        prices:,
+        transit_days:,
+        with_excessive_length_fees: @conf.dig(:attributes, :rates, :with_excessive_length_fees),
+      )
+
+      rate_response.rates = [rate]
+      rate_response
+    end
+
+    # Tracking
+  end
+end

data/lib/freight_kit/carriers/totl.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class TOTL < CarrierLogistics
+    class << self
+      def maximum_height
+        Measured::Length.new(105, :inches)
+      end
+
+      def maximum_weight
+        Measured::Weight.new(10_000, :pounds)
+      end
+
+      def minimum_length_for_overlength_fees
+        Measured::Length.new(40, :inches)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+
+      def pickup_number_is_tracking_number?
+        true
+      end
+
+      def required_credential_types
+        %i[api]
+      end
+
+      def requirements
+        %i[credentials]
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'Total Transportation'
+    @scac = 'TOTL'
+
+    # Documents
+
+    # Pickups
+
+    # Rates
+
+    # Tracking
+
+    # protected
+
+    # Documents
+
+    # Rates
+
+    def parse_rate_response(shipment:, response:)
+      rate_response = RateResponse.new(request: last_request, response:)
+
+      if response.blank?
+        rate_response.error = ResponseError.new('Unknown response')
+        return rate_response
+      end
+
+      if response.is_a?(String) && response.include?('WebSpeed error')
+        rate_response.error = ResponseError.new('API Error: Temporary error (CarrierLogistics WebSpeed error)')
+        return rate_response
+      end
+
+      error = response.dig('error', 'errormessage')
+
+      if error.present?
+        if error.downcase.include?('invalid username/password')
+          rate_response.error = InvalidCredentialsError.new
+          return rate_response
+        end
+
+        if error.downcase.include?('is not available') || error.downcase.include?('out of the serviceable area')
+          rate_response.error = UnserviceableError.new
+          return rate_response
+        end
+
+        rate_response.error = ResponseError.new("API Error: #{error}")
+        return rate_response
+      end
+
+      if response.dig('ratequote', 'quotetotal').blank?
+        rate_response.error = ResponseError.new('Cost is blank')
+        return rate_response
+      end
+
+      total_cents = parse_amount(response.dig('ratequote', 'quotetotal'))
+
+      transit_days = response.dig('ratequote', 'busdays').to_i
+      estimate_reference = response.dig('ratequote', 'quotenumber')
+
+      ratequote_lines = response.dig('ratequote', 'ratequoteline')
+
+      prices = []
+      ratequote_lines.each do |ratequote_line|
+        next if ratequote_line['chrg'].blank?
+        next if ratequote_line['chargedesc'] == 'FREIGHT'
+
+        cents = parse_amount(ratequote_line['chrg'])
+        next if cents.zero?
+
+        prices << Price.new(
+          blame: :api,
+          cents:,
+          description: ratequote_line_description(ratequote_line),
+        )
+      end
+
+      prices = [
+                 Price.new(
+                   blame: :api,
+                   cents: total_cents - prices.sum(&:cents),
+                   description: 'Freight',
+                 ),
+               ] + prices
+
+      # Carrier-specific pricing structure
+      oversized_pallets_cents = 0
+
+      shipment.packages.each do |package|
+        short_side, long_side = nil
+        if package.length(:in).present? && package.width(:in).present? && package.height(:in).present?
+          long_side = [package.length(:in), package.width(:in)].max
+          short_side = [package.length(:in), package.width(:in)].min
+        end
+
+        next unless short_side &&
+                    long_side &&
+                    package.height(:in) &&
+                    (
+                      short_side > 40 ||
+                      long_side > 48 ||
+                      package.height(:in) > 84
+                    )
+
+        oversized_pallets_cents += 1500
+      end
+
+      if oversized_pallets_cents.nonzero?
+        prices << Price.new(
+          blame: :library,
+          cents: oversized_pallets_cents,
+          description: 'Overlength fees',
+        )
+      end
+
+      RateResponse.new(
+        rates: [
+                 Rate.new(
+                   carrier: self,
+                   carrier_name: self.class.name,
+                   currency: 'USD',
+                   estimate_reference:,
+                   scac: self.class.scac.upcase,
+                   service_name: :standard,
+                   shipment:,
+                   prices:,
+                   transit_days:,
+                   with_excessive_length_fees: @conf.dig(:attributes, :rates, :with_excessive_length_fees),
+                 ),
+               ],
+        request: last_request,
+        response:,
+      )
+    end
+  end
+end