reactive_shipping 3.0.0

data/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/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/gemfiles/activesupport42.gemfile

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

data/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/gemfiles/activesupport51.gemfile

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

data/gemfiles/activesupport52.gemfile

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

data/gemfiles/activesupport_master.gemfile

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

data/lib/certs/eParcel.dtd

@@ -0,0 +1,111 @@
+<!-- EVERY REQUEST CONTAIN THE eparcel TAG -->
+<!ELEMENT eparcel (language?,
+					(  ratesAndServicesRequest |
+						ratesAndServicesResponse |
+						error
+					)+)>
+
+<!ELEMENT language (#PCDATA)>
+<!ELEMENT comment (#PCDATA)>
+
+
+<!-- Standard request to ask for rates and services -->
+<!ELEMENT ratesAndServicesRequest (	merchantCPCID,
+												fromPostalCode?,
+												turnAroundTime?,
+												itemsPrice?,
+												lineItems,
+												city?,
+												provOrState,
+												country,
+												postalCode)>
+	<!ELEMENT merchantID (#PCDATA)>
+	<!ELEMENT fromPostalCode (#PCDATA)>
+	<!ELEMENT turnAroundTime (#PCDATA)>
+	<!ELEMENT itemsPrice (#PCDATA)>
+	<!ELEMENT merchantCPCID (#PCDATA)>
+	<!ELEMENT lineItems (item)+>
+		<!ELEMENT item (quantity, weight, length, width, height, description, imageURL?, readyToShip)>
+			<!ELEMENT quantity (#PCDATA)>
+			<!ELEMENT weight (#PCDATA)>
+			<!ELEMENT length (#PCDATA)>
+			<!ELEMENT width (#PCDATA)>
+			<!ELEMENT height (#PCDATA)>
+			<!ELEMENT description (#PCDATA)>
+			<!ELEMENT imageURL (#PCDATA)>
+			<!ELEMENT readyToShip (#PCDATA)>
+	<!ELEMENT city (#PCDATA)>
+	<!ELEMENT provOrState (#PCDATA)>
+	<!ELEMENT country (#PCDATA)>
+	<!ELEMENT postalCode (#PCDATA)>
+
+<!-- Standard response for request for rates and services -->
+<!ELEMENT ratesAndServicesResponse (statusCode, 
+												statusMessage+, 
+												requestID, 
+												handling, 
+												language, 
+												product+,   
+												packing*, 
+												emptySpace*, 
+												shippingOptions, 
+												comment,
+												nearestPostalOutlet*)>
+
+	<!ELEMENT statusCode (#PCDATA)>
+	<!ELEMENT statusMessage (#PCDATA)>
+	<!ELEMENT requestID (#PCDATA)>
+	<!ELEMENT handling (#PCDATA)>
+
+	<!ELEMENT product (name, rate, shippingDate, deliveryDate, deliveryDayOfWeek, nextDayAM?, packingID)>
+		<!ATTLIST product       id    CDATA    		#REQUIRED>
+		<!ATTLIST product       sequence    CDATA    #REQUIRED>
+		<!ELEMENT name (#PCDATA)>
+		<!ELEMENT rate (#PCDATA)>
+		<!ELEMENT shippingDate (#PCDATA)>
+		<!ELEMENT deliveryDate (#PCDATA)>
+		<!ELEMENT deliveryDayOfWeek (#PCDATA)>
+		<!ELEMENT nextDayAM (#PCDATA)>
+		<!ELEMENT packingID (#PCDATA)>
+
+	<!ELEMENT packing (packingID, box+)>
+		<!ELEMENT box (name, weight, expediterWeight, length, width, height, packedItem+)>
+			<!ELEMENT expediterWeight (#PCDATA)>
+			<!ELEMENT packedItem (quantity, description)>
+
+	<!ELEMENT emptySpace (length, width, height, weight)>
+
+	<!ELEMENT shippingOptions (insurance, deliveryConfirmation, signature)>
+		<!ELEMENT insurance (#PCDATA)>
+		<!ELEMENT deliveryConfirmation (#PCDATA)>
+		<!ELEMENT signature (#PCDATA)>
+
+
+	<!-- *********************************************************  -->
+	<!-- * 'nearestPostalOutlet'  is optional and is returned    *  -->
+	<!-- * only if the merchant profile has this option enabled  *  -->
+	<!-- *********************************************************  -->
+	<!ELEMENT nearestPostalOutlet (postalOutletSequenceNo,
+											distance,
+										   outletName, 
+											businessName , 
+											postalAddress, 
+											phoneNumber, 
+											businessHours+)>
+		<!ELEMENT postalOutletSequenceNo		(#PCDATA)>
+		<!ELEMENT distance 			(#PCDATA)>
+		<!ELEMENT outletName 		(#PCDATA)>
+		<!ELEMENT businessName 		(#PCDATA)>
+		<!ELEMENT postalAddress (addressLine+, postalCode , municipality)>
+			<!ELEMENT addressLine 		(#PCDATA)>
+			<!ELEMENT municipality 		(#PCDATA)>
+		<!ELEMENT phoneNumber 		(#PCDATA)>
+		<!ELEMENT businessHours (dayId, dayOfWeek, time)>
+			<!ELEMENT dayId     					(#PCDATA)>
+			<!ELEMENT dayOfWeek 					(#PCDATA)>
+			<!ELEMENT time 						(#PCDATA)>
+
+
+<!-- Standard error format returned -->
+<!ELEMENT error (statusCode,statusMessage*)>
+

data/lib/reactive_shipping.rb

@@ -0,0 +1,26 @@
+require 'active_support/all'
+require 'active_utils'
+
+require 'nokogiri'
+require 'measured'
+
+require 'reactive_shipping/response'
+require 'reactive_shipping/rate_response'
+require 'reactive_shipping/tracking_response'
+require 'reactive_shipping/delivery_date_estimates_response'
+require 'reactive_shipping/shipping_response'
+require 'reactive_shipping/label_response'
+require 'reactive_shipping/label'
+require 'reactive_shipping/package_item'
+require 'reactive_shipping/package'
+require 'reactive_shipping/location'
+require 'reactive_shipping/rate_estimate'
+require 'reactive_shipping/delivery_date_estimate'
+require 'reactive_shipping/shipment_event'
+require 'reactive_shipping/shipment_packer'
+require 'reactive_shipping/carrier'
+require 'reactive_shipping/carriers'
+require 'reactive_shipping/errors'
+require 'reactive_shipping/external_return_label_request'
+require 'reactive_shipping/external_return_label_response'
+require 'reactive_shipping/address_validation_response'

data/lib/reactive_shipping/address_validation_response.rb

@@ -0,0 +1,30 @@
+module ReactiveShipping
+
+  # Response object class for calls to {ReactiveShipping::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/lib/reactive_shipping/carrier.rb

@@ -0,0 +1,184 @@
+module ReactiveShipping
+
+  # 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 [ReactiveShipping::Location] Where the shipment will originate from.
+    # @param destination [ReactiveShipping::Location] Where the package will go.
+    # @param packages [Array<ReactiveShipping::Package>] The list of packages that will
+    #   be in the shipment.
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ReactiveShipping::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 [ReactiveShipping::Location] Where the shipment will originate from.
+    # @param destination [ReactiveShipping::Location] Where the package will go.
+    # @param packages [Array<ReactiveShipping::Package>] The list of packages that will
+    #   be in the shipment.
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ReactiveShipping::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 [ReactiveShipping::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 [ReactiveShipping::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 ReactiveShipping::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 [ReactiveShipping::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

data/lib/reactive_shipping/carriers.rb

@@ -0,0 +1,35 @@
+module ReactiveShipping
+  module Carriers
+    extend self
+
+    attr_reader :registered
+    @registered = []
+
+    def register(class_name, autoload_require)
+      ReactiveShipping.autoload(class_name, autoload_require)
+      self.registered << class_name
+    end
+
+    def all
+      ReactiveShipping::Carriers.registered.map { |name| ReactiveShipping.const_get(name) }
+    end
+
+    def find(name)
+      all.find { |c| c.name.downcase == name.to_s.downcase } or raise NameError, "unknown carrier #{name}"
+    end
+  end
+end
+
+ReactiveShipping::Carriers.register :BenchmarkCarrier, 'reactive_shipping/carriers/benchmark_carrier'
+ReactiveShipping::Carriers.register :BogusCarrier,     'reactive_shipping/carriers/bogus_carrier'
+ReactiveShipping::Carriers.register :UPS,              'reactive_shipping/carriers/ups'
+ReactiveShipping::Carriers.register :USPS,             'reactive_shipping/carriers/usps'
+ReactiveShipping::Carriers.register :USPSReturns,      'reactive_shipping/carriers/usps_returns'
+ReactiveShipping::Carriers.register :FedEx,            'reactive_shipping/carriers/fedex'
+ReactiveShipping::Carriers.register :Shipwire,         'reactive_shipping/carriers/shipwire'
+ReactiveShipping::Carriers.register :Kunaki,           'reactive_shipping/carriers/kunaki'
+ReactiveShipping::Carriers.register :CanadaPost,       'reactive_shipping/carriers/canada_post'
+ReactiveShipping::Carriers.register :NewZealandPost,   'reactive_shipping/carriers/new_zealand_post'
+ReactiveShipping::Carriers.register :CanadaPostPWS,    'reactive_shipping/carriers/canada_post_pws'
+ReactiveShipping::Carriers.register :Stamps,           'reactive_shipping/carriers/stamps'
+ReactiveShipping::Carriers.register :AustraliaPost,    'reactive_shipping/carriers/australia_post'