dhl_express 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c482cf75a564a668a2d07b6ae09d0364c3f86ba
+  data.tar.gz: 0a3f2875e127dbf21ea1547d1caf5d6da7d350da
+SHA512:
+  metadata.gz: c49ad635687427bb2076102a663567c01460ab18cfc1f76da55b031bc5b69bf4b8178b58f4b3742351c7c700fd7c6453475454055d1bab3e52360c046869d5b8
+  data.tar.gz: fb81f0980e20644727dfdd5894cc474fc4f1bc245aebbf66611439ea85605ff23096590f22ae70847d2c3aba6b12857adec2e8e9a2e6f2b623c6e786468fdaa5

data/.gitignore

@@ -0,0 +1,18 @@
+# osx noise
+.DS_Store
+profile
+
+# xcode noise
+build/*
+*.mode1
+*.mode1v3
+*.mode2v3
+*.perspective
+*.perspectivev3
+*.pbxuser
+*.xcworkspace
+xcuserdata
+
+# svn & cvs
+.svn
+CVS

data/.pryrc

@@ -0,0 +1,9 @@
+Pry.config.editor = "gvim --nofork"
+
+# Print Ruby version at startup
+Pry.config.hooks.add_hook(:when_started, :say_hi) do
+  puts "Using Ruby version #{RUBY_VERSION}"
+end
+
+# Require Sinatra application
+require './lib/dhl_express.rb'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    jp_post (1.0.0)
+      chronic
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    chronic (0.10.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.8.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hitimes (1.2.2)
+    listen (2.7.11)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mini_portile (0.6.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    vcr (2.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  guard-rspec
+  jp_post!
+  rspec
+  typhoeus
+  vcr

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,49 @@
+## DHL Express :package:
+[![Build Status](https://travis-ci.org/SebastianSzturo/dhl_express.svg?branch=master)](https://travis-ci.org/SebastianSzturo/jp_post) [![Code Climate](https://codeclimate.com/github/SebastianSzturo/dhl_express/badges/gpa.svg)](https://codeclimate.com/github/SebastianSzturo/jp_post)
+
+A gem to track international DHL Express package without the DHL SOAP/XML API.
+
+## Requirements
+-  Ruby 1.9
+
+## Installation
+
+Add this to your gemfile
+
+```ruby
+gem 'dhl_express'
+```
+
+and
+
+```
+bundle
+```
+
+## Tracking :round_pushpin:
+
+Track a package with it's waybill tracking number.
+
+```ruby
+package = DhlExpress::Tracking.new("123456789")
+```
+
+Access tracking information.
+
+```ruby
+package = DhlExpress::Tracking.new("123456789")
+
+package.origin # e.g. "TOKYO - TOKYO - JAPAN"
+package.destination # e.g. "GREENSBORO, NC - GREENSBORO - USA" 
+package.status # e.g. String of current history status point
+
+package.history # Array of package movement history in chronological order
+```
+
+## 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

data/dhl_express.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dhl_express/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dhl_express"
+  spec.version       = DhlExpress::VERSION
+  spec.authors       = ["Sebastian Szturo"]
+  spec.email         = ["s.szturo@me.com"]
+  spec.description   = "Gem to access international DHL Express Services."
+  spec.summary       = "Gem to access international DHL Express Services."
+  spec.homepage      = "http://github.com/SebastianSzturo/dhl_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_dependency "nokogiri"
+  spec.add_dependency "chronic"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "typhoeus"
+end

data/lib/dhl_express.rb

@@ -0,0 +1,5 @@
+require "dhl_express/version"
+require "dhl_express/tracking"
+
+module DhlExpress
+end

data/lib/dhl_express/tracking.rb

@@ -0,0 +1,81 @@
+require "typhoeus"
+require "json"
+require "chronic"
+
+module DhlExpress
+  class Tracking
+    # Create a new Tracking object.
+    #
+    # tracking_number - tracking number of the package to lookup.
+    #
+    # Returns an instance of DhlExpress::Tracking.
+    def initialize(tracking_number)
+      raise ArgumentError unless tracking_number
+
+      @tracking_number = tracking_number
+      tracking_url = "https://www.mydhl.dhl.com/shipmentTracking?AWB=#{@tracking_number}"
+
+      @tracking_json = JSON.parse(Typhoeus.get(tracking_url).body)
+
+      raise RuntimeError, "No Tracking found." if @tracking_json["results"].nil?
+    end
+
+    # Origin of the package
+    #
+    # Returns origin as String.
+    def origin
+      origin = @tracking_json["results"][0]["origin"]["value"].strip
+      return origin
+    end
+
+    # Destination of the packaage
+    #
+    # Returns destination as String.
+    def destination
+      destination = @tracking_json["results"][0]["destination"]["value"].strip
+      return destination
+    end
+
+    # Current status of the package in the history
+    #
+    # Returns status as String.
+    def status
+      status = @tracking_json["results"][0]["description"].strip
+      return status
+    end
+
+    # History of package checkpoints in chronological order
+    #
+    # Returns tracking history as Array.
+    def history
+      checkpoints = @tracking_json["results"][0]["checkpoints"]
+
+      history = []
+
+      checkpoints.each do |checkpoint|
+        date = dhl_date_string_as_date(checkpoint)
+        action = checkpoint["description"].strip
+        location = checkpoint["location"].strip
+
+        history << { date: date, action: action, location: location }
+      end
+
+      history.sort_by! { |h| h[:date] }
+
+      return history
+    end
+
+    private
+
+    def dhl_date_string_as_date(checkpoint)
+      date_string = checkpoint["date"]
+      month_string_position = date_string.index(",")+2
+      date_without_weekday = date_string[month_string_position...date_string.length]
+      time = checkpoint["time"]
+
+      date = Chronic.parse("#{date_without_weekday} at #{time}") rescue nil
+      return date
+    end
+
+  end
+end

data/lib/dhl_express/version.rb

@@ -0,0 +1,3 @@
+module DhlExpress
+  VERSION = "1.0.0"
+end

data/spec/dhl_express/tracking_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe DhlExpress::Tracking do
+  describe "#initialize" do
+    it "should not initialize without tracking number argument" do
+      expect { DhlExpress::Tracking.new() }.to raise_error(ArgumentError)
+    end
+
+    it "should not initialize with empty tracking" do
+      VCR.use_cassette 'empty_tracking' do
+        expect { DhlExpress::Tracking.new("1234567") }.to raise_error(RuntimeError)
+      end
+    end
+
+    it "should initialize a tracking object" do
+      VCR.use_cassette 'working_tracking' do
+        package = DhlExpress::Tracking.new("6476119576")
+        expect(package).to be_kind_of(DhlExpress::Tracking)
+      end
+    end
+  end
+
+  describe "#origin" do
+    it "should return a origin string" do
+      VCR.use_cassette 'working_tracking' do
+        package = DhlExpress::Tracking.new("6476119576")
+        expect(package.origin).to be_kind_of(String)
+      end
+    end
+  end
+
+  describe "#destination" do
+    it "should return a destination string" do
+      VCR.use_cassette 'working_tracking' do
+        package = DhlExpress::Tracking.new("6476119576")
+        expect(package.destination).to be_kind_of(String)
+      end
+    end
+  end
+
+  describe "#status" do
+    it "should return a status string" do
+      VCR.use_cassette 'working_tracking' do
+        package = DhlExpress::Tracking.new("6476119576")
+        expect(package.status).to be_kind_of(String)
+      end
+    end
+  end
+
+  describe "#history" do
+    it "should return a history array" do
+      VCR.use_cassette 'working_tracking' do
+        package = DhlExpress::Tracking.new("6476119576")
+        expect(package.history).to be_kind_of(Array)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'dhl_express'
+require 'vcr'
+
+# VCR Setup
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr'
+  c.hook_into :typhoeus
+end
+
+# RSpec Setup
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

data/spec/vcr/empty_tracking.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.mydhl.dhl.com/shipmentTracking?AWB=1234567
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      Cache-Control:
+      - s-maxage=172800
+      - max-age=172800
+      Content-Type:
+      - application/json;charset=UTF-8
+      Expires:
+      - Mon, 10 Nov 2014 06:20:33 GMT
+      MyHeader:
+      - D=37339
+      Content-Length:
+      - '165'
+      Date:
+      - Sat, 08 Nov 2014 06:20:33 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - TS017581b3=012d4839b318947c44326df3f5ecad656d3a45b00b5a5ef3b3f7bc08c8b390e91389419794;
+        Path=/; Secure; HTTPOnly
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "errors" : [ {
+            "code" : 404,
+            "label" : "Not found",
+            "message" : "No result found for your DHL query. Please try again.",
+            "id" : "1234567"
+          } ]
+        }
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: https://www.mydhl.dhl.com/shipmentTracking?AWB=1234567
+  recorded_at: Sat, 08 Nov 2014 06:20:33 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/working_tracking.yml

@@ -0,0 +1,84 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.mydhl.dhl.com/shipmentTracking?AWB=6476119576
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - s-maxage=172800
+      Expires:
+      - Mon, 10 Nov 2014 05:37:23 GMT
+      MyHeader:
+      - D=454085
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Length:
+      - '1404'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sat, 08 Nov 2014 06:20:33 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - TS016f3c0b=01914b743d55f0dfe481a6f14f9bc17ce30eb4edd08abab906ac918865663d03d83d32b156;
+        Path=/
+      - TS017581b3=012d4839b38099af17f13f251b42089167c25acb0b0d839e5ed0d86c977ba6852bec27780bf8dd29a4441c4ee72715fae48a420d94;
+        Path=/; Secure; HTTPOnly
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "results" : [ {
+            "id" : "6476119576",
+            "label" : "Waybill",
+            "type" : "airwaybill",
+            "duplicate" : false,
+            "origin" : {
+              "value" : "TOKYO - HIGASHIKURUME - JAPAN",
+              "label" : "Origin Service Area",
+              "url" : "http://www.dhl.co.jp/en/country_profile.html"
+            },
+            "destination" : {
+              "value" : "GREENSBORO, NC - GREENSBORO - USA",
+              "label" : "Destination Service Area",
+              "url" : "http://www.dhl-usa.com/en/country_profile.html"
+            },
+            "description" : "Shipment information received : Friday, November 07, 2014  at 15:34",
+            "hasDuplicateShipment" : false,
+            "signature" : {
+              "link" : {
+                "url" : "https://proview.dhl.com/GC3/proview/adhocnotify?id=mAtE%2F0oL0r0wvmjggydn8Zh%2FkrRB7XethXdun71Ou1A%3D&appuid=ONWLDos95lgDjSxbiEfEsg%3D%3D&locale=en_G0&token=R3Fk9Yr1tYl7WI25yMeMGrA0V4qA124LF2O22zX5298%3D",
+                "label" : "Sign up for shipment notifications"
+              },
+              "type" : "proview",
+              "description" : "Friday, November 07, 2014  at 15:34",
+              "signatory" : "Shipment information received ",
+              "help" : "help"
+            },
+            "checkpoints" : [ {
+              "counter" : 1,
+              "description" : "Shipment information received",
+              "time" : "15:34",
+              "date" : "Friday, November 07, 2014 ",
+              "location" : "TOKYO - JAPAN"
+            } ],
+            "checkpointLocationLabel" : "Location",
+            "checkpointTimeLabel" : "Time"
+          } ]
+        }
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: https://www.mydhl.dhl.com/shipmentTracking?AWB=6476119576
+  recorded_at: Sat, 08 Nov 2014 06:20:33 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: dhl_express
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sebastian Szturo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to access international DHL Express Services.
+email:
+- s.szturo@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENCE.txt
+- README.md
+- dhl_express.gemspec
+- lib/dhl_express.rb
+- lib/dhl_express/tracking.rb
+- lib/dhl_express/version.rb
+- spec/dhl_express/tracking_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/empty_tracking.yml
+- spec/vcr/working_tracking.yml
+homepage: http://github.com/SebastianSzturo/dhl_express
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem to access international DHL Express Services.
+test_files:
+- spec/dhl_express/tracking_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/empty_tracking.yml
+- spec/vcr/working_tracking.yml