dhl_express_global 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25e0e751ae94b63b522255dbf5845e0fd29cf0da
+  data.tar.gz: 547a4abace99495614dfbfbdb37535975949eefb
+SHA512:
+  metadata.gz: 8ca2bcad9315a1ec247841d40c2a2648199186fde8de11742e0627a4fd81ace783cebd20b408249bf3fc22c760537a0a01427f6120ec4f8c42608e3973b4ba44
+  data.tar.gz: c89c3c5df237c6d5235d922b880f43c0e3c74139048c48a604efe9ce0319ffe872e23dd8eb514d7eceb863f2232936cf247dc182a864558200ebba03c1b59800

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+dhl_credentials.yml
+spec/vcr

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 JONBRWN
+
+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,35 @@
+# DhlExpressGlobal
+
+Ruby API wrapper to interface with DHL Express Global
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dhl_express_global'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dhl_express_global
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Testing / Rspec
+
+This gem is using Rspec for testing. As well VCR is implemented for testing the API. To make VCR work make sure to copy `spec/config/dhl_credentials.example.yml` to `spec/config/dhl_credentials.yml` and update the development credentails with actual account details.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dhl_express_global/fork )
+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 a new Pull Request

data/Rakefile

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

data/dhl_express_global.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dhl_express_global/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dhl_express_global"
+  spec.version       = DhlExpressGlobal::VERSION
+  spec.authors       = ["JONBRWN"]
+  spec.email         = ["jonathanbrown.a@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the DHL Express Global API}
+  spec.description   = %q{Ruby wrapper for the DHL Express Global API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'httparty', '>= 0.8.3'
+  spec.add_dependency 'nokogiri', '>= 1.5.6'
+  spec.add_dependency 'builder'
+  spec.add_dependency 'xml-simple'
+  spec.add_dependency 'activesupport'
+
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'vcr', '~> 2.00'
+  spec.add_development_dependency 'webmock', '~> 1.8.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'debugger'
+end

data/lib/dhl_express_global.rb

@@ -0,0 +1,7 @@
+require 'dhl_express_global/shipment'
+
+module DhlExpressGlobal
+  require 'dhl_express_global/version'
+  #Exceptions: DhlExpressGlobal::RateError
+  class RateError < StandardError; end
+end

data/lib/dhl_express_global/credentials.rb

@@ -0,0 +1,16 @@
+require 'dhl_express_global/helpers'
+
+module DhlExpressGlobal
+  class Credentials
+    include Helpers
+    attr_reader :username, :password, :account_number, :mode
+
+    def initialize(options = {})
+      requires!(options, :username, :password, :account_number, :mode)
+      @username = options[:username]
+      @password = options[:password]
+      @account_number = options[:account_number]
+      @mode = options[:mode]
+    end
+  end
+end

data/lib/dhl_express_global/helpers.rb

@@ -0,0 +1,20 @@
+module DhlExpressGlobal
+  module Helpers
+
+    private
+    # String or :symbol to CamelCase
+    def camelize(s)
+      # s.to_s.split('_').map { |e| e.capitalize }.join('')
+      s.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+    # Helper method to validate required fields
+    def requires!(hash, *params)
+       params.each { |param| raise RateError, "Missing Required Parameter #{param}" if hash[param].nil? }
+    end
+
+    def underscorize(key) #:nodoc:
+      key.to_s.sub(/^(v[0-9]+|ns):/, "").gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+  end
+end

data/lib/dhl_express_global/label.rb

@@ -0,0 +1,52 @@
+require 'base64'
+require 'pathname'
+
+module DhlExpressGlobal
+  class Label
+    attr_accessor :options, :image, :response_details
+
+    def initialize(label_details = {})
+      @response_details = label_details[:envelope][:body][:shipment_response]
+      @options = @response_details[:label_image]
+      @options[:tracking_number] = @response_details[:packages_result][:package_result][:tracking_number] 
+      @options[:file_name] = label_details[:file_name]
+      @image = Base64.decode64(options[:graphic_image]) if has_image?
+
+      if file_name = @options[:file_name]
+        save(file_name, false)
+      end
+    end
+
+    def name
+      [tracking_number, format].join('.')
+    end
+
+    def format
+      options[:label_image_format]
+    end
+
+    def file_name
+      options[:file_name]
+    end
+
+    def tracking_number
+      options[:tracking_number]
+    end
+
+    def save(path, append_name = true)
+      return unless has_image?
+
+      full_path = Pathname.new(path)
+      full_path = full_path.join(name) if append_name
+    
+      File.open(full_path, 'wb') do |f|
+        f.write(@image)
+      end
+    end
+
+    def has_image?
+      options.key?(:graphic_image)
+    end
+
+  end
+end

data/lib/dhl_express_global/request/base.rb

@@ -0,0 +1,157 @@
+require 'httparty'
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+require 'dhl_express_global/helpers'
+
+module DhlExpressGlobal
+  module Request
+    class Base
+      include Helpers
+      include HTTParty
+      format :xml
+
+      attr_accessor :debug
+
+      default_options.update(verify: false)
+
+      # DHL Express Global Test URL
+      TEST_URL = 'https://wsb.dhl.com:443/sndpt/expressRateBook?WSDL'
+
+      # DHL Express Global Production URL
+      PRODUCTION_URL = ''
+
+      # SERVICE_CODES = []
+      
+      # List of Payment Info codes
+      PAYMENT_INFO_CODES = ["CFR", "CIF", "CIP", "CPT", "DAF", "DDP", "DDU", "DAP", "DEQ", "DES", "EXW", "FAS", "FCA", "FOB"]
+
+
+      def initialize(credentials, options = {})
+        requires!(options, :shipper, :recipient, :packages)
+        @credentials = credentials
+        @shipper, @recipient, @packages, @service_type, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:debug]
+        @debug = ENV['DEBUG'] == 'true'
+        @shipping_options = options[:shipping_options] ||= {}
+        @payment_options = options[:payment_options] ||= {}
+      end
+
+      def process_request
+        raise NotImplementedError, 'Override #process_request in subclass'
+      end
+
+      def api_url
+        @credentials.mode == 'production' ? PRODUCTION_URL : TEST_URL
+      end
+
+      def build_xml
+        raise NotImplementedError, 'Override #build_xml in subclass'
+      end
+
+      def parse_response(response)
+        response = Hash.from_xml( response.parsed_response.gsub("\n", "") ) if response.parsed_response.is_a? String
+        response = sanitize_response_keys(response)
+      end
+
+      def sanitize_response_keys(response)
+        if response.is_a? Hash
+          response.inject({}) { |result, (key, value)| result[underscorize(key).to_sym] = sanitize_response_keys(value); result }
+        elsif response.is_a? Array
+          response.collect { |result| sanitize_response_keys(result) }
+        else
+          response
+        end
+      end
+
+      def add_ws_authentication_header(xml)
+        xml[:soapenv].Header {
+          xml[:wsse].Security('soapenv:mustUnderstand' => "1"  , 
+                              'xmlns:wsse' => 'http://schemas.xmlsoap.org/ws/2003/06/secext', 
+                              'xmlns:wsu' => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd') {
+            xml[:wsse].UsernameToken('wsu:Id' => 'UsernameToken') {
+              xml[:wsse].Username @credentials.username
+              xml[:wsse].Password(@credentials.password, 'Type' => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText')
+            }
+          }
+        }
+      end
+
+      def add_shipper(xml)
+        xml.Shipper {
+          xml.Contact {
+            xml.PersonName @shipper[:name]
+            xml.CompanyName @shipper[:company]
+            xml.PhoneNumber @shipper[:phone_number]
+          }
+          xml.Address {
+            add_address_street_lines(xml, @shipper[:address])
+            xml.City @shipper[:city]
+            xml.PostalCode @shipper[:postal_code]
+            xml.StateOrProvinceCode @shipper[:state] if @shipper[:state]
+            xml.CountryCode @shipper[:country_code]
+          }
+        }
+      end
+
+      def add_recipient(xml)
+        xml.Recipient {
+          xml.Contact {
+            xml.PersonName @recipient[:name]
+            xml.CompanyName @recipient[:company]
+            xml.PhoneNumber @recipient[:phone_number]
+          }
+          xml.Address {
+            add_address_street_lines(xml, @recipient[:address])
+            xml.City @recipient[:city]
+            xml.PostalCode @recipient[:postal_code]
+            xml.StateOrProvinceCode @recipient[:state] if @recipient[:state]
+            xml.CountryCode @recipient[:country_code]
+          }
+        }
+      end
+
+      def add_address_street_lines(xml, address)
+        Array(address).take(3).each_with_index do |address_line, i|
+          case i
+          when 0
+            xml.StreetLines address_line
+          when 1
+            xml.StreetLines2 address_line
+          when 2
+            xml.streetLines3 address_line
+          end
+        end
+      end
+
+      def add_requested_packages(xml)
+        @packages.each_with_index do |package, i|
+          xml.RequestedPackages('number' => i + 1) {
+            xml.Weight package[:weight][:value]
+            xml.Dimensions {
+              xml.Length package[:dimensions][:length]
+              xml.Width package[:dimensions][:width]
+              xml.Height package[:dimensions][:height]
+            }
+          }
+        end
+        xml.ShipTimestamp (Time.now + 10*60).strftime("%Y-%m-%dT%H:%M:%SGMT%:z")
+        xml.UnitOfMeasurement @packages.first[:weight][:units] == 'KG' ? 'SI' : 'SU'
+        xml.Content @shipping_options[:package_contents] ||= "NON_DOCUMENTS"
+      end
+
+      # Add information for shipments
+      def add_shipment_info(xml)
+        xml.ShipmentInfo {
+          xml.DropOffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP"
+          xml.ServiceType @shipping_options[:service_type]
+          xml.RequestValueAddedServices @shipping_options[:request_value_added_services] ||= "N"
+          xml.NextBusinessDay @shipping_options[:next_business_day] ||= "N"
+        }
+      end
+
+      def headers
+        {"Content-Type"=>"text/xml; charset=utf-8"}
+      end      
+
+    end
+  end
+end

data/lib/dhl_express_global/request/delete.rb

@@ -0,0 +1,77 @@
+require 'dhl_express_global/request/base'
+
+module DhlExpressGlobal
+  module Request
+    class Delete < Base
+      
+      attr_reader :pickup_date, :pickup_country, :dispatch_confirmation_number, :requestor_name, :reason_code
+
+      def initialize(credentials, options = {})
+        requires!(options, :pickup_date, :pickup_country, :dispatch_confirmation_number, :requestor_name)
+        @credentials = credentials
+        @pickup_date, @pickup_country, @dispatch_confirmation_number, @requestor_name = options[:pickup_date], options[:pickup_country], options[:dispatch_confirmation_number], options[:requestor_name]
+        @reason_code = options[:reason_code] || "001"
+      end
+
+      def process_request
+        api_response = self.class.post api_url, :body => build_xml, :headers => headers
+        puts api_response if @debug
+        response = parse_response(api_response)
+        unless success?(response)
+          failure_response(response)
+        end
+      end
+
+      private
+
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml[:soapenv].Envelope( 'xmlns:soapenv' => "http://schemas.xmlsoap.org/soap/envelope/", 
+                                  'xmlns:del' => "http://scxgxtt.phx-dc.dhl.com/euExpressRateBook/ShipmentMsgRequest") {
+            add_ws_authentication_header(xml)
+            xml[:soapenv].Body {
+              xml[:del].DeleteRequest {
+                xml.PickupDate {
+                  xml.parent.namespace = nil
+                  xml.text pickup_date
+                }
+                xml.PickupCountry {
+                  xml.parent.namespace = nil
+                  xml.text pickup_country
+                }
+                xml.DispatchConfirmationNumber {
+                  xml.parent.namespace = nil
+                  xml.text dispatch_confirmation_number
+                }
+                xml.RequestorName {
+                  xml.parent.namespace = nil
+                  xml.text requestor_name
+                }
+                xml.Reason {
+                  xml.parent.namespace = nil
+                  xml.text reason_code
+                }
+              }
+            }
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def failure_response(response)
+        error_message = response[:envelope][:body][:delete_response][:notification][:message]
+        raise RateError, error_message
+      end
+
+
+      def success?(response)
+        response[:envelope][:body][:delete_response] && ( response[:envelope][:body][:delete_response][:notification][:code] == "0" )
+      end
+
+      def headers
+        super.merge!('SOAPAction' => 'euExpressRateBook_providerServices_ShipmentHandlingServices_Binder_deleteShipmentRequest')
+      end
+
+    end
+  end
+end

data/lib/dhl_express_global/request/label.rb

@@ -0,0 +1,30 @@
+require 'dhl_express_global/label'
+require 'dhl_express_global/request/base'
+require 'dhl_express_global/request/shipment'
+require 'fileutils'
+
+module DhlExpressGlobal
+  module Request
+    class Label < Shipment
+
+      def initialize(credentials, options = {})
+        super(credentials, options)
+        @filename = options[:filename]
+      end
+
+      private
+
+      def success_response(response)
+        super
+
+        label_details = response.merge!({
+            :format => @label_specification[:image_type],
+            :file_name => @filename
+          })
+
+        DhlExpressGlobal::Label.new label_details
+      end
+
+    end
+  end
+end

data/lib/dhl_express_global/request/rate.rb

@@ -0,0 +1,114 @@
+require 'dhl_express_global/request/base'
+
+module DhlExpressGlobal
+  module Request
+    class Rate < Base
+
+      def initialize(credentials, options={})
+        super
+      end
+
+      def process_request
+        api_response = self.class.post api_url, :body => build_xml, :headers => headers
+        puts api_response if @debug
+        response = parse_response(api_response)
+        if success?(response)
+          success_response(response)
+        else
+          failure_response(response)
+        end
+      end
+
+      private
+
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml[:soapenv].Envelope( 'xmlns:soapenv' => "http://schemas.xmlsoap.org/soap/envelope/", 
+                                  'xmlns:ship' => "http://scxgxtt.phx-dc.dhl.com/euExpressRateBook/RateMsgRequest") {
+            add_ws_authentication_header(xml)
+            xml[:soapenv].Body {
+              xml.RateRequest {
+                xml.parent.namespace = nil
+                xml.RequestedShipment {
+                  xml.DropOffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP"
+                  xml.NextBusinessDay @shipping_options[:next_day] ||= "N"
+                  xml.Ship {
+                    add_shipper(xml)
+                    add_recipient(xml)
+                  }
+                  add_requested_packages(xml)
+                  xml.PaymentInfo @payment_info
+                  xml.Account @credentials.account_number
+                }
+              }
+            }
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def add_shipper(xml)
+        xml.Shipper {
+          add_address_street_lines(xml, @shipper[:address])
+          xml.City @shipper[:city]
+          xml.PostalCode @shipper[:postal_code]
+          xml.StateOrProvinceCode @shipper[:state] if @shipper[:state]
+          xml.CountryCode @shipper[:country_code]
+        }
+      end
+
+      def add_recipient(xml)
+        xml.Recipient {
+          add_address_street_lines(xml, @recipient[:address])
+          xml.City @recipient[:city]
+          xml.PostalCode @recipient[:postal_code]
+          xml.StateOrProvinceCode @recipient[:state] if @recipient[:state]
+          xml.CountryCode @recipient[:country_code]
+        }
+      end
+
+      def headers
+        super.merge!("SOAPAction" => "euExpressRateBook_providerServices_ShipmentHandlingServices_Binder_getRateRequest")
+      end
+      ## <RateRequest> 
+      ##   <ClientDetail></ClientDetail>
+      ##   <RequestedShipment>
+      ##     <DropOffType>REQUEST_COURIER</DropOffType>
+      ##     <Ship>
+      ##       <Shipper>
+      ##         <StreetLines>1-16-24, Minami-gyotoku</StreetLines>
+      ##         <City>Ichikawa-shi, Chiba</City>
+      ##         <PostalCode>272-0138</PostalCode>
+      ##         <CountryCode>JP</CountryCode>
+      ##       </Shipper>
+      ##       <Recipient>
+      ##         <StreetLines>63 RENMIN LU, QINGDAO SHI</StreetLines>
+      ##         <City>QINGDAO SHI</City>
+      ##         <PostalCode>266033</PostalCode>
+      ##         <CountryCode>CN</CountryCode>
+      ##       </Recipient>
+      ##     </Ship>
+      ##     <Packages>
+      ##       <RequestedPackages number="1">
+      ##         <Weight>
+      ##           <Value>2.0</Value>
+      ##         </Weight>
+      ##         <Dimensions>
+      ##           <Length>13</Length>
+      ##           <Width>12</Width>
+      ##           <Height>9</Height>
+      ##         </Dimensions>
+      ##       </RequestedPackages>
+      ##     </Packages>
+      ##     <ShipTimestamp>2010-11-26T12:00:00GMT-06:00</ShipTimestamp>
+      ##     <UnitOfMeasurement>SU</UnitOfMeasurement>
+      ##     <Content>NON_DOCUMENTS</Content>
+      ##     <DeclaredValue>0000000200</DeclaredValue>
+      ##     <DeclaredValueCurrecyCode>USD</DeclaredValueCurrecyCode>
+      ##     <PaymentInfo>DDP</PaymentInfo>
+      ##     <Account>000000000</Account>
+      ##   </RequestedShipment>
+      ## </RateRequest>
+    end
+  end
+end

data/lib/dhl_express_global/request/shipment.rb

@@ -0,0 +1,128 @@
+require 'dhl_express_global/request/base'
+
+module DhlExpressGlobal
+  module Request
+    class Shipment < Base
+
+      def initialize(credentials, options={})
+        super
+        requires!(options, :service_type, :payment_info, :international_detail)
+        @international_detail = options[:international_detail]
+        requires!(@international_detail, :commodities)
+        @commodities = @international_detail[:commodities]
+        requires!(@commodities, :description, :customs_value)
+        @payment_info = options[:payment_info]
+        @label_specification = {
+          :image_type => 'PDF',
+          :label_template => 'ECOM26_84_001'
+        }
+
+        @label_specification.merge! options[:label_specification] if options[:label_specification]
+      end
+
+      def process_request
+        api_response = self.class.post api_url, :body => build_xml, :headers => headers
+        puts api_response if @debug
+        response = parse_response(api_response)
+        if success?(response)
+          success_response(response)
+        else
+          failure_response(response)
+        end
+      end
+
+      private
+
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml[:soapenv].Envelope( 'xmlns:soapenv' => "http://schemas.xmlsoap.org/soap/envelope/", 
+                                  'xmlns:ship' => "http://scxgxtt.phx-dc.dhl.com/euExpressRateBook/ShipmentMsgRequest") {
+            add_ws_authentication_header(xml)
+            xml[:soapenv].Body {
+              xml[:ship].ShipmentRequest {
+                xml.RequestedShipment {
+                  xml.parent.namespace = nil
+                  add_shipment_info(xml)
+                  xml.ShipTimestamp @shipping_options[:ship_timestamp] ||= (Time.now + 10*60).strftime("%Y-%m-%dT%H:%M:%SGMT%:z")
+                  xml.PaymentInfo @payment_info
+                  add_international_detail(xml)
+                  xml.Ship {
+                    add_shipper(xml)
+                    add_recipient(xml)
+                  }
+                  add_requested_packages(xml)
+                }
+              }
+            }
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def add_shipment_info(xml)
+        xml.ShipmentInfo {
+          xml.DropOffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP"
+          xml.ServiceType @service_type
+          xml.Account @credentials.account_number
+          xml.Currency @shipping_options[:currency].upcase
+          xml.UnitOfMeasurement @shipping_options[:unit_of_measurement]
+        }
+      end
+
+      def add_international_detail(xml)
+        xml.InternationalDetail {
+          xml.Commodities {
+            xml.NumberOfPieces @commodities[:number_of_pieces] if @commodities[:number_of_pieces]
+            xml.Description @commodities[:description]
+            xml.CountryOfManufacture @commodities[:country_of_manufacture] if @commodities[:country_of_manufacture]
+            xml.Quantity @commodities[:quantity] if @commodities[:quantity]
+            xml.UnitPrice @commodities[:unit_price] if @commodities[:unit_price]
+            xml.CustomsValue @commodities[:customs_value]
+          }
+          xml.Content @international_detail[:content] if @international_detail[:content]
+        }
+      end
+
+      def add_requested_packages(xml)
+        xml.Packages {
+          @packages.each_with_index do |package, i|
+            xml.RequestedPackages('number' => i + 1) {
+              xml.Weight package[:weight][:value]
+              xml.Dimensions {
+                xml.Length package[:dimensions][:length]
+                xml.Width package[:dimensions][:width]
+                xml.Height package[:dimensions][:height]
+              }
+              xml.CustomerReferences @shipping_options[:customer_references] ||= "#{rand(10**10)}"
+            }
+          end
+        }
+      end
+
+
+      def failure_response(response)
+        error_message = error_response(response)
+        raise RateError, error_message
+      end
+
+      def success_response(response)
+        @response_details = response[:envelope][:body][:shipment_response]
+      end
+
+      def success?(response)
+        response[:envelope][:body][:shipment_response] && !error_response(response)
+      end
+
+      def error_response(response)
+        response[:envelope][:body][:shipment_response][:notification][:message]
+      rescue
+        response[:envelope][:body][:shipment_response][:notification].first[:message]
+      end
+
+      def headers
+        super.merge!("SOAPAction" => "euExpressRateBook_providerServices_ShipmentHandlingServices_Binder_createShipmentRequest")
+      end
+
+    end
+  end
+end

data/lib/dhl_express_global/shipment.rb

@@ -0,0 +1,32 @@
+require 'dhl_express_global/credentials'
+require 'dhl_express_global/request/shipment'
+require 'dhl_express_global/request/label'
+require 'dhl_express_global/request/delete'
+require 'dhl_express_global/request/rate'
+
+module DhlExpressGlobal
+
+  class Shipment
+
+    def initialize(options = {})
+      @credentials = Credentials.new(options)
+    end
+
+    def label(options = {})
+      Request::Label.new(@credentials, options).process_request
+    end
+
+    def delete(options = {})
+      Request::Delete.new(@credentials, options).process_request
+    end
+
+    def ship(options = {})
+      Request::Shipment.new(@credentials, options).process_request
+    end
+
+    def rate(options = {})
+      Request::Rate.new(@credentials, options).process_request
+    end
+
+  end
+end

data/lib/dhl_express_global/version.rb

@@ -0,0 +1,3 @@
+module DhlExpressGlobal
+  VERSION = "0.0.1"
+end

data/spec/config/dhl_credentials.example.yml

@@ -0,0 +1,11 @@
+development:
+  :username: 'xxx'
+  :password: 'xxx'
+  :account_number: 'xxx'
+  :mode: 'xxx'
+
+production:
+  :username: 'xxx'
+  :password: 'xxx'
+  :account_number: 'xxx'
+  :mode: 'xxx'

data/spec/lib/delete_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'date'
+
+module DhlExpressGlobal
+  describe Shipment do
+    let (:dhl) { Shipment.new(dhl_credentials) }
+    context '#delete' do
+      context 'delete shipment with dispatch confirmation number', :vcr do
+        let (:tomorrow) { DateTime.now.next_day.to_date.to_s }
+        let(:options) do
+          { :pickup_date => tomorrow, :pickup_country => "IT", 
+            :dispatch_confirmation_number => "FLR-804",  :requestor_name => "Requestor", :reason_code => "001" }
+        end
+
+        it 'deletes a shipment' do
+          expect{ dhl.delete(options) }.to_not raise_error
+        end
+      end
+      context 'context raise an error when the pickup date is invalid', :vcr do
+        let(:options) do
+          { :pickup_date => "2014-07-21", :pickup_country => "IT", 
+            :dispatch_confirmation_number => "FLR-804",  :requestor_name => "Requestor", :reason_code => "001" }
+        end
+
+        it 'raises an error' do
+          expect { dhl.delete(options) }.to raise_error(DhlExpressGlobal::RateError, "Cancellation of booking was not successful. Requested Pickup was not found.")
+        end
+      end
+    end
+  end
+end

data/spec/lib/label_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'tmpdir'
+
+module DhlExpressGlobal
+  describe Label do
+    describe 'ship service for label' do
+      let(:dhl) { Shipment.new(dhl_credentials) }
+      let(:shipper) do 
+        { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "35 Great Jones St", :city => "New York", :state => "NY", :postal_code => "10012", :country_code => "US" }
+      end
+      let(:recipient) do
+        { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Bruehlstrasse, 10", :city => "Ettingen", :state => "CH", :postal_code => "4107", :country_code => "CH" }
+      end
+      let(:packages) do
+        [
+          {
+            :weight => { :units => "KG", :value => 2.86 },
+            :dimensions => { :length => 40, :width => 30, :height => 20, units: "CM" }
+          }
+        ]
+      end
+      let(:commodities) do
+        { :number_of_pieces => 1, :description => "Clothing", :customs_value => 300.00 }
+      end
+      let(:international_detail) do
+        { :commodities => commodities, :content => "NON_DOCUMENTS" }
+      end
+      let(:filename) {
+        require 'tmpdir'
+        File.join(Dir.tmpdir, "label#{rand(15000)}.pdf")
+      }
+      let(:shipping_options) do
+        { :currency => "EUR", :unit_of_measurement => "SI" }
+      end
+      let(:options) do
+        { 
+          :shipper => shipper, 
+          :recipient => recipient, 
+          :packages => packages, 
+          :payment_info => "DDP", 
+          :international_detail => international_detail, 
+          :shipping_options => shipping_options,
+          :service_type => "P",
+          :filename => filename 
+        }
+      end
+
+      describe 'label', :vcr do
+        before do
+          @label = dhl.label(options)
+        end
+
+        it 'should create a label' do
+          expect(File).to exist(filename)
+        end
+
+        it 'should return a tracking number' do
+          expect(@label).to respond_to('tracking_number')
+        end
+
+        it 'should expose complete response' do
+          expect(@label).to respond_to('response_details')
+        end
+
+        it 'should expose the file_name' do
+          expect(@label).to respond_to('file_name')
+        end
+
+        after do
+          require 'fileutils'
+          FileUtils.rm_r(filename) if File.exists?(filename)
+        end
+
+      end 
+    end
+  end
+end

data/spec/lib/rate_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'dhl_express_global'
+
+describe DhlExpressGlobal::Request::Rate do
+  describe 'ship service' do
+    let(:dhl) { DhlExpressGlobal::Shipment.new(dhl_credentials) }
+    let(:shipper) do 
+      { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "35 Great Jones St", :city => "New York", :state => "NY", :postal_code => "10012", :country_code => "US" }
+    end
+    let(:recipient) do
+      { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Bruehlstrasse, 10", :city => "Ettingen", :state => "CH", :postal_code => "4107", :country_code => "CH" }
+    end
+    let(:packages) do
+      [
+        {
+          :weight => { :units => "KG", :value => 2.86 },
+          :dimensions => { :length => 40, :width => 30, :height => 20, units: "CM" }
+        }
+      ]
+    end
+
+    context "international rate request", :vcr do
+      let(:options) do
+        {
+          shipper: shipper,
+          recipient: recipient,
+          packages: packages,
+          payment_info: "DDP"
+        }
+      end
+
+      it "succeeds" do
+        expect {
+          @rate = dhl.rate(options)
+        }.to_not raise_error
+
+        expect(@rate.class).to_not eq(DhlExpressGlobal::RateError)
+      end
+
+    end
+
+  end
+end

data/spec/lib/shipment_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'dhl_express_global'
+
+describe DhlExpressGlobal::Request::Shipment do
+  describe 'ship service' do
+    let(:dhl) { DhlExpressGlobal::Shipment.new(dhl_credentials) }
+    let(:shipper) do 
+      { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "35 Great Jones St", :city => "New York", :state => "NY", :postal_code => "10012", :country_code => "US" }
+    end
+    let(:recipient) do
+      { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Bruehlstrasse, 10", :city => "Ettingen", :state => "CH", :postal_code => "4107", :country_code => "CH" }
+    end
+    let(:packages) do
+      [
+        {
+          :weight => { :units => "KG", :value => 2.86 },
+          :dimensions => { :length => 40, :width => 30, :height => 20, units: "CM" }
+        }
+      ]
+    end
+    let(:commodities) do
+      { :number_of_pieces => 1, :description => "Clothing", :customs_value => 300.00 }
+    end
+    let(:international_detail) do
+      { :commodities => commodities, :content => "NON_DOCUMENTS" }
+    end
+    let(:filename) {
+      require 'tmpdir'
+      File.join(Dir.tmpdir, "label#{rand(15000)}.pdf")
+    }
+    let(:shipping_options) do
+      { :currency => "EUR", :unit_of_measurement => "SI" }
+    end
+
+    context "international shipment", :vcr do
+      let(:options) do
+        { :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "P", :payment_info => "DDP", :international_detail => international_detail, :shipping_options => shipping_options }
+      end
+
+      it "succeeds" do
+        expect {
+          @shipment = dhl.ship(options)
+        }.to_not raise_error
+
+        expect(@shipment.class).to_not eq(DhlExpressGlobal::RateError)
+      end
+
+    end
+
+    context "without service_type specified", :vcr do
+      let(:options) do
+        { :shipper => shipper, :recipient => recipient, :packages => packages, :payment_info => "DDP", :international_detail => international_detail, :shipping_options => shipping_options }
+      end
+
+      it 'raises error' do
+        expect {
+          @shipment = dhl.ship(options)
+        }.to raise_error('Missing Required Parameter service_type')
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'dhl_express_global'
+require 'support/vcr'
+require 'support/credentials'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :production unless dhl_production_credentials
+  c.expect_with :rspec do |expect_config|
+    expect_config.syntax = :expect
+  end
+end

data/spec/support/credentials.rb

@@ -0,0 +1,17 @@
+def dhl_credentials
+  @dhl_credentials ||= credentials["development"]
+end
+
+def dhl_production_credentials
+  @dhl_production_credentials ||= credentials["production"]
+end
+
+private
+
+def credentials
+  @credentials ||= YAML.load_file(credentials_path)
+end
+
+def credentials_path
+  File.expand_path("../../config/dhl_credentials.yml", __FILE__)
+end

data/spec/support/vcr.rb

@@ -0,0 +1,14 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = File.expand_path('../../vcr', __FILE__)
+  c.hook_into :webmock
+end
+
+RSpec.configure do |c|
+  c.include DhlExpressGlobal::Helpers
+  c.around(:each, :vcr) do |example|
+    name = underscorize(example.metadata[:full_description].split(/\s+/, 2).join("/")).gsub(/[^\w\/]+/, "_")
+    VCR.use_cassette(name) { example.call }
+  end
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: dhl_express_global
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JONBRWN
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: builder
+  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: xml-simple
+  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: activesupport
+  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: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.00'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.00'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: debugger
+  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: Ruby wrapper for the DHL Express Global API
+email:
+- jonathanbrown.a@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dhl_express_global.gemspec
+- lib/dhl_express_global.rb
+- lib/dhl_express_global/credentials.rb
+- lib/dhl_express_global/helpers.rb
+- lib/dhl_express_global/label.rb
+- lib/dhl_express_global/request/base.rb
+- lib/dhl_express_global/request/delete.rb
+- lib/dhl_express_global/request/label.rb
+- lib/dhl_express_global/request/rate.rb
+- lib/dhl_express_global/request/shipment.rb
+- lib/dhl_express_global/shipment.rb
+- lib/dhl_express_global/version.rb
+- spec/config/dhl_credentials.example.yml
+- spec/lib/delete_spec.rb
+- spec/lib/label_spec.rb
+- spec/lib/rate_spec.rb
+- spec/lib/shipment_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the DHL Express Global API
+test_files:
+- spec/config/dhl_credentials.example.yml
+- spec/lib/delete_spec.rb
+- spec/lib/label_spec.rb
+- spec/lib/rate_spec.rb
+- spec/lib/shipment_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb