freight_kit 0.1.20 → 0.1.21

data/lib/freight_kit/carriers/cross_country_freight_solutions.rb

@@ -0,0 +1,419 @@
+module FreightKit
+  module Carriers
+    class CrossCountryFreightSolutions < FreightKit::Carrier
+      class << self
+        def check_mailing_addresses
+          [
+            Address.new(
+              city: 'Bismarck',
+              country: Countries.find_by(iso31661_alpha2: 'US'),
+              id: 'bc2db4c6-b4c8-4082-adfc-4a3e764510a7',
+              postal_code: '58502',
+              region_abbreviation: 'ND',
+              street: 'PO Box 4030'
+            )
+          ]
+        end
+
+        def contacts
+          [Contact.new(department: 'Main', id: '2336a4d3-4f04-4eab-9e38-d0afb74dce62', phone: '+17012228498')]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Bismarck',
+            country: Countries.find_by(iso31661_alpha2: 'US'),
+            id: 'f78d1f2e-1299-405b-a0a2-45c99b4d7a14',
+            postal_code: '58501',
+            region_abbreviation: 'ND',
+            street: '1841 Hancock Drive'
+          )
+        end
+
+        def id = '08c02bcf-11fb-40a7-950a-58e6503f540f'
+        def legal_name = 'CrossCountry Freight Solutions Inc'
+
+        # Per carrier at 2022-12-16T02:31:00Z
+        def mappable_accessorials
+          {
+            afterhours_delivery: 'AFTERHRS',
+            afterhours_pickup: 'AFTERHRS',
+            airport_delivery: 'AIRPORT PD',
+            airport_pickup: 'AIRPORT PD',
+            amusement_park_delivery: 'LIMITEDACC',
+            amusement_park_pickup: 'LIMITEDACC',
+            appointment_delivery: 'APPT_NOTIF',
+            appointment_pickup: 'APPT_NOTIF',
+            athletic_facility_delivery: 'LIMITEDACC',
+            athletic_facility_pickup: 'LIMITEDACC',
+            brewery_delivery: 'LIMITEDACC',
+            brewery_pickup: 'LIMITEDACC',
+            cemetery_delivery: 'LIMITEDACC',
+            cemetery_pickup: 'LIMITEDACC',
+            church_delivery: 'LIMITEDACC',
+            church_pickup: 'LIMITEDACC',
+            construction_delivery: 'LIMITEDACC',
+            construction_pickup: 'LIMITEDACC',
+            convention_delivery: 'LIMITEDACC',
+            convention_pickup: 'LIMITEDACC',
+            corrected_bol: 'BOL_CORR',
+            driver_assist: 'EXTRA LBR',
+            early_morning_delivery: 'AFTERHRS',
+            fair_delivery: 'LIMITEDACC',
+            fair_pickup: 'LIMITEDACC',
+            farm_delivery: 'LIMITEDACC',
+            farm_pickup: 'LIMITEDACC',
+            fitness_center_delivery: 'LIMITEDACC',
+            fitness_center_pickup: 'LIMITEDACC',
+            golf_course_delivery: 'LIMITEDACC',
+            golf_course_pickup: 'LIMITEDACC',
+            government_delivery: 'LIMITEDACC',
+            government_pickup: 'LIMITEDACC',
+            grocery_store_delivery: 'LIMITEDACC',
+            grocery_store_pickup: 'LIMITEDACC',
+            grocery_warehouse_delivery: 'FOODWREHSE',
+            grocery_warehouse_pickup: 'FOODWREHSE',
+            hospital_delivery: 'LIMITEDACC',
+            hospital_pickup: 'LIMITEDACC',
+            hotel_delivery: 'LIMITEDACC',
+            hotel_pickup: 'LIMITEDACC',
+            inside_delivery: 'INSIDE',
+            inside_pickup: 'INSIDE',
+            inspection_site_delivery: 'LIMITEDACC',
+            inspection_site_pickup: 'LIMITEDACC',
+            jobsite_delivery: 'LIMITEDACC',
+            jobsite_pickup: 'LIMITEDACC',
+            liftgate_delivery: 'LIFTGT',
+            liftgate_pickup: 'LIFTGT',
+            mall_delivery: 'MALL',
+            mall_pickup: 'MALL',
+            marina_delivery: 'LIMITEDACC',
+            marina_pickup: 'LIMITEDACC',
+            military_site_delivery: 'LIMITEDACC',
+            military_site_pickup: 'LIMITEDACC',
+            mine_site_pickup: 'LIMITEDACC',
+            motel_delivery: 'LIMITEDACC',
+            motel_pickup: 'LIMITEDACC',
+            nursing_home_delivery: 'LIMITEDACC',
+            nursing_home_pickup: 'LIMITEDACC',
+            park_delivery: 'LIMITEDACC',
+            park_pickup: 'LIMITEDACC',
+            prison_delivery: 'LIMITEDACC',
+            prison_pickup: 'LIMITEDACC',
+            ranch_delivery: 'LIMITEDACC',
+            ranch_pickup: 'LIMITEDACC',
+            reservation_delivery: 'APPT_NOTIF',
+            reservation_pickup: 'APPT_NOTIF',
+            residential_delivery: 'RESIDENT',
+            residential_pickup: 'RESIDENT',
+            resort_delivery: 'LIMITEDACC',
+            resort_pickup: 'LIMITEDACC',
+            restaurant_delivery: 'LIMITEDACC',
+            restaurant_pickup: 'LIMITEDACC',
+            school_delivery: 'LIMITEDACC',
+            school_pickup: 'LIMITEDACC',
+            steel_mill_delivery: 'LIMITEDACC',
+            steel_mill_pickup: 'LIMITEDACC',
+            storage_facility_delivery: 'LIMITEDACC',
+            storage_facility_pickup: 'LIMITEDACC',
+            university_delivery: 'LIMITEDACC',
+            university_pickup: 'LIMITEDACC',
+            utility_site_delivery: 'LIMITEDACC',
+            utility_site_pickup: 'LIMITEDACC',
+            winery_delivery: 'LIMITEDACC',
+            winery_pickup: 'LIMITEDACC'
+          }
+        end
+
+        def minimum_length_for_overlength_fees = Measured::Length.new(6, :feet)
+        def name = 'CrossCountry Freight Solutions'
+        def overlength_fees_require_tariff? = false
+        def required_credential_types = %i[api_key api_proxy]
+        def requirements = %i[credentials]
+        def scac = 'CCYQ'
+        def unquotable_accessorials = %i[athletic_facility_delivery dock_dropoff dock_pickup]
+
+        def unserviceable_accessorials
+          %i[
+            customs_brokerage
+            flatbed_delivery
+            flatbed_pickup
+            guaranteed_delivery
+            guaranteed_delivery_am
+            guaranteed_delivery_pm
+          ]
+        end
+
+        def us_dot_number = 313_378
+        def us_mc_number = 209_657
+        def website_url = 'https://www.ccfs.com'
+      end
+
+      include FreightKit::Rateable
+      include FreightKit::Trackable
+      include FreightKit::Documentable
+      include FreightKit::Pickupable
+
+      API = {
+        domain: 'ccfs.com/api/public',
+        endpoints: { bol: '/Image', pod: '/Image', rates: '/Quote', track: '/Track', pickup: '/Pickup' },
+        methods: { bol: :get, pod: :get, rates: :post, track: :get, pickup: :post }
+      }.freeze
+      JSON_HEADERS = { Accept: 'application/json', charset: 'utf-8', 'Content-Type' => 'application/json' }.freeze
+
+      protected
+
+      def build_accessorials(shipment:)
+        accessorials = []
+        serviceable_accessorials?(shipment.accessorials)
+
+        accessorials << { Code: 'HAZMAT', Factor: 1 } if shipment.hazmat?
+
+        shipment.packages.each do |package|
+          longest_dimension = [package.width(:inches), package.length(:inches)].max.ceil
+
+          next if longest_dimension < 96
+
+          package.quantity.times do
+            accessorials << { Code: 'EXLEN', Factor: longest_dimension }
+          end
+        end
+
+        shipment.accessorials.map do |accessorial|
+          next if unquotable_accessorials.include?(accessorial)
+
+          accessorials << { Code: mappable_accessorials[accessorial.to_sym], Factor: 1 }
+        end
+
+        accessorials
+      end
+
+      def build_pickup_request(
+        delivery_from:,
+        delivery_to:,
+        dispatcher:,
+        pickup_from:,
+        pickup_to:,
+        scac:,
+        service:,
+        shipment:
+      )
+        dispatcher_phone = dispatcher.phone.delete('^0-9')
+        receiver = shipment.destination.contact
+        receiver_phone = receiver.phone.delete('^0-9')
+
+        build_request(
+          :pickup,
+          body: {
+            PickupAddress: {
+              Name: shipment.origin.contact.company_name || shipment.destination.origin.name,
+              Address1: shipment.origin.address1,
+              Address2: '',
+              City: shipment.origin.city,
+              State: shipment.origin.province,
+              Zip: shipment.origin.postal_code.to_s,
+              Phone: dispatcher_phone.presence || '',
+              Contact: shipment.origin.contact.name,
+              Country: shipment.origin.country.code(:alpha2).value
+            },
+            DeliveryAddress: {
+              Name: receiver.company_name || receiver.name,
+              Address1: shipment.destination.address1,
+              Address2: '',
+              City: shipment.destination.city,
+              State: shipment.destination.province,
+              Zip: shipment.destination.postal_code.to_s,
+              Phone: receiver_phone || '',
+              Contact: shipment.destination.contact.name,
+              Country: shipment.destination.country.code(:alpha2).value
+            },
+            PickupSchedule: {
+              After: pickup_from.iso8601,
+              Before: pickup_to.iso8601,
+              AppointmentRequired: false,
+              AppointmentMade: false
+            },
+            TotalWeight: shipment.packages.sum { |p| p.pounds(:total).ceil },
+            TotalUnits: shipment.packages.sum(&:quantity),
+            TotalBills: 1,
+            # TODO: Update with actual value: TotalBills desc =>
+            # Total number of freight bills that will be picked up
+            TestFlag: false
+          }.to_json
+        )
+      end
+
+      def build_rate_request(shipment:)
+        build_request(
+          :rates,
+          body: {
+            Orig: shipment.origin.postal_code,
+            Dest: shipment.destination.postal_code,
+            Accessorials: build_accessorials(shipment:),
+            Details: shipment.packages.map do |package|
+              {
+                Height: package.inches(:height).ceil.to_f,
+                Length: package.inches(:length).ceil.to_f,
+                Width: package.inches(:width).ceil.to_f,
+                Units: package.quantity.to_i,
+                Class: package.freight_class.to_f,
+                Weight: package.pounds(:total).ceil.to_f
+              }
+            end
+          }.to_json
+        )
+      end
+
+      def build_request(action, body: {}, query: {})
+        api_key = fetch_credential(:api_key).api_key
+        proxy_url = fetch_credential(:api_proxy).proxy_url
+
+        request = {
+          url: build_url(action),
+          headers: { APIKEY: api_key },
+          method: API.dig(:methods, action),
+          body:,
+          query:,
+          proxy_url:
+        }.compact
+
+        save_request(request)
+        request
+      end
+
+      def build_tracking_request(tracking_number) = build_request(:track, query: { ReferenceNum: tracking_number })
+      def build_url(action) = "https://#{API[:domain]}#{API.dig(:endpoints, action)}"
+
+      def commit(_action, request)
+        response = HTTPClient.request(
+          request[:method],
+          request[:url],
+          headers: request[:headers].merge(JSON_HEADERS),
+          body: request[:body],
+          query: request[:query],
+          proxy: request[:proxy_url]
+        )
+
+        unless response.code == 200
+          message = begin
+            JSON.parse(response.body)['Message'] || "HTTP #{response.code}"
+          rescue JSON::ParserError
+            "HTTP #{response.code}"
+          end
+
+          raise FreightKit::InvalidCredentialsError, message if message == 'API key is inactive'
+
+          raise FreightKit::ResponseError, message
+        end
+
+        JSON.parse(response.body)
+      end
+
+      def parse_document_response(type, tracking_number)
+        # Tracking Endpoint returns Images for the Shipment
+        request = build_request(:track, query: { ReferenceNum: tracking_number })
+        response = commit(type, request)
+
+        document_response = DocumentResponse.new
+
+        unless response
+          document_response.error = DocumentNotFoundError.new
+          return document_response
+        end
+
+        # API response sometimes returns an array
+        response = response.first if response.is_a?(Array)
+
+        unless response
+          document_response.error = DocumentNotFoundError.new
+          return document_response
+        end
+
+        document = response['Images']&.find { |image| image['DocumentType'] == type.upcase }
+
+        unless document
+          document_response.error = DocumentNotFoundError.new
+          return document_response
+        end
+
+        decoded_pdf_data = Base64.decode64(document['Content'])
+        document_response.assign_attributes(content_type: 'application/pdf', data: decoded_pdf_data)
+
+        document_response
+      end
+
+      def parse_pickup_response(response)
+        pickup_response = PickupResponse.new(request: last_request, response:)
+        pickup_number = response['FreightBillNum']
+
+        if pickup_number.blank?
+          pickup_response.error = FreightKit::ResponseError.new('Unknown response')
+          return pickup_response
+        end
+
+        pickup_response.pickup_number = pickup_number
+        pickup_response
+      end
+
+      def parse_rate_response(shipment:, response:)
+        rate_response = RateResponse.new(request: last_request, response:)
+
+        if response.blank?
+          rate_response.error = ResponseError.new('API Error: Unknown response')
+          return rate_response
+        end
+
+        if response['Message'].include?('Quotes between these points are not available')
+          rate_response.error = UnserviceableError.new(response['Message'])
+          return rate_response
+        end
+
+        if response['TotalCharge'].blank?
+          rate_response.error = ResponseError.new('Cost is blank')
+          return rate_response
+        end
+
+        estimate_reference = response['QuoteNum']
+        expires_at = ::Time.iso8601(response['QuoteExpiryDate'])
+
+        transit_days = (
+          ::Time.iso8601(response['EarliestDeliveryDate']).to_date -
+          ::Time.iso8601(response['PickupDate']).to_date
+        ).to_i
+
+        prices = []
+
+        ['AccessorialCharge', 'FuelCharge', 'HighCostCharge', 'MinCharge'].each do |charge_line_key|
+          charge_line = response[charge_line_key]
+          next unless charge_line
+
+          cents = (charge_line.to_f * 100).to_i
+          prices << Price.new(blame: :api, cents:, description: charge_line_key)
+        end
+
+        rate = Rate.new(
+          carrier: self,
+          carrier_name: name,
+          currency: 'USD',
+          estimate_reference:,
+          expires_at:,
+          scac:,
+          service_name: :standard,
+          shipment:,
+          prices:,
+          transit_days:,
+          with_excessive_length_fees: rates_with_excessive_length_fees?
+        )
+
+        rate_response.rates = [rate]
+        rate_response
+      end
+
+      def parse_tracking_response(response)
+        TrackingResponse.new(carrier: self, request: last_request, response:)
+
+        # TODO
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/crowley.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class Crowley < Carrier
+      class << self
+        def id = 'f8bee282-bf3a-47d1-9137-86d59276b37a'
+        def name = 'Crowley'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/csa_transportation.rb

@@ -0,0 +1,40 @@
+module FreightKit
+  module Carriers
+    class CSATransportation < Carrier
+      class << self
+        def contacts
+          [
+            Contact.new(
+              department: 'Dispatch - Los Angeles, CA',
+              email: 'la@csatransportation.com',
+              id: '5fb9d67e-df34-4320-842a-16a34a018e87'
+            ),
+            Contact.new(
+              department: 'Customer Service - Vancouver, BC, Canada',
+              id: 'aa12aaa2-d1e9-46a0-9925-00943a140fe0',
+              phone: '+16042140006'
+            )
+          ]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Toronto',
+            country: Countries.find_by(iso31661_alpha2: 'CA'),
+            id: '7251a46e-5e7c-4c9f-81cf-1b9ff1061587',
+            postal_code: 'M8W 1Z7',
+            region_abbreviation: 'ON',
+            street: '355 Horner Ave'
+          )
+        end
+
+        def id = 'd90c6453-9f49-471b-afe4-18c79e5e9c98'
+        def legal_name = '669779 Ontario Ltd'
+        def name = 'CSA Transportation'
+        def us_dot_number = 1_526_989
+        def us_mc_number = 569_538
+        def website_url = 'https://www.csatransportation.com'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/csx_transportation.rb

@@ -0,0 +1,40 @@
+module FreightKit
+  module Carriers
+    class CSXTransportation < Carrier
+      class << self
+        def check_mailing_addresses
+          [
+            Address.new(
+              city: 'Atlanta',
+              country: Countries.find_by(iso31661_alpha2: 'US'),
+              id: 'c9210256-1316-41e9-8ff6-23b94f52f6a9',
+              postal_code: '30353',
+              region_abbreviation: 'GA',
+              street: 'PO Box 532601'
+            )
+          ]
+        end
+
+        def contacts
+          [Contact.new(department: 'Main', id: '46196ba3-6636-414d-8b07-cc83c99ce960', phone: '+18002320144')]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Jacksonville',
+            country: Countries.find_by(iso31661_alpha2: 'US'),
+            id: 'd720e677-7499-4c8e-af96-3163ccf248f5',
+            postal_code: '32202-4423',
+            region_abbreviation: 'FL',
+            street: '500 Water St'
+          )
+        end
+
+        def id = '0d9f649c-c591-4d49-b50d-b1029dd67086'
+        def legal_name = 'CSX Transportation Inc'
+        def name = 'CSX Transportation'
+        def us_dot_number = 29_619
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/custom_global_logistics.rb

@@ -0,0 +1,14 @@
+module FreightKit
+  module Carriers
+    class CustomGlobalLogistics < Carrier
+      class << self
+        def id = 'a1a410c9-0a21-41f6-8dfe-28aa43930b45'
+        def legal_name = 'Custom Global Logistics, LLC'
+        def name = 'Custom Global Logistics'
+        def scac = 'CGLA'
+        def us_dot_number = 2_227_976
+        def us_mc_number = 410_857
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/d_and_a_transport.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DAndATransport < Carrier
+      class << self
+        def id = '9430b06d-18f0-460f-868f-c6cb7d914687'
+        def name = 'D&A Transport'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/dak_transport.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DAKTransport < Carrier
+      class << self
+        def id = 'b5e8e4c0-5f8a-4e82-ba06-4195402ced16'
+        def name = 'DAK Transport'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/dash_courier_and_logistics_north_carolina.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DashCourierAndLogisticsNorthCarolina < Carrier
+      class << self
+        def id = '6036027d-2ea4-47e7-aab8-1d2eba12d77c'
+        def name = 'Dash Courier & Logistics (North Carolina)'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/daylight_transport.rb

@@ -0,0 +1,29 @@
+module FreightKit
+  module Carriers
+    class DaylightTransport < Carrier
+      class << self
+        def contacts
+          [Contact.new(department: 'Main', id: '5a5258d8-4353-4e94-bde2-105cc3143099', phone: '+18004689999')]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Cypress',
+            country: Countries.find_by(iso31661_alpha2: 'US'),
+            id: 'abb2048d-eef6-472c-b6a0-be0567f1203f',
+            postal_code: '90630',
+            region_abbreviation: 'CA',
+            street: '5660 Katella Ave Suite 250'
+          )
+        end
+
+        def id = '1ae7d8cc-725c-4043-bb7a-3e61821dbe10'
+        def legal_name = 'Daylight Transport LLC'
+        def name = 'Daylight Transport'
+        def scac = 'DYLT'
+        def us_dot_number = 898_079
+        def us_mc_number = 390_739
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/dayton_freight_lines.rb

@@ -0,0 +1,30 @@
+module FreightKit
+  module Carriers
+    class DaytonFreightLines < Carrier
+      class << self
+        def contacts
+          [Contact.new(department: 'Main', id: 'cb9c576e-e525-4254-90e0-190057a9d5eb', phone: '+19372644060')]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Dayton',
+            country: Countries.find_by(iso31661_alpha2: 'US'),
+            id: '619636dd-3364-462b-a71c-a243f37b430a',
+            postal_code: '45414',
+            region_abbreviation: 'OH',
+            street: '6450 Poe Ave Suite 311'
+          )
+        end
+
+        def id = '5b843d67-3fb7-4758-8f57-67f499f1d084'
+        def legal_name = 'Dayton Freight Lines Inc'
+        def name = 'Dayton Freight Lines'
+        def scac = 'DAFG'
+        def us_dot_number = 273_301
+        def us_mc_number = 189_528
+        def website_url = 'https://daytonfreight.com'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/dbr_logistics.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DBRLogistics < Carrier
+      class << self
+        def id = '51051ff4-d370-4b94-9e8e-6d2eb0a56ce8'
+        def name = 'DBR Logistics'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/deep_south_freight.rb

@@ -0,0 +1,27 @@
+module FreightKit
+  module Carriers
+    class DeepSouthFreight < Carrier
+      class << self
+        def contacts
+          [Contact.new(department: 'Main', id: '5058bfcb-9d63-405a-8563-edc8de55df0a', phone: '+12053260490')]
+        end
+
+        def headquarters
+          Address.new(
+            city: 'Birmingham',
+            country: Countries.find_by(iso31661_alpha2: 'US'),
+            id: 'c796119c-02d6-4a82-9de6-e3b8ba80b310',
+            postal_code: '35204',
+            region_abbreviation: 'AL',
+            street: '2221 17th Street North'
+          )
+        end
+
+        def id = 'f5d46839-6f1d-43be-94ef-1fda3e0b2b22'
+        def legal_name = 'Tvs Inc'
+        def name = 'Deep South Freight'
+        def us_dot_number = 273_403
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/delta_express.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DeltaExpress < Carrier
+      class << self
+        def id = 'd302e108-0beb-4048-a39f-4f13810b379b'
+        def name = 'Delta Express'
+      end
+    end
+  end
+end

data/lib/freight_kit/carriers/delta_transport.rb

@@ -0,0 +1,10 @@
+module FreightKit
+  module Carriers
+    class DeltaTransport < Carrier
+      class << self
+        def id = 'ae0e1479-e59b-4874-8179-6891f0c17e16'
+        def name = 'Delta Transport'
+      end
+    end
+  end
+end