stalkr 0.9.0

data/Rakefile

@@ -0,0 +1,35 @@
+
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "stalkr"
+    gemspec.summary = "Ruby library for tracking packages"
+    gemspec.description = "Ruby library for tracking UPS, Fedex and USPS packages."
+    gemspec.email = "chetan@pixelcop.net"
+    gemspec.homepage = "http://github.com/chetan/stalkr"
+    gemspec.authors = ["Chetan Sarva"]
+    gemspec.add_dependency('scrapi', '= 1.2.0')
+    gemspec.add_dependency('tzinfo', '>= 0.3.15')
+    gemspec.add_dependency('json', '>= 1.4.6')
+    gemspec.add_dependency('tidy', '>= 1.1.2')
+    gemspec.add_dependency('htmlentities', '>= 4.2.2')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+require "rake/testtask"
+desc "Run unit tests"
+Rake::TestTask.new("test") { |t|
+    #t.libs << "test"
+    t.ruby_opts << "-rubygems"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = false
+    t.warning = false
+}
+
+require "yard"
+YARD::Rake::YardocTask.new("docs") do |t|
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/stalkr.rb

@@ -0,0 +1,50 @@
+
+if RUBY_PLATFORM =~ /darwin/ then
+    # fix for scrapi on Mac OS X
+    require "tidy"
+    Tidy.path = "/usr/lib/libtidy.dylib"
+end
+
+require 'scrapi'
+require 'htmlentities'
+require 'date'
+
+require 'stalkr/base'
+require 'stalkr/result'
+require 'stalkr/ups'
+require 'stalkr/usps'
+require 'stalkr/fedex'
+
+if not DateTime.new.public_methods.include? "to_time" then
+    # monkey patch DateTime to add to_time (exists in Ruby 1.9.2 and above)
+    class DateTime
+        def to_time
+          d = new_offset(0)
+          t = d.instance_eval do
+            Time.utc(year, mon, mday, hour, min, sec +
+                     sec_fraction)
+          end.getlocal
+        end
+    end
+end
+
+module Stalkr
+
+	def self.shippers
+		return [ Stalkr::UPS, Stalkr::USPS, Stalkr::FEDEX ]
+	end
+
+    def self.track(id)
+        shipper = nil
+        if id =~ /\d{22}/ then
+            shipper = Stalkr::USPS
+        elsif id =~ /^1Z/ then
+            shipper = Stalkr::UPS
+        elsif id =~ /\d{20}/ or id =~ /\d{15}/ then
+            shipper = Stalkr::FEDEX
+        end
+        raise 'Unknown shipper code' if shipper.nil?
+        return shipper.new.track(id)
+    end
+
+end # module Stalkr

data/lib/stalkr/base.rb

@@ -0,0 +1,47 @@
+
+module Stalkr
+
+    class Base
+
+        class << self
+            attr_accessor :regex
+        end
+
+        def fetchurl(url)
+            return Net::HTTP.get_response(URI.parse(URI.escape(url))).body
+        end
+
+        def strip_tags(html)
+
+            HTMLEntities.new.decode(
+                html.gsub(/<.+?>/,'').
+                gsub(/<br *\/>/m, '')
+            )
+
+        end
+
+        def cleanup_html(str)
+            str.gsub!(/&nbsp;/, ' ')
+            str = strip_tags(str)
+            str.strip!
+            str.squeeze!(" \n\r")
+            return str
+        end
+
+        def self.is_valid?(id)
+            return (id =~ regex() ? true : false)
+        end
+
+        def self.extract_id(str)
+            if str =~ regex() then
+                # return the first non-nil backreference
+                m = $~.to_a
+                m.shift
+                return m.find{ |s| not s.nil? }.gsub(/ /, '').upcase
+            end
+            return nil
+        end
+
+    end # class Base
+
+end # module Stalkr

data/lib/stalkr/fedex.rb

@@ -0,0 +1,84 @@
+
+require 'json'
+require 'yaml'
+
+module Stalkr
+
+class FEDEX < Base
+
+    self.regex = /\b((96\d\d\d\d\d ?\d\d\d\d|96\d\d) ?\d\d\d\d ?d\d\d\d( ?\d\d\d)?)|(\d{12}|\d{15})\b/i
+
+    def track(id)
+
+        url = "http://www.fedex.com/Tracking?tracknumbers=%CODE%"
+
+        url.gsub!(/%CODE%/, id)
+        html = fetchurl(url)
+
+        if html =~ /invalid._header/ then
+            ret = Result.new(:FEDEX)
+            ret.status = UNKNOWN
+            return ret
+        end
+
+        info_scraper = Scraper.define do
+
+            array :dates
+
+            process "div.detailshipmentstatus", :status => :text
+            process "div.detailshipdates > div.fielddata", :dates => :text
+            process "div.detaildestination > div.fielddata", :destination => :text
+            process_first "div.detailshipfacts div.dataentry", :service_type => :text
+
+            result :status, :dates, :destination, :service_type
+
+        end
+
+        ret = Result.new(:FEDEX)
+
+        info = info_scraper.scrape(html)
+
+        if info.status.strip.downcase == "delivered" then
+            ret.status = DELIVERED
+        end
+        ret.location = info.destination.strip
+
+        # obj.service_type = info.service_type.strip
+
+        # try to get dates
+        shipped_date = info.dates[0].strip
+        delivery_date = info.dates[1].strip if info.dates.length == 2
+        if shipped_date.empty? then
+            shipped_date = DateTime.strptime( $1, "%b %d, %Y" ).to_time if html =~ /var shipDate = "(.*?);$"/
+            delivery_date = DateTime.strptime( "#{$1} -5", "%b %d, %Y %I:%M %p %z" ).to_time if html =~ /var deliveryDateTime = "(.*?)";$/
+        end
+        ret.delivered_at = delivery_date
+        ret.updated_at = delivery_date
+
+        # pull progress from JSON
+        # if html =~ /^var detailInfoObject = (.*);$/ then
+        #     json = $1
+        #     progress = JSON.parse(json)
+        #     scans = progress['scans']
+        #
+        #     progress = []
+        #
+        #     scans.each { |scan|
+        #         o = OpenStruct.new
+        #         o.location      = scan['scanLocation']
+        #         o.date          = scan['scanDate']
+        #         o.local_time    = scan['scanTime']
+        #         o.desc          = scan['scanStatus']
+        #         progress << o
+        #     }
+        #
+        #     obj.progress = progress
+        #
+        # end
+
+        return ret
+
+    end
+
+end # class FEDEX
+end # module Stalkr

data/lib/stalkr/result.rb

@@ -0,0 +1,18 @@
+
+module Stalkr
+
+    UNKNOWN = :unknown
+    DELIVERED = :delivered
+    IN_TRANSIT = :in_transit
+
+    class Result
+
+        attr_accessor :shipper, :status, :updated_at, :delivered_at, :location
+
+        def initialize(shipper)
+            @shipper = shipper
+        end
+
+    end # class Result
+
+end # module Stalkr

data/lib/stalkr/ups.rb

@@ -0,0 +1,79 @@
+
+class Array
+
+    def to_perly_hash()
+        h = {}
+        self.each_index { |i|
+            next if i % 2 != 0
+            h[ self[i] ] = self[i+1]
+        }
+        return h
+    end
+
+end
+
+module Stalkr
+
+class UPS < Base
+
+    self.regex = /\b(1Z ?[0-9A-Z]{3} ?[0-9A-Z]{3} ?[0-9A-Z]{2} ?[0-9A-Z]{4} ?[0-9A-Z]{3} ?[0-9A-Z]|[\dT]\d{3} ?\d{4} ?\d{3})\b/i
+
+    def track(id)
+
+        url = "http://wwwapps.ups.com/WebTracking/processInputRequest?TypeOfInquiryNumber=T&loc=en_US&InquiryNumber1=%CODE%"
+
+        url.gsub!(/%CODE%/, id)
+        html = fetchurl(url)
+
+        detail_scraper = Scraper.define do
+
+            array :keys
+            array :vals
+            array :lists
+
+            process "#trkNum", :trackingNumber => :text
+            process "#tt_spStatus", :status => :text
+            process "#fontControl dt", :keys => :text
+            process "#fontControl dd", :vals => :text
+            process "#fontControl ul.clearfix li", :lists => :text
+
+            result :keys, :vals, :trackingNumber, :status, :lists
+
+        end
+
+        details = detail_scraper.scrape(html)
+
+        if not details.trackingNumber then
+            raise "UPS scraper failed"
+        end
+
+        ret = Result.new(:UPS)
+
+        ret.status = case details.status.strip.downcase
+            when "in transit"
+                IN_TRANSIT
+            when "delivered"
+                DELIVERED
+            else
+                UNKNOWN
+        end
+
+        hash = {}
+        details.keys.each_with_index do |k,i|
+            hash[k] = details.vals[i]
+        end
+
+        if ret.status == DELIVERED then
+            delivered_at = cleanup_html( hash["Delivered On:"] )
+            ret.delivered_at = DateTime.strptime( delivered_at, "%A, %m/%d/%Y at %I:%M %p" ).to_time
+        end
+
+        cleanup_html( details.lists[3] ) =~ /Updated: (.*?)$/
+        ret.updated_at = DateTime.strptime( $1, "%m/%d/%Y %I:%M %p" ).to_time
+
+        return ret
+
+    end
+
+end # class UPS
+end # module Stalkr

data/lib/stalkr/usps.rb

@@ -0,0 +1,78 @@
+
+module Stalkr
+
+class USPS < Base
+
+    # 20 or 22 digits, beginning with 91 (and with or without spaces between groupings)
+    self.regex = /\b(91\d{2} ?\d{4} ?\d{4} ?\d{4} ?\d{4} ?\d{2}|91\d{2} ?\d{4} ?\d{4} ?\d{4} ?\d{4})\b/i
+
+    def track(id)
+
+        # cleanup id
+        id.gsub!(/ /, '')
+
+        url = "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?origTrackNum=%CODE%"
+
+        url.gsub!(/%CODE%/, id)
+        html = fetchurl(url)
+
+        info_scraper = Scraper.define do
+
+            array :details
+            array :info
+            array :txt
+
+            process "span.mainTextbold", :info => :text
+            process "td.mainTextbold", :details => :text
+            process "td.mainText", :txt => :text
+
+            result :details, :info, :txt
+
+        end
+
+        scrape = info_scraper.scrape(html)
+
+        # verify its the correct response page
+        if scrape.info[0].gsub(/ /, '') != id then
+            raise "USPS scraper failed"
+        end
+
+        # extract and return
+        ret = Result.new(:USPS)
+        if scrape.txt.find{ |t| t =~ /There is no record of this item/ } then
+            ret.status = UNKNOWN
+        elsif scrape.info.find{ |i| i.downcase == "delivered" } then
+            ret.status = DELIVERED
+        else
+            ret.status = UNKNOWN
+        end
+
+        if scrape.details and not scrape.details.empty? then
+            if scrape.details[0] =~ /^(.*?), (.*? \d+, \d+), (\d+:\d+ .m), (.*?)$/ then
+                ret.location = $4
+                # not sure if this time is always in EST or the time of the area in which it was delivered?
+                ret.updated_at = DateTime.strptime( "#{$2} #{$3} -0500", "%B %d, %Y %I:%M %p %z" ).to_time
+                if ret.status == DELIVERED then
+                    ret.delivered_at = ret.updated_at
+                end
+
+            elsif scrape.details[0] =~ /Electronic Shipping Info Received/ then
+                ret.status = IN_TRANSIT
+            end
+
+        elsif s = scrape.txt.find{ |t| t =~ /files offline/ }
+            s =~ /at (\d+:\d+ .m) on (.*? \d+, \d+) in (.*?)\.$/
+            ret.location = $3
+            # not sure if this time is always in EST or the time of the area in which it was delivered?
+            ret.updated_at = DateTime.strptime( "#{$2} #{$1} -0500", "%B %d, %Y %I:%M %p %z" ).to_time
+            if ret.status == DELIVERED then
+                ret.delivered_at = ret.updated_at
+            end
+
+        end
+
+        return ret
+    end
+
+end # class USPS
+end # module Stalkr

data/test/stalkr/fedex_test.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class FEDEX_Test < Test::Unit::TestCase
+
+    def test_track
+        id = "106050761498748"
+        info = Stalkr::FEDEX.new.track(id)
+        assert(info.shipper == :FEDEX)
+        assert(info.status == Stalkr::DELIVERED)
+        assert(info.delivered_at.kind_of? Time)
+    end
+
+    def test_track_bad_code
+
+        id = "foobar"
+        info = Stalkr::FEDEX.new.track(id)
+        assert(info.status == Stalkr::UNKNOWN)
+
+    end
+
+    def test_extract_id
+        str = "asdf 106050761498748 asdfas"
+        assert(Stalkr::FEDEX.extract_id(str) == "106050761498748")
+    end
+
+end

data/test/stalkr/ups_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class UPS_Test < Test::Unit::TestCase
+
+    def test_track
+        id = "1ZX799470341200708"
+        info = Stalkr::UPS.new.track(id)
+        assert(info.shipper == :UPS)
+        assert(info.status == Stalkr::DELIVERED)
+        assert(info.delivered_at.kind_of? Time)
+    end
+
+    def test_track_bad_code
+
+        begin
+            id = "foobar"
+            info = Stalkr::UPS.new.track(id)
+            flunk("no exception was thrown")
+        rescue => ex
+            if ex.message != "UPS scraper failed" then
+                flunk("wrong exception was thrown")
+            end
+        end
+
+    end
+
+    def test_valid_id
+        id = "1ZX799470341200708"
+        ret = Stalkr::UPS.is_valid?(id)
+        assert(ret)
+    end
+
+    def test_invalid_id
+        id = "1X799470341200708"
+        ret = Stalkr::UPS.is_valid?(id)
+        assert(!ret)
+    end
+
+    def test_extract_id
+        str = "asdf 1ZX799470341200708 asdfas"
+        assert(Stalkr::UPS.extract_id(str) == "1ZX799470341200708")
+    end
+
+end

data/test/stalkr/usps_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class USPS_Test < Test::Unit::TestCase
+
+    def test_track
+        id = "9102901001299192824023"
+        info = Stalkr::USPS.new.track(id)
+        assert(info.shipper == :USPS)
+        assert(info.status == Stalkr::DELIVERED)
+        assert(info.delivered_at.kind_of? Time)
+    end
+
+    def test_older_pkg
+        id = "9102927003525018504915"
+        info = Stalkr::USPS.new.track(id)
+        assert(info.shipper == :USPS)
+        assert(info.status == Stalkr::DELIVERED)
+        assert(info.delivered_at.kind_of? Time)
+    end
+
+    def test_track_bad_code
+        id = "9102901001312014825845"
+        info = Stalkr::USPS.new.track(id)
+        assert(info.shipper == :USPS)
+        assert(info.status == Stalkr::UNKNOWN)
+    end
+
+    def test_extract_id
+        str = "asdf 9102901001299192824023 asdfas"
+        assert(Stalkr::USPS.extract_id(str) == "9102901001299192824023")
+    end
+
+end

data/test/stalkr_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Stalkr_Test < Test::Unit::TestCase
+
+    # useless test is useless :)
+    def test_autoload_classes
+        assert Stalkr::UPS
+        assert Stalkr::USPS
+        assert Stalkr::FEDEX
+    end
+
+    def test_unknown_shipper_code
+        begin
+            Stalkr.track("foobar")
+            flunk("no exception was thrown")
+        rescue => ex
+            if ex.message != "Unknown shipper code" then
+                flunk("wrong exception was thrown")
+            end
+        end
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+
+require "rubygems"
+
+if not ENV.include? "TM_MODE" then
+    begin; require "turn"; rescue LoadError; end
+end
+
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/stalkr'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: stalkr
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Chetan Sarva
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: scrapi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        - 15
+        version: 0.3.15
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: tidy
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 4
+        - 2
+        - 2
+        version: 4.2.2
+  type: :runtime
+  version_requirements: *id005
+description: Ruby library for tracking UPS, Fedex and USPS packages.
+email: chetan@pixelcop.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION
+- lib/stalkr.rb
+- lib/stalkr/base.rb
+- lib/stalkr/fedex.rb
+- lib/stalkr/result.rb
+- lib/stalkr/ups.rb
+- lib/stalkr/usps.rb
+- test/stalkr/fedex_test.rb
+- test/stalkr/ups_test.rb
+- test/stalkr/usps_test.rb
+- test/stalkr_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/chetan/stalkr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Ruby library for tracking packages
+test_files: 
+- test/stalkr/fedex_test.rb
+- test/stalkr/ups_test.rb
+- test/stalkr/usps_test.rb
+- test/stalkr_test.rb
+- test/test_helper.rb