dhl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa40048126f12bd3fc7c5ed6c7d6f57801961ab5
+  data.tar.gz: 591643d4d78424fdd97b645735bb40e1ab5c118a
+SHA512:
+  metadata.gz: 12afcfbbeee3de8265bd66bd737d20f25f239f1a6cf1e946f8ec200344fa292569bd6523d9aa2658299fc0e568c1c95acf5d8a13b5677290112114d64102b180
+  data.tar.gz: 393580cbca56eaabf094bdea4092e80b501de3a4018c7a918471fd17466cde9f31c736e46ea324b2cf92f30299301e96dc6527a443a04266b9a568b1689898f9

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dhl.gemspec
+gemspec
+
+
+source 'https://rubygems.org'
+
+gem 'savon', '~> 2.2.0'
+
+group :test do
+  gem 'factory_girl', '~> 4.2.0'
+  gem 'webmock', "~> 1.9.0"
+  gem 'vcr', "~> 2.4.0"
+  # gem 'turn'
+  gem 'rake'
+  gem 'rspec', "~> 2.13.0"
+  gem 'pry'
+end
+
+# Specify your gem's dependencies in the_tvdb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alessandro Mencarini
+
+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,93 @@
+# DHL
+
+[![Build Status](https://travis-ci.org/momitians/dhl.png?branch=master)](https://travis-ci.org/momitians/dhl)
+[![Code Climate](https://codeclimate.com/github/momitians/dhl.png)](https://codeclimate.com/github/momitians/dhl)
+
+This gem will provide a wrapper to DHL SOAP API. Given DHL credentials and the addresses, will generate a shipping label.
+
+It refers to the DHL test environment and cannot be used, as of yet, for production environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dhl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dhl
+
+## Usage
+
+### Package Tracking
+
+TBD
+
+### Request Shipment
+
+```ruby
+# Start by creating a new shipment request
+shipment_request = Dhl::ShipmentRequest.new
+
+# Set sender info
+shipment_request.shipper.name         = 'Package Sender'
+shipment_request.shipper.company      = 'The Packs Inc'
+shipment_request.shipper.phone        = '555-4321'
+shipment_request.shipper.email        = 'ps@example.com'
+shipment_request.shipper.address      = 'Geary Boulevard, 1234'
+shipment_request.shipper.address2     = 'First floor, Apt 2'
+shipment_request.shipper.postal_code  = '54321'
+shipment_request.shipper.city         = 'San Francisco'
+shipment_request.shipper.state_name   = 'CA'
+shipment_request.shipper.country_code = 'USA'
+
+# Set recipient info
+shipment_request.recipient.name         = 'Package Receiver'
+shipment_request.recipient.company      = 'Pack It Ltd'
+shipment_request.recipient.phone        = '555-1234'
+shipment_request.recipient.email        = 'pr@example.com'
+shipment_request.recipient.address      = 'Times Square, 1234'
+shipment_request.recipient.address2     = 'Third floor, Apt 5'
+shipment_request.recipient.postal_code  = '12345'
+shipment_request.recipient.city         = 'New York'
+shipment_request.recipient.state_name   = 'NY'
+shipment_request.recipient.country_code = 'USA'
+
+# Set a pickup date and time
+shipment_request.shipment.pickup_time = Time.new(2013, 05, 20, 10, 00, 00, "-08:00")
+
+# Add Packages with weight, width, height, length and a reference string
+shipment_request.packages.add(10, 15, 5, 20, 'Pack')
+
+# Execute the reeuqest
+result = Dhl.client.request_shipment(shipment_request)
+
+```
+
+If everything goes well, result will be a hash with:
+* tracking_numbers: Shipment tracking number
+* shipping_label: Path to the shipping label PDF
+
+## Testing
+
+For testing purposes please set the timezone to UTC
+
+```shell
+$ export TZ=UTC
+```
+
+## 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
+
+## Licence
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT). © 2013 [Momit S.r.l.](http://momit.it/)

data/Rakefile

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

data/dhl.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dhl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dhl"
+  spec.version       = Dhl::VERSION
+  spec.authors       = ["Alessandro Mencarini"]
+  spec.email         = ["a.mencarini@freegoweb.it"]
+  spec.description   = %q{A wrapper for DHL SOAP interface. }
+  spec.summary       = %q{This gem will provide a wrapper to DHL SOAP API. Given DHL credentials and the addresses, will generate a shipping label.}
+  spec.homepage      = "http://momitians.github.io/dhl"
+  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 "savon", "~> 2.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "factory_girl", "~> 4.2.0"
+  spec.add_development_dependency "vcr", "~> 2.4.0"
+  spec.add_development_dependency "webmock", "~> 1.9.0"
+end

data/lib/dhl.rb

@@ -0,0 +1,34 @@
+require 'savon'
+
+require "dhl/client"
+require "dhl/configuration"
+require "dhl/contact"
+require "dhl/packages"
+require "dhl/package"
+require "dhl/shipment"
+require "dhl/shipment_request"
+require "dhl/tracking_request"
+
+require "dhl/version"
+
+module Dhl
+
+  def self.setup
+    yield self.config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.client(options={})
+    @client ||= Client.new(options)
+  end
+
+end
+
+class Hash
+  def remove_empty
+    reject{ |key, value| value.nil? || value == '' }
+  end
+end

data/lib/dhl/client.rb

@@ -0,0 +1,78 @@
+module Dhl
+  class Client
+
+    def config
+      Dhl.config
+    end
+
+    def client_options
+      {
+        wsse_auth: [config.username, config.password],
+        wsse_timestamp: true,
+        convert_request_keys_to: :camelcase
+      }
+    end
+
+    def initialize(options)
+      config.username ||= options[:username]
+      raise 'Provide a username (e.g.: `export DHL_USERNAME=dhlusername`).' if !config.username
+
+      config.password ||= options[:password]
+      raise 'Provide a password (e.g.: `export DHL_PASSWORD=dhlpassword`).' if !config.password
+
+      config.account ||= options[:account]
+      raise 'Provide a DHL account number (e.g.: `export DHL_ACCOUNT=123456789`).' if !config.account
+
+      @requests_soap_client = Savon.client(client_options.merge(wsdl: "https://wsbuat.dhl.com:8300/amer/GEeuExpressRateBook?WSDL"))
+      @tracking_soap_client = Savon.client(client_options.merge(wsdl: "https://wsbuat.dhl.com:8300/gbl/glDHLExpressTrack?WSDL"))
+    end
+
+    def requests_soap_client
+      # SOAP Client operations:
+      # => [:get_rate_request, :create_shipment_request, :delete_shipment_request]
+      @requests_soap_client
+    end
+
+    def tracking_soap_client
+      # SOAP Client operations:
+      # => [:track_shipment_request]
+      @tracking_soap_client
+    end
+
+
+    def request_shipment(shipment_request)
+      response = requests_soap_client.call(:create_shipment_request, message: shipment_request.to_hash )
+
+      if response.body[:shipment_response][:notification][:@code] != '0'
+        raise "Error: #{response.body[:shipment_response][:notification][:message]}"
+      end
+
+      result = {}
+
+      image_format = response.body[:shipment_response][:label_image][:label_image_format]
+      shipment_identification_number = response.body[:shipment_response][:shipment_identification_number]
+      shipping_label_filename = "#{shipment_identification_number}.#{image_format.downcase}"
+      Dir.mkdir('labels') unless File.exists?('labels')
+      File.open("labels/#{shipping_label_filename}", 'wb') do |f|
+        f.write( Base64.decode64( response.body[:shipment_response][:label_image][:graphic_image]) )
+        result[:shipping_label] = File.absolute_path(f)
+      end
+
+      package_result = response.body[:shipment_response][:packages_result][:package_result]
+      result[:tracking_numbers] = package_result.is_a?(Array) ? package_result.map{|r| r[:tracking_number]} : package_result[:tracking_number]
+
+      result
+    end
+
+    def track(numbers)
+      request = Dhl::TrackingRequest.new(numbers)
+      response = tracking_soap_client.call(:track_shipment_request, message: request.to_hash)
+      response.body
+    end
+
+    # def request_rate
+    #   response = @soap_client.call(:get_rate_request, message: request_rate_hash )
+    # end
+
+  end
+end

data/lib/dhl/configuration.rb

@@ -0,0 +1,12 @@
+module Dhl
+  class Configuration
+
+    attr_accessor :username, :password, :account
+    def initialize
+      @username = ENV['DHL_USERNAME']
+      @password = ENV['DHL_PASSWORD']
+      @account = ENV['DHL_ACCOUNT']
+    end
+
+  end
+end

data/lib/dhl/contact.rb

@@ -0,0 +1,30 @@
+module Dhl
+  class Contact
+
+    attr_accessor :name, :company, :phone, :email, :address, :address2, :address3,
+      :street_name, :street_number, :state_name, :city, :postal_code, :country_code
+
+    def to_hash
+      {
+        contact: {
+          person_name: @name,
+          company_name: @company,
+          phone_number: @phone,
+          email_address: @email # Optional
+        }.remove_empty,
+        address: {
+          street_lines: @address,
+          street_lines_2: @address2, # Optional
+          street_lines_3: @address3, # Optional
+          city: @city,
+          postal_code: @postal_code,
+          country_code: @country_code,
+          street_name: @street_name, # Optional
+          street_number: @street_number, # Optional
+          state_or_province_code: @state_name # Optional
+        }.remove_empty
+      }
+    end
+
+  end
+end

data/lib/dhl/examples.rb

@@ -0,0 +1,208 @@
+    request_rate_small_hash = {
+      requested_shipment: {
+        drop_off_type: "REGULAR_PICKUP",
+        ship: {
+          shipper: address_structure,
+          recipient: address_structure
+        },
+        packages: {
+          requested_packages: [
+            {
+              weight: {
+                value: '15'
+              },
+              dimensions: {
+                length: '3',
+                width: '3',
+                height: '3'
+              }
+            }
+          ]
+        },
+        ship_timestamp: Time.now.strftime('%Y-%m-%dT%H:%M:%SGMT+01:00'), # When is the shipment going to be ready for pickup?
+        account: ENV['DHL_CUSTOMER_CODE'],
+        unit_of_measurement: 'SI' # Or SU, UK, US,
+      }
+    }
+    response = client.call(:get_rate_request, message: request_rate_small_hash )
+
+    request_rate_hash = {
+      requested_shipment: {
+        drop_off_type: "REGULAR_PICKUP",
+        next_business_day: nil, # Optional, Y or N
+        ship: {
+          shipper: address_structure,
+          recipient: address_structure
+        },
+        packages: {
+          requested_packages: [
+            1 => {
+              weight: '15',
+              dimensions: {
+                length: '3,0',
+                width: '3,0',
+                height: '3,0'
+              }
+            }
+          ]
+        },
+        ship_timestamp: Time.now.strftime('%Y-%m-%dT%H:%M:%SGMT%z'), # When is the shipment going to be ready for pickup?
+        unit_of_measurement: 'SI', # Or SU, UK, US
+        content: '', # Optional
+        payment_info: '', # Optional
+        account: '', # Optional
+        billing: {}, # Optional
+        special_services: {} # Optional
+      }
+    }
+
+
+    # request_shipment examples
+    request_shipment_small_hash = {
+      requested_shipment: {
+        shipment_info: {
+          drop_off_type: "REGULAR_PICKUP",
+          service_type: 'N',
+          currency: 'EUR',
+          unit_of_measurement: 'SI', # Or SU, UK, US
+          account: ENV['DHL_CUSTOMER_CODE'],
+
+        },
+        ship_timestamp: Time.now.+(5.days).strftime('%Y-%m-%dT19:%M:%SGMT+01:00'), # When is the shipment going to be ready for pickup?
+        payment_info: 'DDP',
+        international_detail: {
+          commodities: {
+            number_of_pieces: 1,
+            description: 'Goods',
+          }
+        },
+        ship: {
+          shipper: contact_structure,
+          recipient: recipient_contact_structure,
+        },
+        packages: [
+          requested_packages: {
+            weight: '15',
+            dimensions: {
+              length: '3',
+              width: '3',
+              height: '3'
+            },
+            customer_references: 'ewqqwe'
+          },
+          :attributes! => { requested_packages: { number: 1 } }
+        ]
+      }
+    }
+    response = client.call(:create_shipment_request, message: request_shipment_small_hash )
+
+    request_shipment_hash = {
+      requested_shipment: {
+
+        shipment_info: {
+          # REGULAR_PICKUP if regularly served, REQUEST_COURIER if a courier should specifically go
+          drop_off_type: "REGULAR_PICKUP",
+          service_type: '',
+          currency: 'EUR',
+          unit_of_measurement: 'SI', # Or SU, UK, US
+          account: '', # Optional, the customer account
+          billing: { # Optional
+            shipper_account_number: '', # DHL Account Number
+            shipping_payment_type: '', # S for ShipperAccountNumber, R for BillingAccountNumber, or T for BillingAccountNumber
+            billing_account_number: '', # Optional, if PaymentType is R or T
+          },
+          special_services: {}, # Optional
+
+          shipment_identification_number: nil, # Unused
+          packages_count: nil, # Unused
+          send_package: nil # Unused
+        },
+        ship_timestamp: Time.now.strftime('%Y-%m-%dT%H:%M:%SGMT%z'), # When is the shipment going to be ready for pickup?
+        payment_info: nil,
+        international_detail: {
+          commodities: {
+            number_of_pieces: 1,
+            description: 'Goods',
+            country_of_manufacture: 'IT', # Optional
+            quantity: '1', # Optional
+            unit_price: '100.00', # Optional
+            customs_value: '100.00' # Optional
+          },
+          content: 'NON_DOCUMENTS', # Optional, NON_DOCUMENTS or DOCUMENTS
+          export_reference: nil # Optional; e.g.: EEI/ITN reference information required for the US export
+        },
+        ship: {
+          shipper: contact_structure,
+          recipient: contact_structure,
+          pickup: contact_structure # Optional
+        },
+        packages: {
+          requested_packages: [
+            {
+              weight: '15.000',
+              dimensions: {
+                length: '3,0',
+                width: '3,0',
+                height: '3,0'
+              },
+              customer_references: 'ewqqwe',
+              insured_value: '100,00' # Optional
+            }
+          ]
+        }
+      }
+    }
+
+
+
+    def address_structure
+      {
+        street_lines: 'Loc Bellocchi 68B',
+        city: 'Fano',
+        postal_code: '61032',
+        country_code: 'IT',
+        street_name: 'Loc Bellocchi', # Optional
+        street_number: '68B', # Optional
+        # street_lines_2: '', # Optional
+        # street_lines_3: '', # Optional
+        state_or_province_code: 'PU' # Optional
+      }
+    end
+
+    def recipient_address_structure
+      {
+        street_lines: 'via Stephenson 48',
+        city: 'Milano',
+        postal_code: '20028',
+        country_code: 'IT',
+        street_name: 'via Stephenson', # Optional
+        street_number: '48', # Optional
+        # street_lines_2: '', # Optional
+        # street_lines_3: '', # Optional
+        state_or_province_code: 'MI' # Optional
+      }
+    end
+
+
+    def contact_structure
+      {
+        contact: {
+          person_name: 'Alessandro Mencarini',
+          company_name: 'freego',
+          phone_number: '+391234567890',
+          email_address: 'a.mencarini@freegoweb.it' # Optional
+        },
+        address: address_structure
+      }
+    end
+    def recipient_contact_structure
+      {
+        contact: {
+          person_name: 'Maurizio de Magnis',
+          company_name: 'Momit',
+          phone_number: '+390987654321',
+          email_address: 'maurizio.demagnis@momit.it' # Optional
+        },
+        address: recipient_address_structure
+      }
+    end