rrd-track 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dc1119a97d15171935a8fed7b8f74a44fbe755b
-  data.tar.gz: 6c24c8b211c229e05aabc48096b7fd1472cca2e7
+  metadata.gz: 347aed7783f12924af79b05b36445ddb85f457a5
+  data.tar.gz: 158a044571e878f540639677314b184f0292bfe1
 SHA512:
-  metadata.gz: 3f609ff5c683c0ea4cad3a405edfa9b9f7443aab179248e372cc9b272c371fd42bbd7c6a1c1636b37b1a75c0b7960cf94ab94465236c57c01453dda14fc04c2e
-  data.tar.gz: 6071fb9e23924ccbfed59c24c82fd87106b8aa91ccfba0c62695eef200dd3be8f67cbf9191f8bbae6bcdf05b07f6a7fa6ed5343a475a9790df9b17d2a7d20f86
+  metadata.gz: b5d7a0ef976a86d7c0b0b7492ae89bc3807c544ae454f983e10b7b817be2a10ae7862578afbf5ec1fdc193c46ad195eea68c074eaca6427df40e0a62a764ed56
+  data.tar.gz: e4dc8f5c10707bcf4da0e8be7093d12b26ab517c161be3a0fd49e744ddc8dd1afcd941126f2d52136e4fe01c66642361b1fff8ccb6aaa72c6703d3d5cd183623

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile.lock

@@ -41,8 +41,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print (~> 1.2.0)
-  rake (~> 10.1.1)
+  awesome_print (~> 1.2)
+  rake (~> 10.1)
   rrd-track!
   rspec (~> 2.14)
-  webmock (~> 1.17.4)
+  webmock (~> 1.17)

data/lib/rrd-track.rb

@@ -0,0 +1,27 @@
+require "rrd-track/client"
+require "rrd-track/configuration"
+require "rrd-track/version"
+
+module RRD
+  class << self
+    attr_writer :configuration
+
+    def client
+      @client ||= Client.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def track(tracking_number)
+      client.request(RRD::Request::Tracking.new(tracking_number))
+    end
+
+    alias_method :config, :configuration
+  end
+end

data/lib/rrd-track/client.rb

@@ -0,0 +1,38 @@
+require 'nokogiri'
+require 'typhoeus'
+
+require "rrd-track/errors"
+require "rrd-track/request/tracking"
+require "rrd-track/response/tracking"
+
+module RRD
+  class Client
+    
+    def request(request, &block)
+      response = Typhoeus::Request.get(tracking_api_url, {
+        timeout: RRD.config.timeout,
+        params: request.api_params,
+        headers: { Accept: "application/xml" }
+      })
+
+      # Parse the request
+      xml = Nokogiri::XML.parse(response.body)
+
+      if (error = xml.search('error')).any?
+        code = error.search('code').text
+        description = error.search('description').text
+
+        raise Error.for_code(code).new(code, description)
+      end
+
+      request.response_handler(xml)
+    end
+
+    private
+    
+    def tracking_api_url
+      "http://www.ppxtrack.com/api/ParcelTracking"
+    end
+
+  end
+end

data/lib/rrd-track/configuration.rb

@@ -0,0 +1,9 @@
+module RRD
+  class Configuration
+    attr_accessor :timeout
+
+    def initialize
+      @timeout  = 5000
+    end
+  end
+end

data/lib/rrd-track/errors.rb

@@ -0,0 +1,35 @@
+module RRD
+  class Error < StandardError
+    attr_reader :code, :description
+
+    def initialize(code, description)
+      super(description)
+      @code = code
+      @description = description
+    end
+
+    class << self
+      def for_code(code)
+        case code
+        when '100'; UsernameNotFoundError
+        when '110'; PasswordNotFoundError
+        when '120'; TrackingNumberNotFoundError
+        when '130'; AuthenticationError
+        when '200'; ShippingSiteError
+        when '300'; DatabaseError
+        when '400'; BadTrackingNumberError
+        else      ; Error
+        end
+      end
+    end
+  end
+
+  class ValidationError < Error; end
+  class UsernameNotFoundError < ValidationError; end
+  class PasswordNotFoundError < ValidationError; end
+  class TrackingNumberNotFoundError < ValidationError; end
+  class AuthenticationError < Error; end
+  class ShippingSiteError < Error; end
+  class DatabaseError < Error; end
+  class BadTrackingNumberError < Error; end
+end

data/lib/rrd-track/request/tracking.rb

@@ -0,0 +1,21 @@
+module RRD::Request
+  class Tracking
+
+    attr_accessor :tracking_number
+    
+    def initialize(tracking_number)
+      @tracking_number = tracking_number
+    end
+
+    def api_params
+      {
+        id: tracking_number
+      }
+    end
+
+    def response_handler(xml)
+      RRD::Response::Tracking.new(xml)
+    end
+  
+  end
+end

data/lib/rrd-track/response/shipment_detail.rb

@@ -0,0 +1,18 @@
+module RRD::Response
+  class ShipmentDetail
+    attr_accessor :airway_bill, 
+                  :tracking_number, 
+                  :location, 
+                  :status, 
+                  :vendor_code, 
+                  :vendor_name, 
+                  :is_courier
+
+    def initialize(init)
+      init.each_pair do |key, val|
+        instance_variable_set('@' + key.to_s, val)
+      end
+    end
+    
+  end
+end

data/lib/rrd-track/response/track_detail.rb

@@ -0,0 +1,14 @@
+module RRD::Response
+  class TrackDetail
+    attr_accessor :description, 
+                  :location, 
+                  :timestamp
+
+    def initialize(init)
+      init.each_pair do |key, val|
+        instance_variable_set('@' + key.to_s, val)
+      end
+    end
+
+  end
+end

data/lib/rrd-track/response/tracking.rb

@@ -0,0 +1,43 @@
+module RRD::Response
+  class Tracking
+    require 'rrd-track/response/shipment_detail'
+    require 'rrd-track/response/track_detail'
+    
+    attr_accessor :tracking_events, :shipment_detail
+
+    def initialize(xml)
+       @shipment_detail = parse_shipment_detail(xml.search("ParcelTrackingViewModel"))
+       @tracking_events = []
+       xml.search("StopDetailViewModel").each do |event|
+         @tracking_events << parse_tracking_detail(event)
+       end
+     end
+     
+     private
+     
+     def parse_shipment_detail(node)
+      RRD::Response::ShipmentDetail.new(
+        {
+          airway_bill:        node.search('AirwayBill').text, 
+          tracking_number:    node.search('TrackingNumber').text, 
+          location:           node.search('Location').text, 
+          status:             node.search('Status').text,  
+          vendor_code:        node.search('VendorCode').text,  
+          vendor_name:        node.search('VendorName').text,
+          is_courier:         node.search('IsCourier').text
+        }
+      )
+     end
+
+     def parse_tracking_detail(node)
+      RRD::Response::TrackDetail.new(
+        {
+         description:   node.search('Description').text,
+         location:      node.search('Location').text,
+         timestamp:     node.search('TimeStamp').text
+        }
+      )
+     end
+
+  end
+end

data/lib/rrd-track/version.rb

@@ -0,0 +1,3 @@
+module RRD
+  VERSION = "1.0.1"
+end

data/spec/rrd-track/track_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe RRD do
+  
+  it "tracks shipped packages" do
+
+    rrd_tracking_xml = File.read("#{Dir.pwd}/spec/rrd_api_responses/shipment_shipped.xml")
+
+    WebMock.stub_request(:get, "http://www.ppxtrack.com/api/ParcelTracking?id=2043XXXXXX1513").
+            with(headers: {'User-Agent'=>'Typhoeus - https://github.com/typhoeus/typhoeus'}).
+            to_return(status: 200, body: rrd_tracking_xml)
+
+    result = RRD::track('2043XXXXXX1513')
+
+    expect(result).to   be_kind_of(RRD::Response::Tracking)
+  end
+
+
+  it "tracks shipped packages with two events" do
+
+    rrd_tracking_xml = File.read("#{Dir.pwd}/spec/rrd_api_responses/shipment_shipped.xml")
+
+    WebMock.stub_request(:get, "http://www.ppxtrack.com/api/ParcelTracking?id=2043XXXXXX1513").
+            with(headers: {'User-Agent'=>'Typhoeus - https://github.com/typhoeus/typhoeus'}).
+            to_return(status: 200, body: rrd_tracking_xml)
+
+    result = RRD::track('2043XXXXXX1513')
+
+    expect(result.tracking_events.count).to       eq(11)
+    expect(result.tracking_events.first).to       be_kind_of(RRD::Response::TrackDetail)
+  end
+
+
+end

data/spec/rrd_api_responses/shipment_shipped.xml

@@ -0,0 +1 @@
+<ParcelTrackingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rrdl.International.Model.ViewModel"><AirwayBill>3999682</AirwayBill><AirwayBillDisplay>3999682(02)</AirwayBillDisplay><IsCourier>false</IsCourier><LastActivity>2014-02-07T10:09:58</LastActivity><Location>Brampton</Location><Status>Item successfully delivered</Status><Stops><StopDetailViewModel><Description>Item successfully delivered</Description><Location>Brampton</Location><TimeStamp>2014-02-07T10:09:58</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Item out for delivery</Description><Location>Brampton</Location><TimeStamp>2014-02-07T08:57:21</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Item processed at local delivery facility</Description><Location>Brampton</Location><TimeStamp>2014-02-07T05:34:21</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Item processed</Description><Location>Mississauga</Location><TimeStamp>2014-02-06T20:02:32</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Item processed</Description><Location>Mississauga</Location><TimeStamp>2014-02-06T19:52:56</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Item picked up by Canada Post</Description><Location>Mississauga</Location><TimeStamp>2014-02-06T19:22:53</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Electronic information submitted by shipper</Description><Location>Mississauga</Location><TimeStamp>2014-02-03T19:34:30</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>In transit to Canada Post tracking#: 7100848307767497</Description><Location></Location><TimeStamp>2014-02-03T14:22:54</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Parcel Shipped</Description><Location>Itasca IL</Location><TimeStamp>2014-02-03T14:21:54</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>Parcel Received</Description><Location>Itasca IL</Location><TimeStamp>2014-02-03T14:07:40</TimeStamp></StopDetailViewModel><StopDetailViewModel><Description>E-File Uploaded</Description><Location>Itasca IL</Location><TimeStamp>2014-02-03T11:59:14</TimeStamp></StopDetailViewModel></Stops><TrackingNumber>7100848307767497</TrackingNumber><VendorCode>02</VendorCode><VendorName>CPC-PARCELS</VendorName></ParcelTrackingViewModel>

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'awesome_print'
+require 'rrd-track'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+  WebMock.disable_net_connect!(:allow_localhost => true)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrd-track
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Scott Rocher
@@ -101,12 +101,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/rrd-track.rb
+- lib/rrd-track/client.rb
+- lib/rrd-track/configuration.rb
+- lib/rrd-track/errors.rb
+- lib/rrd-track/request/tracking.rb
+- lib/rrd-track/response/shipment_detail.rb
+- lib/rrd-track/response/track_detail.rb
+- lib/rrd-track/response/tracking.rb
+- lib/rrd-track/version.rb
 - rrd-track.gemspec
+- spec/rrd-track/track_spec.rb
+- spec/rrd_api_responses/shipment_shipped.xml
+- spec/spec_helper.rb
 homepage: https://github.com/rochers/rrd-track
 licenses: []
 metadata: {}
@@ -130,4 +144,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Request, parse, and work with RR Donnelley tracking events.
-test_files: []
+test_files:
+- spec/rrd-track/track_spec.rb
+- spec/rrd_api_responses/shipment_shipped.xml
+- spec/spec_helper.rb