odfl 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 402041458682d35a2ded22ee864eb0c1629d6cea
-  data.tar.gz: 587ac0e9c0f868a791fe1d66662b876582b0a9ee
+  metadata.gz: a30fc4c7716e4880cd056dd66644da31b423f577
+  data.tar.gz: 567fbdde1e965fab69de0fc2bf5a83d4941ab1e2
 SHA512:
-  metadata.gz: dabcd7d96110493778034ba33a2e4049fc44691010c171b446dc9e30c41364ace0b3a469174d1241d9406cc3744297af69652122c3f6cc4dd031f209c61ab975
-  data.tar.gz: ea57142ae55a0763f4ee78fdbe3108914afd8c582340363e5ac883e0be96bad466f6052a46e947620ca1a90525956f3f3a9cecc2ac8db8cc794c6b7cf190f1b3
+  metadata.gz: 3711ce543943439d54172926c2c9847fcf99c4463a4e292439163741903691ab830004415627360eb4d70117ec2ea69267c49a83c746a7407fc74cd4c4be3ada
+  data.tar.gz: 8e09d32f020b5e80cfc4f86aa83527102013b5b0b587338126218e9760a458db1f463e9cf036e261950753185249c4414503689eb22158ae14430238f5fdca16

data/.gitignore

@@ -12,4 +12,5 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.1.1
+addons:
+  code_climate:
+    repo_token: d8ad7ffd449b9dd008e83ef3c79ccd033fd726d94ff1ae3597df674bea81b3c5

data/README.md

@@ -1,6 +1,17 @@
 # Odfl
 
-TODO: Write a gem description
+Get Old Dominion Freight Line Shipping Quotes
+
+[RDoc](http://rubydoc.info/gems/odfl)
+
+[![Gem Version](https://badge.fury.io/rb/odfl.svg)](http://badge.fury.io/rb/odfl)
+[![Code Climate](https://codeclimate.com/github/rmevans1/odfl-gem/badges/gpa.svg)](https://codeclimate.com/github/rmevans1/odfl-gem)
+[![Test Coverage](https://codeclimate.com/github/rmevans1/odfl-gem/badges/coverage.svg)](https://codeclimate.com/github/rmevans1/odfl-gem)
+[![Build Status](https://travis-ci.org/rmevans1/odfl-gem.svg?branch=master)](https://travis-ci.org/rmevans1/odfl-gem)
+
+The gem allows you to retrieve shipping quotes from Old Dominion Freight Line.
+A customer account is required to retrieve customer specific pricing. However,
+an odfl account is not required to run rate quotes
 
 ## Installation
 
@@ -12,7 +23,7 @@ gem 'odfl'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,12 +31,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+``` ruby
+require 'odfl'
+require 'odfl_freight'
+
+# create a new quote object
+quote = Odfl.new
+# create a new freight object
+pallet = OdflFreight.new
+
+# Set basic ODFL items for quote
+quote.set_origin(20602)
+quote.set_destination(90210)
+quote.movement = "O"
+
+# Create a basic shipment item
+pallet.ratedClass = 70
+pallet.weight = 1000
+quote.addFreight(pallet.to_hash)
+
+# Get rates
+quote.get_rates
+```
+
+### Debugging
+
+If you are having trouble getting quotes and need to see the request
+and response it can be enable with the following
+
+Attribute 1 turns logging on
+Attribute 2 sets log level to :debug
+Attribute 3 sets pretty_print_xml to true
+
+``` ruby
+quote = Odfl.new(true, :debug, true)
+```
+
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/odfl/fork )
+1. Fork it ( https://github.com/rmevans1/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
+
+## Disclaimer
+
+It is your responsibility to make sure that the quotes that are returned are accurate. I have made
+every effort possible to make sure the quotes are accurate. I assume no responsibility for any quotes
+that come back cheaper than they should.

data/lib/odfl/version.rb

@@ -1,3 +1,3 @@
 class Odfl
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/odfl.rb

@@ -4,7 +4,8 @@ require 'savon'
 class Odfl
 
   attr_reader :originPostalCode, :originCountry, :destinationPostalCode, :destinationCountry,
-              :totalCubicVolume, :cubicUnits, :pickupDateTime, :deliveryDateTime, :codAmount
+              :totalCubicVolume, :cubicUnits, :pickupDateTime, :deliveryDateTime, :codAmount,
+              :resultHash
   attr_accessor :client, :response, :request, :freight, :accessorials, :currencyFormat
 
   # 1 Character Alpha Either O (outbound) or I (inbound). Defaults to "O"
@@ -58,9 +59,9 @@ class Odfl
   # Customers first and last name
   attr_accessor :firstName, :lastName
 
-  def initialize #:notnew: stops RDoc from seeing the initialize method
+  def initialize(log = false, log_level= :debug, pretty_print_xml = false) #: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)
+                            log: log, log_level: log_level, pretty_print_xml: pretty_print_xml)
     self.freight = Array.new
     self.accessorials = Array.new
     self.tariff = 559
@@ -173,46 +174,30 @@ class Odfl
   # 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
+  # * +month+ Pickup/Delivery Month 1-12
+  # * +day+ Pickup/Delivery Day 1-31
+  # * +year+ Pickup/Delivery Year (4 digit year)
+  # * +hour+ Pickup/Delivery Hour 0-23
+  # * +minute+ Pickup/Delivery Minute 0-59
+  # * +type+ The type of time to set either "pickup" or "delivery"
   #
   # ==== Usage
   #   quote = Odfl.new
-  #   quote.setPickupDateTime(12,25,2014,12,30)
-  def setPickupDateTime(month, day, year, hour, minute)
+  #   quote.setPickupDeliveryDateTime(12,25,2014,12,30, "delivery")
+  def setPickupDeliveryDateTime(month, day, year, hour, minute, type)
     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'
+    date = "#{year}-#{month}-#{day}T#{hour}:#{minute}:#{second}"
 
-    @deliveryDateTime = "#{year}-#{month}-#{day}T#{hour}:#{minute}:#{second}"
+    if type == 'delivery'
+      @deliveryDateTime = date
+    else
+      @pickupDateTime = date
+    end
   end
 
   # Set an amount for COD
@@ -265,5 +250,33 @@ class Odfl
                                                             firstName: self.firstName,
                                                             lastName: self.lastName
                                                })
+    processResult(@response)
+
+    if @resultHash[:success] == '1'
+      true
+    else
+      false
+    end
+  end
+
+  def getOriginatingServiceCenter
+    @resultHash[:originating_service_center]
+  end
+
+  def getDestinationServiceCenter
+    @resultHash[:destination_service_center]
+  end
+
+  def get_estimate
+    @resultHash[:rate_estimate]
+  end
+
+  def get_error
+    @resultHash[:error_messages][:string]
+  end
+
+  private
+  def processResult(result)
+    @resultHash = result.to_hash[:my_rate_response]
   end
 end

data/lib/odfl_freight.rb

@@ -6,14 +6,4 @@ class OdflFreight
     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

@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_dependency 'savon', '~> 2.8'
 end

data/spec/lib/odfl_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe Odfl do
-  quote = Odfl.new
 
   it 'should set the origin zip code and country' do
+    quote = Odfl.new
     quote.set_origin(29579)
     expect(quote).not_to be_nil
     expect(quote.originPostalCode).to eq(29579)
@@ -11,6 +11,7 @@ describe Odfl do
   end
 
   it 'should set the destination zip code and country' do
+    quote = Odfl.new
     quote.set_destination(20602)
     expect(quote).not_to be_nil
     expect(quote.destinationPostalCode).to eq(20602)
@@ -18,9 +19,135 @@ describe Odfl do
   end
 
   it 'should set the movement of the shipment' do
+    quote = Odfl.new
     quote.movement = 'O'
     expect(quote).not_to be_nil
     expect(quote.movement).to eq('O')
   end
 
+  it 'should set the delivery date and time' do
+    quote = Odfl.new
+    quote.setPickupDeliveryDateTime(12,25,2014,12,30,'delivery')
+    expect(quote).not_to be_nil
+    expect(quote.deliveryDateTime).to eq('2014-12-25T12:30:00')
+  end
+
+  it 'should set the pickup date and time' do
+    quote = Odfl.new
+    quote.setPickupDeliveryDateTime(12,22,2014,12,30,'pickup')
+    expect(quote).not_to be_nil
+    expect(quote.pickupDateTime).to eq('2014-12-22T12:30:00')
+  end
+
+  it 'should add an accessorial' do
+    quote = Odfl.new
+    quote.addAccessorial('HYD')
+    expect(quote).not_to be_nil
+    expect(quote.accessorials.count).to eq(1)
+  end
+
+  it 'should not add a duplicate accessorial' do
+    quote = Odfl.new
+    quote.addAccessorial('HYD')
+    expect(quote).not_to be_nil
+    expect(quote.accessorials.count).to eq(1)
+    quote.addAccessorial('HYD')
+    expect(quote.accessorials.count).to eq(1)
+  end
+
+  it 'should set COD amount and add COD accessorial' do
+    quote = Odfl.new
+    quote.setCODAmount(1000.25)
+    expect(quote).not_to be_nil
+    expect(quote.codAmount).to eq(1000.25)
+    expect(quote.accessorials.include?('COD')).to be_truthy
+  end
+
+  it 'should set cubic volume and cubic volume units' do
+    quote = Odfl.new
+    quote.setCubicVolume(100)
+    expect(quote).not_to be_nil
+    expect(quote.totalCubicVolume).to eq(100)
+    expect(quote.cubicUnits).to eq('CF')
+  end
+
+  it 'should add a freight item' do
+    quote = Odfl.new
+    pallet = OdflFreight.new
+    pallet.ratedClass = 70
+    pallet.weight = 1000
+    quote.addFreight(pallet.to_hash)
+    expect(quote).not_to be_nil
+    expect(quote.freight.count).to eq(1)
+  end
+
+  it 'should return false for an invalid quote' do
+    quote = Odfl.new
+
+    quote.set_destination(90210)
+    result = quote.get_rates
+
+    expect(quote).not_to be_nil
+    expect(result).to be_falsey
+  end
+
+  it 'get_error function should return a string for the error message' do
+    quote = Odfl.new
+
+    quote.get_rates
+
+    expect(quote.get_error).to be_a_kind_of(String)
+  end
+
+  it 'should return a valid rate estimate for a valid quote' do
+    quote = Odfl.new
+
+    quote.set_origin(20602)
+    quote.set_destination(90210)
+
+    pallet = OdflFreight.new
+    pallet.ratedClass = 70
+    pallet.weight = 1000
+    quote.addFreight(pallet.to_hash)
+
+    result = quote.get_rates
+    expect(result).to be_truthy
+    rate = quote.get_estimate
+
+    expect(rate).to be_a_kind_of(Hash)
+
+    expect(Float(rate[:gross_freight_charge])).to be > 0
+  end
+
+  it 'should return a valid hash for originating service center' do
+    quote = Odfl.new
+    quote.set_origin(20602)
+    quote.set_destination(90210)
+
+    pallet = OdflFreight.new
+    pallet.ratedClass = 70
+    pallet.weight = 1000
+    quote.addFreight(pallet.to_hash)
+
+    result = quote.get_rates
+    expect(result).to be_truthy
+
+    expect(quote.getOriginatingServiceCenter).to be_a_kind_of(Hash)
+  end
+
+  it 'should return a valid hash for destination service center' do
+    quote = Odfl.new
+    quote.set_origin(20602)
+    quote.set_destination(90210)
+
+    pallet = OdflFreight.new
+    pallet.ratedClass = 70
+    pallet.weight = 1000
+    quote.addFreight(pallet.to_hash)
+
+    result = quote.get_rates
+    expect(result).to be_truthy
+
+    expect(quote.getDestinationServiceCenter).to be_a_kind_of(Hash)
+  end
 end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
-require 'odfl'
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'odfl'
+require 'odfl_freight'

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: odfl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-20 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'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
 - !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
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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
@@ -74,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Get freight quotes from Old Dominion Freight Line