freight_kit 0.1.15 → 0.1.16

data/lib/freight_kit/carriers/pens.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class PENS < FreightKit::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(6, :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
+
+    include FreightKit::Rateable
+
+    class << self
+      attr_reader :name, :scac
+    end
+    @name = 'Peninsula Truck Lines'
+    @scac = 'PENS'
+
+    # Documents
+
+    # Tracking
+
+    protected
+
+    def commit(action, request)
+      client_args = {
+                      wsdl: request_url(action),
+                      convert_request_keys_to: :lower_camelcase,
+                      env_namespace: :soap,
+                      element_form_default: :qualified
+                    }
+
+      call_args = { message: request }
+
+      ::FreightKit::SoapClient.new(
+        carrier: self,
+        action:,
+        client_args:,
+        call_args:,
+        soap_operation: @conf.dig(:api, :actions, action),
+      ).call
+    end
+
+    def parse_amount(amount)
+      negative = amount.start_with?('-$') || amount.start_with?('-')
+
+      ['$', '-', ','].each do |char|
+        amount = amount.sub(char, '')
+      end
+
+      return 0 if amount.blank?
+
+      amount = (amount.to_f * 100).to_i
+      return amount unless negative
+
+      amount * -1
+    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_rate_request(shipment:)
+      raise UnserviceableError, 'Unable to quote accessorials over API' if shipment.accessorials.present?
+
+      api_credentials = fetch_credential(:api)
+
+      request = {
+                  accessorial_list: '', # TODO: Fix this!
+                  account: api_credentials.account,
+                  class_list: shipment.packages.map(&:freight_class).join(','),
+                  customer_type: 'B',
+                  destination_zip: shipment.destination.postal_code.to_s,
+                  none_palletized_mode: shipment.packages.map(&:packaging).map(&:pallet?).any?(false) ? 'Y' : 'N',
+                  origin_zip: shipment.origin.postal_code.to_s,
+                  password: api_credentials.password,
+                  plt_count_list: shipment.packages.map(&:quantity).join(','),
+                  plt_length_list: shipment.packages.map { |p| p.inches(:length).ceil }.join(','),
+                  plt_total_weight: shipment.packages.map { |p| p.pounds(:total).ceil }.join(','),
+                  plt_width_list: shipment.packages.map { |p| p.inches(:width).ceil }.join(','),
+                  user_id: api_credentials.username,
+                  weight_list: shipment.packages.map { |p| p.pounds(:total) }.join(',')
+                }
+
+      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
+
+      error = response.dig(:create_pens_rate_quote_response, :create_pens_rate_quote_result, :errors, :message)
+
+      if error.present?
+        if error.include?('[RatingService.ValidateZipCodes]')
+          rate_response.error = UnserviceableError.new('Origin or destination has no service available')
+        end
+
+        rate_response.error = ResponseError.new(error) if rate_response.error.blank?
+        return rate_response
+      end
+
+      result = response.dig(:create_pens_rate_quote_response, :create_pens_rate_quote_result)
+
+      if result.dig(:quote, :gross_charge).blank?
+        rate_response.error = ResponseError.new('Cost is blank')
+        return rate_response
+      end
+
+      service_type = :standard
+      api_service_type = result.dig(:quote, :transit_type)
+
+      @conf.dig(:services, :mappable).each do |key, val|
+        service_type = key if api_service_type.downcase.include?(val)
+      end
+
+      transit_days = service_type == :next_day_ltl ? 1 : nil # TODO: Detect correctly
+
+      estimate_reference = result.dig('quote', 'quote_number')
+
+      prices = []
+
+      prices << Price.new(
+        blame: :api,
+        cents: parse_amount(result.dig(:quote, :gross_charge)),
+        description: 'Charge based on class and weight',
+      )
+
+      accessorial_details = result.dig(:quote, :accessorial_detail)
+      accessorial_details = [accessorial_details] if accessorial_details.is_a?(Hash)
+
+      accessorial_details.each do |accessorial_detail|
+        accessorial_item = accessorial_detail[:accessorial_item]
+
+        prices << Price.new(
+          blame: :api,
+          cents: parse_amount(accessorial_item[:charge]),
+          description: accessorial_item[:description]&.capitalize,
+        )
+      end
+
+      prices << Price.new(
+        blame: :api,
+        cents: parse_amount(result.dig(:quote, :discount_amount)),
+        description: 'Discount',
+      )
+
+      prices << Price.new(
+        blame: :api,
+        cents: parse_amount(result.dig(:quote, :fsc_amount)),
+        description: 'Fuel surcharge',
+      )
+
+      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