polar_express 0.0.1.alpha → 0.0.3.alpha

data/README.md

@@ -27,9 +27,25 @@ Or install it yourself as:
 @tracker = PolarExpress.new('DHL', '017219678663')
 info = @tracker.track!
 info.status # => :delivered
+info.statuses 
+# [{:date=>
+#    #<DateTime: 2012-12-05T15:52:00+08:00>,
+#   :city=>nil,
+#   :status=>:shipping_instructions_received,
+#   :text=>
+#    "The instruction data for this shipment have been provided by the sender to DHL electronically"},
+#  {:date=>
+#    #<DateTime: 2012-12-06T07:31:00+08:00>,
+#   :city=>"Berlin-Friedrichshain",
+#   :status=>:in_delivery_vehicle,
+#   :text=>"The shipment has been loaded onto the delivery vehicle"},
+#  {:date=>
+#    #<DateTime: 2012-12-12T15:42:00+08:00>,
+#   :city=>nil,
+#   :status=>:delivered,
+#   :text=>"The recipient has picked up the shipment from the retail outlet"}]
 ```
 
-
 ## Contributing
 
 1. Fork it

data/lib/polar_express.rb

@@ -2,6 +2,7 @@ require "polar_express/version"
 require "polar_express/polar_express"
 require "polar_express/tracker"
 require "polar_express/dhl"
+require "polar_express/gls"
 require "polar_express/shipping_info"
 
 module PolarExpress
@@ -9,4 +10,5 @@ module PolarExpress
   require 'open-uri'
   require 'nokogiri'
   require 'date'
+  require 'json'
 end

data/lib/polar_express/dhl.rb

@@ -1,4 +1,3 @@
-require 'pp'
 module PolarExpress
   module DHL
     class Tracker
@@ -25,28 +24,41 @@ module PolarExpress
         def timeline
           page.css("tr#toggle-#{@number}_1 table tbody tr").map do |tr|
             {
-              date: DateTime.parse(tr.css('td.overflow').text.strip),
-              city: tr.css('td.location').text.strip,
-              status: text_to_status(tr.css('td.status').text.strip)
+              date: DateTime.parse(get_date(tr.css('td.overflow').text)),
+              city: (city = tr.css('td.location').text.strip) == '--' ? nil : city,
+              status: text_to_status(status_text = tr.css('td.status').text.strip),
+              text: status_text
             }
           end
         end
+        # TODO: look for better status names
         def text_to_status(text)
           case text
-          when 'The shipment has been successfully delivered'
+          when /The recipient has picked up the shipment from/
             :delivered
-          when "The shipment has been loaded onto the delivery vehicle"
+          when /The shipment has been successfully delivered/
+            :delivered
+          when /The shipment is on its way to the postal retail outlet/
+            :in_delivery_vehicle_to_retail_outler
+          when /The shipment has been delivered for pick-up at the/
+            :waiting_for_pick_up_in_retail_office
+          when /The shipment has been loaded onto the delivery vehicle/
             :in_delivery_vehicle
-          when "The shipment has been processed in the destination parcel center"
-            :destination_city
-          when "The shipment has been processed in the parcel center of origin"
-            :origin_city
-          when "The instruction data for this shipment have been provided by the sender to DHL electronically"
+          when /The shipment has been processed in the destination parcel center/
+            :destination_parcel_center
+          when /The shipment has been processed in the parcel center of origin/
+            :origin_parcel_center
+          when /The instruction data for this shipment have been provided by the sender to DHL electronically/
             :shipping_instructions_received
+          when /A .+ attempt at delivery is being made/
+            :new_delivery_attempt
           else
             :other
           end
         end
+        def get_date(str)
+          str.scan(/[\d]{1,2}\.[\d]{1,2}\.[\d]{4} [\d]{1,2}:[\d]{1,2}/).flatten.first
+        end
     end
   end
 end

data/lib/polar_express/gls.rb

@@ -0,0 +1,61 @@
+module PolarExpress
+  module GLS
+    class Tracker
+      attr_accessor :number
+      def initialize(number)
+        @number = number
+      end
+      def track!
+        info = ShippingInfo.new(@number)
+        info.statuses = timeline
+        info
+      end
+      private
+        def tracking_url
+          "https://gls-group.eu/app/service/open/rest/EU/en/rstt001?match=#{@number}&caller=witt002Scheme"
+        end
+        def page
+          @page ||= JSON.parse(open(tracking_url).read)
+        end
+        def history
+          @history ||= page["tuStatus"].first["history"].map do |event|
+            {
+              city: event['address']['city'],
+              date: DateTime.parse(event['date'] + ' ' + event['time'].split(':')[0] + ':00'),
+              text: event['evtDscr']
+            }
+          end.uniq.reverse
+        end
+        def timeline
+          history.each_with_index.map do |event, index|
+            # GLS specific logic
+            next if event[:text] == 'Inbound to GLS location to document physical hand over'
+            if event[:text] == 'Inbound to GLS location' and history[index-1][:text] == 'Outbound from GLS location'
+              event[:text] = 'The shipment has been processed in the destination parcel center'
+            end
+            event[:status] = text_to_status(event[:text])
+            event
+          end.compact
+        end
+        # TODO: look for better status names
+        def text_to_status(text)
+          case text
+          when /Delivered/
+            :delivered
+          when /Out for delivery on GLS vehicle/
+            :in_delivery_vehicle
+          when /The shipment has been processed in the destination parcel center/
+            :destination_parcel_center
+          when /Inbound to GLS location/
+            :origin_parcel_center
+          when /Outbound from GLS location/
+            :in_shipment
+          when /Information transmitted, no shipment available now/
+            :shipping_instructions_received
+          else
+            :other
+          end
+        end
+    end
+  end
+end

data/lib/polar_express/tracker.rb

@@ -7,7 +7,7 @@ module PolarExpress
       @courier_tracker = Object.const_get("PolarExpress::#{@courier}::Tracker").new(@shipping_number)
     end
     def track!
-      @courier_tracker.track!
+      @track ||= @courier_tracker.track!
     end
     
     private
@@ -17,6 +17,8 @@ module PolarExpress
         case name.upcase
         when 'DHL'
           :DHL
+        when 'GLS'
+          :GLS
         end
       end
   end

data/lib/polar_express/version.rb

@@ -1,3 +1,3 @@
 module PolarExpress
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.3.alpha"
 end

data/spec/polar_express/polar_express_spec.rb

@@ -2,20 +2,41 @@ require 'spec_helper'
 describe PolarExpress do
   context 'Gem Basics' do
     it "creates a new instance of the gem" do
-      @tracker = PolarExpress.new('DHL', '017219678663')
-      @tracker.shipping_number.should == '017219678663'
+      @tracker = PolarExpress.new('DHL', '1234')
+      @tracker.should respond_to :shipping_number
     end
   end
   context 'DHL' do
     before do
-      @tracker = PolarExpress.new('DHL', '017219678663')
+      @tracker = PolarExpress.new('DHL', '777707971894')
     end
-    it "recognizes DHL" do
+    it "recognizes it" do
       @tracker.courier.should eq :DHL
     end
-    it "tracks DHL" do
-      info = @tracker.track!
-      info.status.should eq :delivered
+    it "tracks it" do
+      @tracker.track!.status.should eq :delivered
+    end
+    it "records tracking statuses" do
+      statuses = @tracker.track!.statuses
+      statuses.length.should > 1
+    end
+    it "tracks date correctly" do
+      @tracker.track!.statuses.first[:date].should == DateTime.new(2013, 03, 15, 17, 45)
+    end
+  end
+  context 'GLS' do
+    before do
+      @tracker = PolarExpress.new('GLS', '291740105981')
+    end
+    it "recognizes it" do
+      @tracker.courier.should eq :GLS
+    end
+    it "tracks it" do
+      @tracker.track!.status.should eq :delivered
+    end
+    it "records tracking statuses" do
+      statuses = @tracker.track!.statuses
+      statuses.length.should > 1
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,13 @@
 require 'polar_express'
+
+# http://stackoverflow.com/questions/1819614/how-do-i-globally-configure-rspec-to-keep-the-color-and-format-specdoc-o
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polar_express
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.3.alpha
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - Rakefile
 - lib/polar_express.rb
 - lib/polar_express/dhl.rb
+- lib/polar_express/gls.rb
 - lib/polar_express/polar_express.rb
 - lib/polar_express/shipping_info.rb
 - lib/polar_express/tracker.rb