odfl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f323ec7e95ba78efebe77045e9042a7688b05e9c
+  data.tar.gz: f3093f6feb856e80fbd44790631872dde953e8b3
+SHA512:
+  metadata.gz: 895f2bc15695ce1effdd72b089744976abee8b5c67fe40186a12b1da78f51276d742ee1fdd44b2c651df46fe6abce456c746687ba7721508ca012a39209b18eb
+  data.tar.gz: f9e95ea14cc4b2b8a9d81abef3f096b5705c75b3b83a9f49cf3cddbcd538c204f3f4fca8733f570ef114f196efed48d355676658670c909625bbc30f416c86f5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/.idea
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in odfl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Evans
+
+MIT License
+
+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,31 @@
+# Odfl
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'odfl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odfl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/odfl/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/odfl.rb

@@ -0,0 +1,269 @@
+require "odfl/version"
+require 'savon'
+
+class Odfl
+
+  attr_reader :originPostalCode, :originCountry, :destinationPostalCode, :destinationCountry,
+              :totalCubicVolume, :cubicUnits, :pickupDateTime, :deliveryDateTime, :codAmount
+  attr_accessor :client, :response, :request, :freight, :accessorials, :currencyFormat
+
+  # 1 Character Alpha Either O (outbound) or I (inbound). Defaults to "O"
+  attr_accessor :movement
+  # Required for ODFL Customer Account Pricing
+  attr_accessor :odfl4MeUser, :odfl4MePassword, :odflCustomerAccount
+  # Tariff Code for Quote Request
+  # Defaults to 559
+  #
+  # ==== Acceptable values
+  # * *559* Standard LTL (default)
+  # * *698* Security Divider- Requires Linear Feet
+  # * *688* Household Services Home Move
+  attr_accessor :tariff
+  # Mexico Service Center
+  # Use for shipments to and from mexico
+  #
+  # ==== Acceptable values
+  # * *TUS* Tulsa AZ
+  # * *LRD* Laredo TX
+  attr_accessor :mexicoServiceCenter
+  # Get a reference number for the current quote request
+  # Only use if you are actually planning to ship
+  attr_accessor :requestReferenceNumber
+  # Set the weight units
+  # Defaults to LBS for pounds
+  attr_accessor :weightUnits
+  # Set the linear feet
+  # Required for tariff 698- Security Divider
+  attr_accessor :linearFeet
+  # Number of stackable pallets
+  attr_accessor :numberStackablePallets
+  # Shipment Type
+  # Defaults to LTL with optional guaranteed returned
+  #
+  # ==== Acceptable Values
+  # * *LTL* Standard LTL rate only returned
+  # * *GTD* Guaranteed rate only returned
+  # * *GTO* Expedited delivery rate returned (requires pickup and delivery date/time)
+  attr_accessor :shipType
+  # Insurance amount
+  # Required for IND or INH accessorials
+  attr_accessor :insuranceAmount
+  # Number of Loose Pieces
+  attr_accessor :loosePieces
+  # Customer Email Address
+  attr_accessor :email
+  # Send email offers to customer
+  # Defaults to false
+  attr_accessor :sendEmailOffers
+  # Customers first and last name
+  attr_accessor :firstName, :lastName
+
+  def initialize #:notnew: stops RDoc from seeing the initialize method
+    @client = Savon.client(wsdl: 'https://www.odfl.com/wsRate_v3/services/Rate/wsdl/Rate.wsdl', ssl_verify_mode: :none,
+                            log: true, log_level: :debug, pretty_print_xml: true)
+    self.freight = Array.new
+    self.accessorials = Array.new
+    self.tariff = 559
+    self.currencyFormat = "USD"
+    self.requestReferenceNumber = false
+    self.weightUnits = "LBS"
+    self.sendEmailOffers = false
+  end
+
+  # Allows the user to set the origin zip and country of the shipment
+  #
+  # ==== Attributes
+  # * +zip+ - the zip code of the shipment origin
+  # * +country+ - the country of the shipment origin defaults to USA
+  #
+  # ==== Usage
+  #
+  # 1. Example usage 2
+  #   quote = Odfl.new
+  #   quote.set_origin(20602)
+  # 2. Example usage 2
+  #   quote = Odfl.new
+  #   quote.set_origin(90210, "USA")
+  def set_origin(zip, country = "USA")
+    @originPostalCode = zip
+    @originCountry = country
+  end
+
+  # Allows the user to set the destination zip and country of the shipment
+  #
+  # ==== Attributes
+  # * +zip+ - the zip code of the shipment destination
+  # * +country+ - the country of the shipment destination defaults to USA
+  #
+  # ==== Usage
+  #
+  # 1. Example Usage 1
+  #   quote = Odfl.new
+  #   quote.set_destination(20602)
+  # 2. Example Usage 2
+  #   quote = Odfl.new
+  #   quote.set_destination(90210, "USA")
+  def set_destination(zip, country="USA")
+    @destinationPostalCode = zip
+    @destinationCountry = country
+  end
+
+  # Adds freight items to the current quote
+  # *Note:* Either before or during the addFreight call
+  # you must call the to_hash method on the freight object
+  #
+  # ==== Usage
+  #   quote = Odfl.new
+  #   quote.addFreight(pallet.to_hash)
+  def addFreight(pallet)
+    self.freight.push(pallet)
+  end
+
+  # Allows the user to add additional services also called accessorials
+  #
+  # ==== Valid Options
+  # * *ARN* Arrival Notification
+  # * *HYD* Lift Gate Service
+  # * *COD* COD - Requires COD Amount
+  # * *CA* Appointment
+  # * *IND* Insurance- Requires Insurance Amount
+  # * *IDC* Inside Pickup/Delivery
+  # * *OVL* Overlength Article- 12' but less than 20'
+  # * *RDC* Residential/Non-Commercial Pickup/Delivery
+  # * *CSD* Construction Site Pickup/Delivery
+  # * *CDC* Schools, Colleges, Churches Pickup/Delivery
+  # * *LDC* Secured or Limited Access Pickup/Delivery
+  # * *SWD* Self Storage Delivery
+  # * *PFF* Protect From Freezing
+  # * *HAZ* Hazardous Material
+  # * *OV2* Overlength Article - 20' to 28'
+  # * *DSM* Delivery Service to Mines
+  # * *HSO* Scale Tickets Per Military Move (Home Moves Only)
+  # * *INH* Home Move Insurance (Home Moves Only)
+  #
+  # ==== Usage
+  #   quote = Odfl.new
+  #   quote.addAccessorial("HYD")
+  def addAccessorial(accessorial)
+    if !self.accessorials.include?(accessorial)
+      self.accessorials.push(accessorial)
+    end
+  end
+
+  # Sets cubic volume for rate request
+  #
+  # ==== Attributes
+  # * +totalCubicVolume+ - the total volume of the shipment
+  # * +cubicUnits+ (optional)- the unit of measure for cubic volume defaults to CF for cubic feet
+  #
+  # ==== Usage
+  #
+  # 1. Example Usage 1
+  #   quote = Odfl.new
+  #   quote.setCubicVolume(100)
+  # 2. Example Usage 2
+  #   quote = Odfl.new
+  #   quote.setCubicVolume(100, "CF")
+  def setCubicVolume(totalCubicVolume, cubicUnits = "CF")
+    @totalCubicVolume = totalCubicVolume
+    @cubicUnits = cubicUnits
+  end
+
+  # Set the pickup date and time
+  # Required for Expedited GTO rates
+  #
+  # ==== Attributes
+  # * +month+ Pickup Month 1-12
+  # * +day+ Pickup Day 1-31
+  # * +year+ Pickup Year (4 digit year)
+  # * +hour+ Pickup Hour 0-23
+  # * +minute+ Pickup Minute 0-59
+  #
+  # ==== Usage
+  #   quote = Odfl.new
+  #   quote.setPickupDateTime(12,25,2014,12,30)
+  def setPickupDateTime(month, day, year, hour, minute)
+    month = month<10 ? "0#{month}" : "#{month}"
+    day = day<10 ? "0#{day}" : "#{day}"
+    hour = hour<10 ? "0#{hour}" : "#{hour}"
+    minute = minute<10 ? "0#{minute}" : "#{minute}"
+    second = '00'
+
+    @pickupDateTime = "#{year}-#{month}-#{day}T#{hour}:#{minute}:#{second}"
+  end
+
+  # Set the delivery date and time
+  # Required for Expedited GTO rates
+  #
+  # ==== Attributes
+  # * +month+ Delivery Month 1-12
+  # * +day+ Delivery Day 1-31
+  # * +year+ Delivery Year (4 digit year)
+  # * +hour+ Delivery Hour 0-23
+  # * +minute+ Delivery Minute 0-59
+  #
+  # ==== Usage
+  #   quote = Odfl.new
+  #   quote.setDeliveryDateTime(12,25,2014,12,30)
+  def setDeliveryDateTime(month, day, year, hour, minute)
+    month = month<10 ? "0#{month}" : "#{month}"
+    day = day<10 ? "0#{day}" : "#{day}"
+    hour = hour<10 ? "0#{hour}" : "#{hour}"
+    minute = minute<10 ? "0#{minute}" : "#{minute}"
+    second = '00'
+
+    @deliveryDateTime = "#{year}-#{month}-#{day}T#{hour}:#{minute}:#{second}"
+  end
+
+  # Set an amount for COD
+  # This will also automatically add the COD accessorial
+  #
+  # ==== Attributes
+  # * *amount* The COD amount
+  #
+  # ==== Usage
+  #   quote = Odfl.new
+  #   quote.setCODAmount(100.53)
+  def setCODAmount(amount)
+    @codAmount = amount
+    self.addAccessorial('COD')
+  end
+
+  def get_rates
+    @response = @client.call(:get_rate_estimate, message: { originPostalCode: @originPostalCode,
+                                                            originCountry: @originCountry,
+                                                            destinationPostalCode: @destinationPostalCode,
+                                                            destinationCountry: @destinationCountry,
+                                                            odfl4MeUser: self.odfl4MeUser,
+                                                            odfl4MePassword: self.odfl4MePassword,
+                                                            odflCustomerAccount: self.odflCustomerAccount,
+                                                            tariff: self.tariff,
+                                                            movement: self.movement,
+                                                            mexicoServiceCenter: self.mexicoServiceCenter,
+                                                            currencyFormat: self.currencyFormat,
+                                                            requestReferenceNumber: self.requestReferenceNumber,
+                                                            freightItems: {
+                                                                Freight: self.freight
+                                                            },
+                                                            weightUnits: self.weightUnits,
+                                                            numberPallets: self.freight.count,
+                                                            linearFeet: self.linearFeet,
+                                                            accessorials: {
+                                                                string: self.accessorials
+                                                            },
+                                                            totalCubicVolume: @totalCubicVolume,
+                                                            cubicUnits: @cubicUnits,
+                                                            numberStackablePallets: self.numberStackablePallets,
+                                                            pickupDateTime: @pickupDateTime,
+                                                            deliveryDateTime: @deliveryDateTime,
+                                                            shipType: self.shipType,
+                                                            codAmount: @codAmount,
+                                                            insuranceAmount: self.insuranceAmount,
+                                                            loosePieces: self.loosePieces,
+                                                            email: self.email,
+                                                            sendEmailOffers: self.sendEmailOffers,
+                                                            firstName: self.firstName,
+                                                            lastName: self.lastName
+                                               })
+  end
+end

data/lib/odfl/version.rb

@@ -0,0 +1,3 @@
+class Odfl
+  VERSION = "1.0.0"
+end

data/lib/odfl_freight.rb

@@ -0,0 +1,19 @@
+class OdflFreight
+  attr_accessor :ratedClass, :nmfc, :nmfcsub, :weight, :length, :width, :height, :numberOfUnits, :dimensionUnits, :actualClass
+
+  def to_hash
+    hash = {}
+    instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+    hash
+  end
+
+  def to_soap_array
+    result=Array.new
+
+    instance_variables.each do |var|
+      result.push({var.to_s.delete("@") => Integer(instance_variable_get(var))})
+    end
+
+    result
+  end
+end

data/odfl.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'odfl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "odfl"
+  spec.version       = Odfl::VERSION
+  spec.authors       = ["Robert Evans"]
+  spec.email         = ["robertevans@robertevansmb.com"]
+  spec.summary       = %q{Get freight quotes from Old Dominion Freight Line}
+  spec.description   = %q{Get freight quotes form ODFL. A valid odfl account is required.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  
+  spec.add_dependency 'savon'
+end

data/spec/lib/odfl_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Odfl do
+  quote = Odfl.new
+
+  it 'should set the origin zip code and country' do
+    quote.set_origin(29579)
+    expect(quote).not_to be_nil
+    expect(quote.originPostalCode).to eq(29579)
+    expect(quote.originCountry).to eq('USA')
+  end
+
+  it 'should set the destination zip code and country' do
+    quote.set_destination(20602)
+    expect(quote).not_to be_nil
+    expect(quote.destinationPostalCode).to eq(20602)
+    expect(quote.destinationCountry).to eq('USA')
+  end
+
+  it 'should set the movement of the shipment' do
+    quote.movement = 'O'
+    expect(quote).not_to be_nil
+    expect(quote.movement).to eq('O')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'odfl'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: odfl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get freight quotes form ODFL. A valid odfl account is required.
+email:
+- robertevans@robertevansmb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/odfl.rb
+- lib/odfl/version.rb
+- lib/odfl_freight.rb
+- odfl.gemspec
+- spec/lib/odfl_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Get freight quotes from Old Dominion Freight Line
+test_files:
+- spec/lib/odfl_spec.rb
+- spec/spec_helper.rb