freight_kit 0.1.20 → 0.1.22

data/lib/freight_kit/carriers/mtvl.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module FreightKit
-  class MTVL < TheGreatInformationFactory
-    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
-    end
-
-    REACTIVE_FREIGHT_CARRIER = true
-
-    class << self
-      attr_reader :name, :scac
-    end
-    @name = 'GLS Freight'
-    @scac = 'MTVL'
-
-    def build_soap_header
-      soap_header = super
-      soap_header[:password] = soap_header[:password]&.downcase
-
-      soap_header
-    end
-  end
-end

data/lib/freight_kit/carriers/numk.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module FreightKit
-  class NUMK < TheGreatInformationFactory
-    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(4, :ft)
-      end
-
-      def overlength_fees_require_tariff?
-        false
-      end
-
-      def requirements
-        %i[credentials]
-      end
-    end
-
-    include FreightKit::Documentable
-
-    REACTIVE_FREIGHT_CARRIER = true
-
-    class << self
-      attr_reader :name, :scac
-    end
-    @name = 'Numark Transportation'
-    @scac = 'NUMK'
-
-    def build_calculated_accessorials(packages)
-      longest_dimension = packages.map { |package| [package.length(:in), package.width(:in)].max }.max.ceil
-
-      return ['OVER'] if longest_dimension > 48
-
-      []
-    end
-
-    def build_soap_header
-      soap_header = super
-      soap_header[:password] = soap_header[:password]&.downcase
-
-      soap_header
-    end
-
-    protected
-
-    def wrap_request(request)
-      { 'args0' => request }
-    end
-  end
-end

data/lib/freight_kit/carriers/otcl.rb

@@ -1,520 +0,0 @@
-# frozen_string_literal: true
-
-module FreightKit
-  class OTCL < 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(150, :pounds)
-      end
-
-      def minimum_length_for_overlength_fees
-        Measured::Length.new(6, :feet)
-      end
-
-      def overlength_fees_require_tariff?
-        false
-      end
-
-      def pickup_number_is_tracking_number?
-        true
-      end
-
-      def required_credential_types
-        %i[api_key]
-      end
-
-      def requirements
-        %i[credentials]
-      end
-    end
-
-    REACTIVE_FREIGHT_CARRIER = true
-
-    class << self
-      attr_reader :name, :scac
-    end
-    @name = 'OnTrac'
-    @scac = 'OTCL'
-
-    XML_HEADERS = {
-                    Accept: 'application/xml',
-                    charset: 'utf-8',
-                    'Content-Type': 'application/xml'
-                  }.freeze
-
-    # Override Carrier#serviceable_accessorials? since we have separate delivery/pickup accessorials
-    def serviceable_accessorials?(accessorials)
-      return true if accessorials.blank?
-
-      if !self.class::REACTIVE_FREIGHT_CARRIER ||
-         !@conf.dig(:accessorials, :mappable) ||
-         !@conf.dig(:accessorials, :unquotable) ||
-         !@conf.dig(:accessorials, :unserviceable)
-        raise NotImplementedError, "#{self.class.name}: #serviceable_accessorials? not supported"
-      end
-
-      serviceable_accessorials = @conf.dig(:accessorials, :mappable).keys +
-                                 @conf.dig(:accessorials, :unquotable)
-      serviceable_count = (serviceable_accessorials & accessorials).size
-
-      unserviceable_accessorials = @conf.dig(:accessorials, :unserviceable)
-      unserviceable_count = (unserviceable_accessorials & accessorials).size
-
-      if serviceable_count != accessorials.size || !unserviceable_count.zero?
-        raise FreightKit::UnserviceableError, "#{self.class.name}: Some accessorials unserviceable"
-      end
-
-      true
-    end
-
-    # Documents
-
-    # Pickups
-
-    def create_pickup(
-      delivery_from:,
-      delivery_to:,
-      dispatcher:,
-      pickup_from:,
-      pickup_to:,
-      scac:,
-      service:,
-      shipment:
-    )
-      request = build_shipment_request(
-        delivery_from:,
-        delivery_to:,
-        dispatcher:,
-        pickup_from:,
-        pickup_to:,
-        scac:,
-        service:,
-        shipment:,
-      )
-
-      labels = parse_shipment_response(commit(request))
-
-      request = build_pickup_request(
-        delivery_from:,
-        delivery_to:,
-        dispatcher:,
-        pickup_from:,
-        pickup_to:,
-        scac:,
-        service:,
-        shipment:,
-      )
-
-      parse_pickup_response(response: commit(request), labels:)
-    end
-
-    # 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, options = {})
-      api_credentials = fetch_credential(:api_key)
-
-      env = @test_mode ? :test : :production
-
-      url = "https://#{@conf.dig(:api, :domain)}#{@conf.dig(:api, :endpoints, env, action)}"
-      url = url.gsub('%ACCOUNT_NUMBER%', api_credentials.account)
-
-      url += "?pw=#{api_credentials.api_key}"
-      url << "&#{options[:params]}" if options[:params].present?
-
-      url
-    end
-
-    def build_request(action, options = {})
-      request = {
-                  url: build_url(action, options),
-                  headers: XML_HEADERS,
-                  method: @conf.dig(:api, :methods, action)
-                }
-
-      save_request(request)
-      request
-    end
-
-    def commit(request)
-      body = request[:body]
-      headers = request[:headers]
-      method = request[:method]
-      url = request[:url]
-
-      response = case method
-                 when :post
-                   HTTPClient.post(url, headers:, body:)
-                 else
-                   HTTPClient.get(url, headers:)
-                 end
-
-      response.parsed_response if response&.parsed_response
-    end
-
-    def serviceable_states?(states)
-      valid_states = ['AZ', 'CA', 'CO', 'ID', 'NV', 'OR', 'UT', 'WA']
-
-      invalid_states = []
-      states.each do |state|
-        invalid_states << state if valid_states.exclude?(state)
-      end
-
-      return true if invalid_states.blank?
-
-      raise FreightKit::UnserviceableError, "No service to #{invalid_states.join(", ")}"
-    end
-
-    # Documents
-
-    # Pickups
-
-    def build_pickup_request(
-      delivery_from:,
-      delivery_to:,
-      dispatcher:,
-      pickup_from:,
-      pickup_to:,
-      scac:,
-      service:,
-      shipment:
-    )
-      dispatcher_phone = dispatcher.phone.sub('+1', '').delete('^0-9')
-
-      raise UnserviceableError, 'Palletized freight unsupported' unless shipment.loose?
-
-      request_body = {
-                       Address: shipment.origin.address1,
-                       City: shipment.origin.city,
-                       CloseAt: pickup_to.strftime('%H:%M:00'),
-                       Contact: shipment.origin.contact.name || 'Shipping',
-                       Date: pickup_from.to_date,
-                       DelZip: shipment.destination.postal_code,
-                       Instructions: '',
-                       Name: shipment.origin.contact.company_name,
-                       Phone: dispatcher_phone,
-                       ReadyAt: pickup_from.strftime('%H:%M:00'),
-                       State: shipment.origin.province,
-                       Zip: shipment.origin.postal_code
-                     }.freeze
-
-      request = {
-                  headers: XML_HEADERS,
-                  method: @conf.dig(:api, :methods, :pickups),
-                  url: build_url(:pickups),
-                  body: request_body.to_xml(root: 'OnTracPickupRequest', skip_types: true)
-                }
-
-      save_request(request)
-      request
-    end
-
-    def build_shipment_request(
-      delivery_from:,
-      delivery_to:,
-      dispatcher:,
-      pickup_from:,
-      pickup_to:,
-      scac:,
-      service:,
-      shipment:
-    )
-      dispatcher_phone = dispatcher.phone.sub('+1', '').delete('^0-9')
-      receiver_phone = shipment.destination.contact.phone.sub('+1', '').delete('^0-9')
-
-      declared_value = if shipment.declared_value_cents.blank?
-                         '0'
-                       else
-                         format('%.2f', (shipment.declared_value_cents.to_f / 100).ceil)
-                       end
-
-      raise UnserviceableError, 'Palletized freight unsupported' unless shipment.loose?
-
-      base_api_shipment = {
-                            consignee: {
-                                         Name: shipment.destination.contact.company_name,
-                                         Addr1: shipment.destination.address1,
-                                         Addr2: '',
-                                         Addr3: '',
-                                         City: shipment.destination.city,
-                                         Contact: shipment.destination.contact.name || 'Shipping',
-                                         Phone: receiver_phone || '',
-                                         State: shipment.destination.province,
-                                         Zip: shipment.destination.postal_code.to_s
-                                       },
-                            shipper: {
-                                       Name: shipment.origin.contact.company_name,
-                                       Addr1: shipment.origin.address1,
-                                       City: shipment.origin.city,
-                                       State: shipment.origin.province,
-                                       Zip: shipment.origin.postal_code,
-                                       Contact: shipment.origin.contact.name || 'Shipping',
-                                       Phone: dispatcher_phone
-                                     },
-                            BillTo: '0',
-                            CargoType: '0',
-                            COD: '0',
-                            CODType: 'NONE',
-                            Declared: declared_value,
-                            DelEmail: dispatcher.email,
-                            Instructions: '',
-                            LabelType: '1', # PDF label
-                            Reference: shipment.order_number,
-                            Reference2: shipment.po_number,
-                            Reference3: '',
-                            Residential: shipment.accessorials.include?(:residential_delivery) ? 'true' : 'false',
-                            SaturdayDel: 'false',
-                            Service: 'C',
-                            ShipDate: pickup_from.to_date.to_s,
-                            ShipEmail: dispatcher.email,
-                            SignatureRequired: 'true',
-                            Tracking: ''
-                          }.freeze
-
-      api_shipments = []
-
-      shipment.packages.each do |package|
-        package.quantity.times do
-          api_shipments << base_api_shipment.merge(
-            {
-              DIM: {
-                     Length: package.length(:inches).ceil,
-                     Width: package.width(:inches).ceil,
-                     Height: package.height(:inches).ceil
-                   },
-              UID: SecureRandom.uuid,
-              Weight: package.pounds(:each).ceil
-            },
-          )
-        end
-      end
-
-      request = {
-                  headers: XML_HEADERS,
-                  method: @conf.dig(:api, :methods, :shipments),
-                  url: build_url(:shipments),
-                  body: {
-                          Shipments: api_shipments
-                        }.to_xml(root: 'OnTracShipmentRequest', skip_types: true)
-                }
-
-      save_request(request)
-      request
-    end
-
-    def parse_pickup_response(response:, labels:)
-      pickup_response = PickupResponse.new(request: last_request, response:)
-
-      if response.blank?
-        pickup_response.error = FreightKit::ResponseError.new('API Error: Blank response')
-        return pickup_response
-      end
-
-      error = response.dig('OnTracPickupResponse', 'Error')
-
-      if error.present?
-        pickup_response.error = FreightKit::ResponseError.new(error.capitalize)
-        return pickup_response
-      end
-
-      pickup_number = response.dig('OnTracPickupResponse', 'Tracking')
-
-      if pickup_number.blank?
-        pickup_response.error = FreightKit::ResponseError.new('Blank pickup number')
-        return pickup_response
-      end
-
-      pickup_response.pickup_number = pickup_number
-      pickup_response
-    end
-
-    def parse_shipment_response(response)
-      raise FreightKit::ResponseError, 'API Error: Blank response' if response.blank?
-
-      error = response.dig('OnTracShipmentResponse', 'Shipments', 'Error')
-
-      if error.blank? && response.dig('OnTracShipmentResponse', 'Shipments', 'Shipment').is_a?(Hash)
-        error = response.dig('OnTracShipmentResponse', 'Shipments', 'Shipment', 'Error')
-      end
-
-      if error.present?
-        error = error.capitalize
-
-        raise FreightKit::InvalidCredentialsError, error if error.downcase.include?('invalid username')
-
-        raise FreightKit::UnserviceableError, error if error.downcase.include?('no valid service')
-
-        raise FreightKit::UnserviceableError, error if error.downcase.include?('not serviced')
-
-        raise FreightKit::ResponseError, "API Error: #{error}"
-      end
-
-      api_shipments = response.dig('OnTracShipmentResponse', 'Shipments', 'Shipment')
-      api_shipments = [api_shipments] unless api_shipments.is_a?(Array)
-
-      base64_labels = api_shipments&.map { |s| s['Label'] }
-      raise FreightKit::ResponseError, 'API Error: Blank label' if base64_labels.blank?
-
-      base64_labels.map { |base64_label| Label.new(data: base64_label) }
-    end
-
-    # Rates
-
-    def build_rate_request(shipment:)
-      serviceable_accessorials?(shipment.accessorials)
-      serviceable_states?([shipment.origin.province, shipment.destination.province])
-
-      # API supports non-loose items (see below) but per OnTrac it shouldn't be quoted. We'll raise an error here but
-      # leave the support baked-in below anyway.
-      raise FreightKit::UnserviceableError, 'Palletized freight unsupported' unless shipment.loose?
-
-      dim_weights_too_heavy = shipment.packages.map(&:dim_weight).select { |w| w > self.class.maximum_weight.value }
-
-      if dim_weights_too_heavy.any?
-        message = <<~MESSAGE.squish
-          Dimensional weight(s) of #{dim_weights_too_heavy.map(&:round).join("lbs, ")} lbs more than maximum of
-          #{self.class.maximum_weight.value.round} lbs
-        MESSAGE
-        raise FreightKit::UnserviceableError, message
-      end
-
-      params = ''.dup
-      params << 'packages='
-
-      total_weight = shipment.packages.map { |p| p.pounds(:total) }.sum
-
-      i = 1
-      package_param_parts = []
-
-      shipment.packages.each do |package|
-        package.quantity.times do
-          declared_value = if shipment.declared_value_cents.blank?
-                             0
-                           else
-                             shipment.declared_value_cents.to_f * (package.pounds(:each) / total_weight)
-                           end
-
-          declared_value = declared_value.to_s
-
-          parts = []
-
-          parts << "ID#{i}"
-          parts << shipment.origin.postal_code
-          parts << shipment.destination.postal_code
-          parts << shipment.accessorials.include?(:residential_delivery).to_s
-          parts << '0'
-          parts << 'false' # Staurday delivery
-          parts << declared_value
-          parts << package.pounds(:each).ceil
-          parts << "#{package.inches(:length).ceil}X#{package.inches(:width).ceil}X#{package.inches(:height).ceil}"
-          parts << 'C'
-          parts << '0' # not a letter
-          parts << '0' # always 0 per documentation
-
-          package_param_parts << parts.join(';')
-        end
-      end
-
-      params << package_param_parts.join(',')
-
-      build_request(:rates, { params: })
-    end
-
-    def parse_rate_response(shipment:, response:)
-      rate_response = RateResponse.new(request: last_request, response:)
-
-      if response.blank?
-        rate_response.error = ResponseError.new('Blank response')
-        return rate_response
-      end
-
-      error = response.dig('OnTracRateResponse', 'Shipments', 'Shipment', 'Error') ||
-              response.dig('OnTracRateResponse', 'Shipments', 'Error') ||
-              response.dig('OnTracRateResponse', 'Error')
-
-      if error.blank? && response.dig('OnTracRateResponse', 'Shipments', 'Shipment').is_a?(Hash)
-        error = response.dig('OnTracRateResponse', 'Shipments', 'Shipment', 'Rates', 'Rate', 'Error')
-      end
-
-      if error.present?
-        case error.downcase
-        when ->(value) { value.include?('not serviced') }
-          rate_response.error = UnserviceableError.new(error)
-          return rate_response
-        when ->(value) { value.include?('invalid username') }
-          rate_response.error = InvalidCredentialsError.new(error)
-          return rate_response
-        when ->(value) { value.include?('no valid service') }
-          rate_response.error = UnserviceableError.new(error)
-          return rate_response
-        end
-
-        rate_response.error = ResponseError.new(error)
-        return rate_response
-      end
-
-      prices = []
-      transit_days = nil
-
-      api_shipments = response.dig('OnTracRateResponse', 'Shipments', 'Shipment')
-      api_shipments = [api_shipments] unless api_shipments.is_a?(Array)
-
-      if api_shipments.any? { |api_shipment| api_shipment['Error']&.downcase&.include?('not serviced') }
-        rate_response.error = UnserviceableError.new
-        return rate_response
-      end
-
-      api_shipments.each do |api_shipment|
-        api_rate = api_shipment.dig('Rates', 'Rate')
-        api_transit_days = api_rate['TransitDays'].to_i
-
-        transit_days = api_transit_days if transit_days.blank? || transit_days < api_transit_days
-
-        cents = (api_rate['ServiceCharge'].to_f * 100).to_i
-        prices << Price.new(blame: :api, cents:, description: 'Service charge')
-
-        cents = (api_rate['FuelCharge'].to_f * 100).to_i
-        prices << Price.new(blame: :api, cents:, description: 'Fuel charge')
-      end
-
-      rate = Rate.new(
-        carrier_name: self.class.name,
-        carrier: self,
-        currency: 'USD',
-        prices:,
-        scac: self.class.scac.upcase,
-        service_name: :standard,
-        shipment:,
-        transit_days:,
-        with_excessive_length_fees: @conf.dig(:attributes, :rates, :with_excessive_length_fees),
-      )
-
-      rate_response.rates = [rate]
-      rate_response
-    end
-
-    # Tracking
-  end
-end