dhlgm-track 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55f08aff64e7cde66738c31709241d06176253b7
+  data.tar.gz: 89dc7ed41c8f538d63c3211d3cdc20e96a231978
+SHA512:
+  metadata.gz: 91d9f7d5f9dd0b5b52dd382a0fd13582f2e827300cae06cd2d94a82ac6fc17b9288318d22b8da92e742c932b35a2dc579ca095b10d347bb642e0f676070e93ed
+  data.tar.gz: 59abbb5678230b1b39d0208207ef8099d50615a0c0b6def64b087256f6f0c86f0b2667f4f47eaa0445d83a5fed55513f837f9e7f8737d65b938652a8c29b6352

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,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dhlgm-track.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Scott Rocher
+
+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,39 @@
+# DHLGM::Track
+
+Track packages through the DHL Global Mail API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dhlgm-track'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dhlgm-track
+
+## Rails Installation
+
+Setup an initializer `config/initializers/dhlgm-track.rb' to configure the gem to use your DHL Global Mail API credentials.
+
+    DHLGM.configure do |config|
+      config.username = 'your_username'
+      config.password = 'your_password'
+    end
+
+## Usage
+Tracking packages is easy. Once configured, simply call track and pass your tracking number.
+
+    DHLGM::track('GMXXXXXXXXXXXXXXXX')
+
+## 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dhlgm-track.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dhlgm-track/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dhlgm-track"
+  gem.version       = DHLGM::VERSION
+  gem.authors       = ["Scott Rocher"]
+  gem.email         = ["scottrocher@gmail.com"]
+  gem.description   = %q{Track packages through the DHL Global Mail API}
+  gem.summary       = %q{Request, parse, and work with DHL Global Mail API tracking events.}
+  gem.homepage      = "https://github.com/rochers/dhlgm-track"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency "nokogiri", ["~> 1.6"]
+  gem.add_runtime_dependency "typhoeus", ["~> 0.6"]
+
+  gem.add_development_dependency "rspec", ["~> 2.14"]
+end

data/lib/dhlgm-track.rb

@@ -0,0 +1,27 @@
+require "dhlgm-track/client"
+require "dhlgm-track/configuration"
+require "dhlgm-track/version"
+
+module DHLGM
+  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(DHLGM::Request::Tracking.new(tracking_number))
+    end
+
+    alias_method :config, :configuration
+  end
+end

data/lib/dhlgm-track/client.rb

@@ -0,0 +1,40 @@
+require 'nokogiri'
+require 'typhoeus'
+
+require "dhlgm-track/errors"
+require "dhlgm-track/request/tracking"
+require "dhlgm-track/response/tracking"
+
+module DHLGM
+  class Client
+    
+    def request(request, &block)
+      response = Typhoeus::Request.get(tracking_api_url, {
+        timeout: DHLGM.config.timeout,
+        params: {
+          uname:  DHLGM.config.username,
+          pass:   DHLGM.config.password,
+        }.merge(request.api_params)
+      })
+
+      # 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
+      "https://api.dhlglobalmail.com/api.cfm"
+    end
+
+  end
+end

data/lib/dhlgm-track/configuration.rb

@@ -0,0 +1,11 @@
+module DHLGM
+  class Configuration
+    attr_accessor :password, :timeout, :username
+
+    def initialize
+      @timeout  = 5000
+      @username = ENV['DHLGM_USERNAME']
+      @password = ENV['DHLGM_PASSWORD']
+    end
+  end
+end

data/lib/dhlgm-track/errors.rb

@@ -0,0 +1,35 @@
+module DHLGM
+  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/dhlgm-track/request/tracking.rb

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

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

@@ -0,0 +1,21 @@
+module DHLGM::Response
+  class ShipmentDetail
+    attr_accessor :tracking_number, 
+                  :delivery_confirm, 
+                  :customer_confirm, 
+                  :address1, 
+                  :address2, 
+                  :city, 
+                  :state, 
+                  :zip, 
+                  :weight, 
+                  :shipped
+
+    def initialize(init)
+      init.each_pair do |key, val|
+        instance_variable_set('@' + key.to_s, val)
+      end
+    end
+    
+  end
+end

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

@@ -0,0 +1,19 @@
+module DHLGM::Response
+  class TrackDetail
+    attr_accessor :code, 
+                  :date, 
+                  :time, 
+                  :city, 
+                  :state, 
+                  :description, 
+                  :postalcode, 
+                  :country
+
+    def initialize(init)
+      init.each_pair do |key, val|
+        instance_variable_set('@' + key.to_s, val)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,51 @@
+module DHLGM::Response
+  class Tracking
+    require 'dhlgm-track/response/shipment_detail'
+    require 'dhlgm-track/response/track_detail'
+    
+    attr_accessor :tracking_events, :shipment_detail
+
+    def initialize(xml)
+       @shipment_detail = parse_shipment_detail(xml.search("shipment"))
+       @tracking_events = []
+       xml.search("event").each do |event|
+         @tracking_events << parse_tracking_detail(event)
+       end
+     end
+     
+     private
+     
+     def parse_shipment_detail(node)
+      DHLGM::Response::ShipmentDetail.new(
+        {
+          tracking_number:    node.search('trackingnumber').text, 
+          delivery_confirm:   node.search('deliveryconfirm').text, 
+          customer_confirm:   node.search('customerconfirm').text,  
+          address1:           node.search('address1').text,  
+          address2:           node.search('address2').text,  
+          city:               node.search('city').text,  
+          state:              node.search('state').text,  
+          zip:                node.search('zip').text,  
+          weight:             node.search('weight').text,  
+          shipped:            node.search('shipped').text
+        }
+      )
+     end
+
+     def parse_tracking_detail(node)
+      DHLGM::Response::TrackDetail.new(
+        {
+         code:        node.search('code').text,
+         date:        node.search('date').text,
+         time:        node.search('time').text,
+         city:        node.search('city').text,
+         state:       node.search('state').text,
+         description: node.search('description').text,
+         postalcode:  node.search('postalcode').text,
+         country:     node.search('country').text
+        }
+      )
+     end
+
+  end
+end

data/lib/dhlgm-track/version.rb

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

data/spec/dhlgm-track/track_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe DHLGM do
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dhlgm-track
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Scott Rocher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Track packages through the DHL Global Mail API
+email:
+- scottrocher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dhlgm-track.gemspec
+- lib/dhlgm-track.rb
+- lib/dhlgm-track/client.rb
+- lib/dhlgm-track/configuration.rb
+- lib/dhlgm-track/errors.rb
+- lib/dhlgm-track/request/tracking.rb
+- lib/dhlgm-track/response/shipment_detail.rb
+- lib/dhlgm-track/response/track_detail.rb
+- lib/dhlgm-track/response/tracking.rb
+- lib/dhlgm-track/version.rb
+- spec/dhlgm-track/track_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rochers/dhlgm-track
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Request, parse, and work with DHL Global Mail API tracking events.
+test_files:
+- spec/dhlgm-track/track_spec.rb
+- spec/spec_helper.rb