freight_kit 0.1.15 → 0.1.16

data/lib/freight_kit/carriers/cnwy.rb

@@ -0,0 +1,327 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class CNWY < Carrier
+    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(8, :feet)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+
+      def required_credential_types
+        %i[api api_key]
+      end
+
+      def requirements
+        %i[credentials]
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'XPO Logistics'
+    @scac = 'CNWY'
+
+    # Documents
+
+    # Pickups
+
+    # 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_headers
+      {
+        accept: 'application/json',
+        authorization: "Bearer #{bearer_token}",
+        'Content-Type': 'application/json'
+      }
+    end
+
+    def bearer_token
+      @bearer_token ||= commit(build_bearer_token_request)[:access_token]
+    end
+
+    def build_bearer_token_request
+      api_credentials = fetch_credential(:api)
+
+      body = URI.encode_www_form(
+        grant_type: 'password',
+        password: api_credentials.password,
+        username: api_credentials.username,
+      )
+
+      {
+        body:,
+        headers: {
+                   authorization: "Basic #{api_credentials.api_key}",
+                   content_type: 'application/x-www-form-urlencoded'
+                 },
+        method: :post,
+        url: build_url(:token)
+      }
+    end
+
+    def build_url(action)
+      scheme = @conf.dig(:api, :use_ssl) ? 'https://' : 'http://'
+      "#{scheme}#{@conf.dig(:api, :domain)}#{@conf.dig(:api, :endpoints, action)}"
+    end
+
+    def commit(request)
+      url = request[:url]
+      headers = request[:headers] || build_headers
+      method = request[:method]
+      body = request[:body]
+
+      response = case method
+                 when :post
+                   HTTParty.post(url, headers:, body:, debug_output: $stdout)
+                 else
+                   HTTParty.get(url, headers:, debug_output: $stdout)
+                 end
+
+      begin
+        json = JSON.parse(response.body).deep_symbolize_keys
+      rescue JSON::ParserError => e
+        # CNWY returns a string during runtime/server error
+        raise FreightKit::ResponseError, 'Runtime Error' if response.body.include?('Runtime Error')
+
+        raise e
+      end
+
+      error = if json.is_a?(Hash)
+                json[:error_description] || json.dig(:fault, :description) || json.dig(:error, :message)
+              end
+
+      if error.blank?
+        return json if (200..299).include?(response.code)
+      else
+        case response.code
+        when 401
+          raise FreightKit::InvalidCredentialsError
+        end
+      end
+
+      raise FreightKit::ResponseError, error
+    end
+
+    def request_url(action)
+      scheme = @conf.dig(:api, :use_ssl, action) ? 'https://' : 'http://'
+      "#{scheme}#{@conf.dig(:api, :domains, action)}#{@conf.dig(:api, :endpoints, action)}"
+    end
+
+    # Documents
+
+    # Rates
+
+    def build_accessorials(shipment:)
+      serviceable_accessorials?(shipment.accessorials)
+
+      accessorial_codes = []
+      accessorial_codes << 'SSC'
+      accessorial_codes << 'ZHM' if shipment.hazmat?
+
+      if shipment.destination.province.upcase == 'HI'
+        accessorial_codes = accessorial_codes.map { |code| ['DID', 'OIP'].include?(code) ? 'WHN' : code }.uniq
+      end
+
+      longest_dimension_in = shipment.packages.map { |p| [p.width(:inch), p.length(:inch)].max }.max.ceil
+
+      # Switch to accessorials rather than accessorial_codes since now we need more complex structures
+
+      accessorials = accessorial_codes.map { |accessorial_code| { accessorial_cd: accessorial_code, quantity: 0 } }
+
+      return accessorials if longest_dimension_in < 96 && shipment.accessorials.blank?
+
+      if longest_dimension_in >= 96
+        accessorials << {
+                          accessorial_cd: 'ELS',
+                          quantity_uom: 'INCH',
+                          quantity: longest_dimension_in
+                        }
+      end
+
+      return accessorials if shipment.accessorials.blank?
+
+      shipment.accessorials.map do |accessorial|
+        next if @conf.dig(:accessorials, :unquotable)&.include?(accessorial)
+
+        accessorials << { accessorial_cd: @conf.dig(:accessorials, :mappable, accessorial), quantity: 0 }
+      end
+
+      accessorials
+    end
+
+    def parse_amount(amount)
+      (amount.to_f * 100).to_i
+    end
+
+    def build_commodity(shipment:)
+      shipment.packages.map do |package|
+        {
+          dimensions: {
+                        dimensions_uom: 'INCH',
+                        height: package.inches(:height).ceil,
+                        length: package.inches(:length).ceil,
+                        width: package.inches(:width).ceil
+                      },
+          gross_weight: {
+                          weight: package.pounds(:total).ceil,
+                          weight_uom: 'LBS'
+                        },
+          hazmat_ind: package.hazmat?,
+          nmfc_class: package.freight_class.to_s,
+          nmfc_item_cd: package.nmfc,
+          piece_cnt: package.quantity
+        }
+      end
+    end
+
+    def build_rate_request(shipment:)
+      api_credentials = fetch_credential(:api)
+      shipment_date = shipment.pickup_at.date_time_with_zone.iso8601
+
+      accessorials = build_accessorials(shipment:)
+      commodity = build_commodity(shipment:)
+
+      body = {
+               shipmentInfo: {
+                               accessorials:,
+                               bill_2_party: { acct_inst_id: api_credentials.account },
+                               commodity:,
+                               consignee: { address: { postal_cd: shipment.destination.postal_code.to_s } },
+                               pallet_cnt: shipment.packages.map(&:packaging).map(&:pallet?).count(true),
+                               payment_term_cd: 'P', # prepaid,
+                               shipment_date:,
+                               shipper: { address: { postal_cd: shipment.origin.postal_code.to_s } }
+                             }
+             }.deep_transform_keys! { |key| key.to_s.camelize(:lower) }.to_json
+
+      request = {
+                  body:,
+                  headers: build_headers,
+                  method: :post,
+                  url: build_url(:rates)
+                }
+
+      save_request(request)
+      request
+    end
+
+    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.dig(:data, :rateQuote, :totCharge, 0, :amt).blank?
+        rate_response.error = ResponseError.new('Cost is empty')
+        return rate_response
+      end
+
+      accessorials = response.dig(:data, :rateQuote, :shipmentInfo, :accessorials)
+      commodities = response.dig(:data, :rateQuote, :shipmentInfo, :commodity)
+      deficit_weight = response.dig(:data, :rateQuote, :deficitRatingInfo)
+
+      prices = []
+
+      prices << FreightKit::Price.new(
+        blame: :api,
+        cents: parse_amount(
+          commodities.sum { |c| c.dig(:charge, :chargeAmt, :amt) },
+        ),
+        description: 'Freight',
+      )
+
+      if deficit_weight.present?
+        prices << FreightKit::Price.new(
+          blame: :api,
+          cents: parse_amount(deficit_weight.dig(:deficitAmt, :amt)),
+          description: <<~DESC.squish,
+            Deficit weight
+            #{deficit_weight.dig(:deficitWght, :weight).ceil}
+            #{deficit_weight.dig(:deficitWght, :weightUom).downcase}
+          DESC
+        )
+      end
+
+      prices << FreightKit::Price.new(
+        blame: :api,
+        cents: parse_amount(response.dig(:data, :rateQuote, :totDiscountAmt, :amt)) * -1,
+        description: "Discount #{response.dig(:data, :rateQuote, :actlDiscountPct)}%",
+      )
+
+      prices += accessorials.map do |accessorial|
+        FreightKit::Price.new(
+          blame: :api,
+          cents: parse_amount(accessorial.dig(:chargeAmt, :amt)),
+          description: accessorial[:accessorialDesc].squish.capitalize.gsub('Xpo', 'XPO'),
+        )
+      end
+
+      comment = response.dig(:data, :rateQuote, :shipmentInfo, :comment)
+      days = if comment.blank?
+               nil
+             else
+               comment.match(/\d+ days/)&.to_s&.split(' days')&.first&.to_i
+             end
+
+      expires_at = if days.is_a?(Integer) && days.positive?
+                     days.days.from_now
+                   else
+                     2.days.from_now
+                   end
+
+      estimate_reference = response.dig(:data, :rateQuote, :confirmationNbr)
+      transit_days = response.dig(:data, :transitTime, :transitDays)
+
+      rate = Rate.new(
+        carrier: self,
+        carrier_name: self.class.name,
+        currency: 'USD',
+        estimate_reference:,
+        expires_at:,
+        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/ctbv.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class CTBV < CarrierLogistics
+    class << self
+      def maximum_height
+        Measured::Length.new(105, :inches)
+      end
+
+      def maximum_weight
+        Measured::Weight.new(6999, :pounds)
+      end
+
+      def minimum_length_for_overlength_fees
+        Measured::Length.new(8, :feet)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'The Custom Companies'
+    @scac = 'CTBV'
+
+    # Documents
+
+    # Rates
+    def build_calculated_accessorials(shipment)
+      [].tap do |builder|
+        longest_dimension = shipment.packages.map { |package| [package.length(:in), package.width(:in)].max }.max.ceil
+
+        case longest_dimension
+        when (96..143) then builder << 'OL1'
+        when (144..) then builder << 'OL'
+        end
+      end
+    end
+
+    # Tracking
+
+    # protected
+
+    # Documents
+
+    # Rates
+  end
+end

data/lib/freight_kit/carriers/dcha.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class DCHA < 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(12, :feet)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'Mountain Valley Express'
+    @scac = 'DCHA'
+
+    # Documents
+
+    # Rates
+    def build_calculated_accessorials(shipment)
+      [].tap do |builder|
+        builder << 'HAZM' if shipment.packages.any?(&:hazmat?)
+
+        if shipment.accessorials.present? && %i[
+                                               residential_delivery
+                                               residential_pickup
+                                             ].intersect?(shipment.accessorials)
+          builder << 'RES'
+        end
+
+        longest_dimension = shipment.packages.map { |package| [package.length(:in), package.width(:in)].max }.max.ceil
+
+        case longest_dimension
+        when (144..155) then builder << 'XL12'
+        when (156..167) then builder << 'XL13'
+        when (168..179) then builder << 'XL14'
+        when (180..191) then builder << 'XL15'
+        when (192..203) then builder << 'XL16'
+        when (204..215) then builder << 'XL17'
+        when (216..227) then builder << 'XL18'
+        when (228..239) then builder << 'XL19'
+        when (240..251) then builder << 'XL20'
+        when (252..483) then builder << 'XL21'
+        when (484..275) then builder << 'XL22'
+        when (276..287) then builder << 'XL23'
+        when (288..299) then builder << 'XL24'
+        when (300..311) then builder << 'XL25'
+        when (312..323) then builder << 'XL26'
+        when (324..) then builder << 'XL27'
+        end
+      end
+    end
+
+    # Tracking
+
+    # protected
+
+    # Documents
+
+    # Rates
+  end
+end

data/lib/freight_kit/carriers/dlds.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class DLDS < 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(8, :feet)
+      end
+
+      def overlength_fees_require_tariff?
+        false
+      end
+    end
+
+    REACTIVE_FREIGHT_CARRIER = true
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'Diamond Line Delivery'
+    @scac = 'DLDS'
+
+    # Documents
+
+    # Rates
+    def build_calculated_accessorials(shipment)
+      [].tap do |builder|
+        builder << 'SS'
+        builder << 'HAZ' if shipment.packages.any?(&:hazmat?)
+      end
+    end
+
+    # Tracking
+
+    # protected
+
+    # Documents
+
+    # Rates
+  end
+end