dhl-intraship 0.0.7

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+atlassian-ide-plugin.xml
+.idea

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Team Europe
+
+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,91 @@
+# Dhl::Intraship
+
+This is a simple gem to wrap the DHL Intraship SOAP Api. Note that currently only the simplest usecase is implemented:
+Sending a national day definite package without any extra services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dhl-intraship'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dhl-intraship
+
+## Usage
+
+Initialize a new API object using
+
+```ruby
+api = Dhl::Infraship::API.new(config, options)
+```
+
+Config is the following hash:
+
+```ruby
+config = {user: 'your Intraship API user name', #mandatory
+          signature: 'Your Intraship API user password', #mandatory
+          ekp: 'Your DHL EKP (first part of your DHL Account number)', #mandatory
+          procedure_id: 'The prodedureId (second part of your DHL Account number)', #optional, defaults to '01'
+          partner_id: 'The partnerId (=attendance, third part of your DHL Account number)' #optional, defaults to '01'
+          }
+```
+
+Options is an optional parameter and can contain the following parameters:
+
+```ruby
+options = {test: true, # If test is set, all API calls go against the Intraship test system
+           label_response_type: :xml} # If it's set to XML the createShipment-Calls return the label data as XML instead of the PDF-Link
+```
+
+To send a shipment to DHL you need to create it first:
+
+```ruby
+sender_address = Dhl::Intraship::Address.new(company: 'Team Europe Ventures',
+                                             street: 'Mohrenstraße',
+                                             house_number: '60',
+                                             zip: '10117',
+                                             city: 'Berlin',
+                                             country_code: 'DE',
+                                             email: 'info@teameurope.net')
+
+receiver_address = Dhl::Intraship::Address.new(firstname: 'John',
+                                               lastname: 'Doe',
+                                               street: 'Mainstreet',
+                                               house_number: '10',
+                                               street_additional: 'Appartment 2a',
+                                               zip: '90210',
+                                               city: 'Springfield',
+                                               country_code: 'DE',
+                                               email: 'john.doe@example.com')
+
+# Note that the weight parameter is in kg and the length/height/width in cm
+shipment = Dhl::Intraship::Shipment.new(sender_address: sender_address,
+                                        receiver_address: receiver_address,
+                                        shipment_date: Date.today,
+                                        weight: 2,
+                                        length: 30,
+                                        height:15,
+                                        width: 25)
+```
+
+Note that the actual api-call takes an array of shipments
+
+```ruby
+result = api.createShipmentDD([shipment])
+```
+
+The result contains the "shipment_number", as well as the "label_url" (or the "xml_label" when it was specified as repsonse type)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/dhl-intraship.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dhl-intraship/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alexander Kops"]
+  gem.email         = ["a.kops@teameurope.net"]
+  gem.description   = %q{A simple gem to access the DHL Intraship API}
+  gem.summary       = %q{This wraps the DHL Intraship SOAP Interface for creating shipments}
+  gem.homepage      = "https://github.com/teameurope/dhl-intraship"
+
+  gem.add_dependency "savon", "~> 0.9.9"
+  gem.add_development_dependency "rspec", "~> 2.9"
+  gem.add_development_dependency "savon_spec", "~> 0.1.6"
+
+  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.name          = "dhl-intraship"
+  gem.require_paths = ["lib"]
+  gem.version       = Dhl::Intraship::VERSION
+end

data/lib/dhl-intraship.rb

@@ -0,0 +1,5 @@
+require "dhl-intraship/version"
+require "dhl-intraship/api"
+require "dhl-intraship/address"
+require "dhl-intraship/shipment"
+require "dhl-intraship/product_code"

data/lib/dhl-intraship/address.rb

@@ -0,0 +1,78 @@
+module Dhl
+  module Intraship
+    class Address
+      attr_accessor :company, :salutation, :firstname, :lastname, :street, :house_number, :street_additional,
+      :zip, :city, :country_code, :email
+
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          setter = :"#{key.to_s}="
+          if self.respond_to?(setter)
+            self.send(setter, value)
+          end
+        end
+      end
+
+      def company?
+        !self.company.blank?
+      end
+
+      def country_code=(country_code)
+        raise "Country code must be an ISO-3166 two digit code" unless country_code.length == 2
+        @country_code = country_code
+      end
+
+      # Note: DHL rejects valid email addresses containing the + sign
+      def email=(email)
+        split = email.split('@')
+        local_part = split[0]
+        if local_part.include?('+')
+          local_part = local_part.split('+')[0]
+        end
+
+        @email = "#{local_part}@#{split[1]}"
+      end
+
+      def append_to_xml(xml)
+        xml.Company do |xml|
+          if company?
+            xml.cis(:Company) do |xml|
+              xml.cis(:name1, company)
+              if !street_additional.blank?
+                xml.cis(:name2, street_additional)
+              end
+            end
+          else
+            xml.cis(:Person) do |xml|
+              xml.cis(:salutation, salutation)
+              xml.cis(:firstname, firstname)
+              xml.cis(:lastname, lastname)
+            end
+          end
+        end
+        xml.Address do |xml|
+          xml.cis(:streetName, street)
+          xml.cis(:streetNumber, house_number)
+          xml.cis(:careOfName, street_additional) unless street_additional.nil?
+          xml.cis(:Zip) do |xml|
+            if country_code == 'DE'
+              xml.cis(:germany, zip)
+            elsif ['GB','UK'].include?(country_code)
+              xml.cis(:england, zip)
+            else
+              xml.cis(:other, zip)
+            end
+          end
+          xml.cis(:city, city)
+          xml.cis(:Origin) do |xml|
+            xml.cis(:countryISOCode, country_code)
+          end
+        end
+        xml.Communication do |xml|
+          xml.cis(:email, self.email)
+          xml.cis(:contactPerson, "#{firstname} #{lastname}")
+        end
+      end
+    end
+  end
+end

data/lib/dhl-intraship/api.rb

@@ -0,0 +1,104 @@
+require 'savon'
+
+module Dhl
+  module Intraship
+    class API
+
+      DEFAULT_NAMESPACES = {
+          "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+          "xmlns:de" => "http://de.ws.intraship",
+          "xmlns:is" => "http://dhl.de/webservice/is_base_de",
+          "xmlns:cis" => "http://dhl.de/webservice/cisbase"}
+
+      INTRASHIP_WSDL = ""
+      INTRASHIP_ENDPOINT = ""
+      INTRASHIP_TEST_WSDL = "http://test-intraship.dhl.com/ws/1_0/ISService/DE.wsdl"
+      INTRASHIP_TEST_ENDPOINT = "http://test-intraship.dhl.com/ws/1_0/de/ISService"
+
+       def initialize(config, options = {})
+         raise "User must be specified" if config[:user].nil?
+         raise "Signature (password) must be specified" if config[:signature].nil?
+         raise "EKP (first part of the DHL account number) must be specified" if config[:ekp].nil?
+
+         if options[:test]
+            wsdl_url = INTRASHIP_TEST_WSDL
+            endpoint = INTRASHIP_TEST_ENDPOINT
+         else
+            wsdl_url = INTRASHIP_WSDL
+            endpoint = INTRASHIP_ENDPOINT
+         end
+
+         @user = config[:user]
+         @signature = config[:signature]
+         @ekp = config[:ekp]
+         @procedure_id = config[:procedure_id] || '01'
+         @partner_id = config[:partner_id] || '01'
+
+         @options = options
+         @client = ::Savon::Client.new do
+           wsdl.document = wsdl_url
+           wsdl.endpoint = endpoint
+         end
+       end
+
+      def createShipmentDD(shipments)
+        begin
+          # For some reason the class instance variables are not accessible inside of the request block
+          user = @user
+          signature = @signature
+          ekp = @ekp
+          procedure_id = @procedure_id
+          partner_id = @partner_id
+
+          returnXML = @config && @config[:label_response_type] && @config[:label_response_type] == :xml;
+          result = @client.request "de:CreateShipmentDDRequest" do
+            soap.xml do |xml|
+              xml.soapenv(:Envelope, DEFAULT_NAMESPACES) do |xml|
+                xml.soapenv(:Header) do |xml|
+                  xml.cis(:Authentification) do |xml|
+                    xml.cis(:user, user)
+                    xml.cis(:signature, signature)
+                    xml.cis(:accountNumber, "#{ekp}|#{procedure_id}|#{partner_id}")
+                    xml.cis(:type, '0')
+                  end
+                end
+                xml.soapenv(:Body) do |xml|
+                  xml.de(:"CreateShipmentDDRequest") do |xml|
+                    xml.cis(:Version) do |xml|
+                      xml.cis(:majorRelease, '1')
+                      xml.cis(:minorRelease, '0')
+                    end
+                    xml.ShipmentOrder do |xml|
+                      xml.SequenceNumber('1')
+                      shipments.each do |shipment|
+                        shipment.append_to_xml(ekp, partner_id, xml)
+                        xml.LabelResponseType('XML') if returnXML
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+          r = result.to_hash[:create_shipment_response]
+          if r[:status][:status_code] == '0'
+            shipment_number = r[:creation_state][:shipment_number][:shipment_number]
+
+            if returnXML
+              xml_label = r[:creation_state][:xmllabel]
+              {shipment_number: shipment_number, xml_label: xml_label}
+            else
+              label_url = r[:creation_state][:labelurl]
+              {shipment_number: shipment_number, label_url: label_url}
+            end
+
+          else
+            raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]}"
+          end
+        rescue Savon::Error => error
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/dhl-intraship/product_code.rb

@@ -0,0 +1,18 @@
+module Dhl
+  module Intraship
+    class ProductCode
+      # Day definite product codes
+      DHL_PACKAGE = 'EPN'
+      WORLD_PACKAGE = 'BPI'
+      DHL_EURO_PACKAGE = 'EPI'
+      DHL_EURO_PLUS = 'EUP'
+
+      # Time definite product codes
+      DOMESTIC_EXPRESS = 'DXM'
+      STARTDAY_EXPRESS = 'TDK'
+      DHL_EXPRESS_WORLDWIDE = 'WPX'
+
+      VALID_PRODUCT_CODES = [DHL_PACKAGE, WORLD_PACKAGE, DHL_EURO_PACKAGE, DHL_EURO_PLUS, DOMESTIC_EXPRESS, STARTDAY_EXPRESS, DHL_EXPRESS_WORLDWIDE]
+    end
+  end
+end

data/lib/dhl-intraship/shipment.rb

@@ -0,0 +1,57 @@
+require "dhl-intraship/product_code"
+
+module Dhl
+  module Intraship
+    class Shipment
+      PACKAGE_TYPE = 'PK'
+
+      attr_accessor :sender_address, :receiver_address, :shipment_date, :weight, :length, :height, :width, :product_code
+
+      def initialize(attributes = {})
+        self.product_code = ProductCode::DHL_PACKAGE
+        attributes.each do |key, value|
+          setter = :"#{key.to_s}="
+          if self.respond_to?(setter)
+            self.send(setter, value)
+          end
+        end
+      end
+
+      def product_code=(product_code)
+        raise "No valid product code #{product_code}" unless ProductCode::VALID_PRODUCT_CODES.include?(product_code)
+        @product_code = product_code
+      end
+
+      def append_to_xml(ekp, partner_id, xml)
+        raise "Shipment date must be set!" if shipment_date.nil?
+        raise "Sender address must be set!" if sender_address.nil?
+        raise "Receiver address must be set!" if sender_address.nil?
+        xml.Shipment do |xml|
+          xml.ShipmentDetails do |xml|
+            xml.ProductCode(product_code)
+            xml.ShipmentDate(shipment_date.strftime("%Y-%m-%d"))
+            xml.cis(:EKP, ekp)
+            xml.Attendance do |xml|
+              xml.cis(:partnerID, partner_id)
+            end
+            xml.ShipmentItem do |xml|
+              xml.WeightInKG(weight)
+              xml.LengthInCM(length) unless length.nil?
+              xml.WidthInCM(width) unless width.nil?
+              xml.HeightInCM(height) unless height.nil?
+              xml.PackageType(PACKAGE_TYPE)
+            end
+          end
+          # Shipper information
+          xml.Shipper do |xml|
+            sender_address.append_to_xml(xml)
+          end
+          # Receiver information
+          xml.Receiver do |xml|
+            receiver_address.append_to_xml(xml)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhl-intraship/version.rb

@@ -0,0 +1,5 @@
+module Dhl
+  module Intraship
+    VERSION = "0.0.7"
+  end
+end

data/spec/dhl-intraship/address_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Dhl
+  module Intraship
+
+    describe Address do
+      before{@address = Address.new}
+
+      it "should remove the part after a + from the email address" do
+        @address.email = "test+part@teameurope.net"
+        @address.email.should == "test@teameurope.net"
+      end
+
+    end
+  end
+end

data/spec/dhl-intraship/create_shipment_dd_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Dhl
+  module Intraship
+
+    TEST_RESPONSE = <<EOS
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body>
+    <ns2:CreateShipmentResponse xmlns:ns2="http://de.ws.intraship">
+      <Version xmlns="http://dhl.de/webservice/cisbase">
+        <majorRelease>1</majorRelease>
+        <minorRelease>0</minorRelease>
+        <build>11</build>
+      </Version>
+      <status>
+        <StatusCode>0</StatusCode>
+        <StatusMessage>ok</StatusMessage>
+      </status>
+      <CreationState>
+        <StatusCode>0</StatusCode>
+        <StatusMessage>ok</StatusMessage>
+        <SequenceNumber>1</SequenceNumber>
+        <ShipmentNumber>
+          <ns1:shipmentNumber xmlns:ns1="http://dhl.de/webservice/cisbase">00340433836000191469</ns1:shipmentNumber>
+        </ShipmentNumber>
+        <PieceInformation>
+          <PieceNumber>
+            <ns1:licensePlate xmlns:ns1="http://dhl.de/webservice/cisbase">00340433836000191469</ns1:licensePlate>
+          </PieceNumber>
+        </PieceInformation>
+        <Labelurl>http://test-intraship.dhl.com:80/cartridge.55/WSPrint?code=2DF3501616A182E9328C91C83B00509C4A611A39324EAA66</Labelurl>
+      </CreationState>
+    </ns2:CreateShipmentResponse>
+  </soapenv:Body>
+</soapenv:Envelope>
+EOS
+
+    describe API do
+      before(:each) do
+        config = {user: 'user', signature: 'signature', ekp: 'ekp12345'}
+        options = {test: true}
+        @api = API.new(config, options)
+      end
+
+      it "should create an API call" do
+        savon.expects("de:CreateShipmentDDRequest" ).returns( code: 200, headers: {},body: TEST_RESPONSE )
+
+        shipment = Shipment.new(shipment_date: Date.today + 1)
+
+        sender = Address.new
+        receiver = Address.new
+        shipment.receiver_address=receiver
+        shipment.sender_address=sender
+
+        @api.createShipmentDD([shipment]).should_not be_nil
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'savon/spec'
+require 'dhl-intraship/api'
+require 'dhl-intraship/shipment'
+require 'dhl-intraship/address'
+
+RSpec.configure do |config|
+  config.include Savon::Spec::Macros
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dhl-intraship
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Kops
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: savon_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: A simple gem to access the DHL Intraship API
+email:
+- a.kops@teameurope.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dhl-intraship.gemspec
+- lib/dhl-intraship.rb
+- lib/dhl-intraship/address.rb
+- lib/dhl-intraship/api.rb
+- lib/dhl-intraship/product_code.rb
+- lib/dhl-intraship/shipment.rb
+- lib/dhl-intraship/version.rb
+- spec/dhl-intraship/address_spec.rb
+- spec/dhl-intraship/create_shipment_dd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/teameurope/dhl-intraship
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This wraps the DHL Intraship SOAP Interface for creating shipments
+test_files:
+- spec/dhl-intraship/address_spec.rb
+- spec/dhl-intraship/create_shipment_dd_spec.rb
+- spec/spec_helper.rb