reactive_freight 0.0.1

data/lib/reactive_freight/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/lib/reactive_freight/configuration/carriers/totl.yml

@@ -0,0 +1,107 @@
+:accessorials:
+  :mappable:
+    :appointment_delivery: '&APPT=yes'
+    :inside_delivery: '&IDL=yes'
+    :inside_pickup: '&IDL=yes'
+    :liftgate_delivery: '&LIFT=yes'
+    :liftgate_pickup: '&LIFTP=yes'
+    :residential_delivery: '&RESI=yes'
+    :residential_pickup: '&RESP=yes'
+  # 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
+    - :restaurant_delivery
+    - :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:
+    - :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/lib/reactive_freight/configuration/carriers/wrds.yml

@@ -0,0 +1,19 @@
+: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
+    :departed: departed
+:services:
+  :types:
+    - :standard

data/lib/reactive_freight/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/boldetail.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/lib/reactive_freight/configuration/platforms/liftoff.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/lib/reactive_freight/package.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module ReactiveShipping
+  class Package
+    VALID_FREIGHT_CLASSES = [55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400].freeze
+
+    attr_writer :declared_freight_class
+
+    def initialize(grams_or_ounces, dimensions, options = {})
+      options = @@default_options.update(options) if @@default_options
+      options.symbolize_keys!
+      @options = options
+
+      # For backward compatibility
+      if dimensions.is_a?(Array)
+        @dimensions = [dimensions].flatten.reject(&:nil?)
+      else
+        @dimensions = [dimensions.dig(:height), dimensions.dig(:width), dimensions.dig(:length)]
+        @dimensions = [@dimensions].flatten.reject(&:nil?)
+      end
+
+      imperial = (options[:units] == :imperial)
+
+      weight_imperial = dimensions_imperial = imperial if options.include?(:units)
+
+      if options.include?(:weight_units)
+        weight_imperial = (options[:weight_units] == :imperial)
+      end
+
+      if options.include?(:dim_units)
+        dimensions_imperial = (options[:dim_units] == :imperial)
+      end
+
+      @weight_unit_system = weight_imperial ? :imperial : :metric
+      @dimensions_unit_system = dimensions_imperial ? :imperial : :metric
+
+      @weight = attribute_from_metric_or_imperial(grams_or_ounces, Measured::Weight, @weight_unit_system, :grams, :ounces)
+
+      if @dimensions.blank?
+        zero_length = Measured::Length.new(0, (dimensions_imperial ? :inches : :centimetres))
+        @dimensions = [zero_length] * 3
+      else
+        # Overriding ReactiveShipping's protected process_dimensions which sorts
+        # them making it confusing for ReactiveFreight carrier API's that expect
+        # the H x W x L order. Since H x W x L is nonstandard in the freight
+        # industry ReactiveFreight introduces explicit functions for each
+        @dimensions = @dimensions.map do |l|
+          attribute_from_metric_or_imperial(l, Measured::Length, @dimensions_unit_system, :centimetres, :inches)
+        end
+        2.downto(@dimensions.length) do |_n|
+          @dimensions.unshift(@dimensions[0])
+        end
+      end
+
+      @value = Package.cents_from(options[:value])
+      @currency = options[:currency] || (options[:value].currency if options[:value].respond_to?(:currency))
+      @cylinder = (options[:cylinder] || options[:tube]) ? true : false
+      @gift = options[:gift] ? true : false
+      @oversized = options[:oversized] ? true : false
+      @unpackaged = options[:unpackaged] ? true : false
+    end
+
+    def cubic_ft
+      if !inches[0].blank? && !inches[1].blank? && !inches[2].blank?
+        cubic_ft = (inches[0] * inches[1] * inches[2]).to_f / 1728
+        return ('%0.2f' % cubic_ft).to_f
+      end
+      nil
+    end
+
+    def density
+      if !inches[0].blank? && !inches[1].blank? && !inches[2].blank? && pounds
+        density = pounds.to_f / cubic_ft
+        return ('%0.2f' % density).to_f
+      end
+      nil
+    end
+
+    def calculated_freight_class
+      sanitized_freight_class(density_to_freight_class(density))
+    end
+
+    def declared_freight_class
+      @declared_freight_class || @options[:declared_freight_class]
+    end
+
+    def freight_class
+      declared_freight_class.blank? ? calculated_freight_class : declared_freight_class
+    end
+
+    def length(unit)
+      @dimensions[2].convert_to(unit).value.to_f
+    end
+
+    def width(unit)
+      @dimensions[1].convert_to(unit).value.to_f
+    end
+
+    def height(unit)
+      @dimensions[0].convert_to(unit).value.to_f
+    end
+
+    protected
+
+    def density_to_freight_class(density)
+      return nil unless density
+      return 400 if density < 1
+      return 60 if density > 30
+
+      density_table = [
+        [1, 2, 300],
+        [2, 4, 250],
+        [4, 6, 175],
+        [6, 8, 125],
+        [8, 10, 100],
+        [10, 12, 92.5],
+        [12, 15, 85],
+        [15, 22.5, 70],
+        [22.5, 30, 65],
+        [30, 35, 60]
+      ]
+      density_table.each do |density_row|
+        return density_row[2] if (density >= density_row[0]) && (density < density_row[1])
+      end
+    end
+
+    def sanitized_freight_class(freight_class)
+      return nil if freight_class.blank?
+
+      if VALID_FREIGHT_CLASSES.include?(freight_class)
+        return freight_class.to_i == freight_class ? freight_class.to_i : freight_class
+      end
+
+      nil
+    end
+  end
+end

data/lib/reactive_freight/platform.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ReactiveShipping
+  class Platform < ReactiveShipping::Carrier
+    attr_accessor :conf
+
+    def initialize(options = {})
+      requirements.each { |key| requires!(options, key) }
+      @conf = nil
+      @debug = options[:debug].blank? ? false : true
+      @options = options
+      @last_request = nil
+      @test_mode = @options[:test]
+
+      conf_path = File.join(__dir__, 'configuration', 'platforms', "#{self.class.ancestors[1].name.split('::')[1].underscore}.yml")
+      @conf = YAML.safe_load(File.read(conf_path), permitted_classes: [Symbol])
+
+      conf_path = File.join(__dir__, 'configuration', 'carriers', "#{self.class.to_s.split('::')[1].underscore}.yml")
+      @conf = @conf.deep_merge(YAML.safe_load(File.read(conf_path), permitted_classes: [Symbol]))
+
+      @rates_with_excessive_length_fees = @conf.dig(:attributes, :rates, :with_excessive_length_fees)
+    end
+
+    def find_bol(*)
+      raise NotImplementedError, "#{self.class.name}: #find_bol not supported"
+    end
+
+    def find_estimate(*)
+      raise NotImplementedError, "#{self.class.name}: #find_estimate not supported"
+    end
+
+    def find_pod(*)
+      raise NotImplementedError, "#{self.class.name}: #find_pod not supported"
+    end
+  end
+end