package_tracker 0.0.2

data/spec/carrier/fedex_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../spec_helper'
+
+describe 'FedEx' do  
+  before do
+    @valid_credentials = {:key => "1111", :password => "2222", :account => "3333", :meter => "4444"}
+    @invalid_credentials = {:key => "5555", :password => "6666", :account => "7777", :meter => "8888"}
+    @valid_tracking_number = "999999999999"
+    @invalid_tracking_number = "000000000000"
+    
+    @client = PackageTracker::Client.new(:fedex => @valid_credentials)
+    @invalid_credentials_client = PackageTracker::Client.new(:fedex => @invalid_credentials)
+        
+    stub_request(:post, "https://gateway.fedex.com/xml")
+      .with(:body => PackageTracker::Carriers::FedEx.send(:request_data, @valid_tracking_number, @valid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/fedex/valid.xml"), :status => 200)
+      
+    stub_request(:post, "https://gateway.fedex.com/xml")
+      .with(:body => PackageTracker::Carriers::FedEx.send(:request_data, @valid_tracking_number, @invalid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/fedex/invalid_credentials.xml"), :status => 200)
+      
+    stub_request(:post, "https://gateway.fedex.com/xml")
+      .with(:body => PackageTracker::Carriers::FedEx.send(:request_data, @invalid_tracking_number, @valid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/fedex/invalid_tracking_number.xml"), :status => 200)
+      
+    stub_request(:post, "https://gatewaybeta.fedex.com/xml")
+      .to_return(:body => File.new("spec/fixtures/responses/fedex/valid.xml"), :status => 200)
+  end
+  
+  it 'should send requests to the test server in test mode' do
+    test_client = PackageTracker::Client.new(:fedex => @valid_credentials)
+    test_client.test_mode!
+    test_client.track(@valid_tracking_number)
+    WebMock.should have_requested(:post, "https://gatewaybeta.fedex.com/xml")
+  end
+
+  it 'should send requests to the live server in production mode' do
+    @client.track(@valid_tracking_number)
+    WebMock.should have_requested(:post, "https://gateway.fedex.com/xml")
+  end
+
+  it 'should raise an error with missing credentials' do
+    lambda { PackageTracker::Client.new(:fedex => {:key => "1111"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    lambda { PackageTracker::Client.new(:fedex => {:password => "2222"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    lambda { PackageTracker::Client.new(:fedex => {:account => "3333"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    lambda { PackageTracker::Client.new(:fedex => {:meter => "4444"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    
+    lambda { @client.track(@valid_tracking_number) }.should_not raise_error(PackageTracker::MissingCredentialsError)
+  end
+  
+  it 'should raise an error with invalid credentials' do
+    lambda { @invalid_credentials_client.track(@valid_tracking_number) }.should raise_error(PackageTracker::InvalidCredentialsError)
+  end
+  
+  it 'should raise an error when an invalid tracking number is supplied' do
+    lambda { @client.track(@invalid_tracking_number) }.should raise_error(PackageTracker::InvalidTrackingNumberError)
+  end
+  
+  it 'should return a response object' do
+    response = @client.track(@valid_tracking_number)
+    response.should be_an_instance_of(PackageTracker::Response)
+  end
+  
+  it 'should return the correct number of statuses' do
+    @client.track(@valid_tracking_number).statuses.length.should == 8
+  end
+end

data/spec/carrier/ups_spec.rb

@@ -0,0 +1,75 @@
+require_relative '../spec_helper'
+
+describe "UPS" do  
+  before do
+    @valid_credentials = {:user_id => "1111", :password => "2222", :key => "3333"}
+    @invalid_credentials = {:user_id => "4444", :password => "5555", :key => "6666"}
+    @valid_tracking_number = "1ZA2552X0397250131"
+    @invalid_tracking_number = "1ZA2552X0397250132"
+    
+    @client = PackageTracker::Client.new(:ups => @valid_credentials)
+    @invalid_credentials_client = PackageTracker::Client.new(:ups => @invalid_credentials)
+    
+    stub_request(:post, "http://www.ups.com/ups.app/xml/Track")
+      .with(:body => PackageTracker::Carriers::UPS.send(:request_data, @valid_tracking_number, @valid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/ups/valid.xml"), :status => 200)
+      
+    stub_request(:post, "http://www.ups.com/ups.app/xml/Track")
+      .with(:body => PackageTracker::Carriers::UPS.send(:request_data, @valid_tracking_number, @invalid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/ups/invalid_credentials.xml"), :status => 200)
+      
+    stub_request(:post, "http://www.ups.com/ups.app/xml/Track")
+      .with(:body => PackageTracker::Carriers::UPS.send(:request_data, @invalid_tracking_number, @valid_credentials))
+      .to_return(:body => File.new("spec/fixtures/responses/ups/invalid_tracking_number.xml"), :status => 200)
+
+    stub_request(:post, "http://wwwcie.ups.com/ups.app/xml/Track")
+      .to_return(:body => File.new("spec/fixtures/responses/ups/valid.xml"), :status => 200)
+  end
+  
+  it 'should send requests to the test server when in test mode' do
+    test_client = PackageTracker::Client.new(:ups => @valid_credentials)
+    test_client.test_mode!
+    test_client.track(@valid_tracking_number)
+    WebMock.should have_requested(:post, "http://wwwcie.ups.com/ups.app/xml/Track")
+  end
+  
+  it 'should send requests to the live server when in production mode' do
+    @client.track(@valid_tracking_number)
+    WebMock.should have_requested(:post, "http://www.ups.com/ups.app/xml/Track")
+  end
+  
+  it 'should handle missing credentials' do
+    lambda { PackageTracker::Client.new(:ups => {:user_id => "1111"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    lambda { PackageTracker::Client.new(:ups => {:password => "2222"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    lambda { PackageTracker::Client.new(:ups => {:key => "3333"}).track(@valid_tracking_number) }.should raise_error(PackageTracker::MissingCredentialsError)
+    
+    lambda { @client.track("1ZA2552X0397250131") }.should_not raise_error(PackageTracker::MissingCredentialsError)
+  end
+  
+  it 'should handle invalid credentials' do
+    lambda { @invalid_credentials_client.track("1ZA2552X0397250131") }.should raise_error(PackageTracker::InvalidCredentialsError)
+  end
+  
+  it 'should handle invalid tracking numbers' do
+    lambda { @client.track(@invalid_tracking_number) }.should raise_error(PackageTracker::InvalidTrackingNumberError)
+  end
+  
+  it 'should properly build the request body' do
+    @client.track(@valid_tracking_number)
+    # WebMock.should have_requested(:post, "http://www.ups.com/ups.app/xml/Track").with(:body => File.new("spec/fixtures/requests/ups/valid.xml").read)
+    pending "Not Exactly sure of the best way to test this"
+  end
+  
+  it 'should return a response object' do
+    response = @client.track(@valid_tracking_number)
+    response.should be_an_instance_of(PackageTracker::Response)
+  end
+  
+  it 'should return the correct number of status activities' do
+    @client.track(@valid_tracking_number).statuses.length.should == 13
+  end
+  
+  it 'should be able to verify delivery' do
+    @client.track(@valid_tracking_number).delivered?.should == true
+  end
+end

data/spec/fixtures/requests/ups/invalid_credentials.xml

@@ -0,0 +1 @@
+<?xmlversion='1.0'?><AccessRequestxml:lang='en-US'><AccessLicenseNumber>6666</AccessLicenseNumber><UserId>4444</UserId><Password>5555</Password></AccessRequest><?xmlversion='1.0'?><TrackRequestxml:lang='en-US'><Request><TransactionReference><XpciVersion>1.0</XpciVersion></TransactionReference><RequestAction>Track</RequestAction><RequestOption>activity</RequestOption></Request><TrackingNumber>1ZA2552X0397250131</TrackingNumber></TrackRequest>

data/spec/fixtures/requests/ups/invalid_tracking_number.xml

@@ -0,0 +1,17 @@
+<?xml version='1.0'?>
+  <AccessRequest xml:lang='en-US'>
+    <AccessLicenseNumber>3333</AccessLicenseNumber>
+    <UserId>1111</UserId>
+    <Password>2222</Password>
+  </AccessRequest>
+  <?xml version='1.0'?>
+  <TrackRequest xml:lang='en-US'>
+    <Request>
+      <TransactionReference>
+        <XpciVersion>1.0</XpciVersion>
+      </TransactionReference>
+      <RequestAction>Track</RequestAction>
+      <RequestOption>activity</RequestOption>
+    </Request>
+    <TrackingNumber>1ZA2552X0397250132</TrackingNumber>
+  </TrackRequest>

data/spec/fixtures/requests/ups/valid.xml

@@ -0,0 +1,17 @@
+<?xml version='1.0'?>
+  <AccessRequest xml:lang='en-US'>
+    <AccessLicenseNumber>3333</AccessLicenseNumber>
+    <UserId>1111</UserId>
+    <Password>2222</Password>
+  </AccessRequest>
+  <?xml version='1.0'?>
+  <TrackRequest xml:lang='en-US'>
+    <Request>
+      <TransactionReference>
+        <XpciVersion>1.0</XpciVersion>
+      </TransactionReference>
+      <RequestAction>Track</RequestAction>
+      <RequestOption>activity</RequestOption>
+    </Request>
+    <TrackingNumber>#{tracking_number}</TrackingNumber>
+  </TrackRequest>

data/spec/fixtures/responses/fedex/invalid_credentials.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ns:TrackReply xmlns:ns="http://fedex.com/ws/track/v3">
+  <ns:HighestSeverity>ERROR</ns:HighestSeverity>
+  <ns:Notifications>
+    <ns:Severity>ERROR</ns:Severity>
+    <ns:Source>prof</ns:Source>
+    <ns:Code>1000</ns:Code>
+    <ns:Message>Authentication Failed</ns:Message>
+  </ns:Notifications>
+  <ns:TransactionDetail>
+    <ns:CustomerTransactionId>Package Tracker Ruby Gem</ns:CustomerTransactionId>
+  </ns:TransactionDetail>
+  <ns:Version>
+    <ns:ServiceId>trck</ns:ServiceId>
+    <ns:Major>3</ns:Major>
+    <ns:Intermediate>0</ns:Intermediate>
+    <ns:Minor>0</ns:Minor>
+  </ns:Version>
+</ns:TrackReply>

data/spec/fixtures/responses/fedex/invalid_tracking_number.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<v3:TrackReply xmlns:v3="http://fedex.com/ws/track/v3">
+  <v3:HighestSeverity>ERROR</v3:HighestSeverity>
+  <v3:Notifications>
+    <v3:Severity>ERROR</v3:Severity>
+    <v3:Source>trck</v3:Source>
+    <v3:Code>9040</v3:Code>
+    <v3:Message>No information for the following shipments has been received by our system yet.  Please try again or contact Customer Service at 1.800.Go.FedEx(R) 800.463.3339.</v3:Message>
+    <v3:LocalizedMessage>No information for the following shipments has been received by our system yet.  Please try again or contact Customer Service at 1.800.Go.FedEx(R) 800.463.3339.</v3:LocalizedMessage>
+  </v3:Notifications>
+  <v3:TransactionDetail>
+    <v3:CustomerTransactionId>Package Tracker Ruby Gem</v3:CustomerTransactionId>
+  </v3:TransactionDetail>
+  <v3:Version>
+    <v3:ServiceId>trck</v3:ServiceId>
+    <v3:Major>3</v3:Major>
+    <v3:Intermediate>0</v3:Intermediate>
+    <v3:Minor>0</v3:Minor>
+  </v3:Version>
+  <v3:DuplicateWaybill>false</v3:DuplicateWaybill>
+  <v3:MoreData>false</v3:MoreData>
+</v3:TrackReply>

data/spec/fixtures/responses/fedex/valid.xml

@@ -0,0 +1,160 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<v3:TrackReply xmlns:v3="http://fedex.com/ws/track/v3">
+  <v3:HighestSeverity>SUCCESS</v3:HighestSeverity>
+  <v3:Notifications>
+    <v3:Severity>SUCCESS</v3:Severity>
+    <v3:Source>trck</v3:Source>
+    <v3:Code>0</v3:Code>
+    <v3:Message>Request was successfully processed.</v3:Message>
+    <v3:LocalizedMessage>Request was successfully processed.</v3:LocalizedMessage>
+  </v3:Notifications>
+  <v3:TransactionDetail>
+    <v3:CustomerTransactionId>Package Tracker Ruby Gem</v3:CustomerTransactionId>
+  </v3:TransactionDetail>
+  <v3:Version>
+    <v3:ServiceId>trck</v3:ServiceId>
+    <v3:Major>3</v3:Major>
+    <v3:Intermediate>0</v3:Intermediate>
+    <v3:Minor>0</v3:Minor>
+  </v3:Version>
+  <v3:DuplicateWaybill>false</v3:DuplicateWaybill>
+  <v3:MoreData>false</v3:MoreData>
+  <v3:TrackDetails>
+    <v3:TrackingNumber>9611804854517911563928</v3:TrackingNumber>
+    <v3:TrackingNumberUniqueIdentifier>12010~854517911563928</v3:TrackingNumberUniqueIdentifier>
+    <v3:StatusCode>DL</v3:StatusCode>
+    <v3:StatusDescription>Delivered</v3:StatusDescription>
+    <v3:CarrierCode>FDXG</v3:CarrierCode>
+    <v3:OtherIdentifiers>
+      <v3:Value>37371076</v3:Value>
+      <v3:Type>CUSTOMER_REFERENCE</v3:Type>
+    </v3:OtherIdentifiers>
+    <v3:OtherIdentifiers>
+      <v3:Value>Dn1M27rSR</v3:Value>
+      <v3:Type>GROUND_SHIPMENT_ID</v3:Type>
+    </v3:OtherIdentifiers>
+    <v3:ServiceInfo>FedEx Home Delivery</v3:ServiceInfo>
+    <v3:ServiceType>GROUND_HOME_DELIVERY</v3:ServiceType>
+    <v3:PackageWeight>
+      <v3:Units>LB</v3:Units>
+      <v3:Value>26.0</v3:Value>
+    </v3:PackageWeight>
+    <v3:Packaging>Package</v3:Packaging>
+    <v3:PackageSequenceNumber>1</v3:PackageSequenceNumber>
+    <v3:PackageCount>1</v3:PackageCount>
+    <v3:OriginLocationAddress>
+      <v3:City>PHOENIX</v3:City>
+      <v3:StateOrProvinceCode>AZ</v3:StateOrProvinceCode>
+      <v3:CountryCode>US</v3:CountryCode>
+      <v3:Residential>false</v3:Residential>
+    </v3:OriginLocationAddress>
+    <v3:ShipTimestamp>2010-11-30T00:00:00</v3:ShipTimestamp>
+    <v3:DestinationAddress>
+      <v3:City>SAN FRANCISCO</v3:City>
+      <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+      <v3:CountryCode>US</v3:CountryCode>
+      <v3:Residential>false</v3:Residential>
+    </v3:DestinationAddress>
+    <v3:ActualDeliveryTimestamp>2010-12-03T10:32:38-08:00</v3:ActualDeliveryTimestamp>
+    <v3:ActualDeliveryAddress>
+      <v3:City>San Francisco</v3:City>
+      <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+      <v3:CountryCode>US</v3:CountryCode>
+      <v3:Residential>false</v3:Residential>
+    </v3:ActualDeliveryAddress>
+    <v3:DeliverySignatureName>GELISABETH</v3:DeliverySignatureName>
+    <v3:SignatureProofOfDeliveryAvailable>true</v3:SignatureProofOfDeliveryAvailable>
+    <v3:Events>
+      <v3:Timestamp>2010-12-03T10:32:38-08:00</v3:Timestamp>
+      <v3:EventType>DL</v3:EventType>
+      <v3:EventDescription>Delivered</v3:EventDescription>
+      <v3:Address>
+        <v3:City>San Francisco</v3:City>
+        <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+        <v3:PostalCode>94105</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-12-03T03:22:00-08:00</v3:Timestamp>
+      <v3:EventType>OD</v3:EventType>
+      <v3:EventDescription>On FedEx vehicle for delivery</v3:EventDescription>
+      <v3:Address>
+        <v3:City>SOUTH SAN FRANCISCO</v3:City>
+        <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+        <v3:PostalCode>94080</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-12-02T21:23:25-08:00</v3:Timestamp>
+      <v3:EventType>AR</v3:EventType>
+      <v3:EventDescription>At local FedEx facility</v3:EventDescription>
+      <v3:Address>
+        <v3:City>SOUTH SAN FRANCISCO</v3:City>
+        <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+        <v3:PostalCode>94080</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-12-02T19:02:44-08:00</v3:Timestamp>
+      <v3:EventType>DP</v3:EventType>
+      <v3:EventDescription>Departed FedEx location</v3:EventDescription>
+      <v3:Address>
+        <v3:City>SACRAMENTO</v3:City>
+        <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+        <v3:PostalCode>95824</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-12-02T15:57:00-08:00</v3:Timestamp>
+      <v3:EventType>AR</v3:EventType>
+      <v3:EventDescription>Arrived at FedEx location</v3:EventDescription>
+      <v3:Address>
+        <v3:City>SACRAMENTO</v3:City>
+        <v3:StateOrProvinceCode>CA</v3:StateOrProvinceCode>
+        <v3:PostalCode>95824</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-11-30T14:41:00-07:00</v3:Timestamp>
+      <v3:EventType>AR</v3:EventType>
+      <v3:EventDescription>Arrived at FedEx location</v3:EventDescription>
+      <v3:Address>
+        <v3:City>PHOENIX</v3:City>
+        <v3:StateOrProvinceCode>AZ</v3:StateOrProvinceCode>
+        <v3:PostalCode>85043</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-11-30T09:53:00-07:00</v3:Timestamp>
+      <v3:EventType>PU</v3:EventType>
+      <v3:EventDescription>Picked up</v3:EventDescription>
+      <v3:Address>
+        <v3:City>PHOENIX</v3:City>
+        <v3:StateOrProvinceCode>AZ</v3:StateOrProvinceCode>
+        <v3:PostalCode>85043</v3:PostalCode>
+        <v3:CountryCode>US</v3:CountryCode>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+    <v3:Events>
+      <v3:Timestamp>2010-11-30T08:23:00-07:00</v3:Timestamp>
+      <v3:EventType>OC</v3:EventType>
+      <v3:EventDescription>Shipment information sent to FedEx</v3:EventDescription>
+      <v3:Address>
+        <v3:Residential>false</v3:Residential>
+      </v3:Address>
+    </v3:Events>
+  </v3:TrackDetails>
+</v3:TrackReply>

data/spec/fixtures/responses/ups/invalid_credentials.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <Response>
+    <TransactionReference>
+      <XpciVersion>1.0</XpciVersion>
+    </TransactionReference>
+    <ResponseStatusCode>0</ResponseStatusCode>
+    <ResponseStatusDescription>Failure</ResponseStatusDescription>
+    <Error>
+      <ErrorSeverity>Hard</ErrorSeverity>
+      <ErrorCode>250003</ErrorCode>
+      <ErrorDescription>Invalid Access License number</ErrorDescription>
+    </Error>
+  </Response>
+</TrackResponse>

data/spec/fixtures/responses/ups/invalid_tracking_number.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <Response>
+    <TransactionReference>
+      <XpciVersion>1.0</XpciVersion>
+    </TransactionReference>
+    <ResponseStatusCode>0</ResponseStatusCode>
+    <ResponseStatusDescription>Failure</ResponseStatusDescription>
+    <Error>
+      <ErrorSeverity>Hard</ErrorSeverity>
+      <ErrorCode>151018</ErrorCode>
+      <ErrorDescription>Invalid tracking number</ErrorDescription>
+    </Error>
+  </Response>
+</TrackResponse>