active_shipping 0.12.6 → 1.0.0.pre1

data/lib/active_shipping/rate_response.rb

@@ -0,0 +1,13 @@
+module ActiveShipping
+  class RateResponse < Response
+    attr_reader :rates
+
+    def initialize(success, message, params = {}, options = {})
+      @rates = Array(options[:estimates] || options[:rates] || options[:rate_estimates])
+      super
+    end
+
+    alias_method :estimates, :rates
+    alias_method :rate_estimates, :rates
+  end
+end

data/lib/active_shipping/response.rb

@@ -0,0 +1,41 @@
+module ActiveShipping #:nodoc:
+  class Error < ActiveUtils::ActiveUtilsError
+  end
+
+  class ResponseError < Error
+    attr_reader :response
+
+    def initialize(response = nil)
+      if response.is_a? Response
+        super(response.message)
+        @response = response
+      else
+        super(response)
+      end
+    end
+  end
+
+  class Response
+    attr_reader :params
+    attr_reader :message
+    attr_reader :test
+    attr_reader :xml
+    attr_reader :request
+
+    def initialize(success, message, params = {}, options = {})
+      @success, @message, @params = success, message, params.stringify_keys
+      @test = options[:test] || false
+      @xml = options[:xml]
+      @request = options[:request]
+      raise ResponseError.new(self) unless success
+    end
+
+    def success?
+      @success ? true : false
+    end
+
+    def test?
+      @test ? true : false
+    end
+  end
+end

data/lib/active_shipping/shipment_event.rb

@@ -0,0 +1,17 @@
+module ActiveShipping
+  class ShipmentEvent
+    attr_reader :name, :time, :location, :message
+
+    def initialize(name, time, location, message = nil)
+      @name, @time, @location, @message = name, time, location, message
+    end
+
+    def delivered?
+      status == :delivered
+    end
+
+    def status
+      @status ||= name.downcase.gsub("\s", "_").to_sym
+    end
+  end
+end

data/lib/active_shipping/shipment_packer.rb

@@ -0,0 +1,73 @@
+module ActiveShipping
+  class ShipmentPacker
+    class OverweightItem < StandardError
+    end
+
+    EXCESS_PACKAGE_QUANTITY_THRESHOLD = 10_000
+    class ExcessPackageQuantity < StandardError; end
+
+    # items           - array of hashes containing quantity, grams and price.
+    #                   ex. [{:quantity => 2, :price => 1.0, :grams => 50}]
+    # dimensions      - [5.0, 15.0, 30.0]
+    # maximum_weight  - maximum weight in grams
+    # currency        - ISO currency code
+    def self.pack(items, dimensions, maximum_weight, currency)
+      return [] if items.empty?
+      packages = []
+
+      # Naive in that it assumes weight is equally distributed across all items
+      # Should raise early enough in most cases
+      total_weight = 0
+      items.map!(&:symbolize_keys).each do |item|
+        total_weight += item[:quantity].to_i * item[:grams].to_i
+
+        if item[:grams].to_i > maximum_weight
+          raise OverweightItem, "The item with weight of #{item[:grams]}g is heavier than the allowable package weight of #{maximum_weight}g"
+        end
+
+        if total_weight > maximum_weight * EXCESS_PACKAGE_QUANTITY_THRESHOLD
+          raise ExcessPackageQuantity, "Unable to pack more than #{EXCESS_PACKAGE_QUANTITY_THRESHOLD} packages"
+        end
+      end
+
+      items = items.map(&:dup).sort_by! { |i| i[:grams].to_i }
+
+      state = :package_empty
+      while state != :packing_finished
+        case state
+        when :package_empty
+          package_weight, package_value = 0, 0
+          state = :filling_package
+        when :filling_package
+          items.each do |item|
+            quantity = if item[:grams].to_i <= 0
+              item[:quantity].to_i
+            else
+              # Grab the max amount of this item we can fit into this package
+              # Or, if there are fewer than the max for this item, put
+              # what is left into this package
+              [(maximum_weight - package_weight) / item[:grams].to_i, item[:quantity].to_i].min
+            end
+
+            item_weight = quantity * item[:grams].to_i
+            item_value = quantity * Package.cents_from(item[:price])
+
+            package_weight += item_weight
+            package_value += item_value
+
+            item[:quantity] = item[:quantity].to_i - quantity
+          end
+
+          items.reject! { |i| i[:quantity].to_i == 0 }
+
+          state = :package_full
+        when :package_full
+          packages << ActiveShipping::Package.new(package_weight, dimensions, :value => package_value, :currency => currency)
+          state = items.any? ? :package_empty : :packing_finished
+        end
+      end
+
+      packages
+    end
+  end
+end

data/lib/active_shipping/shipping_response.rb

@@ -0,0 +1,12 @@
+module ActiveShipping
+  class ShippingResponse < Response
+    attr_reader :shipping_id # string
+    attr_reader :tracking_number # string
+
+    def initialize(success, message, params = {}, options = {})
+      @shipping_id = options[:shipping_id]
+      @tracking_number = options[:tracking_number]
+      super
+    end
+  end
+end

data/lib/active_shipping/tracking_response.rb

@@ -0,0 +1,52 @@
+module ActiveShipping
+  class TrackingResponse < Response
+    attr_reader :carrier # symbol
+    attr_reader :carrier_name # string
+    attr_reader :status # symbol
+    attr_reader :status_code # string
+    attr_reader :status_description # string
+    attr_reader :ship_time # time
+    attr_reader :scheduled_delivery_date # time
+    attr_reader :actual_delivery_date # time
+    attr_reader :delivery_signature # string
+    attr_reader :tracking_number # string
+    attr_reader :shipment_events # array of ShipmentEvents in chronological order
+    attr_reader :shipper_address, :origin, :destination # Location objects
+
+    def initialize(success, message, params = {}, options = {})
+      @carrier = options[:carrier].parameterize.to_sym
+      @carrier_name = options[:carrier]
+      @status = options[:status]
+      @status_code = options[:status_code]
+      @status_description = options[:status_description]
+      @ship_time = options[:ship_time]
+      @scheduled_delivery_date = options[:scheduled_delivery_date]
+      @actual_delivery_date = options[:actual_delivery_date]
+      @delivery_signature = options[:delivery_signature]
+      @tracking_number = options[:tracking_number]
+      @shipment_events = Array(options[:shipment_events])
+      @shipper_address = options[:shipper_address]
+      @origin = options[:origin]
+      @destination = options[:destination]
+      super
+    end
+
+    def latest_event
+      @shipment_events.last
+    end
+
+    def is_delivered?
+      @status == :delivered
+    end
+
+    def has_exception?
+      @status == :exception
+    end
+
+    alias_method(:exception_event, :latest_event)
+    alias_method(:delivered?, :is_delivered?)
+    alias_method(:exception?, :has_exception?)
+    alias_method(:scheduled_delivery_time, :scheduled_delivery_date)
+    alias_method(:actual_delivery_time, :actual_delivery_date)
+  end
+end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "0.12.6"
+  VERSION = "1.0.0.pre1"
 end

data/lib/vendor/quantified/test/length_test.rb

@@ -75,10 +75,10 @@ class LengthTest < Test::Unit::TestCase
   end
 
   def test_numeric_methods_not_added_for_some_units
-    assert_raises NoMethodError do
+    assert_raises(NoMethodError) do
       2.yards
     end
-    assert_raises NoMethodError do
+    assert_raises(NoMethodError) do
       2.millimetres
     end
   end

data/lib/vendor/xml_node/test/test_parsing.rb

@@ -6,7 +6,7 @@ require File.dirname(__FILE__) + "/../lib/xml_node"
 
 class TestXmlNode < Test::Unit::TestCase
   def test_parse_sanity
-    assert_raise(ArgumentError) { XmlNode.parse }
+    assert_raises(ArgumentError) { XmlNode.parse }
     assert_nothing_raised { XmlNode.parse('<feed/>') }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_shipping
 version: !ruby/object:Gem::Version
-  version: 0.12.6
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - James MacAulay
@@ -10,8 +10,30 @@ authors:
 - Jimmy Baker
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZhZG1p
+  bnMxFzAVBgoJkiaJk/IsZAEZFgdzaG9waWZ5MRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE0MDUxNTIwMzM0OFoXDTE1MDUxNTIwMzM0OFowPzEPMA0GA1UEAwwGYWRt
+  aW5zMRcwFQYKCZImiZPyLGQBGRYHc2hvcGlmeTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0/81O3e1vh5smcwp2G
+  MpLQ6q0kejQLa65bPYPxdzWA1SYOKyGfw+yR9LdFzsuKpwWzKq6zX35lj1IckWS4
+  bNBEQzxmufUxU0XPM02haFB8fOfDJzdXsWte9Ge4IFwahwn68gpMqN+BvxL+KMYz
+  Iut9YmN44d4LZdsENEIO5vmybuG2vYDz7R56qB0PA+Q2P2CdhymsBad2DQs69FBo
+  uico9V6VMYYctL9lCYdzu9IXrOYNTt88suKIVzzAlHOKeN0Ng5qdztFoTR8sfxDr
+  Ydg3KHl5n47wlpgd8R0f/4b5gGxW+v9pyJCgQnLlRu7DedVSvv7+GMtj3g9r3nhJ
+  KqECAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFI/o
+  maf34HXbUOQsdoLHacEKQgunMB0GA1UdEQQWMBSBEmFkbWluc0BzaG9waWZ5LmNv
+  bTAdBgNVHRIEFjAUgRJhZG1pbnNAc2hvcGlmeS5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBADkK9aj5T0HPExsov4EoMWFnO+G7RQ28C30VAfKxnL2UxG6i4XMHVs6Xi94h
+  qXFw1ec9Y2eDUqaolT3bviOk9BB197+A8Vz/k7MC6ci2NE+yDDB7HAC8zU6LAx8Y
+  Iqvw7B/PSZ/pz4bUVFlTATif4mi1vO3lidRkdHRtM7UePSn2rUpOi0gtXBP3bLu5
+  YjHJN7wx5cugMEyroKITG5gL0Nxtu21qtOlHX4Hc4KdE2JqzCPOsS4zsZGhgwhPs
+  fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
+  TConQSX2BnZdhIEYW+cKzEC/bLc=
+  -----END CERTIFICATE-----
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,14 +41,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -47,14 +69,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.0.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.0.0.pre2
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -89,14 +111,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -160,35 +182,35 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
+- CHANGELOG.md
+- CONTRIBUTING.md
 - MIT-LICENSE
-- README.markdown
+- README.md
 - lib/active_shipping.rb
-- lib/active_shipping/shipping/base.rb
-- lib/active_shipping/shipping/carrier.rb
-- lib/active_shipping/shipping/carriers.rb
-- lib/active_shipping/shipping/carriers/benchmark_carrier.rb
-- lib/active_shipping/shipping/carriers/bogus_carrier.rb
-- lib/active_shipping/shipping/carriers/canada_post.rb
-- lib/active_shipping/shipping/carriers/canada_post_pws.rb
-- lib/active_shipping/shipping/carriers/fedex.rb
-- lib/active_shipping/shipping/carriers/kunaki.rb
-- lib/active_shipping/shipping/carriers/new_zealand_post.rb
-- lib/active_shipping/shipping/carriers/shipwire.rb
-- lib/active_shipping/shipping/carriers/stamps.rb
-- lib/active_shipping/shipping/carriers/ups.rb
-- lib/active_shipping/shipping/carriers/usps.rb
-- lib/active_shipping/shipping/errors.rb
-- lib/active_shipping/shipping/label_response.rb
-- lib/active_shipping/shipping/location.rb
-- lib/active_shipping/shipping/package.rb
-- lib/active_shipping/shipping/rate_estimate.rb
-- lib/active_shipping/shipping/rate_response.rb
-- lib/active_shipping/shipping/response.rb
-- lib/active_shipping/shipping/shipment_event.rb
-- lib/active_shipping/shipping/shipment_packer.rb
-- lib/active_shipping/shipping/shipping_response.rb
-- lib/active_shipping/shipping/tracking_response.rb
+- lib/active_shipping/carrier.rb
+- lib/active_shipping/carriers.rb
+- lib/active_shipping/carriers/benchmark_carrier.rb
+- lib/active_shipping/carriers/bogus_carrier.rb
+- lib/active_shipping/carriers/canada_post.rb
+- lib/active_shipping/carriers/canada_post_pws.rb
+- lib/active_shipping/carriers/fedex.rb
+- lib/active_shipping/carriers/kunaki.rb
+- lib/active_shipping/carriers/new_zealand_post.rb
+- lib/active_shipping/carriers/shipwire.rb
+- lib/active_shipping/carriers/stamps.rb
+- lib/active_shipping/carriers/ups.rb
+- lib/active_shipping/carriers/usps.rb
+- lib/active_shipping/errors.rb
+- lib/active_shipping/label_response.rb
+- lib/active_shipping/location.rb
+- lib/active_shipping/package.rb
+- lib/active_shipping/rate_estimate.rb
+- lib/active_shipping/rate_response.rb
+- lib/active_shipping/response.rb
+- lib/active_shipping/shipment_event.rb
+- lib/active_shipping/shipment_packer.rb
+- lib/active_shipping/shipping_response.rb
+- lib/active_shipping/tracking_response.rb
 - lib/active_shipping/version.rb
 - lib/certs/eParcel.dtd
 - lib/vendor/quantified/MIT-LICENSE

data/lib/active_shipping/shipping/base.rb

@@ -1,13 +0,0 @@
-module ActiveMerchant
-  module Shipping
-    module Base
-      mattr_accessor :mode
-      self.mode = :production
-
-      def self.carrier(name)
-        ActiveMerchant::Shipping::Carriers.all.find { |c| c.name.downcase == name.to_s.downcase } ||
-          raise(NameError, "unknown carrier #{name}")
-      end
-    end
-  end
-end

data/lib/active_shipping/shipping/carrier.rb

@@ -1,84 +0,0 @@
-module ActiveMerchant
-  module Shipping
-    class Carrier
-      include RequiresParameters
-      include PostsData
-      include Quantified
-
-      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.
-      def initialize(options = {})
-        requirements.each { |key| requires!(options, key) }
-        @options = options
-        @last_request = nil
-        @test_mode = @options[:test]
-      end
-
-      # Override to return required keys in options hash for initialize method.
-      def requirements
-        []
-      end
-
-      # Override with whatever you need to get the rates
-      def find_rates(origin, destination, packages, options = {})
-      end
-
-      # Override with whatever you need to get a shipping label
-      def create_shipment(origin, destination, packages, options = {})
-      end
-
-      # Validate credentials with a call to the API. By default this just does a find_rates call
-      # with the orgin 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.
-      def valid_credentials?
-        location = self.class.default_location
-        find_rates(location, location, Package.new(100, [5, 15, 30]), :test => test_mode)
-      rescue ActiveMerchant::Shipping::ResponseError
-        false
-      else
-        true
-      end
-
-      def maximum_weight
-        Mass.new(150, :pounds)
-      end
-
-      protected
-
-      def node_text_or_nil(xml_node)
-        xml_node ? xml_node.text : nil
-      end
-
-      # Override in subclasses for non-U.S.-based carriers.
-      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. Probably won't ever be overridden.
-      def save_request(r)
-        @last_request = r
-      end
-
-      def timestamp_from_business_day(days)
-        return unless days
-        date = DateTime.now.utc
-        days.times do
-          begin
-            date = date + 1
-          end while [0, 6].include?(date.wday)
-        end
-        date
-      end
-    end
-  end
-end