freight_kit 0.1.15 → 0.1.16

data/configuration/carriers/saia.yml

@@ -0,0 +1,129 @@
+:accessorials:
+  :mappable:
+    :airport_delivery: LimitedAccessLocation
+    :airport_pickup: LimitedAccessLocationPU
+    :amusement_park_delivery: LimitedAccessLocation
+    :amusement_park_pickup: LimitedAccessLocationPU
+    :appointment_delivery: ArrivalNotice/Appointment
+    :cemetery_delivery: LimitedAccessLocation
+    :cemetery_pickup: LimitedAccessLocationPU
+    :church_delivery: LimitedAccessLocation
+    :church_pickup: LimitedAccessLocationPU
+    :construction_delivery: LimitedAccessLocation
+    :construction_pickup: LimitedAccessLocationPU
+    :convention_delivery: TradeShowDelivery
+    :convention_pickup: TradeShowPickup
+    :driver_assist: WhiteGlove
+    :fair_delivery: LimitedAccessLocation
+    :fair_pickup: LimitedAccessLocationPU
+    :government_delivery: LimitedAccessLocation
+    :government_pickup: LimitedAccessLocationPU
+    :inside_delivery: InsideDelivery
+    :inside_pickup: InsidePickup
+    :jobsite_delivery: LimitedAccessLocation
+    :jobsite_pickup: LimitedAccessLocationPU
+    :liftgate_delivery: LiftgateService
+    :liftgate_pickup: LiftgateServicePU
+    :marina_delivery: LimitedAccessLocation
+    :marina_pickup: LimitedAccessLocationPU
+    :military_site_delivery: LimitedAccessLocation
+    :military_site_pickup: LimitedAccessLocationPU
+    :mine_site_delivery: LimitedAccessLocation
+    :mine_site_pickup: LimitedAccessLocationPU
+    :prison_delivery: LimitedAccessLocation
+    :prison_pickup: LimitedAccessLocationPU
+    :residential_delivery: ResidentialDelivery
+    :residential_pickup: ResidentialPickup
+    :school_delivery: LimitedAccessLocation
+    :school_pickup: LimitedAccessLocationPU
+    :steel_mill_delivery: LimitedAccessLocation
+    :steel_mill_pickup: LimitedAccessLocationPU
+    :storage_facility_delivery: LimitedAccessLocation
+    :storage_facility_pickup: LimitedAccessLocationPU
+    :university_delivery: LimitedAccessLocation
+    :university_pickup: LimitedAccessLocationPU
+    :utility_site_delivery: LimitedAccessLocation
+    :utility_site_pickup: LimitedAccessLocationPU
+  # May be inaccurate
+  :unquotable:
+    - :athletic_facility_delivery
+    - :athletic_facility_pickup
+    - :brewery_delivery
+    - :brewery_pickup
+    - :dock_dropoff
+    - :dock_pickup
+    - :farm_delivery
+    - :farm_pickup
+    - :fitness_center_delivery
+    - :fitness_center_pickup
+    - :golf_course_delivery
+    - :golf_course_pickup
+    - :grocery_store_delivery
+    - :grocery_store_pickup
+    - :grocery_warehouse_delivery
+    - :grocery_warehouse_pickup
+    - :hospital_delivery
+    - :hospital_pickup
+    - :hotel_delivery
+    - :hotel_pickup
+    - :inspection_site_delivery
+    - :inspection_site_pickup
+    - :mall_delivery
+    - :mall_pickup
+    - :motel_delivery
+    - :motel_pickup
+    - :nursing_home_delivery
+    - :nursing_home_pickup
+    - :park_delivery
+    - :park_pickup
+    - :ranch_delivery
+    - :ranch_pickup
+    - :reservation_delivery
+    - :reservation_pickup
+    - :resort_delivery
+    - :resort_pickup
+    - :restaurant_delivery
+    - :restaurant_pickup
+    - :winery_delivery
+    - :winery_pickup
+  # May be inaccurate
+  :unserviceable:
+    - :afterhours_delivery
+    - :afterhours_pickup
+    - :appointment_pickup
+    - :customs_brokerage
+    - :early_morning_delivery
+    - :early_morning_pickup
+    - :flatbed_delivery
+    - :flatbed_pickup
+    - :guaranteed_delivery
+    - :guaranteed_delivery_am
+    - :guaranteed_delivery_pm
+:api:
+  :actions:
+    :rates: :create
+    :track: :get_by_pro_number
+  :domain: www.saiasecure.com
+  :endpoints:
+    :rates: /webservice/ratequote/soap.asmx?wsdl
+    :track: /webservice/shipment/soap.asmx?wsdl 
+  :use_ssl: true
+:attributes:
+  :rates:
+    :with_excessive_length_fees: true
+:events:
+  :types:
+    :arrived_at_terminal: arrived
+    :delivered: delivered
+    :departed: departed from terminal
+    :located: arrived at breakbulk terminal
+    :out_for_delivery: dispatched for delivery
+    :picked_up: pickup from customer
+    :trailer_unloaded: unload trailer # must be before :trailer_closed
+    :trailer_closed: load trailer
+:services:
+  :types:
+    - :standard
+    - :guaranteed_delivery
+    - :guaranteed_delivery_am
+    - :guaranteed_delivery_pm

data/configuration/carriers/sefl.yml

@@ -0,0 +1,115 @@
+:accessorials:
+  :mappable:
+    :airport_delivery: chkAPD
+    :airport_pickup: chkAPU
+    :amusement_park_delivery: chkLAD
+    :amusement_park_pickup: chkLAP
+    :appointment_delivery: chkAN
+    :athletic_facility_delivery: chkLAD
+    :athletic_facility_pickup: chkLAP
+    :cemetery_delivery: chkLAD
+    :cemetery_pickup: chkLAP
+    :church_delivery: chkLAD
+    :church_pickup: chkLAP
+    :construction_delivery: chkLAD
+    :construction_pickup: chkLAP
+    :convention_delivery: chkLAD
+    :convention_pickup: chkLAP
+    :dock_dropoff: chkSHC
+    :fair_delivery: chkLAD
+    :fair_pickup: chkLAP
+    :farm_delivery: chkLAD
+    :farm_pickup: chkLAP
+    :fitness_center_delivery: chkLAD
+    :fitness_center_pickup: chkLAP
+    :golf_course_delivery: chkLAD
+    :golf_course_pickup: chkLAP
+    :government_delivery: chkLAD
+    :government_pickup: chkLAP
+    :grocery_store_delivery: chkLAD
+    :grocery_store_pickup: chkLAP
+    :guaranteed_delivery: chkDG
+    :guaranteed_delivery_am: chkNG
+    :guaranteed_delivery_pm: chkDG
+    :hospital_delivery: chkLAD
+    :hospital_pickup: chkLAP
+    :hotel_delivery: chkLAD
+    :hotel_pickup: chkLAP
+    :inside_delivery: chkID
+    :inside_pickup: chkIP
+    :inspection_site_delivery: chkLAD
+    :inspection_site_pickup: chkLAP
+    :jobsite_delivery: chkLAD
+    :jobsite_pickup: chkLAP
+    :liftgate_delivery: chkLGD
+    :liftgate_pickup: chkLGP
+    :mall_delivery: chkLAD
+    :mall_pickup: chkLAP
+    :marina_delivery: chkLAD
+    :marina_pickup: chkLAP
+    :military_site_delivery: chkLAD
+    :military_site_pickup: chkLAP
+    :mine_site_delivery: chkLAD
+    :mine_site_pickup: chkLAP
+    :motel_delivery: chkLAD
+    :motel_pickup: chkLAP
+    :nursing_home_delivery: chkLAD
+    :nursing_home_pickup: chkLAP
+    :park_delivery: chkLAD
+    :park_pickup: chkLAP
+    :prison_delivery: chkLAD
+    :prison_pickup: chkLAP
+    :ranch_delivery: chkLAD
+    :ranch_pickup: chkLAP
+    :reservation_delivery: chkLAD
+    :reservation_pickup: chkLAP
+    :residential_delivery: chkPR
+    :residential_pickup: chkPR
+    :resort_delivery: chkLAD
+    :resort_pickup: chkLAP
+    :restaurant_delivery: chkLAD
+    :restaurant_pickup: chkLAP
+    :school_delivery: chkLAD
+    :school_pickup: chkLAP
+    :steel_mill_delivery: chkLAD
+    :steel_mill_pickup: chkLAP
+    :storage_facility_delivery: chkLAD
+    :storage_facility_pickup: chkLAP
+    :university_delivery: chkLAD
+    :university_pickup: chkLAP
+    :utility_site_delivery: chkLAD
+    :utility_site_pickup: chkLAP
+  # May be inaccurate
+  :unquotable:
+    - :dock_pickup
+  # May be inaccurate
+  :unserviceable:
+    - :afterhours_delivery
+    - :afterhours_pickup
+    - :appointment_pickup
+    - :brewery_delivery
+    - :brewery_pickup
+    - :customs_brokerage
+    - :driver_assist
+    - :early_morning_delivery
+    - :early_morning_pickup
+    - :flatbed_delivery
+    - :flatbed_pickup
+    - :grocery_warehouse_delivery
+    - :grocery_warehouse_pickup
+    - :winery_delivery
+    - :winery_pickup
+:api:
+  :domain: www.sefl.com
+  :endpoints:
+    :rates: /webconnect/ratequotes/rest/submitQuote
+  :methods:
+    :get_rate: :get
+    :rates: :post
+  :use_ssl: false
+:attributes:
+  :rates:
+    :with_excessive_length_fees: true
+:services:
+  :types:
+    - :standard

data/configuration/carriers/totl.yml

@@ -0,0 +1,111 @@
+:accessorials:
+  :mappable:
+    :appointment_delivery: 'APPT'
+    :inside_delivery: 'IDL'
+    :inside_pickup: 'IDL'
+    :liftgate_delivery: 'LIFT'
+    :liftgate_pickup: 'LIFTP'
+    :residential_delivery: 'RESI'
+    :residential_pickup: 'RESP'
+    :restaurant_delivery:
+     - 'IDL'
+     - 'LIFT'
+    :restaurant_pickup:
+     - 'IDL'
+     - 'LIFTP'
+  # May be inaccurate
+  :unquotable:
+    - :amusement_park_delivery
+    - :amusement_park_pickup
+    - :athletic_facility_delivery
+    - :athletic_facility_delivery
+    - :athletic_facility_pickup
+    - :cemetery_delivery
+    - :cemetery_pickup
+    - :church_delivery
+    - :church_pickup
+    - :construction_delivery
+    - :construction_pickup
+    - :dock_dropoff
+    - :dock_pickup
+    - :farm_delivery
+    - :farm_pickup
+    - :fitness_center_delivery
+    - :fitness_center_pickup
+    - :golf_course_delivery
+    - :golf_course_pickup
+    - :government_delivery
+    - :government_pickup
+    - :grocery_store_delivery
+    - :grocery_store_pickup
+    - :hospital_delivery
+    - :hospital_pickup
+    - :hotel_delivery
+    - :hotel_pickup
+    - :inspection_site_delivery
+    - :inspection_site_pickup
+    - :jobsite_delivery
+    - :jobsite_pickup
+    - :mall_delivery
+    - :mall_pickup
+    - :marina_delivery
+    - :marina_pickup
+    - :mine_site_delivery
+    - :mine_site_pickup
+    - :motel_delivery
+    - :motel_pickup
+    - :nursing_home_delivery
+    - :nursing_home_pickup
+    - :park_delivery
+    - :park_pickup
+    - :prison_delivery
+    - :prison_pickup
+    - :ranch_delivery
+    - :ranch_pickup
+    - :reservation_delivery
+    - :reservation_pickup
+    - :resort_delivery
+    - :resort_pickup
+    - :school_delivery
+    - :school_pickup
+    - :steel_mill_delivery
+    - :steel_mill_pickup
+    - :storage_facility_delivery
+    - :storage_facility_pickup
+    - :university_delivery
+    - :university_pickup
+    - :utility_site_delivery
+    - :utility_site_pickup
+  # May be inaccurate
+  :unserviceable:
+    - :airport_delivery
+    - :airport_pickup
+    - :appointment_pickup
+    - :brewery_delivery
+    - :brewery_pickup
+    - :convention_delivery
+    - :convention_pickup
+    - :customs_brokerage
+    - :driver_assist
+    - :early_morning_delivery
+    - :fair_delivery
+    - :fair_pickup
+    - :flatbed_delivery
+    - :flatbed_pickup
+    - :grocery_warehouse_delivery
+    - :grocery_warehouse_pickup
+    - :guaranteed_delivery
+    - :guaranteed_delivery_am
+    - :guaranteed_delivery_pm
+    - :military_site_delivery
+    - :military_site_pickup
+    - :winery_delivery
+    - :winery_pickup
+:api:
+  :carrier_code: tot
+:attributes:
+  :rates:
+    :with_excessive_length_fees: true
+:services:
+  :types:
+    - :standard

data/configuration/carriers/tqyl.yml

@@ -0,0 +1,28 @@
+:api:
+  :domain: public.api.tql.com
+  :endpoints:
+    :rates: /ltl/quotes
+    :track: /tracking/%TRACKING_NUMBER%
+    :pickup: /ltl/loads/tender
+    :auth: /identity/token
+  :methods:
+    :rates: :post
+    :track: :get
+    :pickup: :post
+    :auth: :post
+:attributes:
+  :rates:
+    :with_excessive_length_fees: true
+# Per carrier at 2023-02-13
+:accessorials:
+  :mappable:
+    :appointment_delivery: APPTDEL
+    :inside_delivery: INPU
+    :inside_pickup: INDEL
+    :liftgate_delivery: LGDEL
+    :liftgate_pickup: LGPU
+:events:
+  :types:
+    :picked_up: Tendered
+    :delivered: Delivered
+    :out_for_delivery: In Transit

data/configuration/carriers/wrds.yml

@@ -0,0 +1,20 @@
+:api:
+  :domain: tracking.wrds.com
+  :endpoints:
+    :pod: /zLogin.aspx
+    :track: /zTrack2.aspx
+  :methods:
+    :track: :post
+  :use_ssl:
+    :bol: false
+    :pod: false
+    :track: true
+:events:
+  :types:
+    :arrived_at_terminal: arrived
+    :delivered: delivered
+    :delivery_appointment_scheduled: delivery appt made
+    :departed: departed
+:services:
+  :types:
+    - :standard

data/configuration/platforms/carrier_logistics.yml

@@ -0,0 +1,25 @@
+:api:
+  :domain: tracking.carrierlogistics.com
+  :endpoints:
+    :bol: /scripts/@CARRIER_CODE@.pol/web-login.htm?
+    :pod: /scripts/@CARRIER_CODE@.pol/web-login.htm?
+    :rates: /scripts/@CARRIER_CODE@.pol/ratequote.xml?
+    :track: /scripts/@CARRIER_CODE@.pol/protracexml.htm?
+  :use_ssl:
+    :bol: true
+    :pod: true
+    :rates: true
+    :track: true
+:attributes:
+  :rates:
+    :with_excessive_length_fees: false
+:events:
+  :types:
+    :arrived_at_terminal: trailer arrived
+    :delivered: delivered
+    :departed: trailer departed
+    :out_for_delivery: out for delivery
+    :picked_up: picked up
+    :pickup_scheduled: pickup request received
+    :trailer_closed: loaded on trailer
+    :trailer_unloaded: undisp

data/configuration/platforms/next.yml

@@ -0,0 +1,12 @@
+:api:
+  :endpoints:
+    :authenticate: /authenticate
+    :show: /shipments
+  :methods:
+    :authenticate: :post
+    :show: :get
+  :prefix: /api/v1
+  :scopes:
+    :broker: /broker
+    :customer: /customer
+  :use_ssl: true

data/configuration/platforms/the_great_information_factory.yml

@@ -0,0 +1,122 @@
+:accessorials:
+  :mappable:
+    :appointment_delivery: NOTFEE
+    :inside_delivery: INSDEL
+    :liftgate_delivery: LIFDEL
+    :liftgate_pickup: LIFPIC
+    :mall_delivery: INSDEL
+    :residential_delivery: RESDEL
+    :residential_pickup: RESPIC
+    :restaurant_delivery: INSDEL
+  # May be inaccurate
+  :unquotable:
+    - :athletic_facility_delivery
+    - :athletic_facility_pickup
+    - :cemetery_delivery
+    - :cemetery_pickup
+    - :church_delivery
+    - :church_pickup
+    - :construction_delivery
+    - :construction_pickup
+    - :dock_dropoff
+    - :dock_pickup
+    - :farm_delivery
+    - :farm_pickup
+    - :fitness_center_delivery
+    - :fitness_center_pickup
+    - :flatbed_delivery
+    - :flatbed_pickup
+    - :golf_course_delivery
+    - :golf_course_pickup
+    - :government_delivery
+    - :government_pickup
+    - :grocery_store_delivery
+    - :grocery_store_pickup
+    - :holiday_delivery
+    - :holiday_pickup
+    - :hospital_delivery
+    - :hospital_pickup
+    - :hotel_delivery
+    - :hotel_pickup
+    - :inspection_site_delivery
+    - :inspection_site_pickup
+    - :jobsite_delivery
+    - :jobsite_pickup
+    - :military_site_delivery
+    - :military_site_pickup
+    - :mine_site_delivery
+    - :mine_site_pickup
+    - :motel_delivery
+    - :motel_pickup
+    - :nursing_home_delivery
+    - :nursing_home_pickup
+    - :park_delivery
+    - :park_pickup
+    - :prison_delivery
+    - :prison_pickup
+    - :ranch_delivery
+    - :ranch_pickup
+    - :reservation_delivery
+    - :reservation_pickup
+    - :resort_delivery
+    - :resort_pickup
+    - :restaurant_pickup
+    - :school_delivery
+    - :school_pickup
+    - :steel_mill_delivery
+    - :steel_mill_pickup
+    - :storage_facility_delivery
+    - :storage_facility_pickup
+    - :university_delivery
+    - :university_pickup
+    - :utility_site_delivery
+    - :utility_site_pickup
+  # May be inaccurate
+  :unserviceable:
+    - :afterhours_delivery
+    - :airport_delivery
+    - :airport_pickup
+    - :amusement_park_delivery
+    - :amusement_park_pickup
+    - :appointment_pickup
+    - :brewery_delivery
+    - :brewery_pickup
+    - :convention_delivery
+    - :convention_pickup
+    - :customs_brokerage
+    - :driver_assist
+    - :early_morning_delivery
+    - :fair_delivery
+    - :fair_pickup
+    - :grocery_warehouse_delivery
+    - :grocery_warehouse_pickup
+    - :guaranteed_delivery
+    - :guaranteed_delivery_am
+    - :guaranteed_delivery_pm
+    - :inside_pickup
+    - :marina_delivery
+    - :marina_pickup
+    - :saturday_delivery
+    - :saturday_pickup
+    - :sunday_delivery
+    - :sunday_pickup
+    - :winery_delivery
+    - :winery_pickup
+:api:
+  :actions:
+    :rates: :getquote
+    :track: :tracktrace
+    :pickup: :requestpickup
+  :use_ssl:
+    :rates: false
+    :track: false
+:events:
+  :types:
+    :arrived_at_terminal: arrived
+    :delivered: delivered
+    :departed: departed
+    :out_for_delivery: out for delvry
+    :pickup_information_sent_to_carrier: p/u dispatched
+:services:
+  :types:
+    - :standard

data/freight_kit.gemspec

@@ -23,8 +23,9 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/next-tms/freight_kit'
   spec.summary = spec.description
 
-  spec.files = Dir['lib/**/*'] +
-               Dir['[A-Z]*'] +
+  spec.files = Dir['[A-Z]*'] +
+               Dir['configuration/*/*.yml'] +
+               Dir['lib/**/*'] +
                Dir['test/**/*']
   spec.require_paths = ['lib']
 
@@ -35,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('rubocop-next', '~> 1.0.7')
   spec.add_development_dependency('yard', '~> 0.9.28')
 
-  spec.add_dependency('activemodel', '>= 4.2', '< 8.1.4')
-  spec.add_dependency('activesupport', '>= 4.2', '< 8.1.4')
+  spec.add_dependency('activemodel', '>= 7.1', '< 8.1.4')
+  spec.add_dependency('activesupport', '>= 7.1', '< 8.1.4')
   spec.add_dependency('active_utils', '>= 3.3.1', '< 3.7.0')
   spec.add_dependency('benchmark', '~> 0.5.0')
   spec.add_dependency('business_time', '~> 0.13.0')
@@ -44,11 +45,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency('measured', '>= 2.0', '< 3.2.2')
   spec.add_dependency('mimemagic', '~> 0.4.3')
   spec.add_dependency('nokogiri', '>= 1.6', '< 1.20')
-  spec.add_dependency('place_kit', '~> 0.0.2')
-  spec.add_dependency('savon', '>= 2.0', '< 2.16')
+  spec.add_dependency('place_kit', '~> 0.0.6')
+  spec.add_dependency('rmagick', '>= 4.2.5', '< 7.1.0')
+  spec.add_dependency('savon', '>= 2.17', '< 2.18')
   spec.add_dependency('tzinfo-data', '~> 1.2023', '>= 1.2023.3')
   spec.add_dependency('watir', '>= 7.0', '< 7.4')
-  spec.add_dependency('zeitwerk', '>= 2.6.0', '< 2.7.6')
+  spec.add_dependency('zeitwerk', '>= 2.6.0', '< 2.8.3')
 
   spec.required_ruby_version = '>= 3.2.0'
 end

data/lib/freight_kit/api_clients/soap_client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module FreightKit
+  class SoapClient
+    API_EXCEPTIONS = [
+                       Savon::HTTPError,
+                       Net::ReadTimeout,
+                       Net::OpenTimeout,
+                       Errno::ECONNREFUSED,
+                       Errno::ECONNRESET,
+                       Errno::EHOSTUNREACH,
+                     ]
+
+    def initialize(carrier:, action:, client_args:, call_args:, soap_operation:)
+      @carrier = carrier
+      @action = action
+      @client_args = client_args || {}
+      @call_args = call_args
+      @soap_operation = soap_operation
+    end
+
+    def call(handle_soap_fault_error: true)
+      # http = OpenStruct.new(code: 500, body: {})
+      # raise Savon::HTTPError, http
+
+      api_exceptions = API_EXCEPTIONS
+
+      # For testing and debugging
+      # client_args.merge!(log: true, pretty_print_xml: true)
+
+      Savon.client(**client_args).call(soap_operation, **call_args).body
+    rescue *api_exceptions => e
+      response = build_response_class(action:)
+      response.error = ResponseError.new("Network Error: #{e}")
+
+      response
+    rescue Savon::InvalidResponseError
+      response = build_response_class(action:)
+      response.error = ResponseError.new('API Error: Invalid response')
+
+      response
+    rescue Savon::SOAPFault => e
+      raise unless handle_soap_fault_error
+
+      response = build_response_class(action:)
+      response.error = ResponseError.new("API Error: #{e}")
+
+      response
+    rescue StandardError => e
+      response = build_response_class(action:)
+      response.error = ResponseError.new("API Error: #{e}")
+
+      response
+    end
+
+    private
+
+    attr_reader :carrier, :action, :client_args, :call_args, :soap_operation
+
+    def build_response_class(action:)
+      request = call_args[:message]
+
+      case action
+      when :rates then RateResponse.new(request:, response: nil)
+      when :track then TrackingResponse.new(carrier:, request:, response: nil)
+      when :pickup then PickupResponse.new(request:, response: nil)
+      end
+    end
+  end
+end

data/lib/freight_kit/api_clients.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'freight_kit/api_clients/soap_client'