polar_express 0.0.1.alpha

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in polar_express.gemspec
+gemspec
+gem 'nokogiri', '~> 1.5.6'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 José Tomás Albornoz
+
+MIT License
+
+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.md

@@ -0,0 +1,46 @@
+# Polar Express
+
+Get on board of The Polar Express and let's have a train ride to package tracking!
+
+## Gem in development
+Note: this gem is in current development, so don't expect anything to work yet (not even the usage example!!!)
+
+Feel free to contribute to the project :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'polar_express'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install polar_express
+
+## Usage
+
+```ruby
+@tracker = PolarExpress.new('DHL', '017219678663')
+info = @tracker.track!
+info.status # => :delivered
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+### What can I help with?
+- work on DHL implementation
+- write more tests
+- documentation. rdoc?
+- discuss about the structure of the gem. is there space for improvement?

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/polar_express.rb

@@ -0,0 +1,12 @@
+require "polar_express/version"
+require "polar_express/polar_express"
+require "polar_express/tracker"
+require "polar_express/dhl"
+require "polar_express/shipping_info"
+
+module PolarExpress
+  # I don't really know if doing the requires in here helps to keep them under this scope.
+  require 'open-uri'
+  require 'nokogiri'
+  require 'date'
+end

data/lib/polar_express/dhl.rb

@@ -0,0 +1,52 @@
+require 'pp'
+module PolarExpress
+  module DHL
+    class Tracker
+      attr_accessor :number
+      def initialize(number)
+        @number = number
+      end
+      def track!
+        info = ShippingInfo.new(@number)
+        info.percentage = package_percentage
+        info.statuses   = timeline
+        info
+      end
+      private
+        def tracking_url
+          "http://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=en&idc=#{@number}"
+        end
+        def page
+          @page ||= Nokogiri::HTML open tracking_url
+        end
+        def package_percentage
+          page.css("#progress-#{@number}_1").text.scan(/([\d]+)/).flatten.first.to_i
+        end
+        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)
+            }
+          end
+        end
+        def text_to_status(text)
+          case text
+          when 'The shipment has been successfully delivered'
+            :delivered
+          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"
+            :shipping_instructions_received
+          else
+            :other
+          end
+        end
+    end
+  end
+end

data/lib/polar_express/polar_express.rb

@@ -0,0 +1,7 @@
+module PolarExpress
+  # let's have the module behave like a class
+  # http://stackoverflow.com/questions/318850/private-module-methods-in-ruby
+  def self.new(*args)
+    Tracker.new(*args)
+  end
+end

data/lib/polar_express/shipping_info.rb

@@ -0,0 +1,18 @@
+module PolarExpress
+  class ShippingInfo
+    attr_accessor :percentage, :shipping_number, :statuses
+    def initialize(number = nil)
+      @shipping_number = number
+      @statuses = []
+    end
+    def status
+      statuses.last[:status] if statuses.length > 0
+    end
+    def last_event_at
+      statuses.last[:date] if statuses.length > 0
+    end
+    def last_event_city
+      statuses.last[:city] if statuses.length > 0
+    end
+  end
+end

data/lib/polar_express/tracker.rb

@@ -0,0 +1,23 @@
+module PolarExpress  
+  class Tracker
+    attr_reader :courier, :shipping_number
+    def initialize(courier, shipping_number)
+      @courier         = identify_courier(courier)
+      @shipping_number = shipping_number
+      @courier_tracker = Object.const_get("PolarExpress::#{@courier}::Tracker").new(@shipping_number)
+    end
+    def track!
+      @courier_tracker.track!
+    end
+    
+    private
+      # returns a courier's symbol given it's name.
+      # ideally it should be much smarter, supporting company's name, etc.
+      def identify_courier(name)
+        case name.upcase
+        when 'DHL'
+          :DHL
+        end
+      end
+  end
+end

data/lib/polar_express/version.rb

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

data/polar_express.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'polar_express/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "polar_express"
+  spec.version       = PolarExpress::VERSION
+  spec.authors       = ["José Tomás Albornoz"]
+  spec.email         = ["jojo@eljojo.net"]
+  spec.description   = %q{Package tracking done right.}
+  spec.summary       = %q{An easy an fun way of tracking packages. info = PolarExpress.new('DHL', '123456789').track!}
+  spec.homepage      = "https://github.com/eljojo/polar_express"
+  spec.license       = "mit"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3.0.pre"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "shoulda"
+end

data/spec/polar_express/polar_express_spec.rb

@@ -0,0 +1,21 @@
+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'
+    end
+  end
+  context 'DHL' do
+    before do
+      @tracker = PolarExpress.new('DHL', '017219678663')
+    end
+    it "recognizes DHL" do
+      @tracker.courier.should eq :DHL
+    end
+    it "tracks DHL" do
+      info = @tracker.track!
+      info.status.should eq :delivered
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'polar_express'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: polar_express
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- José Tomás Albornoz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0.pre
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0.pre
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Package tracking done right.
+email:
+- jojo@eljojo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/polar_express.rb
+- lib/polar_express/dhl.rb
+- lib/polar_express/polar_express.rb
+- lib/polar_express/shipping_info.rb
+- lib/polar_express/tracker.rb
+- lib/polar_express/version.rb
+- polar_express.gemspec
+- spec/polar_express/polar_express_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/eljojo/polar_express
+licenses:
+- mit
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An easy an fun way of tracking packages. info = PolarExpress.new('DHL', '123456789').track!
+test_files:
+- spec/polar_express/polar_express_spec.rb
+- spec/spec_helper.rb