freight_kit 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6580f865ed67b79e9b6c426bd519af397ff527725b8d48e74a489b42ad3bb793
-  data.tar.gz: 98b55c646d50f715d79a63ba7e0defe0a2b53d74f5d872064931b506327c0f6d
+  metadata.gz: 7357fe3d89bb6525533f590aa14998b9ed50a5ed59466534a5cc5097f98cc056
+  data.tar.gz: a0deaa40957126d1579bafb5208348882151bf463abbbc1b672996be32e03393
 SHA512:
-  metadata.gz: 1fad0c913388a085bd5d94231bc5ca1d68aaeef57a251d05a43506ef863404442fd19d7113235a78a4b556a16a0dde83070b8d5cc094d0fb07e0873810f2b4f6
-  data.tar.gz: 6637da5a16e09322598cff6e4cdeb9ef6c30b45f794504ac348d05dfee0b81e68e3c305a1975554c2c6ab7d131edc863507be0d885c850f2131fe35cb3fc057a
+  metadata.gz: 1b61b3c484f97b4da79f9ec2a501171acdd04914ea810b1167e9e644fe426fbb58ffdf36518ae8a1485663125b0f76f16ca27fb71d6448a7f15ebc691e09f477
+  data.tar.gz: 680d19347cc9999481a95972dd8cfb45e1398e64cebc5325f066ae33035d6f26ec2177290958403be7241b9ad12c4510d5e46b0522ed3480f8321b18b694c833

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    freight_kit (0.1.2)
+    freight_kit (0.1.3)
       active_utils (>= 3.3.1, < 3.5.0)
-      activemodel (>= 4.2, < 7.1.3)
+      activemodel (>= 4.2, < 7.1.4)
       activesupport (>= 4.2, < 7.1.4)
       httparty (~> 0.10)
       measured (>= 2.0, < 2.8.3)
       mimemagic (~> 0.4.3)
       nokogiri (>= 1.6, < 1.17)
-      place_kit (~> 0.0.1)
+      place_kit (~> 0.0.2)
       savon (>= 2.0, < 2.15)
       tzinfo-data (~> 1.2023, >= 1.2023.3)
-      watir (>= 7.0, < 7.2)
+      watir (>= 7.0, < 7.4)
+      zeitwerk (>= 2.6.0, < 2.6.13)
 
 GEM
   remote: https://rubygems.org/
@@ -73,8 +74,8 @@ GEM
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
-    place_kit (0.0.1)
-      activesupport (>= 6.0.0, < 7.1)
+    place_kit (0.0.2)
+      activesupport (>= 6.0.0, < 7.2)
       fastcsv (~> 0.0.6)
     public_suffix (5.0.3)
     racc (1.7.1)
@@ -82,7 +83,7 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     redcarpet (3.6.0)
-    regexp_parser (2.8.1)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -146,7 +147,7 @@ GEM
       nokogiri (>= 1.8.1)
       nori (~> 2.4)
       wasabi (~> 3.4)
-    selenium-webdriver (4.12.0)
+    selenium-webdriver (4.16.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
@@ -160,11 +161,12 @@ GEM
       addressable
       httpi (~> 2.0)
       nokogiri (>= 1.4.2)
-    watir (7.1.0)
+    watir (7.3.0)
       regexp_parser (>= 1.2, < 3)
-      selenium-webdriver (~> 4.0)
-    websocket (1.2.9)
+      selenium-webdriver (~> 4.2)
+    websocket (1.2.10)
     yard (0.9.34)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-22

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/accessorial_symbols.txt

@@ -32,6 +32,8 @@
 :fitness_center_pickup
 :flatbed_delivery
 :flatbed_pickup
+:gated_community_delivery
+:gated_community_pickup
 :golf_course_delivery
 :golf_course_pickup
 :government_delivery

data/freight_kit.gemspec

@@ -31,10 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('business_time', '~> 0.13.0')
   spec.add_development_dependency('faker', '~> 3.2.1')
   spec.add_development_dependency('rake', '~> 13.1.0')
+  spec.add_development_dependency('redcarpet', '~> 3.6.0') # for yard
   spec.add_development_dependency('rspec', '~> 3.12')
   spec.add_development_dependency('rubocop-next', '~> 1.0.3')
-
-  spec.add_development_dependency('redcarpet', '~> 3.6.0') # for yard
   spec.add_development_dependency('yard', '~> 0.9.28')
 
   spec.add_dependency('activemodel', '>= 4.2', '< 7.1.4')
@@ -44,10 +43,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency('measured', '>= 2.0', '< 2.8.3')
   spec.add_dependency('mimemagic', '~> 0.4.3')
   spec.add_dependency('nokogiri', '>= 1.6', '< 1.17')
-  spec.add_dependency('place_kit', '~> 0.0.1')
+  spec.add_dependency('place_kit', '~> 0.0.2')
   spec.add_dependency('savon', '>= 2.0', '< 2.15')
   spec.add_dependency('tzinfo-data', '~> 1.2023', '>= 1.2023.3')
-  spec.add_dependency('watir', '>= 7.0', '< 7.2')
+  spec.add_dependency('watir', '>= 7.0', '< 7.4')
+  spec.add_dependency('zeitwerk', '>= 2.6.0', '< 2.6.13')
 
   spec.required_ruby_version = '>= 3.2.0'
 end

data/lib/freight_kit/carrier.rb

@@ -98,8 +98,54 @@ module FreightKit
       def required_credential_types
         %i[api]
       end
+
+      # The template URL for tracking one of carrier's `NUMBERS` publicly. A template URL is a URL containing the token
+      # "%s" that can be replaced to generate a valid URL.
+      #
+      # This method is designed to provide a template URL for a specific tracking-related key, allowing applications to
+      # generate valid tracking URLs without involving FreightKit each time. The `key` parameter must be one of the
+      # predefined carrier number types specified in the `NUMBERS` constant.
+      #
+      # @see `NUMBERS`
+      # @param [Symbol] key The symbol representing the type of tracking information for which the template URL is
+      # needed.
+      # @raise [ArgumentError]
+      # @return [String, nil] The template URL or nil if no template is available for the given key.
+      def tracking_url_template(key)
+        raise ArgumentError, "key must be one of: #{NUMBERS.join(", ")}" if NUMBERS.exclude?(key)
+
+        "#{self}::#{key.to_s.upcase}_TRACKING_URL_TEMPLATE".constantize
+      end
+
+      # Regular expression to use for validating carrier's `NUMBERS`.
+      #
+      # Returns the regular expression used for validating the carrier's number based on the provided `key`.
+      # The `key` parameter must be one of the predefined carrier number types specified in the `NUMBERS` constant.
+      #
+      # @see `NUMBERS`
+      # @param [Symbol] key The symbol representing the carrier number type for which the regular expression is needed.
+      # @raise [ArgumentError] Raised if the provided key is not one of the specified carrier number types.
+      # @return [Regexp] The regular expression for validating the specified carrier number type.
+      def valid_number_regex(key)
+        raise ArgumentError, "key must be one of: #{NUMBERS.join(", ")}" if NUMBERS.exclude?(key)
+
+        "#{self}::VALID_#{key.to_s.upcase}_REGEX".constantize
+      end
     end
 
+    BOL_NUMBER_TRACKING_URL_TEMPLATE = nil
+    ORDER_NUMBER_TRACKING_URL_TEMPLATE = nil
+    PICKUP_NUMBER_TRACKING_URL_TEMPLATE = nil
+    PO_NUMBER_TRACKING_URL_TEMPLATE = nil
+    TRACKING_NUMBER_TRACKING_URL_TEMPLATE = nil
+    VALID_BOL_NUMBER_REGEX = nil
+    VALID_ORDER_NUMBER_REGEX = nil
+    VALID_PICKUP_NUMBER_REGEX = nil
+    VALID_PO_NUMBER_REGEX = nil
+    VALID_TRACKING_NUMBER_REGEX = nil
+
+    NUMBERS = %i[bol_number order_number pickup_number po_number tracking_number]
+
     attr_accessor :conf, :rates_with_excessive_length_fees, :tmpdir
     attr_reader :credentials, :customer_location, :last_request, :tariff
 

data/lib/freight_kit/errors/document_not_found_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class DocumentNotFoundError < FreightKit::Error; end
+  class DocumentNotFoundError < Error; end
 end

data/lib/freight_kit/errors/expired_credentials_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class ExpiredCredentialsError < FreightKit::InvalidCredentialsError; end
+  class ExpiredCredentialsError < InvalidCredentialsError; end
 end

data/lib/freight_kit/errors/http_error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class HTTPError < FreightKit::Error
+  class HTTPError < Error
     attr_reader :body, :code
 
     def initialize(body:, code:)

data/lib/freight_kit/errors/invalid_credentials_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class InvalidCredentialsError < FreightKit::Error; end
+  class InvalidCredentialsError < Error; end
 end

data/lib/freight_kit/errors/response_error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class ResponseError < FreightKit::Error
+  class ResponseError < Error
     attr_reader :response
 
     def initialize(response = nil)

data/lib/freight_kit/errors/shipment_not_found_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class ShipmentNotFoundError < FreightKit::Error; end
+  class ShipmentNotFoundError < Error; end
 end

data/lib/freight_kit/errors/unserviceable_accessorials_error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class UnserviceableAccessorialsError < FreightKit::UnserviceableError
+  class UnserviceableAccessorialsError < UnserviceableError
     attr_reader :accessorials
 
     def initialize(accessorials:)
@@ -11,7 +11,9 @@ module FreightKit
     end
 
     def message
-      @message ||= "Unable to service #{@accessorials.map { |accessorial| accessorial.to_s.gsub("_", " ") }.join(", ")}"
+      @message ||= "Unable to service #{@accessorials.map do |accessorial|
+                                          accessorial.to_s.gsub("_", " ")
+                                        end.join(", ")}"
     end
   end
 end

data/lib/freight_kit/errors/unserviceable_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreightKit
-  class UnserviceableError < FreightKit::Error; end
+  class UnserviceableError < Error; end
 end

data/lib/freight_kit.rb

@@ -3,10 +3,7 @@
 require 'active_model'
 require 'active_support/all'
 require 'active_utils'
-
 require 'cgi'
-require 'yaml'
-
 require 'httparty'
 require 'measured'
 require 'mimemagic'
@@ -15,20 +12,28 @@ require 'open-uri'
 require 'place_kit'
 require 'savon'
 require 'watir'
+require 'yaml'
+require 'zeitwerk'
+
+module FreightKit
+  VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip.freeze
+
+  class Inflector < Zeitwerk::Inflector
+    def camelize(basename, abspath)
+      if basename =~ /\Ahttp_(.*)/
+        return "HTTP#{super(::Regexp.last_match(1), abspath)}"
+      end
+
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem
+
+loader.collapse("#{__dir__}/freight_kit/errors")
+loader.collapse("#{__dir__}/freight_kit/models")
+
+loader.inflector = FreightKit::Inflector.new
 
-require 'freight_kit/error'
-require 'freight_kit/errors'
-
-require 'freight_kit/model'
-require 'freight_kit/models'
-
-require 'freight_kit/carrier'
-require 'freight_kit/carriers'
-require 'freight_kit/contact'
-require 'freight_kit/package_item'
-require 'freight_kit/package'
-require 'freight_kit/packaging'
-require 'freight_kit/platform'
-require 'freight_kit/shipment_packer'
-require 'freight_kit/tariff'
-require 'freight_kit/version'
+loader.setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freight_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Third Party Transportation Systems LLC
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: business_time
@@ -56,47 +56,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 13.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-next
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -245,14 +245,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -302,7 +302,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -312,7 +312,27 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.4'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.6.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.6.13
 description: Freight carrier API and website abstraction library for transportation
   management systems (TMS)
 email:
@@ -334,9 +354,7 @@ files:
 - lib/freight_kit.rb
 - lib/freight_kit/carrier.rb
 - lib/freight_kit/carriers.rb
-- lib/freight_kit/contact.rb
 - lib/freight_kit/error.rb
-- lib/freight_kit/errors.rb
 - lib/freight_kit/errors/document_not_found_error.rb
 - lib/freight_kit/errors/expired_credentials_error.rb
 - lib/freight_kit/errors/http_error.rb
@@ -346,7 +364,7 @@ files:
 - lib/freight_kit/errors/unserviceable_accessorials_error.rb
 - lib/freight_kit/errors/unserviceable_error.rb
 - lib/freight_kit/model.rb
-- lib/freight_kit/models.rb
+- lib/freight_kit/models/contact.rb
 - lib/freight_kit/models/credential.rb
 - lib/freight_kit/models/date_time.rb
 - lib/freight_kit/models/document_response.rb
@@ -366,7 +384,6 @@ files:
 - lib/freight_kit/platform.rb
 - lib/freight_kit/shipment_packer.rb
 - lib/freight_kit/tariff.rb
-- lib/freight_kit/version.rb
 - service_type_symbols.txt
 - shipment_event_symbols.txt
 homepage: https://github.com/next-tms/freight_kit

data/lib/freight_kit/errors.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'freight_kit/errors/http_error'
-require 'freight_kit/errors/invalid_credentials_error'
-require 'freight_kit/errors/expired_credentials_error'
-require 'freight_kit/errors/document_not_found_error'
-require 'freight_kit/errors/shipment_not_found_error'
-require 'freight_kit/errors/response_error'
-require 'freight_kit/errors/unserviceable_error'
-require 'freight_kit/errors/unserviceable_accessorials_error'

data/lib/freight_kit/models.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'freight_kit/models/credential'
-require 'freight_kit/models/label'
-require 'freight_kit/models/price'
-require 'freight_kit/models/rate'
-require 'freight_kit/models/shipment'
-
-require 'freight_kit/models/date_time'
-require 'freight_kit/models/location'
-
-require 'freight_kit/models/response'
-require 'freight_kit/models/document_response'
-require 'freight_kit/models/pickup_response'
-require 'freight_kit/models/rate_response'
-require 'freight_kit/models/shipment_event'
-require 'freight_kit/models/tracking_response'

data/lib/freight_kit/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module FreightKit
-  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
-end