ups-ruby 0.8.3

data/spec/support/schema_path.rb

@@ -0,0 +1,5 @@
+module SchemaPath
+  def schema_path(schema)
+    File.expand_path(File.join('spec', 'support', schema))
+  end
+end

data/spec/support/shipping_options.rb

@@ -0,0 +1,48 @@
+module ShippingOptions
+  def shipper
+    {
+      company_name: 'Veeqo Limited',
+      attention_name: 'Walter White',
+      phone_number: '01792 123456',
+      address_line_1: '11 Wind Street',
+      city: 'Swansea',
+      state: 'Wales',
+      postal_code: 'SA1 1DA',
+      country: 'GB',
+      shipper_number: ENV['UPS_ACCOUNT_NUMBER']
+    }
+  end
+
+  def ship_to
+    {
+      company_name: 'Google Inc.',
+      attention_name: 'Sergie Bryn',
+      phone_number: '0207 031 3000',
+      address_line_1: '1 St Giles High Street',
+      city: 'London',
+      state: 'England',
+      postal_code: 'WC2H 8AG',
+      country: 'GB'
+    }
+  end
+
+  def package
+    {
+      weight: '0.5',
+      unit: 'KGS',
+      dimensions: {
+        length: 40.0,
+        width: 30.0,
+        height: 20.0,
+        unit: 'CM'
+      }
+    }
+  end
+
+  def reference_number
+    {
+      code: 'IK',
+      value: '1234567890'
+    }
+  end
+end

data/spec/support/xsd_validator.rb

@@ -0,0 +1,11 @@
+require 'minitest/assertions'
+
+module Minitest::Assertions
+  def assert_passes_validation(schema_path, xml_to_validate)
+    schema = Nokogiri::XML::Schema(File.read(schema_path))
+    document = Nokogiri::XML::Document.parse(xml_to_validate)
+    schema.validate(document)
+  end
+end
+
+String.infect_an_assertion :assert_passes_validation, :must_pass_validation

data/spec/ups/builders/address_builder_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe UPS::Builders::AddressBuilder do
+  describe "when passed a US Address" do
+    let(:address_hash) { {
+      address_line_1: 'Googleplex',
+      address_line_2: '1600 Amphitheatre Parkway',
+      city: 'Mountain View',
+      state: 'California',
+      postal_code: '94043',
+      country: 'US',
+    } }
+
+    describe "with a non-abbreviated state" do
+      subject { UPS::Builders::AddressBuilder.new address_hash }
+
+      it "should change the state to be the abbreviated state name" do
+        subject.opts[:state].must_equal 'CA'
+      end
+    end
+
+    describe "with a non-abbreviated state with mixed casing" do
+      subject { UPS::Builders::AddressBuilder.new address_hash.merge({ state: 'CaLiFoRnIa' }) }
+
+      it "should change the state to be the abbreviated state name" do
+        subject.opts[:state].must_equal 'CA'
+      end
+    end
+
+    describe "with an abbreviated state" do
+      subject { UPS::Builders::AddressBuilder.new address_hash.merge({ state: 'ca' }) }
+
+      it "should retrun the abbreviated state" do
+        subject.opts[:state].must_equal 'CA'
+      end
+    end
+  end
+
+  describe "when passed a Canadian Address" do
+    let(:address_hash) { {
+      address_line_1: '1253 McGill College',
+      city: 'Montreal',
+      state: 'Quebec',
+      postal_code: 'H3B 2Y5',
+      country: 'CA',
+    } }
+
+    describe "with a non-abbreviated state" do
+      subject { UPS::Builders::AddressBuilder.new address_hash }
+
+      it "should change the state to be the abbreviated state name" do
+        subject.opts[:state].must_equal 'QC'
+      end
+    end
+
+    describe "with a non-abbreviated state with mixed casing" do
+      subject { UPS::Builders::AddressBuilder.new address_hash.merge({ state: 'QuEbEc' }) }
+
+      it "should change the state to be the abbreviated state name" do
+        subject.opts[:state].must_equal 'QC'
+      end
+    end
+
+    describe "with an abbreviated state" do
+      subject { UPS::Builders::AddressBuilder.new address_hash.merge({ state: 'qc' }) }
+
+      it "should retrun the abbreviated state" do
+        subject.opts[:state].must_equal 'QC'
+      end
+    end
+  end
+
+  describe "when passed a IE address" do
+    let(:address_hash) { {
+      address_line_1: 'Barrow Street',
+      city: 'Dublin 4',
+      state: 'County Dublin',
+      postal_code: '',
+      country: 'IE',
+    } }
+
+    describe "normalizes the state field" do
+      subject { UPS::Builders::AddressBuilder.new address_hash }
+
+      it "should change the state to be the abbreviated state name" do
+        subject.opts[:state].must_equal 'Dublin'
+      end
+    end
+
+    describe "when passed a empty state" do
+      subject { UPS::Builders::AddressBuilder.new address_hash.merge({ state: '' }) }
+      it "should throw an exception" do
+        proc { subject }.must_raise UPS::Exceptions::InvalidAttributeError
+      end
+    end
+  end
+end

data/spec/ups/builders/rate_builder_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class UPS::Builders::TestRateBuilder < Minitest::Test
+  include SchemaPath
+  include ShippingOptions
+
+  def setup
+    @rate_builder = UPS::Builders::RateBuilder.new do |builder|
+      builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+      builder.add_shipper shipper
+      builder.add_ship_to ship_to
+      builder.add_ship_from shipper
+      builder.add_package package
+    end
+  end
+
+  def test_validates_against_xsd
+    assert_passes_validation schema_path('RateRequest.xsd'), @rate_builder.to_xml
+  end
+end

data/spec/ups/builders/ship_accept_builder_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+class UPS::Builders::TestShipAcceptBuilder < Minitest::Test
+  include SchemaPath
+
+  def setup
+    @ship_accept_builder = UPS::Builders::ShipAcceptBuilder.new do |builder|
+      builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+      builder.add_shipment_digest "rO0ABXNy...HB4cA=="
+    end
+  end
+
+  def test_validates_against_xsd
+    assert_passes_validation schema_path('ShipAcceptRequest.xsd'), @ship_accept_builder.to_xml
+  end
+end

data/spec/ups/builders/ship_confirm_builder_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class UPS::Builders::TestShipConfirmBuilder < Minitest::Test
+  include SchemaPath
+  include ShippingOptions
+
+  def setup
+    @ship_confirm_builder = UPS::Builders::ShipConfirmBuilder.new do |builder|
+      builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+      builder.add_shipper shipper
+      builder.add_ship_to ship_to
+      builder.add_ship_from shipper
+      builder.add_package package
+      builder.add_label_specification 'gif', { height: '100', width: '100' }
+      builder.add_description 'Los Pollo Hermanos'
+      builder.add_reference_number reference_number
+    end
+  end
+
+  def test_validates_against_xsd
+    assert_passes_validation schema_path('ShipConfirmRequest.xsd'), @ship_confirm_builder.to_xml
+  end
+end

data/spec/ups/connection/rates_negotiated_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe UPS::Connection do
+  include ShippingOptions
+
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { UPS::Connection.new(test_mode: true) }
+
+  describe "if requesting rates" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when UPS::Connection::RATE_PATH
+          {body: File.read("#{stub_path}/rates_negotiated_success.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.rates do |rate_builder|
+        rate_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        rate_builder.add_shipper shipper
+        rate_builder.add_ship_from shipper
+        rate_builder.add_ship_to ship_to
+        rate_builder.add_package package
+        rate_builder.add_rate_information
+      end
+    end
+
+    it "should return neotiated rates" do
+      expect(subject.rated_shipments).wont_be_empty
+      expect(subject.rated_shipments).must_equal [
+        {
+          :service_code=>"11",
+          :service_name=>"UPS Standard",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"24.78"
+
+        },
+        {
+          :service_code=>"65",
+          :service_name=>"UPS Saver",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"45.15"
+        },
+        {
+          :service_code=>"54",
+          :service_name=>"Express Plus",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"80.89"
+        },
+        {
+          :service_code=>"07",
+          :service_name=>"Express",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"47.08"
+        }
+      ]
+    end
+  end
+end

data/spec/ups/connection/rates_standard_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'support/shipping_options'
+
+describe UPS::Connection do
+  include ShippingOptions
+
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { UPS::Connection.new(test_mode: true) }
+
+  describe "if requesting rates" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when UPS::Connection::RATE_PATH
+          {body: File.read("#{stub_path}/rates_success.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.rates do |rate_builder|
+        rate_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        rate_builder.add_shipper shipper
+        rate_builder.add_ship_from shipper
+        rate_builder.add_ship_to ship_to
+        rate_builder.add_package package
+      end
+    end
+
+    it "should return standard rates" do
+      expect(subject.rated_shipments).wont_be_empty
+      expect(subject.rated_shipments).must_equal [
+        {
+          :service_code=>"11",
+          :service_name=>"UPS Standard",
+          :warnings=>[
+            "Your invoice may vary from the displayed reference rates",
+            "Ship To Address Classification is changed from Commercial to Residential"
+          ],
+          :total=>"25.03"
+        },
+        {
+          :service_code=>"65",
+          :service_name=>"UPS Saver",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"45.82"
+        },
+        {
+          :service_code=>"54",
+          :service_name=>"Express Plus",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"82.08"
+        },
+        {
+          :service_code=>"07",
+          :service_name=>"Express",
+          :warnings=>["Your invoice may vary from the displayed reference rates"],
+          :total=>"47.77"
+        }
+      ]
+    end
+  end
+end

data/spec/ups/connection/ship_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'tempfile'
+require 'support/shipping_options'
+
+describe UPS::Connection do
+  include ShippingOptions
+
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { UPS::Connection.new(test_mode: true) }
+
+  describe "if requesting a shipment" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when UPS::Connection::SHIP_CONFIRM_PATH
+          {body: File.read("#{stub_path}/ship_confirm_success.xml"), status: 200}
+        when UPS::Connection::SHIP_ACCEPT_PATH
+          {body: File.read("#{stub_path}/ship_accept_success.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.ship do |shipment_builder|
+        shipment_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        shipment_builder.add_shipper shipper
+        shipment_builder.add_ship_from shipper
+        shipment_builder.add_ship_to ship_to
+        shipment_builder.add_package package
+        shipment_builder.add_payment_information ENV['UPS_ACCOUNT_NUMBER']
+        shipment_builder.add_service '07'
+      end
+    end
+
+    it "should do what ever it takes to get that shipment shipped!" do
+      subject.wont_equal false
+      subject.success?.must_equal true
+      subject.graphic_image.must_be_kind_of File
+      subject.html_image.must_be_kind_of File
+      subject.tracking_number.must_equal '1Z2220060292353829'
+    end
+  end
+
+  describe "ups returns an error during ship confirm" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when UPS::Connection::SHIP_CONFIRM_PATH
+          {body: File.read("#{stub_path}/ship_confirm_failure.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.ship do |shipment_builder|
+        shipment_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        shipment_builder.add_shipper shipper
+        shipment_builder.add_ship_from shipper
+        shipment_builder.add_ship_to ship_to
+        shipment_builder.add_package package
+        shipment_builder.add_payment_information ENV['UPS_ACCOUNT_NUMBER']
+        shipment_builder.add_service '07'
+      end
+    end
+
+    it "should return a Parsed response with an error code and error description" do
+      subject.wont_equal false
+      subject.success?.must_equal false
+      subject.error_description.must_equal "Missing or invalid shipper number"
+    end
+  end
+
+  describe "ups returns an error during ship accept" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when UPS::Connection::SHIP_CONFIRM_PATH
+          {body: File.read("#{stub_path}/ship_confirm_success.xml"), status: 200}
+        when UPS::Connection::SHIP_ACCEPT_PATH
+          {body: File.read("#{stub_path}/ship_accept_failure.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.ship do |shipment_builder|
+        shipment_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        shipment_builder.add_shipper shipper
+        shipment_builder.add_ship_from shipper
+        shipment_builder.add_ship_to ship_to
+        shipment_builder.add_package package
+        shipment_builder.add_payment_information ENV['UPS_ACCOUNT_NUMBER']
+        shipment_builder.add_service '07'
+      end
+    end
+
+    it "should return a Parsed response with an error code and error description" do
+      subject.wont_equal false
+      subject.success?.must_equal false
+      subject.error_description.must_equal "Missing or invalid shipper number"
+    end
+  end
+end