trackerific 0.7.1 → 0.7.2

data/spec/lib/trackerific/services/base_spec.rb

@@ -10,4 +10,60 @@ describe Trackerific::Services::Base do
       AnotherTestService.name.should eq :another_test_service
     end
   end
+
+  describe "#track" do
+    it "should create a new instance and call #track with the given id" do
+      TestService.any_instance.should_receive(:track).with('ID')
+      TestService.track('ID')
+    end
+  end
+
+  describe "#credentials" do
+    it "should read the credentials for the service from Trackerific.config" do
+      TestService.credentials.should eq({ :user => 'test' })
+    end
+  end
+
+  describe "#can_track?" do
+    context "when #credentials is nil" do
+      before { TestService.stub(:credentials).and_return(nil) }
+
+      it "should return false even if it matches one of #package_id_matchers" do
+        TestService.can_track?("TEST").should be_false
+      end
+    end
+
+    context "when #credentials is defined" do
+      before { Trackerific.stub(:credentials).and_return({:user => 'test'}) }
+
+      subject { TestService.can_track?(id) }
+
+      context "when the given id matches one of #package_id_matchers" do
+        let(:id) { 'TEST' }
+        it { should be_true }
+      end
+
+      context "when the given id doesn't match any of #package_id_matchers" do
+        let(:id) { 'invalid' }
+        it { should be_false }
+      end
+    end
+  end
+
+  describe "#package_id_matchers" do
+    it "should raise a NotImplementedError when not overridden" do
+      expect {
+        Trackerific::Services::Base.package_id_matchers
+      }.to raise_error NotImplementedError
+    end
+  end
+
+  context "when creating a new instance without credentials" do
+    before { TestService.stub(:credentials).and_return(nil) }
+    it "should raise a Trackerific::Error" do
+      expect {
+        TestService.new
+      }.to raise_error Trackerific::Error
+    end
+  end
 end

data/spec/lib/trackerific/services/concerns/soap_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Trackerific::Services::Concerns::SOAP do
+  class TestConcernsSOAP
+    include Trackerific::Services::Concerns::SOAP
+
+    def initialize
+      @credentials = { user_id: 'USER ID' }
+    end
+  end
+
+  subject { TestConcernsSOAP }
+
+  it { should respond_to :soap_track_operation }
+  it { should respond_to :soap_track_operation= }
+  it { should respond_to :soap_builder }
+  it { should respond_to :soap_builder= }
+  it { should respond_to :soap_parser }
+  it { should respond_to :soap_parser= }
+  it { should respond_to :soap_wsdl }
+  it { should respond_to :soap_wsdl= }
+
+  describe "#track" do
+    let(:track_operation) { double(:track_operation) }
+    let(:package_id) { "PACKAGE ID" }
+
+    let(:builder) { double(:builder) }
+    let(:builder_instance) { double(:builder_instance) }
+    let(:builder_hash) { {'this' => 'hash'} }
+
+    let(:parser) { double(:parser) }
+    let(:parser_instance) { double(:parser_instance) }
+    let(:parser_response) { double(:parser_response) }
+
+    let(:wsdl) { 'fedex/TrackService_v8' }
+    let(:wsdl_path) { Trackerific::SOAP::WSDL.path(wsdl) }
+    let(:client) { double(:savon_client) }
+    let(:soap_request) { double(:soap_request) }
+
+    before do
+      TestConcernsSOAP.stub(:soap_track_operation).and_return(track_operation)
+      TestConcernsSOAP.stub(:soap_wsdl).and_return(wsdl)
+      TestConcernsSOAP.stub(:soap_builder).and_return(builder)
+      TestConcernsSOAP.stub(:soap_parser).and_return(parser)
+
+      builder.stub(:members).and_return([:user_id, :package_id])
+      builder.should_receive(:new).with("USER ID", package_id).and_return(builder_instance)
+      builder_instance.stub(:hash).and_return(builder_hash)
+
+      Savon.should_receive(:client).with(convert_request_keys_to: :camelcase, wsdl: wsdl_path).and_return(client)
+      client.should_receive(:call).with(track_operation, message: builder_hash).and_return(soap_request)
+
+      parser.should_receive(:new).with(package_id, soap_request).and_return(parser_instance)
+      parser_instance.should_receive(:parse).and_return(parser_response)
+    end
+
+    subject { TestConcernsSOAP.new.track(package_id) }
+
+    context "when the parser responds with a Trackerific::Error" do
+      let(:parser_response) { Trackerific::Error.new }
+      it "should raise the error" do
+        expect { subject }.to raise_error Trackerific::Error
+      end
+    end
+
+    context "when the parser responds with a Trackerific::Details" do
+      let(:parser_response) { Trackerific::Details.new }
+      it { should be parser_response }
+    end
+  end
+end

data/spec/lib/trackerific/services/concerns/xml_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Trackerific::Services::Concerns::XML do
+  class TestConcernsXML
+    include Trackerific::Services::Concerns::XML
+
+    def initialize
+      @credentials = { user_id: 'USER ID' }
+    end
+  end
+
+  subject { TestConcernsXML }
+
+  it { should respond_to :xml_endpoint }
+  it { should respond_to :xml_endpoint= }
+  it { should respond_to :xml_parser }
+  it { should respond_to :xml_parser= }
+  it { should respond_to :xml_builder }
+  it { should respond_to :xml_builder= }
+
+  describe "#track" do
+    let(:endpoint) { "/endpoint" }
+    let(:package_id) { "PACKAGE ID" }
+
+    let(:parser) { double(:parser) }
+    let(:parser_instance) { double(:parser_instance) }
+    let(:parser_response) { double(:parser_response) }
+
+    let(:builder) { double(:builder) }
+    let(:builder_instance) { double(:builder_instance) }
+
+    let(:http_response) { double(:http_response) }
+
+    let(:xml) { "<xml></xml>" }
+
+    before do
+      TestConcernsXML.stub(:xml_endpoint).and_return(endpoint)
+      TestConcernsXML.stub(:xml_parser).and_return(parser)
+      TestConcernsXML.stub(:xml_builder).and_return(builder)
+
+      builder.stub(:members).and_return([:user_id, :package_id])
+      builder.should_receive(:new).with('USER ID', package_id).and_return(builder_instance)
+      builder_instance.stub(:xml).and_return(xml)
+
+      TestConcernsXML.should_receive(:post).with(endpoint, body: xml).and_return(http_response)
+
+      parser.should_receive(:new).with(package_id, http_response).and_return(parser_instance)
+      parser_instance.should_receive(:parse).and_return(parser_response)
+    end
+
+    subject { TestConcernsXML.new.track(package_id) }
+
+    context "when the parser responds with a Trackerific::Error" do
+      let(:parser_response) { Trackerific::Error.new }
+      it "should raise the error" do
+        expect { subject }.to raise_error Trackerific::Error
+      end
+    end
+
+    context "when the parser responds with a Trackerific::Details" do
+      let(:parser_response) { Trackerific::Details.new }
+      it { should be parser_response }
+    end
+  end
+end

data/spec/lib/trackerific/services/fedex_spec.rb

@@ -1,73 +1,71 @@
 require 'spec_helper'
 
-FEDEX_TRACK_URL = "https://gateway.fedex.com/GatewayDC"
-
 describe Trackerific::Services::FedEx do
-  it { should be_a Trackerific::Services::Base }
-
-  it "should be registered" do
-    Trackerific::Services[:fedex].should eq Trackerific::Services::FedEx
-    described_class.name.should eq :fedex
-  end
+  include Savon::SpecHelper
 
   let(:valid_ids) { ["183689015000001", "999999999999999"] }
-  let(:invalid_ids) { %w[these are not fedex tracking ids] }
+  let(:invalid_ids) { %w[these are not valid tracking ids] }
 
-  it "should match valid FedEx ids" do
+  it "should match valid tracking ids" do
     valid_ids.all? {|id| described_class.can_track?(id) }.should be_true
   end
 
-  it "should not match invalid FedEx ids" do
+  it "should not match invalid tracking ids" do
     invalid_ids.all? {|id| described_class.can_track?(id) }.should be_false
   end
 
+  let(:credentials) do
+    { :key => "KEY",
+      :password => "PASSWORD",
+      :account_number => "ACCOUNT NUMBER",
+      :meter_number => "METER NUMBER" }
+  end
+
+  let(:fedex) { described_class.new(credentials) }
+
   describe "#track" do
-    let(:id) { "183689015000001" }
-    let(:credentials) { { account: "123456789", meter: "123456789" } }
-    let(:fedex) { described_class.new(credentials) }
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+    let(:hash) { double(:hash) }
+    let(:package_id) { "PACKAGE ID" }
 
     before do
-      FakeWeb.register_uri(:post, FEDEX_TRACK_URL, body: fixture)
+      Trackerific::Builders::FedEx.any_instance.stub(:hash).and_return(hash)
+      savon.expects(:track).with(message: hash).returns(fixture)
     end
 
-    after { FakeWeb.clean_registry }
+    subject { fedex.track(package_id) }
+
+    context "with an error response" do
+      let(:fixture) { Fixture.read('fedex/error.xml') }
+
+      it "should raise a Trackerific::Error" do
+        expect {
+          subject
+        }.to raise_error Trackerific::Error
+      end
+    end
 
     context "with a successful response" do
       let(:fixture) { Fixture.read('fedex/success.xml') }
-      subject { fedex.track(id) }
-      it { should be_a Trackerific::Details }
-      its(:package_id) { should eq id }
-      its(:summary) { should eq "Delivered" }
 
-      describe "#events" do
-        subject { fedex.track(id).events }
-        its(:length) { should eq 3 }
+      its(:package_id) { should eq package_id }
+      its(:summary) { should be_nil }
+      its(:weight) { should be_nil }
+      its(:via) { should be_nil }
 
-        it "should be an Array of Trackerific::Event" do
-          subject.all? {|el| el.is_a?(Trackerific::Event) }.should be_true
-        end
+      describe "#events" do
+        subject { fedex.track(package_id).events }
+        its(:length) { should eq 5 }
 
-        it "should have the correct event values" do
-          subject[0].date.to_s.should eq "2010-07-01 10:43:51 -0600"
-          subject[0].description.should eq "Delivered"
-          subject[0].location.should eq "GA 30506"
-          subject[1].date.to_s.should eq "2010-07-01 08:48:00 -0600"
-          subject[1].description.should eq "On FedEx vehicle for delivery"
-          subject[1].location.should eq "GA 30601"
-          subject[2].date.to_s.should eq "2010-07-01 05:07:00 -0600"
-          subject[2].description.should eq "At local FedEx facility"
-          subject[2].location.should eq "GA 30601"
+        it "should populate its properties with values from the response" do
+          subject.all? {|e| e.description.nil? }.should be_true
+          subject.all? {|e| e.date.is_a?(DateTime) }.should be_true
+          subject.map(&:location).should eq [
+            "new york, NY US", "Memphis, TN US", "CITY OF INDUSTRY, CA US",
+            "ST JACKSON, MS US", "Ontonagon, MI US" ]
         end
       end
     end
-
-    context "with an error response" do
-      let(:fixture) { Fixture.read('fedex/error.xml') }
-      it "should raise a Trackerific::Error" do
-        expect {
-          fedex.track(id)
-        }.to raise_error Trackerific::Error
-      end
-    end
   end
 end

data/spec/lib/trackerific/services/ups_spec.rb

@@ -5,6 +5,27 @@ UPS_TRACK_URL = 'https://wwwcie.ups.com/ups.app/xml/Track'
 describe Trackerific::Services::UPS do
   it { should be_a Trackerific::Services::Base }
 
+  describe "#base_uri" do
+    subject { described_class.base_uri }
+
+    before do
+      Trackerific.stub(:env).and_return(env)
+      Trackerific.reload!('trackerific/services/ups.rb')
+    end
+
+    after(:all) { Trackerific.reload!('trackerific/services/ups.rb') }
+
+    context "when Trackerific.env is 'production'" do
+      let(:env) { 'production' }
+      it { should eq "https://www.ups.com/ups.app/xml" }
+    end
+
+    context "when Trackerific.env is not 'production'" do
+      let(:env) { 'development' }
+      it { should eq 'https://wwwcie.ups.com/ups.app/xml' }
+    end
+  end
+
   let(:valid_ids) { ["1Z12345E0291980793"] }
   let(:invalid_ids) { %w[these are not valid tracking ids] }
 
@@ -39,8 +60,8 @@ describe Trackerific::Services::UPS do
       describe "#events" do
         subject { ups.track(id).events }
         its(:length) { should eq 1 }
-        it "should have the correct values" do
-          subject[0].date.to_s.should eq "2003-03-13T16:00:00+00:00"
+        it "should populate the properties from the XML" do
+          subject[0].date.should be_a DateTime
           subject[0].description.should eq "DELIVERED"
           subject[0].location.should eq "MAYSVILLE 26833   9700 US"
         end

data/spec/lib/trackerific/services/usps_spec.rb

@@ -1,10 +1,47 @@
 require 'spec_helper'
 
-USPS_URL = %r|http://testing\.shippingapis\.com/.*|
-
 describe Trackerific::Services::USPS do
+  let(:usps_url) { %r|http://testing\.shippingapis\.com/.*| }
+
   it { should be_a Trackerific::Services::Base }
 
+  describe "environment dependent methods/properties" do
+    before do
+      Trackerific.stub(:env).and_return(env)
+      Trackerific.reload!('trackerific/services/usps.rb')
+    end
+
+    after(:all) { Trackerific.reload!('trackerific/services/usps.rb') }
+
+    context "when Trackerific.env is 'production'" do
+      let(:env) { 'production' }
+
+      describe "#base_uri" do
+        subject { described_class.base_uri }
+        it { should eq 'http://production.shippingapis.com' }
+      end
+
+      describe "#xml_endpoint" do
+        subject { described_class.xml_endpoint }
+        it { should eq '/ShippingAPI.dll' }
+      end
+    end
+
+    context "when Trackerific.env is not 'production'" do
+      let(:env) { 'development' }
+
+      describe "#base_uri" do
+        subject { described_class.base_uri }
+        it { should eq 'http://testing.shippingapis.com' }
+      end
+
+      describe "#xml_endpoint" do
+        subject { described_class.xml_endpoint }
+        it { should eq '/ShippingAPITest.dll' }
+      end
+    end
+  end
+
   let(:valid_ids) { ["EJ958083578US"] }
   let(:invalid_ids) { %w[these are not valid tracking ids] }
 
@@ -19,38 +56,11 @@ describe Trackerific::Services::USPS do
   let(:credentials) { { user_id: '123USERID4567' } }
   let(:usps) { described_class.new(credentials) }
 
-  describe "#city_state_lookup" do
-    before do
-      FakeWeb.register_uri(:get, USPS_URL, body: fixture)
-    end
-
-    after(:all) { FakeWeb.clean_registry }
-
-    context "with a successful response" do
-      let(:fixture) { Fixture.read('usps/city_state_lookup.xml') }
-      subject { usps.city_state_lookup("90210") }
-      it "should have the correct values" do
-        subject[:city].should eq "BEVERLY HILLS"
-        subject[:state].should eq "CA"
-        subject[:zip].should eq "90210"
-      end
-    end
-
-    context "with an error response" do
-      let(:fixture) { Fixture.read('usps/error.xml') }
-      it "should raise a Trackerific::Error" do
-        expect {
-          usps.city_state_lookup("90210")
-        }.to raise_error Trackerific::Error
-      end
-    end
-  end
-
   describe "#track" do
     let(:id) { 'EJ958083578US' }
 
     before do
-      FakeWeb.register_uri(:get, USPS_URL, body: fixture)
+      FakeWeb.register_uri(:get, usps_url, body: fixture)
     end
 
     after(:all) { FakeWeb.clean_registry }
@@ -71,15 +81,15 @@ describe Trackerific::Services::USPS do
       describe "#events" do
         subject { usps.track(id).events }
         its(:length) { should eq 3 }
-        it "should have the correct values" do
+        it "should populate the properties from the XML" do
           subject[0].date.to_s.should eq "2013-05-30T11:07:00+00:00"
-          subject[0].description.should eq "Notice left"
+          subject[0].description.should eq "NOTICE LEFT"
           subject[0].location.should eq "WILMINGTON, DE 19801"
           subject[1].date.to_s.should eq "2013-05-30T10:08:00+00:00"
-          subject[1].description.should eq "Arrival at unit"
+          subject[1].description.should eq "ARRIVAL AT UNIT"
           subject[1].location.should eq "WILMINGTON, DE 19850"
           subject[2].date.to_s.should eq "2013-05-29T09:55:00+00:00"
-          subject[2].description.should eq "Accept or pickup"
+          subject[2].description.should eq "ACCEPT OR PICKUP"
           subject[2].location.should eq "EDGEWATER, NJ 07020"
         end
       end