freight_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 832f852aa2321263f0360b108b76090bff3d5555da249ce75852c1b31a616fdc
+  data.tar.gz: f8c416a68c5ae57c52bad4618da2962a4d59e0b8df8f0c6aa74d2396a7b9a29e
+SHA512:
+  metadata.gz: da55cd2f0f21e3741ed674e075d88e1693d62dfc45fb0a32a79f2e58f6defb15928ee686ff13207d266c8ece846ff643c5e7d0d731430c8b5685173911806ea4
+  data.tar.gz: eb616c1fd02a6c104153b4fd0fd0d191c0144c86815e299866c0b255c9d050b50454c27a62589e2cc9f4f1b456e9a409d7a04e5ca08301f82707bf517be0c775

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,201 @@
+PATH
+  remote: .
+  specs:
+    freight_kit (0.1.0)
+      active_utils (~> 3.3.1)
+      activemodel (>= 4.2, < 7.0.8)
+      activesupport (>= 4.2, < 7.0.8)
+      httparty (~> 0.10)
+      measured (>= 2.0, < 2.8.3)
+      mimemagic (~> 0.4.3)
+      nokogiri (>= 1.6, < 1.14)
+      place_kit (~> 0.0.1)
+      savon (>= 2.0, < 2.13)
+      watir (>= 7.0, < 7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_utils (3.3.19)
+      activesupport (>= 4.2)
+      i18n
+    activemodel (7.0.7)
+      activesupport (= 7.0.7)
+    activesupport (7.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ansi (1.5.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    builder (3.2.4)
+    business_time (0.11.0)
+      activesupport (>= 3.2.0)
+      sorted_set
+      tzinfo
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    fastcsv (0.0.7)
+    gyoku (1.4.0)
+      builder (>= 2.1.2)
+      rexml (~> 3.0)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    httpi (2.5.0)
+      rack
+      socksify
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    measured (2.8.2)
+      activesupport (>= 5.2)
+    method_source (1.0.0)
+    mimemagic (0.4.3)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.4)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.13.0)
+    multi_xml (0.6.0)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nori (2.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    place_kit (0.0.1)
+      activesupport (>= 6.0.0, < 7.1)
+      fastcsv (~> 0.0.6)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbtree (0.4.6)
+    redcarpet (3.5.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-graphql (1.4.0)
+      rubocop (>= 0.90, < 2)
+    rubocop-next (1.0.3)
+      rubocop (~> 1.56.0)
+      rubocop-graphql (~> 1.4.0)
+      rubocop-rails (~> 2.20.2)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.23.2)
+      rubocop-shopify (~> 2.14.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    selenium-webdriver (4.11.0)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    set (1.0.3)
+    socksify (1.7.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    timecop (0.9.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    wasabi (3.7.0)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    watir (7.1.0)
+      regexp_parser (>= 1.2, < 3)
+      selenium-webdriver (~> 4.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    websocket (1.2.9)
+    yard (0.9.34)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  business_time (~> 0.11.0)
+  freight_kit!
+  minitest (~> 5.15.0)
+  minitest-reporters (~> 1.5.0)
+  mocha (~> 1.13.0)
+  pry (~> 0.13.1)
+  pry-byebug (~> 3.9.0)
+  rake (~> 13.0.3)
+  redcarpet (~> 3.5.1)
+  rubocop-next (~> 1.0.3)
+  timecop (~> 0.9.4)
+  vcr (~> 6.1.0)
+  webmock (~> 3.14.0)
+  yard (~> 0.9.28)
+
+BUNDLED WITH
+   2.4.19

data/MIT-LICENSE

@@ -0,0 +1,31 @@
+Portions of this project are © 2016 Shopify from project
+ActiveShipping.
+
+Portions of this project are © 2018 Sub Pop Records from project
+RectiveShipping.
+
+Portions of this project are © 2020 Brody Hoskins from project ReactiveFreight.
+
+Portions of this project are © 2021 Brody Hoskins from project HyperCarrier.
+
+Copyright for all later portions this project are held by Third Party Logistics
+Management Systems LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# FreightKit
+
+This library interfaces with the web services of various shipping carriers. The goal is to abstract the features that are most frequently used into a pleasant and consistent Ruby API.
+
+FreightKit supports:
+
+- Downloading scanned documents
+- Finding shipping rates
+- Tracking shipments
+
+On a technical level it supports:
+
+- Abstracted accessorials
+- Abstracted tracking events
+- Cubic feet and density calculations
+- Freight class calculations (and manual overriding)
+
+## Definitions
+
+Carrier: Has unique web services pertaining to whatever real-world services they provide.
+
+Platform: Provides web-accessible services for many carriers at once.
+
+__Note:__ `Carrier`s may extend `Platform`s and override them when their behavior differs from the `Platform`.
+
+## Plug-in System
+
+FreightKit relies on plug-ins (gems) to define how it connects to individual `Carrier`s and `Platform`s.
+
+## Installation
+
+Using bundler, add to the `Gemfile`:
+
+```ruby
+gem 'freight_kit'
+```
+
+Or standalone:
+
+```
+$ gem install freight_kit
+```
+
+__Note__: Plug-ins are required to connect to `Carrier`s and `Platforms` (see above).
+
+## Standard Usage
+
+Start off by initializing the `Carrier` provided by a `Carrier` plug-in:
+
+```ruby
+require 'freight_kit'
+
+# Typically just one `Credential` is required
+credentials = [
+  FreightKit::Credential.new(
+    type: :api,
+    account: 'account_number',
+    username: 'username',
+    password: 'password',
+    tariff: FreightKit::Tariff.new # optional
+  ),
+  FreightKit::Credential.new(
+    type: :oauth2,
+    access_token: 'token',
+    expires_at: DateTime.current + 1.day, # DateTime
+    scope: 'scope'
+  ),
+  FreightKit::Credential.new(
+    type: :website,
+    username: 'username',
+    password: 'password'
+  ),
+  FreightKit::Credential.new(
+    type: :selenoid,
+    base_url: URI.parse('http://domain:4444'),
+    browser: :chrome
+  )
+]
+
+carrier = FreightKit::SCAC.new(credentials)
+```
+
+### Documents
+
+```ruby
+carrier.bol(tracking_number) # BOL generated by carrier
+carrier.scanned_bol(tracking_number) # BOL scanned by carrier
+
+carrier.pod(tracking_number)
+```
+
+### Tracking
+
+```ruby
+tracking = carrier.find_tracking_info(tracking_number)
+
+tracking.delivered?
+tracking.status
+
+tracking.shipment_events.each do |event|
+  puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
+end
+```
+
+### Quoting
+
+```ruby
+packages = [
+  FreightKit::Package.new(
+    371 * 16, # 371 lbs
+    {
+      length: 40, # inches
+      width: 48,
+      height: 47
+    },
+    units: :imperial
+  ),
+  FreightKit::Package.new(
+    371 * 16, # 371 lbs
+    {
+      length: 40, # inches
+      width: 48,
+      height: 47
+    },
+    freight_class: 125, # override calculated freight class
+    units: :imperial
+  )
+]
+
+origin = FreightKit::Location.new(
+  country: 'US',
+  state: 'CA',
+  city: 'Los Angeles',
+  zip: '90001'
+)
+
+destination = FreightKit::Location.new(
+  country: 'US',
+  state: 'IL',
+  city: 'Chicago',
+  zip: '60007'
+)
+
+accessorials = %i[
+  appointment_delivery
+  liftgate_delivery
+  residential_delivery
+]
+
+response = carrier.find_rates(origin, destination, packages, accessorials: accessorials)
+rates = response.rates
+rates = response.rates.sort_by(&:price).collect { |rate| [rate.service_name, rate.price] }
+```

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/accessorial_symbols.txt

@@ -0,0 +1,95 @@
+:afterhours_delivery
+:afterhours_pickup
+:airport_delivery
+:airport_pickup
+:amusement_park_delivery
+:amusement_park_pickup
+:appointment_delivery
+:appointment_pickup
+:athletic_facility_delivery
+:athletic_facility_pickup
+:brewery_delivery
+:brewery_pickup
+:cemetery_delivery
+:cemetery_pickup
+:church_delivery
+:church_pickup
+:construction_delivery
+:construction_pickup
+:convention_delivery
+:convention_pickup
+:customs_brokerage
+:dock_dropoff
+:dock_pickup
+:driver_assist
+:early_morning_delivery
+:early_morning_pickup
+:fair_delivery
+:fair_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
+:grocery_warehouse_delivery
+:grocery_warehouse_pickup
+:guaranteed_delivery
+:guaranteed_delivery_am
+:guaranteed_delivery_pm
+:hospital_delivery
+:hospital_pickup
+:hotel_delivery
+:hotel_pickup
+:inside_delivery
+:inside_pickup
+:inspection_site_delivery
+:inspection_site_pickup
+:jobsite_delivery
+:jobsite_pickup
+:liftgate_delivery
+:liftgate_pickup
+:mall_delivery
+:mall_pickup
+:marina_delivery
+:marina_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
+:residential_delivery
+:residential_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
+:winery_delivery
+:winery_pickup

data/freight_kit.gemspec

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+version = File.read(File.expand_path('VERSION', __dir__)).strip.freeze
+
+Gem::Specification.new do |spec|
+  spec.name = 'freight_kit'
+  spec.version = version
+
+  spec.authors = [
+                   'Third Party Transportation Systems LLC',
+                   'Brody Hoskins',
+                   'Sub Pop Records',
+                   'Shopify',
+                 ]
+  spec.email = [
+                 'hello@next-tms.com',
+                 'brody@brody.digital',
+                 'webmaster@subpop.com',
+                 'integrations-team@shopify.com',
+               ]
+
+  spec.description = 'Freight carrier API and website abstraction library for transportation management systems (TMS)'
+  spec.homepage = 'https://github.com/next-tms/freight_kit'
+  spec.summary = spec.description
+
+  spec.files = Dir['lib/**/*'] +
+               Dir['[A-Z]*'] +
+               Dir['test/**/*']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('business_time', '~> 0.11.0')
+  spec.add_development_dependency('minitest', '~> 5.15.0')
+  spec.add_development_dependency('minitest-reporters', '~> 1.5.0')
+  spec.add_development_dependency('mocha', '~> 1.13.0')
+  spec.add_development_dependency('pry', '~> 0.13.1')
+  spec.add_development_dependency('pry-byebug', '~> 3.9.0')
+  spec.add_development_dependency('rake', '~> 13.0.3')
+  spec.add_development_dependency('rubocop-next', '~> 1.0.3')
+  spec.add_development_dependency('timecop', '~> 0.9.4')
+  spec.add_development_dependency('vcr', '~> 6.1.0')
+  spec.add_development_dependency('webmock', '~> 3.14.0')
+
+  spec.add_development_dependency('redcarpet', '~> 3.5.1') # for yard
+  spec.add_development_dependency('yard', '~> 0.9.28')
+
+  spec.add_dependency('activemodel', '>= 4.2', '< 7.0.8')
+  spec.add_dependency('activesupport', '>= 4.2', '< 7.0.8')
+  spec.add_dependency('active_utils', '~> 3.3.1')
+  spec.add_dependency('httparty', '~> 0.10')
+  spec.add_dependency('measured', '>= 2.0', '< 2.8.3')
+  spec.add_dependency('mimemagic', '~> 0.4.3')
+  spec.add_dependency('nokogiri', '>= 1.6', '< 1.14')
+  spec.add_dependency('place_kit', '~> 0.0.1')
+  spec.add_dependency('savon', '>= 2.0', '< 2.13')
+  spec.add_dependency('watir', '>= 7.0', '< 7.2')
+
+  spec.required_ruby_version = '>= 3.2.0'
+end