simple_shipping 0.4.6

data/spec/lib/simple_shipping/ups/party_builder_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module SimpleShipping::Ups
+  describe PartyBuilder do
+    it_should_behave_like "builders"
+
+    it 'validate account number if party is shipper' do
+      shipper = SimpleShipping::Party.new
+
+      shipper.stub!(:valid? => true)
+      lambda {
+        PartyBuilder.build(shipper, :shipper => true)
+      }.should raise_error SimpleShipping::ValidationError
+
+      shipper.stub!(:account_number => '123')
+      lambda {
+        PartyBuilder.build(shipper, :shipper => true)
+      }.should_not raise_error SimpleShipping::ValidationError
+    end
+  end
+
+  describe "build" do
+    it "should include all addresses" do
+      contact = SimpleShipping::Contact.new(:phone_number => "5555555555", :person_name => "Frank")
+      address = SimpleShipping::Address.new(:country_code => "US", :state_code => "IL", :city => "Chicago", :postal_code => "60622")
+      address.street_line   = "foo"
+      address.street_line_2 = "bar"
+      address.street_line_3 = "baz"
+
+      shipper = SimpleShipping::Party.new(:contact => contact, :address => address)
+      party   = PartyBuilder.build(shipper)
+      party['Address']['AddressLine'].should have(3).addresses
+    end
+
+    it "should exclude nil addresses" do
+      contact = SimpleShipping::Contact.new(:phone_number => "5555555555", :person_name => "Frank")
+      address = SimpleShipping::Address.new(:country_code => "US", :state_code => "IL", :city => "Chicago", :postal_code => "60622")
+      address.street_line   = "foo"
+      address.street_line_2 = nil
+      address.street_line_3 = "baz"
+
+      shipper = SimpleShipping::Party.new(:contact => contact, :address => address)
+      party   = PartyBuilder.build(shipper)
+      party['Address']['AddressLine'].should have(2).addresses
+    end
+  end
+end

data/spec/lib/simple_shipping/ups/response/shipment_response_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SimpleShipping::Ups::ShipmentResponse do
+  it_should_behave_like "responses_with_labels"
+end

data/spec/lib/simple_shipping/ups/response_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe SimpleShipping::Ups::Response do
+  it_should_behave_like "responses"
+
+  context "when success response is received" do
+    subject { response }
+
+    let(:response_fixture) { fixture("ups_shipment_response") }
+    let(:http_response)  { ::HTTPI::Response.new(200, {}, response_fixture) }
+    let(:savon_response) do
+      ::Savon::Response.new(
+        http_response,
+        {
+          strip_namespaces: true,
+          convert_response_tags_to: ->(tag) { tag.snakecase.to_sym }
+        },
+        {}
+      )
+    end
+    let(:response) { ::SimpleShipping::Ups::ShipmentResponse.new(savon_response) }
+
+    its(:shipment_identification_number) { should eq("1Z35679R0294268838") }
+    its(:tracking_number)                { should eq("1Z35679R0294268838") }
+
+    describe "label image" do
+      let(:response_fixture) { fixture("ups_shipment_response_with_faked_label_data") }
+
+      # HTML_IMAGE_DATA is the Base64 decoded version of SFRNTF9JTUFHRV9EQVRB
+      its(:label_html) { should eq("HTML_IMAGE_DATA") }
+    end
+  end
+end

data/spec/lib/simple_shipping/ups/shipment_builder_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SimpleShipping::Ups::ShipmentBuilder do
+  it_should_behave_like "builders"
+
+  describe 'validation' do
+    it 'validates inclusion of service_types' do
+      shipment = SimpleShipping::Shipment.new
+      shipment.stub!(:valid? => true)
+
+      lambda {
+        SimpleShipping::Ups::ShipmentBuilder.build(shipment, :service_type => :ground)
+      }.should_not raise_error SimpleShipping::ValidationError
+      lambda {
+        SimpleShipping::Ups::ShipmentBuilder.build(shipment, :service_type => :bad)
+      }.should raise_error SimpleShipping::ValidationError
+    end
+  end
+end

data/spec/requests/fedex_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe "FedEx integration test" do
+  before { Timecop.freeze }
+  after  { Timecop.return }
+
+  #let(:credentials) do
+  #  YAML.load_file(SimpleShipping::DEMO_CREDENTIALS_FILE)['fedex'].symbolize_keys!
+  #end
+
+  let(:credentials) {{
+    :key            => 'fedex key',
+    :password       => 'secret word',
+    :account_number => '101010101',
+    :meter_number   => '202020202'
+  }}
+
+  let(:demo) do
+    options = credentials.merge(:live => false)
+    SimpleShipping::Demo::Fedex.new(options)
+  end
+
+  context "#shipment_request" do
+    it "builds correct SOAP request envelope" do
+      req_matcher = lambda do |req|
+        expected = Nokogiri::XML(fixture(:fedex_shipment_request, credentials))
+        actual   = Nokogiri::XML(req.body)
+
+        actual.root.should be_equivalent_to(expected.root).respecting_element_order
+
+        req.headers['Soapaction'].should == %{"processShipment"}
+
+        true
+      end
+
+      req = stub_http_request(:post, demo.fedex_client.class.testing_address).
+        with(&req_matcher).
+        to_return(:body => fixture(:fedex_shipment_response), :status => 200, :headers => {})
+
+      resp = demo.shipment_request
+
+      resp.label_image_base64.should be_present
+
+      req.should have_been_made
+    end
+  end
+end

data/spec/requests/ups_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe "UPS test" do
+  let(:credentials) {{
+    :username              => "Joe13",
+    :password              => "JoesSecretWord",
+    :account_number        => "1010101",
+    :access_license_number => "Joe's license"
+  }}
+
+  let(:demo) do
+    options = credentials.merge!(:live => false)
+    SimpleShipping::Demo::Ups.new(options)
+  end
+
+  let(:erb_request_vars) do
+    credentials.merge(:shipment_identification_number => demo.shipment_identification_number)
+  end
+
+  describe "ship_client" do
+    describe "#shipment_request" do
+      it "builds correct SOAP request envelope" do
+        req_matcher = lambda do |req|
+          expected = Nokogiri::XML(fixture(:ups_shipment_request, erb_request_vars))
+          actual   = Nokogiri::XML(req.body)
+
+          actual.root.should be_equivalent_to(expected.root)
+          #actual.root.to_s.should == expected.root.to_s
+
+          true
+        end
+
+        req = stub_http_request(:post, demo.ship_client.class.testing_address).
+          with(&req_matcher).
+          to_return(:body => fixture(:ups_shipment_response), :status => 200, :headers => {})
+
+        resp = demo.shipment_request(
+
+        )
+
+
+        resp.label_image_base64.should be_present
+
+        req.should have_been_made
+      end
+    end
+  end
+
+  describe "void client" do
+    describe "#void_request" do
+      it "builds correct SOAP request envelope" do
+        req_matcher = lambda do |req|
+          expected = Nokogiri::XML(fixture(:ups_void_request, erb_request_vars))
+          actual   = Nokogiri::XML(req.body)
+
+          actual.root.should be_equivalent_to(expected.root)
+          #actual.root.to_s.should == expected.root.to_s
+
+          true
+        end
+
+        req = stub_http_request(:post, demo.void_client.class.testing_address).
+          with(&req_matcher).
+          to_return(:body => fixture(:ups_void_response), :status => 200, :headers => {})
+
+        expect{ demo.void_request }.to(
+          # NOTE: Exception message is important! This is how we can find out whether SOAP request was made correct -- aignatyev 20130204
+          raise_exception(SimpleShipping::RequestError, /No shipment found within the allowed void period/)
+        )
+
+        req.should have_been_made
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'simple_shipping'
+
+require "simplecov"
+require "simplecov-rcov-text"
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+
+require "savon/mock/spec_helper"
+require 'webmock/rspec'
+require "timecop"
+require "erubis"
+require 'equivalent-xml'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+require File.expand_path("../support/custom_matchers/basic_matcher", __FILE__)
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include SimpleShipping::CustomMatchers
+  config.include Savon::SpecHelper
+  config.after(:each)  { savon.unmock! }
+
+  config.before(:each) do
+    # We are going to enable webmock in some spec on-demand.
+    # This is the reason why this config directive is placed in before(:each) hook -- aignatyev 20130204
+    WebMock.disable_net_connect!(:allow_localhost => true)
+  end
+
+  def fixtures_dir
+    Pathname.new(File.expand_path('../fixtures', __FILE__))
+  end
+
+  def fixture(name, vars = {})
+    path = fixtures_dir.join(name.to_s + ".soap.xml.erb")
+    template = File.open(path).read
+
+    Erubis::Eruby.new(template).result(vars)
+  end
+end

data/spec/support/custom_matchers/basic_matcher.rb

@@ -0,0 +1,13 @@
+module SimpleShipping
+  module CustomMatchers
+    class BasicMatcher
+      def failure_message
+        "expected to #{description}"
+      end
+
+      def negative_failure_message
+        "expected to not #{description}"
+      end
+    end
+  end
+end

data/spec/support/custom_matchers/have_attribute_matcher.rb

@@ -0,0 +1,22 @@
+module SimpleShipping
+  module CustomMatchers
+    class HaveAttributeMatcher < BasicMatcher
+      def initialize(attribute)
+        @attribute = attribute.to_sym
+      end
+      
+      def matches?(model)
+        model.respond_to?(@attribute) &&
+        model.respond_to?("#{@attribute}=")
+      end
+
+      def description
+        "have attribute #{@attribute.inspect}"
+      end
+    end
+
+    def have_attribute(attr_name)
+      HaveAttributeMatcher.new(attr_name)
+    end
+  end
+end

data/spec/support/custom_matchers/have_default_value_matcher.rb

@@ -0,0 +1,26 @@
+module SimpleShipping
+  module CustomMatchers
+    class HaveDefaultValueMatcher < BasicMatcher
+      def initialize(value)
+        @value = value
+      end
+      
+      def matches?(model)
+        model.send(@attribute) == @value
+      end
+
+      def for_attribute(attribute)
+        @attribute = attribute.to_sym
+        self
+      end
+
+      def description
+        "have default value #{@value.inspect} for attribute #{@attribute.inspect}"
+      end
+    end
+
+    def have_default_value(value)
+      HaveDefaultValueMatcher.new(value)
+    end
+  end
+end

data/spec/support/custom_matchers/have_errors_on_matcher.rb

@@ -0,0 +1,23 @@
+module SimpleShipping
+  module CustomMatchers
+    class HaveErrorsOnMatcher < BasicMatcher
+
+      def initialize(attribute)
+        @attribute = attribute.to_sym
+      end
+      
+      def matches?(model)
+        model.valid?
+        !!model.errors.messages[@attribute]
+      end
+
+      def description
+        "have errors on #{@attribute.inspect}"
+      end
+    end
+
+    def have_errors_on(attr_name)
+      HaveErrorsOnMatcher.new(attr_name)
+    end
+  end
+end

data/spec/support/custom_matchers/validate_inclusion_of_matcher.rb

@@ -0,0 +1,37 @@
+module SimpleShipping
+  module CustomMatchers
+    class ValidateInclusionOfMatcher < BasicMatcher
+      def initialize(attribute)
+        @attribute = attribute.to_sym
+      end
+      
+      def matches?(model)
+        @enumeration.each do |value|
+          model.send("#{@attribute}=", value)
+          return false if has_error?(model)
+        end
+        model.send("#{@attribute}=", "ANOTHER_VALUE_#{rand}")
+        has_error?(model)
+      end
+
+      def in(*enumeration)
+        @enumeration = enumeration
+        self
+      end
+
+      def description
+        "validate inclusion of #{@attribute.inspect} in #{@enumeration.inspect}"
+      end
+
+      def has_error?(model)
+        model.valid?
+        model.errors.messages[@attribute] and
+        model.errors.messages[@attribute].include?("is not included in the list")
+      end
+    end
+
+    def validate_inclusion_of(attr_name)
+      ValidateInclusionOfMatcher.new(attr_name)
+    end
+  end
+end

data/spec/support/custom_matchers/validate_presence_of_matcher.rb

@@ -0,0 +1,24 @@
+module SimpleShipping
+  module CustomMatchers
+    class ValidatePresenceOfMatcher < BasicMatcher
+      def initialize(attribute)
+        @attribute = attribute.to_sym
+      end
+      
+      def matches?(model)
+        model.send("#{@attribute}=", nil)
+        model.valid?
+        model.errors.messages[@attribute] and
+        model.errors.messages[@attribute].include? "can't be blank"
+      end
+
+      def description
+        "validate presence of #{@attribute.inspect}"
+      end
+    end
+
+    def validate_presence_of(attr_name)
+      ValidatePresenceOfMatcher.new(attr_name)
+    end
+  end
+end

data/spec/support/custom_matchers/validate_submodel_matcher.rb

@@ -0,0 +1,44 @@
+module SimpleShipping
+  module CustomMatchers
+    class ValidateSubmodelMatcher < BasicMatcher
+      def initialize(attribute)
+        @attribute = attribute.to_sym
+      end
+      
+      def matches?(model)
+        @model = model
+
+        @model.send("#{@attribute}=", Class.new.new)
+        return false unless has_error?
+
+        submodel = @class.new
+        submodel.stub!(:valid? => false)
+        @model.send("#{@attribute}=", submodel)
+        return false unless has_error?
+
+        submodel.stub!(:valid? => true)
+        @model.send("#{@attribute}=", submodel)
+        !has_error?
+      end
+
+      def as(klass)
+        @class = klass
+        self
+      end
+
+      def description
+        "validate submodel #{@attribute.inspect} as instance of #{@class}"
+      end
+
+      def has_error?
+        @model.valid?
+        !!@model.errors.messages[@attribute]
+      end
+      private :has_error?
+    end
+
+    def validate_submodel(attr_name)
+      ValidateSubmodelMatcher.new(attr_name)
+    end
+  end
+end