workarea-core 3.4.12

data/vendor/active_shipping/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to ActiveShipping
+
+We love receiving pull requests! Anything from new carriers to documentation fixes.
+
+Also, we are looking for maintainers for the current version of ActiveShipping 2.0.
+
+## Standards
+
+* 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.
+
+If you're stuck, ask questions!
+
+## How to contribute
+
+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/vendor/active_shipping/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/vendor/active_shipping/MIT-LICENSE

@@ -0,0 +1,20 @@
+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
+"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/vendor/active_shipping/README.md

@@ -0,0 +1,163 @@
+# ActiveShipping [![Build status](https://travis-ci.org/Shopify/active_shipping.svg?branch=master)](https://travis-ci.org/Shopify/active_shipping)
+
+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:
+
+- Finding shipping rates
+- Registering shipments
+- Tracking shipments
+- Purchasing shipping labels
+
+## Supported Shipping Carriers
+
+* [USPS](http://www.usps.com)
+* [USPS Returns](http://returns.usps.com)
+* [FedEx](http://www.fedex.com)
+* [Canada Post](http://www.canadapost.ca)
+* [New Zealand Post](http://www.nzpost.co.nz)
+* [Shipwire](http://www.shipwire.com)
+* [Stamps](http://www.stamps.com)
+* [Kunaki](http://www.kunaki.com)
+* [Australia Post](http://auspost.com.au/)
+
+
+## Versions
+Note: `2.x` contains breaking changes, please see the [changelog](https://github.com/Shopify/active_shipping/blob/master/CHANGELOG.md). Shopify will not be actively contributing to the `2.x` version of this gem and is looking for maintainers.
+
+[See our releases](https://github.com/Shopify/active_shipping/releases) for past versions.
+
+## Installation
+
+Using bundler, add to the `Gemfile`:
+
+```ruby
+gem 'active_shipping'
+```
+
+Or stand alone:
+
+```
+$ gem install active_shipping
+```
+
+
+## Sample Usage
+
+### Compare rates from different carriers
+
+```ruby
+require 'active_shipping'
+
+# Package up a poster and a Wii for your nephew.
+packages = [
+  ActiveShipping::Package.new(100,               # 100 grams
+                              [93,10],           # 93 cm long, 10 cm diameter
+                              cylinder: true),   # cylinders have different volume calculations
+
+  ActiveShipping::Package.new(7.5 * 16,          # 7.5 lbs, times 16 oz/lb.
+                              [15, 10, 4.5],     # 15x10x4.5 inches
+                              units: :imperial)  # not grams, not centimetres
+ ]
+
+ # You live in Beverly Hills, he lives in Ottawa
+ origin = ActiveShipping::Location.new(country: 'US',
+                                       state: 'CA',
+                                       city: 'Beverly Hills',
+                                       zip: '90210')
+
+ destination = ActiveShipping::Location.new(country: 'CA',
+                                            province: 'ON',
+                                            city: 'Ottawa',
+                                            postal_code: 'K1P 1J1')
+
+ # Find out how much it'll be.
+ usps = ActiveShipping::USPS.new(login: 'developer-key')
+ response = usps.find_rates(origin, destination, packages)
+
+ usps_rates = response.rates.sort_by(&:price).collect {|rate| [rate.service_name, rate.price]}
+ # => [["USPS Priority Mail International", 4110],
+ #     ["USPS Express Mail International (EMS)", 5750],
+ #     ["USPS Global Express Guaranteed Non-Document Non-Rectangular", 9400],
+ #     ["USPS GXG Envelopes", 9400],
+ #     ["USPS Global Express Guaranteed Non-Document Rectangular", 9400],
+ #     ["USPS Global Express Guaranteed", 9400]]
+```
+
+Dimensions for packages are in `Height x Width x Length` order.
+
+### Track a FedEx package
+
+```ruby
+fedex = ActiveShipping::FedEx.new(login: '999999999', password: '7777777', key: '1BXXXXXXXXXxrcB', account: '51XXXXX20')
+tracking_info = fedex.find_tracking_info('tracking-number', carrier_code: 'fedex_ground') # Ground package
+
+tracking_info.shipment_events.each do |event|
+  puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
+end
+# => Package information transmitted to FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 00:00:00 UTC 2008.
+# Picked up by FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 17:30:00 UTC 2008.
+# Scanned at FedEx sort facility at NASHVILLE, TN on Thu Oct 23 18:50:00 UTC 2008.
+# Departed FedEx sort facility at NASHVILLE, TN on Thu Oct 23 22:33:00 UTC 2008.
+# Arrived at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 02:45:00 UTC 2008.
+# Scanned at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 05:56:00 UTC 2008.
+# Delivered at Knoxville, TN on Fri Oct 24 16:45:00 UTC 2008. Signed for by: T.BAKER
+```
+
+## 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 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.
+
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/Shopify/active_shipping/blob/master/CONTRIBUTING.md).
+
+We love getting pull requests! Anything from new features to documentation clean up.
+
+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).
+
+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).
+
+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)
+```
+
+### 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.
+
+
+### How to contribute
+
+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/vendor/active_shipping/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc "Run the unit and functional remote tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end
+
+namespace :test do
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+    t.warning = false
+  end
+
+  desc "Run functional remote tests"
+  Rake::TestTask.new(:remote) do |t|
+    t.libs << "test"
+    t.pattern = 'test/remote/*_test.rb'
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+desc "Open a pry session preloaded with this library"
+task :console do
+  sh 'ruby -Ilib -Itest test/console.rb'
+end
+
+task default: 'test'

data/vendor/active_shipping/active_shipping.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib/", __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require "active_shipping/version"
+
+Gem::Specification.new do |s|
+  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.post_install_message = "Thanks for installing ActiveShipping! If upgrading to v2.0, please see the changelog for breaking changes: https://github.com/Shopify/active_shipping/blob/master/CHANGELOG.md."
+
+
+  s.add_dependency("measured", ">= 2.0")
+  s.add_dependency("activesupport", ">= 4.2", "< 6.1")
+  s.add_dependency("active_utils", "~> 3.3.1")
+  s.add_dependency("nokogiri", ">= 1.6")
+
+  s.add_development_dependency("minitest")
+  s.add_development_dependency("minitest-reporters")
+  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.add_development_dependency("pry-byebug")
+  s.add_development_dependency("vcr")
+  s.add_development_dependency("webmock")
+end

data/vendor/active_shipping/dev.yml

@@ -0,0 +1,17 @@
+name: active-shipping
+
+up:
+  - ruby: 2.3.1
+  - bundler
+
+commands:
+  test:
+    syntax:
+      optional: file args...
+    desc: 'run all tests or a specific test file'
+    run: |
+      if [[ $# -eq 0 ]]; then
+        bundle exec rake test
+      else
+        bundle exec ruby -Itest "$@"
+      fi

data/vendor/active_shipping/gemfiles/activesupport42.gemfile

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

data/vendor/active_shipping/gemfiles/activesupport50.gemfile

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

data/vendor/active_shipping/gemfiles/activesupport51.gemfile

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

data/vendor/active_shipping/gemfiles/activesupport52.gemfile

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

data/vendor/active_shipping/gemfiles/activesupport_master.gemfile

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

data/vendor/active_shipping/lib/active_shipping.rb

@@ -0,0 +1,26 @@
+require 'active_support/all'
+require 'active_utils'
+
+require 'nokogiri'
+require 'measured'
+
+require 'active_shipping/response'
+require 'active_shipping/rate_response'
+require 'active_shipping/tracking_response'
+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'
+require 'active_shipping/delivery_date_estimate'
+require 'active_shipping/shipment_event'
+require 'active_shipping/shipment_packer'
+require 'active_shipping/carrier'
+require 'active_shipping/carriers'
+require 'active_shipping/errors'
+require 'active_shipping/external_return_label_request'
+require 'active_shipping/external_return_label_response'
+require 'active_shipping/address_validation_response'

data/vendor/active_shipping/lib/active_shipping/address_validation_response.rb

@@ -0,0 +1,29 @@
+module ActiveShipping
+  # Response object class for calls to {ActiveShipping::Carrier#validate_address}.
+  #
+  # @!attribute location
+  #   The Location to be validated
+  #   @return [String]
+  class AddressValidationResponse < Response
+    attr_reader :validity, :classification, :candidate_addresses, :options, :params
+
+    def initialize(success, message, params = {}, options = {})
+      @validity = options[:validity]
+      @candidate_addresses = options[:candidate_addresses]
+      @classification = options[:classification]
+      super
+    end
+
+    def address_match?
+      @validity == :valid
+    end
+
+    def residential?
+      @classification == :residential
+    end
+
+    def commercial?
+      @classification == :commercial
+    end
+  end
+end

data/vendor/active_shipping/lib/active_shipping/carrier.rb

@@ -0,0 +1,183 @@
+module ActiveShipping
+  # 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 that the carrier supports.
+  #
+  # @see #find_rates
+  # @see #create_shipment
+  # @see #cancel_shipment
+  # @see #find_tracking_info
+  #
+  # @!attribute test_mode
+  #   Whether to interact with the carrier's sandbox environment.
+  #   @return [Boolean]
+  #
+  # @!attribute last_request
+  #   The last request performed against the carrier's API.
+  #   @see #save_request
+  class Carrier
+    attr_reader :last_request
+    attr_accessor :test_mode
+    alias_method :test_mode?, :test_mode
+
+    # Credentials should be in options hash under keys :login, :password and/or :key.
+    # @param options [Hash] The details needed to connect to the carrier's API.
+    # @option options [Boolean] :test Set this to true to connect to the carrier's
+    #   sandbox environment instead of the production environment.
+    def initialize(options = {})
+      requirements.each { |key| requires!(options, key) }
+      @options = options
+      @last_request = nil
+      @test_mode = @options[:test]
+    end
+
+    # Asks the carrier for rate estimates for a given shipment.
+    #
+    # @note Override with whatever you need to get the rates from the carrier.
+    #
+    # @param origin [ActiveShipping::Location] Where the shipment will originate from.
+    # @param destination [ActiveShipping::Location] Where the package will go.
+    # @param packages [Array<ActiveShipping::Package>] The list of packages that will
+    #   be in the shipment.
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ActiveShipping::RateResponse] The response from the carrier, which
+    #   includes 0 or more rate estimates for different shipping products
+    def find_rates(origin, destination, packages, options = {})
+      raise NotImplementedError, "#find_rates is not supported by #{self.class.name}."
+    end
+
+    # Registers a new shipment with the carrier, to get a tracking number and
+    # potentially shipping labels
+    #
+    # @note Override with whatever you need to register a shipment, and obtain
+    #   shipping labels if supported by the carrier.
+    #
+    # @param origin [ActiveShipping::Location] Where the shipment will originate from.
+    # @param destination [ActiveShipping::Location] Where the package will go.
+    # @param packages [Array<ActiveShipping::Package>] The list of packages that will
+    #   be in the shipment.
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ActiveShipping::ShipmentResponse] The response from the carrier. This
+    #   response should include a shipment identifier or tracking_number if successful,
+    #   and potentially shipping labels.
+    def create_shipment(origin, destination, packages, options = {})
+      raise NotImplementedError, "#create_shipment is not supported by #{self.class.name}."
+    end
+
+    # Cancels a shipment with a carrier.
+    #
+    # @note Override with whatever you need to cancel a shipping label
+    #
+    # @param shipment_id [String] The unique identifier of the shipment to cancel.
+    #  This can be shipment_id or tracking number depending on carrier. Up to you and
+    #  the carrier
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ActiveShipping::ShipmentResponse] The response from the carrier. This
+    #   response in most cases has a cancellation id.
+    def cancel_shipment(shipment_id, options = {})
+      raise NotImplementedError, "#cancel_shipment is not supported by #{self.class.name}."
+    end
+
+    # Retrieves tracking information for a previous shipment
+    #
+    # @note Override with whatever you need to get a shipping label
+    #
+    # @param tracking_number [String] The unique identifier of the shipment to track.
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ActiveShipping::TrackingResponse] The response from the carrier. This
+    #   response should a list of shipment tracking events if successful.
+    def find_tracking_info(tracking_number, options = {})
+      raise NotImplementedError, "#find_tracking_info is not supported by #{self.class.name}."
+    end
+
+    # Get a list of services available for the a specific route
+    #
+    # @param origin_country_code [String] The country of origin
+    # @param destination_country_code [String] The destination country
+    # @return [Array<String>] A list of names of the available services
+    #
+    def available_services(origin_country_code, destination_country_code, options = {})
+      raise NotImplementedError, "#available_services is not supported by #{self.class.name}."
+    end
+
+    # Validate credentials with a call to the API.
+    #
+    # 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.
+    #
+    # @return [Boolean] Should return `true` if the provided credentials proved to work,
+    #   `false` otherswise.
+    def valid_credentials?
+      location = self.class.default_location
+      find_rates(location, location, Package.new(100, [5, 15, 30]), test: test_mode)
+    rescue ActiveShipping::ResponseError
+      false
+    else
+      true
+    end
+
+    # The maximum weight the carrier will accept.
+    # @return [Measured::Weight]
+    def maximum_weight
+      Measured::Weight.new(150, :pounds)
+    end
+
+    # The address field maximum length accepted by the carrier
+    # @return [Integer]
+    def maximum_address_field_length
+      255
+    end
+
+    protected
+
+    include ActiveUtils::RequiresParameters
+    include ActiveUtils::PostsData
+
+    # Returns the keys that are required to be passed to the options hash
+    # @note Override to return required keys in options hash for initialize method.
+    # @return [Array<Symbol>]
+    def requirements
+      []
+    end
+
+    # The default location to use for {#valid_credentials?}.
+    # @note Override for non-U.S.-based carriers.
+    # @return [ActiveShipping::Location]
+    def self.default_location
+      Location.new(country: 'US',
+                    state: 'CA',
+                    city: 'Beverly Hills',
+                    address1: '455 N. Rexford Dr.',
+                    address2: '3rd Floor',
+                    zip: '90210',
+                    phone: '1-310-285-1013',
+                    fax: '1-310-275-8159')
+    end
+
+    # Use after building the request to save for later inspection.
+    # @return [void]
+    def save_request(r)
+      @last_request = r
+    end
+
+    # Calculates a timestamp that corresponds a given number of business days in the future
+    #
+    # @param days [Integer] The number of business days from now.
+    # @return [DateTime] A timestamp, the provided number of business days in the future.
+    def timestamp_from_business_day(days)
+      return unless days
+      date = DateTime.now.utc
+
+      days.times do
+        date += 1.day
+
+        date += 2.days if date.saturday?
+        date += 1.day if date.sunday?
+      end
+
+      date.to_datetime
+    end
+  end
+end