trackerific 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+gem 'rails', '>= 3.0.0'
+
+gem 'httparty'
+gem 'builder'
+gem 'savon'
+gem 'curb'
+
+group :development do
+  gem 'bundler'
+  gem 'jeweler'
+end
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+end
+
+group :test do
+  gem 'fakeweb'
+end

data/Gemfile.lock

@@ -0,0 +1,115 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    crack (0.1.8)
+    curb (0.7.15)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    gyoku (0.3.1)
+      builder (>= 2.1.2)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+    httpi (0.9.0)
+      ntlm-http (>= 0.1.1)
+      rack
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    ntlm-http (0.1.1)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    savon (0.8.6)
+      builder (>= 2.1.2)
+      crack (~> 0.1.8)
+      gyoku (>= 0.3.0)
+      httpi (>= 0.7.8)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder
+  bundler
+  curb
+  fakeweb
+  httparty
+  jeweler
+  rails (>= 3.0.0)
+  rspec
+  rspec-rails
+  savon

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Travis Haynes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,70 @@
+== Installation:
+
+To use this gem, add this line to your Gemfile
+  gem 'trackerific', :git => 'http://github.com/travishaynes/trackerific.git'
+and then run
+  bundle install
+
+== Usage:
+
+  # Track a FedEx package:
+  fedex = Trackerific::FedEx.new :account => '123456789', :meter => '123456789', :key => 'kQdEJwuHBjtQ7g2', :password => 'qqPpiRoE5WdsMO78j8j5GRdoI'
+  tracking_info = fedex.track_package('999999999999')
+  
+  # Track a USPS package:
+  usps = Trackerific::USPS.new :user_id => '123USERID4567'
+  tracking_info = usps.track_package('EJ958083578US')
+  
+  # Track a UPS package:
+  ups = Trackerific::UPS.new :user_id => 'userid', :key => 'kQdEJwuHBjtQ7g2', :password => 'secret'
+  tracking_info = ups.track_package('1Z12345E0291980793')
+
+=== Tracking Results
+
+The tracking results for all three providers are returned in a Hash in this format:
+
+  {
+    :package_id => 'the package id being tracked',
+    :summary => 'summary of the tracking results',
+    :details => ['array containing each tracking status by date']
+  }
+
+Here's an example of how to print the tracking results out in a readable format:
+
+  puts "Tracking information for package ID: %s" % tracking_info[:package_id]
+  puts tracking_info[:summary]
+  puts "  * %s" % tracking_info[:details].join("\n  * ")
+  
+The above code would yield something that looks like this:
+
+  Tracking information for package ID: EJ958083578US
+  Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.
+    * May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.
+    * May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.
+    * May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.
+
+=== 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:
+
+  begin
+    usps.track_package('EJ958083578US')
+  rescue Trackerific::Error => e
+    puts e.message
+  end
+
+== 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
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Travis Haynes. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "trackerific"
+  gem.homepage = "http://github.com/travishaynes/trackerific"
+  gem.license = "MIT"
+  gem.summary = %Q{Trackerific provides package tracking to Rails.}
+  gem.description = %Q{Trackerific provides USPS, FedEx and UPS package tracking to Rails.}
+  gem.email = "travis.j.haynes@gmail.com"
+  gem.authors = ["Travis Haynes"]
+  gem.add_dependency 'builder', "~> 2.1.2"
+  gem.add_dependency 'xml-simple', "~> 1.0.15"
+  gem.add_dependency 'savon', "~> 0.8.6"
+  gem.add_dependency 'curb', "~> 0.7.15"
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/fedex.rb

@@ -0,0 +1,65 @@
+module Trackerific
+  require 'savon'
+  
+  class FedEx < Base
+    include Trackerific::SoapClient
+    
+    TEST_TRACKING_NUMBERS = ['183689015000001']
+    
+    def required_options
+      [:account, :meter, :key, :password]
+    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]
+      end
+      return {
+        :package_id => package_id,
+        :summary    => tracking_response[:track_reply][:transaction_detail],
+        :details    => tracking_response[:track_reply][:track_details]
+      }
+    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]
+      }
+    end
+    
+  end
+end

data/lib/soap_client.rb

@@ -0,0 +1,13 @@
+module Trackerific
+  require 'savon'
+  
+  module SoapClient
+    def soap_client
+      return @soap_client unless @soap_client.nil?
+      wsdl_document = "#{::File.dirname(__FILE__)}/wsdl/#{self.class.to_s.rpartition("::")[2].downcase}/#{Rails.env}.wsdl"
+      @soap_client = Savon::Client.new do
+        wsdl.document = wsdl_document
+      end
+    end
+  end
+end

data/lib/trackerific.rb

@@ -0,0 +1,32 @@
+module Trackerific
+  require 'rails'
+  
+  class Error < StandardError
+  end
+  
+  class Base
+    def initialize(options = {})
+      required = required_options
+      required.each do |k|
+        raise ArgumentError.new("Missing required parameter: #{k}") unless options.has_key?(k)
+      end
+      options.each do |k, v|
+        raise ArgumentError.new("Invalid parameter: #{k}") unless required.include?(k)
+      end
+      @options = options
+    end
+    
+    def required_options
+      []
+    end
+    
+    def track_package(package_id)
+      @package_id = package_id
+    end
+  end
+  
+  require 'soap_client'
+  require 'usps'
+  require 'fedex'
+  require 'ups'
+end

data/lib/ups.rb

@@ -0,0 +1,81 @@
+module Trackerific
+  require 'httparty'
+  
+  class UPS < Base
+    TEST_TRACKING_NUMBERS = [
+      '1Z12345E0291980793', '1Z12345E6692804405','1Z12345E1392654435',
+      '1Z12345E6892410845','1Z12345E029198079','1Z12345E1591910450'
+    ]
+    
+    def required_options
+      [:key, :user_id, :password]
+    end
+    
+    def track_package(package_id)
+      super
+      http_response = HTTP.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)
+        when "1" then return parse_success_response(http_response)
+        else raise Trackerific::Error, "Invalid response code returned from server."
+      end
+    end
+    
+    protected
+    
+    def parse_success_response(http_response)
+      activity = http_response['TrackResponse']['Shipment']['Package']['Activity']
+      activity = [activity] if activity.is_a? Hash
+      details = []
+      activity.each do |a|
+        status = a['Status']['StatusType']['Description']
+        if status != "UPS INTERNAL ACTIVITY CODE"
+          address = a['ActivityLocation']['Address'].map {|k,v| v}.join(" ")
+          date = "#{a['Date'].to_date} #{a['Time'][0..1]}:#{a['Time'][2..3]}:#{a['Time'][4..5]}".to_datetime
+          details << "#{date.strftime('%b %d %I:%M %P')} #{status}"
+        end
+      end
+      # UPS does not provide a summary, so just use the last tracking details
+      summary = details.last
+      details.delete(summary)
+      return {
+        :package_id => @package_id,
+        :summary => summary,
+        :details => details.reverse
+      }
+    end
+    
+    def parse_error_response(http_response)
+      http_response['TrackResponse']['Response']['Error']['ErrorDescription']
+    end
+    
+    def build_xml_request
+      xml = ""
+      builder = ::Builder::XmlMarkup.new(:target => xml)
+      builder.AccessRequest do |ar|
+        ar.AccessLicenseNumber @options[:key]
+        ar.UserId @options[:user_id]
+        ar.Password @options[:password]
+      end
+      builder.TrackRequest do |tr|
+        tr.Request do |r|
+          r.RequestAction 'Track'
+        end
+        tr.TrackingNumber @package_id
+      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