active_shipping 1.8.6 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5f2cfecba695cbe25301c9243cef963e973709a
-  data.tar.gz: 918729e4323f336d6a8200756ddc139e1cd4e3e7
+  metadata.gz: 462841bf0a8057af2ff59f22965770b482a0007b
+  data.tar.gz: 8676403cf4ddf74d4841c2c3df5c25662dad8255
 SHA512:
-  metadata.gz: aaf1f5071b74e714997db24d095b38cd04dd92e06fe75ce6dbda35ec36b0c854a82c261fdd8a14b5578d64b562bf93a25cdf5ddce02654fdb947dab1ae10cf1c
-  data.tar.gz: eff96dd47c928524bd3f6d7e15617a04a6e30d10f79c684913d5a25d1e858f53cd3be81a61af8bc5a17bd53c2b8588851d3022d5317cffd8ca9c28e832369dc8
+  metadata.gz: 471ff19c9a74e5eb738fb560286e8af4a818d07f66b4258b0d4ec9c62879f38596b50a446de079eb286969a7e2d99fd3daa35c36acf8cc0f145c4cb3c148a70b
+  data.tar.gz: 99b1b6508cde41566cdc8c7b0dd89fa272856b4c1688bd380b83dcd90720a8b98e1ea6160a80a75add005ca9af04132c357f4083bedd41db34813e67d824a5f4

data/.travis.yml

@@ -9,18 +9,23 @@ rvm:
 - "2.3.1"
 
 gemfile:
-- Gemfile.activesupport32
-- Gemfile.activesupport40
-- Gemfile.activesupport41
-- Gemfile.activesupport42
-- Gemfile.activesupport50
+- gemfiles/activesupport32.gemfile
+- gemfiles/activesupport40.gemfile
+- gemfiles/activesupport41.gemfile
+- gemfiles/activesupport42.gemfile
+- gemfiles/activesupport50.gemfile
+- gemfiles/activesupport_master.gemfile
 
 matrix:
   exclude:
     - rvm: "2.0"
-      gemfile: Gemfile.activesupport50
+      gemfile: gemfiles/activesupport50.gemfile
+    - rvm: "2.0"
+      gemfile: gemfiles/activesupport_master.gemfile
+    - rvm: "2.1"
+      gemfile: gemfiles/activesupport50.gemfile
     - rvm: "2.1"
-      gemfile: Gemfile.activesupport50
+      gemfile: gemfiles/activesupport_master.gemfile
 
 env:
   global:

data/CONTRIBUTING.md

@@ -1,45 +1,21 @@
 # Contributing to ActiveShipping
 
-We welcome fixes and additions to this project. Fork this project, make your changes and submit a pull request!
+We love receiving pull requests! Anything from new carriers to documentation fixes.
 
-### Code style
+## Standards
 
-Please use clean, concise code that follows Ruby community standards. For example:
+* PR should explain what the feature does, and why the change exists.
+* PR should include any carrier specific documentation explaining how it works.
+* Code _must_ be tested, including both unit and remote tests where applicable.
+* Be consistent. Write clean code that follows [Ruby community standards](https://github.com/bbatsov/ruby-style-guide).
+* Code should be generic and reusable.
 
-- Be consistent
-- Don't use too much white space
-  - Use 2 space indent, no tabs.
-  - No spaces after `(`, `[` and before `]`, `)`
-- Nor too little
-  - Use spaces around operators and after commas, colons and semicolons
-  - Indent when as deep as case
-- Write lucid code in lieu of adding comments
+If you're stuck, ask questions!
 
-### Pull request guidelines
+## How to contribute
 
-- Add unit tests, and remote tests to make sure we won't introduce regressions to your code later on.
-- Make sure CI passes for all Ruby versions and dependency versions we support.
-- XML handling: use `Nokogiri.XML` for parsing XML, and `Nokogiri::XML::Builder` to generate it.
-- JSON: use the JSON module that is included in Rubys standard ibrary
-- HTTP: use `ActiveUtils`'s `PostsData`.
-- Do not add new gem dependencies.
-
-### Contributors
-
-- James MacAulay (<http://jmacaulay.net>)
-- Tobias Luetke (<http://blog.leetsoft.com>)
-- Cody Fauser (<http://codyfauser.com>)
-- Jimmy Baker (<http://jimmyville.com/>)
-- William Lang (<http://williamlang.net/>)
-- Cameron Fowler
-- Christopher Saunders (<http://christophersaunders.ca>)
-- Denis Odorcic
-- Dennis O'Connor
-- Dennis Theisen
-- Edward Ocampo-Gooding
-- Isaac Kearse
-- John Duff
-- Nigel Ramsay
-- Philip Arndt
-- Vikram Oberoi
-- Willem van Bergen
+1. Fork it ( https://github.com/Shopify/active_shipping/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/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 James MacAulay
+Copyright (c) 2016 Shopify
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -7,10 +7,8 @@ This library interfaces with the web services of various shipping carriers. The
 - Tracking shipments
 - Purchasing shipping labels
 
-Active Shipping is currently being used and improved in a production environment for [Shopify][]. Development is being done by the Shopify integrations team (<integrations-team@shopify.com>). Discussion is welcome in the [Active Merchant Google Group][discuss].
+Active Shipping is currently being used and improved in a production environment for [Shopify](http://shopify.com).
 
-[Shopify]:http://www.shopify.com
-[discuss]:http://groups.google.com/group/activemerchant
 
 ## Supported Shipping Carriers
 
@@ -25,13 +23,28 @@ Active Shipping is currently being used and improved in a production environment
 * [Kunaki](http://www.kunaki.com)
 * [Australia Post](http://auspost.com.au/)
 
+
+## Versions
+
+Development on `master` is for a pre-release of the `2.x` version of this gem. It includes a number of backwards incompatible changes and improvements. Progress can be tracked in [the milestone](https://github.com/Shopify/active_shipping/milestone/1).
+
+We are no longer actively developing version `1.x`. We have released `1.9` and will only backport small fixes to this version, on branch `1-9-stable`, and they should be on `master` first.
+
+
 ## Installation
 
+Using bundler, add to the `Gemfile`:
+
 ```ruby
-gem install active_shipping
+gem 'active_shipping'
+```
+
+Or stand alone:
+
+```
+$ gem install active_shipping
 ```
 
-...or add it to your project's [Gemfile](http://bundler.io/).
 
 ## Sample Usage
 
@@ -86,6 +99,8 @@ packages = [
  #     ["USPS Global Express Guaranteed", 9400]]
 ```
 
+Dimensions for packages are in `Height x Width x Length` order.
+
 ### Track a FedEx package
 
 ```ruby
@@ -104,40 +119,62 @@ end
 # Delivered at Knoxville, TN on Fri Oct 24 16:45:00 UTC 2008. Signed for by: T.BAKER
 ```
 
-#### FedEx connection notes
+## Carrier specific notes
+
+### FedEx connection
+
+The `:login` key passed to `ActiveShipping::FedEx.new()` is really the FedEx meter number, not the FedEx login.
+
+When developing with test credentials, be sure to pass `test: true` to `ActiveShipping::FedEx.new()`.
+
+
+## Tests
+
+You can run the unit tests with:
+
+```
+bundle exec rake test:unit
+```
+
+and the remote tests with:
+
+```
+bundle exec rake test:remote
+```
 
-The :login key passed to ```ActiveShipping::FedEx.new()``` is really the FedEx meter number, not the FedEx login.
+The unit tests mock out requests and responses so that everything runs locally, while the remote tests actually hit the carrier servers. For the remote tests, you'll need valid test credentials for any carriers' tests you want to run. The credentials should go in [`~/.active_shipping/credentials.yml`](https://github.com/Shopify/active_shipping/blob/master/test/credentials.yml). For some carriers, we have public credentials you can use for testing in `.travis.yml`. Remote tests missing credentials will be skipped.
 
-When developing with test credentials, be sure to pass ```test: true``` to ```ActiveShipping::FedEx.new()``` .
 
-## Running the tests
+## Contributing
 
-After installing dependencies with `bundle install`, you can run the unit tests with `rake test:unit` and the remote tests with `rake test:remote`. The unit tests mock out requests and responses so that everything runs locally, while the remote tests actually hit the carrier servers. For the remote tests, you'll need valid test credentials for any carriers' tests you want to run. The credentials should go in ~/.active_shipping/credentials.yml, and the format of that file can be seen in the included [credentials.yml](https://github.com/Shopify/active_shipping/blob/master/test/credentials.yml). For some carriers, we have public credentials you can use for testing: see `.travis.yml`.
+See [CONTRIBUTING.md](https://github.com/Shopify/active_shipping/blob/master/CONTRIBUTING.md).
 
-## Development
+We love getting pull requests! Anything from new features to documentation clean up.
 
-Yes, please! Take a look at the tests and the implementation of the Carrier class to see how the basics work. At some point soon there will be a carrier template generator along the lines of the gateway generator included in Active Merchant, but the [Carrier class](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/carrier.rb) outlines most of what's necessary. The other main classes that would be good to familiarize yourself with are [Location](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/location.rb), [Package](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/package.rb), and [Response](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/response.rb).
+If you're building a new carrier, a good place to start is in the [`Carrier` base class](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/carrier.rb).
 
-For the features that you add, you should have both unit tests and remote tests. It's probably best to start with the remote tests, and then log those requests and responses and use them as the mocks for the unit tests. You can see how this works with the USPS tests right now:
+It would also be good to familiarize yourself with [`Location`](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/location.rb), [`Package`](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/package.rb), and [`Response`](https://github.com/Shopify/active_shipping/blob/master/lib/active_shipping/response.rb).
 
-[https://github.com/Shopify/active_shipping/blob/master/test/remote/usps_test.rb](https://github.com/Shopify/active_shipping/blob/master/test/remote/usps_test.rb)
-[https://github.com/Shopify/active_shipping/blob/master/test/unit/carriers/usps_test.rb](https://github.com/Shopify/active_shipping/blob/master/test/unit/carriers/usps_test.rb)
-[https://github.com/Shopify/active_shipping/tree/master/test/fixtures/xml/usps](https://github.com/Shopify/active_shipping/tree/master/test/fixtures/xml/usps)
+You can use the [`test/console.rb`](https://github.com/Shopify/active_shipping/blob/master/test/console.rb) to do some local testing against real endpoints.
 
 To log requests and responses, just set the `logger` on your Carrier class to some kind of `Logger` object:
 
 ```ruby
-ActiveShipping::USPS.logger = Logger.new($stdout)
+ActiveShipping::USPS.logger = Logger.new(STDOUT)
 ```
 
-(This logging functionality is provided by the [`PostsData` module](https://github.com/Shopify/active_utils/blob/master/lib/active_utils/posts_data.rb) in the `active_utils` dependency.)
+### Anatomy of a pull request
+
+Any new features or carriers should have passing unit _and_ remote tests. Look at some existing carriers as examples.
+
+When opening a pull request, include description of the feature, why it exists, and any supporting documentation to explain interaction with carriers.
 
-To debug API requests and your code, you can run `rake console` to start a Pry session with `ActiveShipping` included
-and instances of the various carriers set up with your test credentials.
-Look at the file [`test/console.rb`](https://github.com/Shopify/active_shipping/blob/master/test/console.rb) to see the other goodies it provides.
 
-After you've pushed your well-tested changes to your github fork, make a pull request, and we'll take it from there! For more information, see [CONTRIBUTING.md](https://github.com/Shopify/active_shipping/blob/master/CONTRIBUTING.md).
+### How to contribute
 
-## Legal Mumbo Jumbo
+1. Fork it ( https://github.com/Shopify/active_shipping/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
 
-Unless otherwise noted in specific files, all code in the ActiveShipping project is under the copyright and license described in the included MIT-LICENSE file.

data/Rakefile

@@ -6,6 +6,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
+  t.warning = false
 end
 
 namespace :test do
@@ -14,6 +15,7 @@ namespace :test do
     t.libs << "test"
     t.pattern = 'test/unit/**/*_test.rb'
     t.verbose = true
+    t.warning = false
   end
 
   desc "Run functional remote tests"
@@ -21,6 +23,7 @@ namespace :test do
     t.libs << "test"
     t.pattern = 'test/remote/*_test.rb'
     t.verbose = true
+    t.warning = false
   end
 end
 

data/active_shipping.gemspec

@@ -1,33 +1,32 @@
-lib = File.expand_path('../lib/', __FILE__)
+lib = File.expand_path("../lib/", __FILE__)
 $:.unshift(lib) unless $:.include?(lib)
 
-require 'active_shipping/version'
+require "active_shipping/version"
 
 Gem::Specification.new do |s|
-  s.name        = "active_shipping"
-  s.version     = ActiveShipping::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["James MacAulay", "Tobi Lutke", "Cody Fauser", "Jimmy Baker"]
-  s.email       = ["james@shopify.com"]
-  s.homepage    = "http://github.com/shopify/active_shipping"
-  s.summary     = "Simple shipping abstraction library"
-  s.description = "Get rates and tracking info from various shipping carriers. Extracted from Shopify."
-  s.license     = 'MIT'
+  s.name          = "active_shipping"
+  s.version       = ActiveShipping::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Shopify"]
+  s.email         = ["integrations-team@shopify.com"]
+  s.homepage      = "http://github.com/shopify/active_shipping"
+  s.summary       = "Simple shipping abstraction library"
+  s.description   = "Get rates and tracking info from various shipping carriers. Extracted from Shopify."
+  s.license       = "MIT"
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_path  = "lib"
 
-  s.add_dependency('quantified',    '~> 1.0.1')
-  s.add_dependency('activesupport', '>= 3.2', '< 5.1.0')
-  s.add_dependency('active_utils',  '~> 3.2.0')
-  s.add_dependency('nokogiri',      '>= 1.6')
+  s.add_dependency("quantified", "~> 1.0.1")
+  s.add_dependency("activesupport", ">= 3.2", "< 5.1.0")
+  s.add_dependency("active_utils", "~> 3.2.0")
+  s.add_dependency("nokogiri", ">= 1.6")
 
-  s.add_development_dependency('minitest')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('mocha', '~> 1')
-  s.add_development_dependency('timecop')
-  s.add_development_dependency('business_time')
-  s.add_development_dependency('pry')
-
-  s.files        = `git ls-files`.split($/)
-  s.executables  = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.test_files   = s.files.grep(%r{^(test|spec|features)/})
-  s.require_path = 'lib'
+  s.add_development_dependency("minitest")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("mocha", "~> 1")
+  s.add_development_dependency("timecop")
+  s.add_development_dependency("business_time")
+  s.add_development_dependency("pry")
 end

data/{Gemfile.activesupport32 → gemfiles/activesupport32.gemfile}

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
-gemspec
+
+gemspec path: '..'
 
 gem 'activesupport', '~> 3.2.0'
 gem 'tzinfo'

data/{Gemfile.activesupport40 → gemfiles/activesupport40.gemfile}

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
-gemspec
+
+gemspec path: '..'
 
 gem 'activesupport', '~> 4.0.0'

data/{Gemfile.activesupport41 → gemfiles/activesupport41.gemfile}

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
-gemspec
+
+gemspec path: '..'
 
 gem 'activesupport', '~> 4.1.0'

data/{Gemfile.activesupport42 → gemfiles/activesupport42.gemfile}

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
-gemspec
+
+gemspec path: '..'
 
 gem 'activesupport', '~> 4.2.0'

data/{Gemfile.activesupport50 → gemfiles/activesupport50.gemfile}

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
-gemspec
+
+gemspec path: '..'
 
 gem 'activesupport', '~> 5.0.0'
 gem 'active_utils', '~> 3.2.2'

data/gemfiles/activesupport_master.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'activesupport', github: 'rails/rails'

data/lib/active_shipping.rb

@@ -1,26 +1,3 @@
-#--
-# Copyright (c) 2009 Jaded Pixel
-#
-# 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.
-#++
-
 require 'active_support/all'
 require 'active_utils'
 
@@ -34,6 +11,7 @@ require 'active_shipping/delivery_date_estimates_response'
 require 'active_shipping/shipping_response'
 require 'active_shipping/label_response'
 require 'active_shipping/label'
+require 'active_shipping/package_item'
 require 'active_shipping/package'
 require 'active_shipping/location'
 require 'active_shipping/rate_estimate'

data/lib/active_shipping/carrier.rb

@@ -1,9 +1,9 @@
 module ActiveShipping
 
-  # Carrier is abstract the base class for all supported carriers.
+  # Carrier is the abstract base class for all supported carriers.
   #
   # To implement support for a carrier, you should subclass this class and
-  # implement all the methods the carrier supports.
+  # implement all the methods that the carrier supports.
   #
   # @see #find_rates
   # @see #create_shipment
@@ -96,7 +96,7 @@ module ActiveShipping
 
     # Validate credentials with a call to the API.
     #
-    # By default this just does a `find_rates` call with the orgin and destination both as
+    # By default this just does a `find_rates` call with the origin and destination both as
     # the carrier's default_location. Override to provide alternate functionality, such as
     # checking for `test_mode` to use test servers, etc.
     #

data/lib/active_shipping/carriers/canada_post_pws.rb

@@ -1,6 +1,6 @@
 module ActiveShipping
   class CanadaPostPWS < Carrier
-    
+
     cattr_reader :name
     @@name = "Canada Post PWS"
 
@@ -569,13 +569,13 @@ module ActiveShipping
 
     def tracking_url(pin)
       case pin.length
-        when 12, 13, 16
-          endpoint + "vis/track/pin/%s/detail" % pin
-        when 15
-          endpoint + "vis/track/dnc/%s/detail" % pin
-        else
-          raise InvalidPinFormatError
-        end
+      when 12, 13, 16
+        "#{endpoint}vis/track/pin/#{pin}/detail"
+      when 15
+        "#{endpoint}vis/track/dnc/#{pin}/detail"
+      else
+        raise InvalidPinFormatError
+      end
     end
 
     def create_shipment_url(options)