trackerific 0.7.1 → 0.7.2

data/spec/fixtures/ups/malformed.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <Response>
+    <ResponseStatusCode>3</ResponseStatusCode>
+    <ResponseStatusDescription>Failure</ResponseStatusDescription>
+    <Error>
+      <ErrorCode>10002</ErrorCode>
+    </Error>
+  </Response>
+</TrackResponse>

data/spec/fixtures/ups/request.xml

@@ -0,0 +1 @@
+<?xml encoding="UTF-8"?><AccessRequest><AccessLicenseNumber>KEY</AccessLicenseNumber><UserId>USER ID</UserId><Password>PASSWORD</Password></AccessRequest><TrackRequest><Request><RequestAction>Track</RequestAction><RequestOption>activity</RequestOption></Request><TrackingNumber>PACKAGE ID</TrackingNumber></TrackRequest>

data/spec/fixtures/usps/malformed.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<oops></oops>

data/spec/fixtures/usps/request.xml

@@ -0,0 +1 @@
+<?xml encoding="UTF-8"?><TrackRequest USERID="USER ID"><TrackID ID="PACKAGE ID"/></TrackRequest>

data/spec/lib/trackerific/builders/base/soap_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Trackerific::Builders::Base::SOAP do
+  let(:builder) { described_class.new(:hello, :world) }
+
+  context "when #build is not implemented in the subclass" do
+    it "should raise a NotImplementedError on initialize" do
+      expect {
+        builder.new
+      }.to raise_error NotImplementedError
+    end
+  end
+
+  context "when #build is implemented in the subclass" do
+    before do
+      builder.any_instance.stub(:build).and_return("BUILD")
+    end
+
+    it "should call #build on initialize" do
+      builder.any_instance.should_receive(:build)
+      builder.new
+    end
+
+    it "should assign the output of #build to #hash" do
+      b = builder.new
+      b.hash.should eq "BUILD"
+    end
+  end
+end

data/spec/lib/trackerific/builders/base/xml_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Trackerific::Builders::Base::XML do
+  let(:builder) { described_class.new(:hello, :world) }
+
+  subject { builder }
+
+  it { should respond_to :xml_version }
+  it { should respond_to :xml_version= }
+
+  context "when #build is not implemented in the subclass" do
+    it "should raise a NotImplementedError on initialize" do
+      expect {
+        builder.new
+      }.to raise_error NotImplementedError
+    end
+  end
+
+  context "when #build is implemented in the subclass" do
+    subject { builder.new('hi', 'earth') }
+
+    before do
+      builder.send(:define_method, :build) do
+        builder.Hello hello
+        builder.World world
+      end
+    end
+
+    let(:xml) do
+      '<?xml encoding="UTF-8"?><Hello>hi</Hello><World>earth</World>'
+    end
+
+    its(:xml) { should eq xml }
+  end
+end

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Trackerific::Builders::FedEx do
+  it { should be_a Trackerific::Builders::Base::SOAP }
+
+  describe "#members" do
+    subject { described_class.members }
+    it { should include :key }
+    it { should include :password }
+    it { should include :account_number }
+    it { should include :meter_number }
+    it { should include :package_id }
+  end
+
+  describe "#new" do
+    let(:params) do
+      [ "KEY", "PASSWORD", "ACCOUNT NUMBER", "METER NUMBER", "PACKAGE ID" ]
+    end
+
+    let(:transaction_id) { "TRANSACTION ID" }
+    let(:instance) { described_class.new(*params) }
+    let(:hash) { instance.hash }
+
+    describe "Web Authentication Detail" do
+      let(:web_authentication_detail) { hash[:web_authentication_detail] }
+
+      describe "User Credential" do
+        subject { web_authentication_detail[:user_credential] }
+        its([:key]) { should eq "KEY" }
+        its([:password]) { should eq "PASSWORD" }
+      end
+    end
+
+    describe "Client Detail" do
+      subject { hash[:client_detail] }
+      its([:account_number]) { should eq "ACCOUNT NUMBER" }
+      its([:meter_number]) { should eq "METER NUMBER" }
+    end
+
+    describe "Transaction Detail" do
+      subject { hash[:transaction_detail] }
+      its([:customer_transaction_id]) { should eq "Trackerific" }
+    end
+
+    describe "Version" do
+      subject { hash[:version] }
+      its([:service_id]) { should eq "trck" }
+      its([:major]) { should eq "8" }
+      its([:intermediate]) { should eq "0" }
+      its([:minor]) { should eq "0" }
+    end
+
+    describe "Selection Details" do
+      let(:selection_details) { hash[:selection_details] }
+      subject { selection_details }
+      its([:carrier_code]) { should eq "FDXE" }
+
+      describe "Package Identifier" do
+        subject { selection_details[:package_identifier] }
+        its([:type]) { should eq "TRACKING_NUMBER_OR_DOORTAG" }
+        its([:value]) { should eq "PACKAGE ID" }
+      end
+    end
+
+    describe "Processing Options" do
+      subject { hash[:processing_options] }
+      it { should eq "INCLUDE_DETAILED_SCANS" }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Trackerific::Builders::UPS do
+  subject { described_class.new("KEY", "USER ID", "PASSWORD", "PACKAGE ID") }
+
+  it { should be_a Trackerific::Builders::Base::XML }
+
+  let(:fixture) { Fixture.read('ups/request.xml') }
+
+  its(:xml) { should eq fixture.strip }
+end

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Trackerific::Builders::USPS do
+  it { should be_a Trackerific::Builders::Base::XML }
+
+  subject { described_class.new("USER ID", "PACKAGE ID") }
+
+  let(:fixture) { Fixture.read('usps/request.xml') }
+
+  its(:xml) { should eq fixture.strip }
+end

data/spec/lib/trackerific/environment_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Trackerific do
+  describe "#env" do
+    let(:rack_env) { nil }
+    let(:rails_env) { nil }
+
+    before(:all) do
+      Trackerific.env = nil
+    end
+
+    before(:each) do
+      ENV['RAILS_ENV'] = rails_env
+      ENV['RACK_ENV'] = rack_env
+    end
+
+    after(:all) do
+      Trackerific.env = 'test'
+      ENV['RAILS_ENV'] = nil
+      ENV['RACK_ENV'] = 'test'
+    end
+
+    subject { Trackerific.env }
+
+    context "when RAILS_ENV and RACK_ENV are not present" do
+      it { should eq 'development' }
+    end
+
+    context "when RAILS_ENV is present" do
+      let(:rails_env) { 'RAILS' }
+      it { should eq rails_env }
+    end
+
+    context "when RACK_ENV is present" do
+      let(:rack_env) { 'RACK' }
+      it { should eq rack_env }
+    end
+
+    context "when RAILS_ENV and RACK_ENV is present" do
+      let(:rack_env) { 'RACK' }
+      let(:rails_env) { 'RAILS' }
+      it { should eq rails_env }
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Trackerific::Parsers::Base do
+  let(:package_id) { "PACKAGE ID" }
+  let(:response) { double(:response) }
+  let(:parser) { described_class.new(package_id, response) }
+
+  let(:response_error) { nil }
+  let(:summary) { "SUMMARY" }
+  let(:events) { double([Trackerific::Event]) }
+
+  describe "#parse" do
+    let(:stub_summary) { true }
+    let(:stub_events) { true }
+    let(:stub_response_error) { true }
+
+    before do
+      parser.stub(:summary).and_return(summary) if stub_summary
+      parser.stub(:events).and_return(events) if stub_events
+      parser.stub(:response_error).and_return(response_error) if stub_response_error
+    end
+
+    subject { parser.parse }
+
+    context "when #response_error is a Trackerific::Error" do
+      let(:response_error) { Trackerific::Error.new }
+      it { should eq response_error }
+    end
+
+    context "when #response_error is false" do
+      let(:response_error) { false }
+      it { should be_a Trackerific::Details }
+      its(:package_id) { should eq package_id }
+      its(:summary) { should eq summary }
+      its(:events) { should eq events }
+    end
+
+    context "when the subclass does not properly define all required methods" do
+      context "when #response_error is not overridden" do
+        let(:stub_response_error) { false }
+        it "should raise a NotImplementedError" do
+          expect { subject }.to raise_error NotImplementedError
+        end
+      end
+
+      context "when #events is not overridden" do
+        let(:stub_events) { false }
+        it "should raise a NotImplementedError" do
+          expect { subject }.to raise_error NotImplementedError
+        end
+      end
+
+      context "when #summary is not overridden" do
+        let(:stub_summary) { false }
+        it "should raise a NotImplementedError" do
+          expect { subject }.to raise_error NotImplementedError
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Trackerific::Parsers::UPS do
+  let(:package_id) { "PACKAGE ID" }
+
+  let(:xml) { "" }
+
+  let(:response) { Hash.from_xml(xml) || {} }
+
+  let(:parser) { described_class.new(package_id, response) }
+
+  subject { parser }
+
+  it { should be_a Trackerific::Parsers::Base }
+
+  describe "#parse" do
+    before do
+      response.stub(:code).and_return(response_code)
+    end
+
+    subject { parser.parse }
+
+    context "when response.code is not 200" do
+      let(:response_code) { 404 }
+      it { should be_a Trackerific::Error }
+      its(:message) { should eq "HTTP returned status 404" }
+    end
+
+    context "when response.code is 200" do
+      let(:response_code) { 200 }
+
+      context "with an unknown/malformed response" do
+        let(:xml) { Fixture.read('ups/malformed.xml') }
+        it { should be_a Trackerific::Error }
+      end
+
+      context "with an error response" do
+        let(:xml) { Fixture.read('ups/error.xml') }
+        it { should be_a Trackerific::Error }
+      end
+
+      context "with a success response" do
+        let(:xml) { Fixture.read('ups/success.xml') }
+        it { should be_a Trackerific::Details }
+
+        it "should populate its properties with values from the XML" do
+          subject.package_id.should eq "PACKAGE ID"
+          subject.summary.should eq "DELIVERED"
+          subject.weight.should be_nil
+          subject.via.should be_nil
+        end
+
+        describe "#events" do
+          subject { parser.parse.events }
+
+          it "should be an Array of Trackerific::Event" do
+            subject.should be_a Array
+            subject.length.should eq 1
+            subject.all? {|e| e.should be_a Trackerific::Event }.should be_true
+          end
+
+          it "should populate the events with values 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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Trackerific::Parsers::USPS do
+  let(:package_id) { "PACKAGE ID" }
+
+  let(:xml) { "" }
+
+  let(:response) { Hash.from_xml(xml) || {} }
+
+  let(:parser) { described_class.new(package_id, response) }
+
+  subject { parser }
+
+  it { should be_a Trackerific::Parsers::Base }
+
+  describe "#parse" do
+    before do
+      response.stub(:code).and_return(response_code)
+    end
+
+    subject { parser.parse }
+
+    context "when response.code is not 200" do
+      let(:response_code) { 404 }
+      it { should be_a Trackerific::Error }
+      its(:message) { should eq "HTTP returned status 404" }
+    end
+
+    context "when response.code is 200" do
+      let(:response_code) { 200 }
+
+      context "with an unknown/malformed response" do
+        let(:xml) { Fixture.read('usps/malformed.xml') }
+        it { should be_a Trackerific::Error }
+      end
+
+      context "with an error response" do
+        let(:xml) { Fixture.read('usps/error.xml') }
+        it { should be_a Trackerific::Error }
+      end
+
+      context "with a success response" do
+        let(:xml) { Fixture.read('usps/success.xml') }
+        it { should be_a Trackerific::Details }
+
+        it "should populate its properties with values from the XML" do
+          subject.package_id.should eq "PACKAGE ID"
+          subject.summary.should eq "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."
+          subject.weight.should be_nil
+          subject.via.should be_nil
+        end
+
+        describe "#events" do
+          subject { parser.parse.events }
+
+          it "should be an Array of Trackerific::Event" do
+            subject.should be_a Array
+            subject.length.should eq 3
+            subject.all? {|e| e.should be_a Trackerific::Event }.should be_true
+          end
+
+          it "should populate the events with values from the XML" do
+            subject[0].date.should be_a DateTime
+            subject[0].description.should eq "NOTICE LEFT"
+            subject[0].location.should eq "WILMINGTON, DE 19801"
+            subject[1].date.should be_a DateTime
+            subject[1].description.should eq "ARRIVAL AT UNIT"
+            subject[1].location.should eq "WILMINGTON, DE 19850"
+            subject[2].date.should be_a DateTime
+            subject[2].description.should eq "ACCEPT OR PICKUP"
+            subject[2].location.should eq "EDGEWATER, NJ 07020"
+          end
+        end
+      end
+    end
+  end
+end