trackerific 0.1.2 → 0.2.0

data/Gemfile

@@ -1,21 +1,21 @@
 source "http://rubygems.org"
 
-gem 'rails', '>= 3.0.0'
+gem "rails", ">= 3.0.0"
 
-gem 'httparty', ">= 0.7.7"
-gem 'builder', ">= 2.1.2"
-gem 'savon', ">= 0.8.6"
-gem 'curb', ">= 0.7.15"
+gem "httparty", ">= 0.7.7"
+gem "builder", ">= 2.1.2"
 
 group :development do
-  gem 'bundler', ">= 1.0.13"
-  gem 'jeweler', ">= 1.5.2"
+  gem "bundler", ">= 1.0.13"
+  gem "jeweler", ">= 1.5.2"
 end
 
 group :development, :test do
-  gem 'rspec-rails', ">= 2.6.1"
+  gem "rspec-rails", ">= 2.6.1"
+  gem "savon_spec", ">= 0.1.6"
+  gem "ruby-debug19", :require => "ruby-debug"
 end
 
 group :test do
-  gem 'fakeweb', ">= 1.3.0"
+  gem "fakeweb", ">= 1.3.0"
 end

data/Gemfile.lock

@@ -28,10 +28,11 @@ GEM
       activemodel (= 3.0.5)
       activesupport (= 3.0.5)
     activesupport (3.0.5)
+    archive-tar-minitar (0.5.2)
     arel (2.0.9)
     builder (2.1.2)
+    columnize (0.3.2)
     crack (0.1.8)
-    curb (0.7.15)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
@@ -49,12 +50,15 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
     mail (2.2.15)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
+    mocha (0.9.12)
     ntlm-http (0.1.1)
     polyglot (0.3.1)
     rack (1.2.2)
@@ -89,11 +93,25 @@ GEM
       activesupport (~> 3.0)
       railties (~> 3.0)
       rspec (~> 2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
     savon (0.8.6)
       builder (>= 2.1.2)
       crack (~> 0.1.8)
       gyoku (>= 0.3.0)
       httpi (>= 0.7.8)
+    savon_spec (0.1.6)
+      mocha (>= 0.9.8)
+      rspec (>= 2.0.0)
+      savon (>= 0.8.0)
     thor (0.14.6)
     treetop (1.4.9)
       polyglot (>= 0.3.1)
@@ -105,10 +123,10 @@ PLATFORMS
 DEPENDENCIES
   builder (>= 2.1.2)
   bundler (>= 1.0.13)
-  curb (>= 0.7.15)
   fakeweb (>= 1.3.0)
   httparty (>= 0.7.7)
   jeweler (>= 1.5.2)
   rails (>= 3.0.0)
   rspec-rails (>= 2.6.1)
-  savon (>= 0.8.6)
+  ruby-debug19
+  savon_spec (>= 0.1.6)

data/README.rdoc

@@ -8,8 +8,8 @@ and then run
 == Usage:
 
   # Track a FedEx package:
-  fedex = Trackerific::FedEx.new :account => '123456789', :meter => '123456789', :key => 'kQdEJwuHBjtQ7g2', :password => 'qqPpiRoE5WdsMO78j8j5GRdoI'
-  tracking_info = fedex.track_package('999999999999')
+  fedex = Trackerific::FedEx.new :account => '123456789', :meter => '123456789'
+  tracking_info = fedex.track_package('183689015000001')
   
   # Track a USPS package:
   usps = Trackerific::USPS.new :user_id => '123USERID4567'
@@ -21,7 +21,8 @@ and then run
 
 === Tracking Results
 
-The tracking results for all three providers are returned in a Hash in this format:
+The tracking results for all three providers are returned in a Hash in this
+format:
 
   {
     :package_id => 'the package id being tracked',
@@ -43,9 +44,24 @@ The above code would yield something that looks like this:
     * May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.
     * May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.
 
+=== Finding a Tracking Service Provider
+
+If you do not know the tracking service provider of a package id, you can use
+the tracking_service helper method to get a Trackerific class that most likely
+will be able to track the given package id.
+
+  include Trackerific
+  tracking_service "183689015000001"    # => Trackerific::FedEx
+  tracking_service "1Z12345E0291980793" # => Trackerific::UPS
+  tracking_service "EJ958083578US"      # => Trackerific::USPS
+  tracking_service "unknown package id" # => nil
+
 === Exception handling:
 
-Exception handling is esssential for tracking packages. If, for example, you enter the wrong number, or the tracking provider has yet to have added the tracking number to their system, a Trackerific::Error will be raised. Here's an example on how to handle Trackerific::Errors:
+Exception handling is esssential for tracking packages. If, for example,
+you enter the wrong number, or the tracking provider has yet to have added the
+tracking number to their system, a Trackerific::Error will be raised. Here's an
+example on how to handle Trackerific::Errors:
 
   begin
     usps.track_package('EJ958083578US')
@@ -55,13 +71,18 @@ Exception handling is esssential for tracking packages. If, for example, you ent
 
 == Contributing to trackerific
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Check out the latest master to make sure the feature hasn't been implemented
+or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make sure to add tests for it. This is important so I don't break it in a
+future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+have your own version, or is otherwise necessary, that is fine, but please
+isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/fedex.rb

@@ -1,64 +1,62 @@
+require 'httparty'
+
 module Trackerific
-  require 'savon'
   
   class FedEx < Base
-    include Trackerific::SoapClient
-    
-    TEST_TRACKING_NUMBERS = ['183689015000001']
+    include ::HTTParty
+    format :xml
+    base_uri "https://gateway.fedex.com"
     
     def required_options
-      [:account, :meter, :key, :password]
+      [:account, :meter]
     end
     
     def track_package(package_id)
       super
-      begin
-        tracking_response = soap_client.request :track do
-          soap.input = 'wsdl:TrackRequest'
-          soap.body = soap_body
-        end.to_hash
-      rescue Savon::HTTP::Error => e
-        raise Trackerific::Error, e.message
-      end
-      if tracking_response[:track_reply][:highest_severity] == 'ERROR'
-        raise Trackerific::Error, tracking_response[:track_reply][:notifications][:message]
+      http_response = self.class.post "/GatewayDC", :body => build_xml_request
+      http_response.error! unless http_response.code == 200
+      
+      track_reply = http_response["FDXTrack2Reply"]
+      raise Trackerific::Error, track_reply["Error"]["Message"] unless track_reply["Error"].nil?
+      
+      details = track_reply["Package"]
+      events = []
+      details["Event"].each do |e|
+        date = Time.parse("#{e["Date"]} #{e["Time"]}").strftime('%b %d %I:%M %P')
+        desc = e["Description"]
+        addr = e["Address"]
+        # Adds event in this format:
+        # MM DD HH:MM am/pm Description City State Zip
+        events << "#{date} #{desc} #{addr["City"]} #{addr["StateOrProvinceCode"]} #{addr["PostalCode"]}"
       end
+      
       return {
-        :package_id => package_id,
-        :summary    => tracking_response[:track_reply][:transaction_detail],
-        :details    => tracking_response[:track_reply][:track_details]
+        :package_id => details["TrackingNumber"],
+        :summary    => details["StatusDescription"],
+        :details    => events
       }
     end
     
     protected
     
-    def soap_body
-      {
-        :WebAuthenticationDetail => {
-          :UserCredential => {
-            :Key => @options[:key],
-            :Password => @options[:password],
-            :order! => [:Key, :Password]
-          }
-        },
-        :ClientDetail => {
-          :AccountNumber => @options[:account],
-          :MeterNumber => @options[:meter]
-        },
-        :Version => {
-          :ServiceId => 'trck',
-          :Major => '4',
-          :Intermediate => '0',
-          :Minor => '0'
-        },
-        :PackageIdentifier => {
-          :Value => @package_id,
-          :Type => 'TRACKING_NUMBER_OR_DOORTAG',
-          :order! => [:Value, :Type]
-        },
-        :IncludeDetailedScans => 'true',
-        :order! => [:WebAuthenticationDetail, :ClientDetail, :Version, :PackageIdentifier, :IncludeDetailedScans]
-      }
+    def build_xml_request
+      xml = ""
+      xmlns_api = "http://www.fedex.com/fsmapi"
+      xmlns_xsi = "http://www.w3.org/2001/XMLSchema-instance"
+      xsi_noNSL = "FDXTrack2Request.xsd"
+      builder = ::Builder::XmlMarkup.new(:target => xml)
+      builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+      builder.FDXTrack2Request "xmlns:api"=>xmlns_api, "xmlns:xsi"=>xmlns_xsi, "xsi:noNamespaceSchemaLocation" => xsi_noNSL do |r|
+        r.RequestHeader do |rh|
+          rh.AccountNumber @options[:account]
+          rh.MeterNumber @options[:meter]
+        end
+        r.PackageIdentifier do |pi|
+          pi.Value @package_id
+        end
+        r.DetailScans true
+      end
+      return xml
     end
     
   end

data/lib/trackerific.rb

@@ -25,8 +25,19 @@ module Trackerific
     end
   end
   
-  require 'soap_client'
   require 'usps'
   require 'fedex'
   require 'ups'
+  
+  def tracking_service(package_id)
+    case package_id
+      when /^.Z/, /^[HK].{10}$/ then Trackerific::UPS
+      when /^96.{20}$/ then Trackerific::FedEx
+      else case package_id.length
+        when 13, 20, 22, 30 then Trackerific::USPS
+        when 12, 15, 19 then Trackerific::FedEx
+        else nil
+      end
+    end
+  end
 end

data/lib/ups.rb

@@ -2,10 +2,12 @@ module Trackerific
   require 'httparty'
   
   class UPS < Base
-    TEST_TRACKING_NUMBERS = [
-      '1Z12345E0291980793', '1Z12345E6692804405','1Z12345E1392654435',
-      '1Z12345E6892410845','1Z12345E029198079','1Z12345E1591910450'
-    ]
+    include ::HTTParty
+    format :xml
+    base_uri defined?(Rails) ? case Rails.env
+      when 'test','development' then 'https://wwwcie.ups.com/ups.app/xml'
+      when 'production' then 'https://www.ups.com/ups.app/xml'
+    end : 'https://www.ups.com/ups.app/xml'
     
     def required_options
       [:key, :user_id, :password]
@@ -13,7 +15,7 @@ module Trackerific
     
     def track_package(package_id)
       super
-      http_response = HTTP.post('/Track', :body => build_xml_request)
+      http_response = self.class.post('/Track', :body => build_xml_request)
       http_response.error! unless http_response.code == 200
       case http_response['TrackResponse']['Response']['ResponseStatusCode']
         when "0" then raise Trackerific::Error, parse_error_response(http_response)
@@ -66,16 +68,5 @@ module Trackerific
       end
       return xml
     end
-    
-    private
-    
-    class HTTP
-      include ::HTTParty
-      format :xml
-      base_uri case Rails.env
-        when 'test','development' then 'https://wwwcie.ups.com/ups.app/xml'
-        when 'production' then 'https://www.ups.com/ups.app/xml'
-      end
-    end
   end
 end

data/lib/usps.rb

@@ -3,8 +3,12 @@ module Trackerific
   require 'httparty'
   
   class USPS < Base
-    HTTP_PATH = '/ShippingAPITest.dll'
-    API = 'TrackV2'
+    include HTTParty
+    format :xml
+    base_uri defined?(Rails) ? case Rails.env
+      when 'test', 'development' then 'http://testing.shippingapis.com'
+      when 'production' then 'https://secure.shippingapis.com'
+    end : 'https://secure.shippingapis.com'
     
     def initialize(options = {})
       super
@@ -17,7 +21,7 @@ module Trackerific
     
     def track_package(package_id)
       super
-      response = HTTP.get(HTTP_PATH, :query => {:API => API, :XML => build_xml_request}.to_query)
+      response = self.class.get('/ShippingAPITest.dll', :query => {:API => 'TrackV2', :XML => build_xml_request}.to_query)
       response.error! unless response.code == 200
       raise Trackerific::Error, response['Error']['Description'] unless response['Error'].nil?
       raise Trackerific::Error, "Tracking information not found in response from server." if response['TrackResponse'].nil?
@@ -40,17 +44,6 @@ module Trackerific
       return tracking_request
     end
     
-    private
-    
-    class HTTP
-      include HTTParty
-      format :xml
-      base_uri case Rails.env
-        when 'test', 'development' then 'http://testing.shippingapis.com'
-        when 'production' then 'https://secure.shippingapis.com'
-      end
-    end
-    
   end
   
 end

data/spec/fixtures/fedex_error_response.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FDXTrack2Reply xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+   <Error>
+      <Code>6035</Code>
+      <Message>Invalid tracking numbers.   Please check the following numbers and resubmit.</Message>
+      <LocalLanguageMessage>Invalid tracking numbers.   Please check the following numbers and resubmit.</LocalLanguageMessage>
+   </Error>
+   <DuplicateWaybill>false</DuplicateWaybill>
+   <MoreData>false</MoreData>
+</FDXTrack2Reply>

data/spec/fixtures/fedex_success_response.xml

@@ -1,12 +1,74 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Header xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/><soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><v4:TrackReply xmlns:v3="http://fedex.com/ws/track/v3" xmlns:v4="http://fedex.com/ws/track/v4"><v4:HighestSeverity>SUCCESS</v4:HighestSeverity><v4:Notifications><v4:Severity>SUCCESS</v4:Severity><v4:Source>trck</v4:Source><v4:Code>0</v4:Code><v4:Message>Request was successfully processed.</v4:Message><v4:LocalizedMessage>Request was successfully processed.</v4:LocalizedMessage></v4:Notifications><v4:TransactionDetail xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
-<v4:CustomerTransactionId>TC030_WSVC_Track_v4 _POS</v4:CustomerTransactionId>
-<v4:Localization>
-<v4:LanguageCode>EN</v4:LanguageCode>
-</v4:Localization>
-</v4:TransactionDetail><v4:Version xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
-<v4:ServiceId>trck</v4:ServiceId>
-<v4:Major>4</v4:Major>
-<v4:Intermediate>0</v4:Intermediate>
-<v4:Minor>0</v4:Minor>
-</v4:Version><v4:DuplicateWaybill>false</v4:DuplicateWaybill><v4:MoreData>false</v4:MoreData><v4:TrackDetails><v4:TrackingNumber>900002707641</v4:TrackingNumber><v4:TrackingNumberUniqueIdentifier>2454532000~900002707641</v4:TrackingNumberUniqueIdentifier><v4:StatusCode>DL</v4:StatusCode><v4:StatusDescription>Delivered</v4:StatusDescription><v4:CarrierCode>FDXE</v4:CarrierCode><v4:OtherIdentifiers><v4:Value>STATION 7</v4:Value><v4:Type>DEPARTMENT</v4:Type></v4:OtherIdentifiers><v4:OtherIdentifiers><v4:Value>699358 JC BILL</v4:Value><v4:Type>SHIPPER_REFERENCE</v4:Type></v4:OtherIdentifiers><v4:ServiceInfo>Standard Overnight</v4:ServiceInfo><v4:ServiceType>STANDARD_OVERNIGHT</v4:ServiceType><v4:PackageWeight><v4:Units>LB</v4:Units><v4:Value>4.0</v4:Value></v4:PackageWeight><v4:ShipmentWeight><v4:Units>LB</v4:Units><v4:Value>4.0</v4:Value></v4:ShipmentWeight><v4:Packaging>Your Packaging</v4:Packaging><v4:PackageSequenceNumber>1</v4:PackageSequenceNumber><v4:PackageCount>1</v4:PackageCount><v4:ShipTimestamp>2008-03-06T17:20:00-08:00</v4:ShipTimestamp><v4:DestinationAddress><v4:City>ALSIP</v4:City><v4:StateOrProvinceCode>IL</v4:StateOrProvinceCode><v4:CountryCode>US</v4:CountryCode><v4:Residential>false</v4:Residential></v4:DestinationAddress><v4:ActualDeliveryTimestamp>2008-03-07T09:14:00-06:00</v4:ActualDeliveryTimestamp><v4:ActualDeliveryAddress><v4:City>ALSIP</v4:City><v4:StateOrProvinceCode>IL</v4:StateOrProvinceCode><v4:CountryCode>US</v4:CountryCode><v4:Residential>false</v4:Residential></v4:ActualDeliveryAddress><v4:DeliveryLocationType>PHARMACY</v4:DeliveryLocationType><v4:DeliveryLocationDescription>Pharmacy</v4:DeliveryLocationDescription><v4:DeliverySignatureName>P.DORIGAN</v4:DeliverySignatureName><v4:SignatureProofOfDeliveryAvailable>true</v4:SignatureProofOfDeliveryAvailable><v4:ProofOfDeliveryNotificationsAvailable>true</v4:ProofOfDeliveryNotificationsAvailable><v4:ExceptionNotificationsAvailable>false</v4:ExceptionNotificationsAvailable><v4:Events><v4:Timestamp>2008-03-07T09:14:00-06:00</v4:Timestamp><v4:EventType>DL</v4:EventType><v4:EventDescription>Delivered</v4:EventDescription><v4:Address><v4:City>ALSIP</v4:City><v4:StateOrProvinceCode>IL</v4:StateOrProvinceCode><v4:PostalCode>60803</v4:PostalCode><v4:CountryCode>US</v4:CountryCode><v4:Residential>false</v4:Residential></v4:Address><v4:ArrivalLocation>DELIVERY_LOCATION</v4:ArrivalLocation></v4:Events></v4:TrackDetails></v4:TrackReply></soapenv:Body></soapenv:Envelope>
+<FDXTrack2Reply xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+   <DuplicateWaybill>false</DuplicateWaybill>
+   <MoreData>false</MoreData>
+   <Package>
+      <TrackingNumber>183689015000001</TrackingNumber>
+      <TrackingNumberUniqueIdentifier>12010~183689015000001</TrackingNumberUniqueIdentifier>
+      <StatusCode>DL</StatusCode>
+      <StatusDescription>Delivered</StatusDescription>
+      <CarrierCode>FDXG</CarrierCode>
+      <OtherIdentifier>
+         <Value>770-886-6395</Value>
+         <Type>CUR</Type>
+      </OtherIdentifier>
+      <Service>FedEx Home Delivery</Service>
+      <Weight>19.8</Weight>
+      <WeightUnits>LBS</WeightUnits>
+      <PackagingDescription>Package</PackagingDescription>
+      <PackageSequenceNumber>1</PackageSequenceNumber>
+      <PackageCount>1</PackageCount>
+      <OriginLocationAddress>
+         <City>ANAHEIM</City>
+         <StateOrProvinceCode>CA</StateOrProvinceCode>
+         <CountryCode>US</CountryCode>
+      </OriginLocationAddress>
+      <ShipDate>2010-06-25</ShipDate>
+      <DestinationAddress>
+         <City>Gainesville</City>
+         <StateOrProvinceCode>GA</StateOrProvinceCode>
+         <CountryCode>US</CountryCode>
+      </DestinationAddress>
+      <DeliveredDate>2010-07-01</DeliveredDate>
+      <DeliveredTime>10:43:51</DeliveredTime>
+      <SignatureProofOfDeliveryAvailable>false</SignatureProofOfDeliveryAvailable>
+      <Event>
+         <Date>2010-07-01</Date>
+         <Time>10:43:51</Time>
+         <Type>DL</Type>
+         <Description>Delivered</Description>
+         <StatusExceptionCode>014</StatusExceptionCode>
+         <StatusExceptionDescription>Left at garage. Signature Service not requested.</StatusExceptionDescription>
+         <Address>
+            <City>Gainesville</City>
+            <StateOrProvinceCode>GA</StateOrProvinceCode>
+            <PostalCode>30506</PostalCode>
+            <CountryCode>US</CountryCode>
+         </Address>
+      </Event>
+      <Event>
+         <Date>2010-07-01</Date>
+         <Time>08:48:00</Time>
+         <Type>OD</Type>
+         <Description>On FedEx vehicle for delivery</Description>
+         <Address>
+            <City>ATHENS</City>
+            <StateOrProvinceCode>GA</StateOrProvinceCode>
+            <PostalCode>30601</PostalCode>
+            <CountryCode>US</CountryCode>
+         </Address>
+      </Event>
+      <Event>
+         <Date>2010-07-01</Date>
+         <Time>05:07:00</Time>
+         <Type>AR</Type>
+         <Description>At local FedEx facility</Description>
+         <Address>
+            <City>ATHENS</City>
+            <StateOrProvinceCode>GA</StateOrProvinceCode>
+            <PostalCode>30601</PostalCode>
+            <CountryCode>US</CountryCode>
+         </Address>
+      </Event>
+   </Package>
+</FDXTrack2Reply>