dhl-bcs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0edf9d48f49c8c00bd677e058a1b9a81728dbbf1
+  data.tar.gz: ae7cd220247f3b37aae0604d30ce3bb01acdbd16
+SHA512:
+  metadata.gz: 726e19231bda1db3dc47835ac20c9d95bc68f3fac5a29140fdc456f741c76ee767a156b8dde6b705f25510f534159f1fb2bf16d04435962c372ae73b1c48c3b7
+  data.tar.gz: d358004816955f652956f13756b46fca01dd73e4217dd38f1362f9e04e6b825f2fd04839a6bf90e23071cd7b0c04532a7d1904832b539d8706946de0c979b289

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/TAGS
+/tags
+/.tags*
+/.idea
+.directory

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at wagner@webit.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christoph Wagner
+
+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,217 @@
+# Dhl::Bcs
+
+This is a client for the DHL Business Customer Shipping (BCS) API version 2.0.
+It is inspired by the [DHL intraship gem](https://github.com/waldher/dhl-intraship) which implements API version 1.0 which is expired.
+The Dhl::Bcs gem uses [Savon 2](https://github.com/savonrb/savon) to communicate via SOAP with the DHL API.
+The DHL BCS API is just for standard parcels. If you are looking for shipping of express parcels this gem is not for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dhl-bcs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dhl-bcs
+
+## Usage
+
+Initialize a new API client using
+
+```ruby
+client = Dhl::Bcs.client(config, options)
+```
+
+Config is the following hash:
+
+```ruby
+config = {
+  api_user: 'The user for API BasicAuth', #mandatory
+  api_pwd: 'The password for API BasicAuth', #mandatory
+  user: 'your BCS user name', #mandatory
+  signature: 'Your BCS user password', #mandatory
+  ekp: 'Your DHL EKP (first part of your DHL Account number)', #mandatory
+  participation_number: 'Your DHL EKP (last two characters of your DHL Account number)' #mandatory
+}
+```
+
+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 DHL test system (defaults to false)
+ log: false # If log is set, you get all logging (with request and response XML) to your standard logger. (defaults to true)
+}
+```
+
+### Create shipments
+
+To create a shipment at DHL you need a sender_address, a receiver_address, and informations about the parcel.
+
+```ruby
+shipment = Dhl::Bcs.build_shipment(
+  shipper: {
+    name: 'Christoph Wagner',
+    company: 'webit! Gesellschaft für neue Medien mbH',
+    street_name: 'Schandauer Straße',
+    street_number: '34',
+    zip: '01309',
+    city: 'Dresden',
+    country_code: 'DE',
+    email: 'wagner@webit.de'
+  },
+  receiver: {
+    name: 'Jane Doe',
+    street_name: 'Willy-Brandt-Straße',
+    street_number: '1',
+    zip: '10557',
+    city: 'Berlin',
+    country_code: 'DE',
+    email: 'jane.doe@example.com'
+  },
+  weight: 3.5,
+  length: 10,
+  width: 20,
+  height: 30,
+  shipment_date: Date.new(2016, 7, 13)
+)
+
+client.create_shipment_order(shipment)
+```
+
+You will get a result that looks like this:
+
+```ruby
+[
+  {
+    status: { status_code: '0', status_text: 'ok', status_message: 'Der Webservice wurde ohne Fehler ausgeführt.' },
+    shipment_number: '22222222201019582121',
+    label_url: 'https://cig.dhl.de/gkvlabel/SANDBOX/dhl-vls/gw/shpmntws/printShipment?token=JD7HKktuvugIFEkhSvCfbEz4J8Ah0dkcVuw4PzBGRyRnW%2FwEPAwfytLtb31e7gMDsSX32%2BEB5exp8nNPs%2FhJSQ%3D%3D',
+  }
+]
+```
+
+This is an Array of Hashes, cause it is possible to send up to 30 parcels at the same time, with the API.
+Say you want to send 3 parcels to the same address you can also do something like that:
+
+```ruby
+shipper = Dhl::Bcs.build_shipper(
+  name: 'Christoph Wagner',
+  company: 'webit! Gesellschaft für neue Medien mbH',
+  street_name: 'Schandauer Straße',
+  street_number: '34',
+  zip: '01309',
+  city: 'Dresden',
+  country_code: 'DE',
+  email: 'wagner@webit.de'
+)
+
+receiver = Dhl::Bcs.build_receiver(
+  name: 'Jane Doe',
+  street_name: 'Willy-Brandt-Straße',
+  street_number: '1',
+  zip: '10557',
+  city: 'Berlin',
+  country_code: 'DE',
+  email: 'jane.doe@example.com'
+)
+
+shipment1 = Dhl::Bcs.build_shipment(shipper: shipper, receiver: receiver, weight: 3)
+shipment2 = Dhl::Bcs.build_shipment(shipper: shipper, receiver: receiver, weight: 3.5)
+shipment3 = Dhl::Bcs.build_shipment(shipper: shipper, receiver: receiver, weight: 4)
+
+client.create_shipment_order(shipment1, shipment2, shipment3)
+```
+
+### Validate shipments
+
+```ruby
+client.validate_shipment(shipment1, shipment2, shipment3)
+```
+
+### Update shipment
+
+You can update a shipment at DHL. It is the same like deleting it and creating a new one just with one request.
+So you will get a new shipping number for it and so on.
+To update a shipment you need the shipment number of the old one and give a complete new shipment that is created instead.
+This works for one shipment at a time.
+```ruby
+client.update_shipment_order('22222222901010000944', shipment)
+```
+
+### Other methods
+
+The methods `delete_shipment_order`, `get_label`, `get_export_doc` and `do_manifest` works technically the same.
+They took one or many (up to 30) shipment numbers and do something with these shipments at DHL.
+
+To delete a shipment you can use:
+```ruby
+client.delete_shipment_order('22222222901010000944')
+```
+
+As result you will get one Hash like:
+```ruby
+{
+  '22222222901010000944' => {
+    status: { status_code: '0', status_text: 'ok', status_message: nil }
+  }
+}
+```    
+
+### Services
+
+There is a basic support to add Services to a shipment in this gem.
+
+```ruby
+shipment.services << Dhl::Bcs.build_service(name: 'IndividualSenderRequirement', attributes: { active: '1', details: 'Test' })
+```
+
+A service has a name and attributes.
+Sometimes a service has children, for example the 'IdentCheck'-Service.
+
+```ruby
+shipment.services << Dhl::Bcs.build_service(name: 'IdentCheck', attributes: { active: '1' }, children: { 'Ident' => { surname: 'Doe', given_name: 'Jon Doe', date_of_birth: '1980-12-24', minimum_age: '18' } })
+```
+
+Check out the DHL developer documentation to configure the services you need.
+
+### Get API version
+
+```ruby
+client.get_version
+```
+You don't need a shipment for that.
+
+### Logging
+
+If you need the last made request and its response from the client you can use:
+```ruby
+client.last_log
+```
+This works even if you used the option `log: false` at the client. This option controlls just the output in the log file or console.
+
+### Everything else
+Have a deeper look at the code of this gem and find out how things work.
+You can help to implement missing things or extend this documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webit-de/dhl-bcs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dhl/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dhl-bcs.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/bcs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dhl-bcs"
+  spec.version       = Dhl::Bcs::VERSION
+  spec.authors       = ["Christoph Wagner"]
+  spec.email         = ["wagner@webit.de"]
+
+  spec.summary       = %q{Client for DHL Business-Customer-Shipping SOAP API 2.0}
+  spec.description   = %q{This is inspired by the dhl-intraship gem that is a little bit outdated and doesn't support the new DHL API. If you need DHL Express Services this is not for you.}
+  spec.homepage      = "https://github.com/webit-de/dhl-bcs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "savon", "~> 2.11"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+end

data/lib/dhl/bcs.rb

@@ -0,0 +1,41 @@
+require 'dhl/bcs/version'
+require 'dhl/bcs/errors'
+require 'dhl/bcs/v2/client'
+require 'dhl/bcs/v2/buildable'
+require 'dhl/bcs/v2/shipment'
+require 'dhl/bcs/v2/shipper'
+require 'dhl/bcs/v2/receiver'
+require 'dhl/bcs/v2/communication'
+require 'dhl/bcs/v2/location'
+require 'dhl/bcs/v2/address'
+require 'dhl/bcs/v2/packstation'
+require 'dhl/bcs/v2/parcel_shop'
+require 'dhl/bcs/v2/postfiliale'
+require 'dhl/bcs/v2/bank_data'
+require 'dhl/bcs/v2/service'
+
+module Dhl
+  module Bcs
+
+    def self.client(config, options = {})
+      V2::Client.new(config, options)
+    end
+
+    def self.build_shipment(*args)
+      V2::Shipment.build(*args)
+    end
+
+    def self.build_shipper(*args)
+      V2::Shipper.build(*args)
+    end
+
+    def self.build_receiver(*args)
+      V2::Receiver.build(*args)
+    end
+
+    def self.build_service(*args)
+      V2::Service.new(*args)
+    end
+
+  end
+end

data/lib/dhl/bcs/errors.rb

@@ -0,0 +1,8 @@
+module Dhl
+  module Bcs
+    class Error < StandardError; end
+
+    class RequestError < StandardError; end
+
+  end
+end

data/lib/dhl/bcs/v2/address.rb

@@ -0,0 +1,20 @@
+module Dhl::Bcs::V2
+  class Address < Location
+
+    ADD_PROPS = %i(company company_addition street_name street_number address_addition dispatching_information).freeze
+    PROPERTIES = Location::PROPERTIES + ADD_PROPS
+    attr_accessor(*ADD_PROPS)
+
+    def to_soap_hash
+      h = {}
+      h['cis:name2'] = company if company
+      h['cis:name3'] = company_addition if company_addition
+      h['cis:streetName'] = street_name
+      h['cis:streetNumber'] = street_number
+      h['cis:addressAddition'] = address_addition if address_addition
+      h['cis:dispatchingInformation'] = dispatching_information if dispatching_information
+      h.merge(super)
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/bank_data.rb

@@ -0,0 +1,23 @@
+module Dhl::Bcs::V2
+  class BankData
+
+    include Buildable
+
+    PROPERTIES = %i(account_owner bank_name iban note1 note2 bic accountreference).freeze
+    attr_accessor(*PROPERTIES)
+
+    def to_soap_hash
+      {
+        'cis:accountOwner' => account_owner,
+        'cis:bank_name' => bank_name,
+        'cis:iban' => iban
+      }.tap do |h|
+        h['cis:note1'] = note1 if note1
+        h['cis:note2'] = note2 if note2
+        h['cis:bic'] = bic if bic
+        h['cis:accountreference'] = accountreference if accountreference
+      end
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/buildable.rb

@@ -0,0 +1,47 @@
+module Dhl::Bcs::V2
+  module Buildable
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def build(attributes)
+        attrib = attributes[underscore(name.split('::').last).to_sym]
+        if attrib.is_a?(self)
+          attrib
+        elsif attrib.nil?
+          klass_attributes = {}
+          self::PROPERTIES.each do |prop|
+            value = attributes.delete(prop)
+            klass_attributes[prop] = value if value
+          end
+          new(klass_attributes)
+        elsif attrib.is_a?(Hash)
+          new(attrib)
+        end
+      end
+
+      private
+
+      # borrowed from rails without acronyms
+      def underscore(camel_cased_word)
+        return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+        word = camel_cased_word.to_s.gsub('::'.freeze, '/'.freeze)
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
+        word.tr!('-'.freeze, '_'.freeze)
+        word.downcase!
+        word
+      end
+
+    end
+
+    def initialize(**attributes)
+      attributes.each do |property, value|
+        send("#{property}=", value) if self.class::PROPERTIES.include?(property)
+      end
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/client.rb

@@ -0,0 +1,139 @@
+require 'savon'
+require 'stringio'
+require 'logger'
+
+module Dhl::Bcs::V2
+  class Client
+
+    WSDL = 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/geschaeftskundenversand-api/2.0/geschaeftskundenversand-api-2.0.wsdl'
+
+    def initialize(config, log: true, test: false, **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?
+      raise "Participation Number (last two characters of account number) must be specified" if config[:participation_number].nil?
+      raise "Api User must be specified" if config[:api_user].nil?
+      raise "Api Password must be specified" if config[:api_pwd].nil?
+
+      @ekp = config[:ekp]
+      @participation_number = config[:participation_number]
+
+      @logIO = StringIO.new
+      @logger = Logger.new($stdout) if log
+
+      @client = Savon.client({
+        endpoint: (test ? 'https://cig.dhl.de/services/sandbox/soap' : 'https://cig.dhl.de/services/production/soap'),
+        wsdl: WSDL,
+        basic_auth: [config[:api_user], config[:api_pwd]],
+        logger: Logger.new(@logIO),
+        log: true,
+        soap_header: {
+          'cis:Authentification' => {
+            'cis:user' => config[:user],
+            'cis:signature' => config[:signature],
+            'cis:type' => 0
+          }
+        },
+        namespaces: { 'xmlns:cis' => 'http://dhl.de/webservice/cisbase' }
+      })
+    end
+
+    def get_version(major: 2, minor: 0, build: nil)
+      request(:get_version,
+        'bcs:Version' => {
+          'majorRelease' => major,
+          'minorRelease' => minor
+        }.tap { |h| h['build'] = build if build }
+      ) do |response|
+        response.body[:get_version_response][:version]
+      end
+    end
+
+    def validate_shipment(*shipments, **options)
+      request(:validate_shipment, build_shipment_orders(shipments, options)) do |response|
+        [response.body[:validate_shipment_response][:validation_state]].flatten.map do |validation_state|
+          validation_state[:status]
+        end
+      end
+    end
+
+    def create_shipment_order(*shipments, **options)
+      request(:create_shipment_order, build_shipment_orders(shipments, options)) do |response|
+        [response.body[:create_shipment_order_response][:creation_state]].flatten.map do |creation_state|
+          creation_state[:label_data]
+        end
+      end
+    end
+
+    def update_shipment_order(shipment_number, shipment, **options)
+      request(:update_shipment_order, { 'cis:shipmentNumber' => shipment_number }.merge(build_shipment_orders([shipment], options))) do |response|
+        clean_response_data(response.body[:update_shipment_order_response][:label_data])
+      end
+    end
+
+    {
+      delete_shipment_order: :deletion_state,
+      get_label: :label_data,
+      get_export_doc: :export_doc_data,
+      do_manifest: :manifest_state
+    }.each do |api_method, response_key|
+      define_method api_method do |*shipment_numbers|
+        raise Dhl::Bcs::DataError, 'No more than 30 shipment_numbers allowed per request!' if shipment_numbers.size > 30
+        request(api_method, 'cis:shipmentNumber' => shipment_numbers) do |response|
+          h = {}
+          [response.body[:"#{api_method}_response"][response_key]].flatten.each do |data|
+            h[data.delete(:shipment_number)] = clean_response_data(data)
+          end
+          h
+        end
+      end
+    end
+
+    # returns base64 encoded PDF Dokument
+    def get_manifest(date)
+      request(:get_manifest, 'manifestDate' => date) do |response|
+        response.body[:get_manifest_response][:manifest_data]
+      end
+    end
+
+    def last_log
+      @logIO.string
+    end
+
+    protected
+
+    def build_shipment_orders(shipments, label_response_type: 'URL')
+      raise Dhl::Bcs::DataError, 'No more than 30 shipments allowed per request!' if shipments.size > 30
+      {
+        'ShipmentOrder' =>
+          shipments.map.with_index(1) do |shipment, index|
+            {
+              'sequenceNumber' => format('%02i', index.to_s),
+              'Shipment' => shipment.to_soap_hash(@ekp, @participation_number),
+              'LabelResponseType' => label_response_type.to_s.upcase
+            }
+          end
+      }
+    end
+
+    def request(action, message = {})
+      @logIO.string = ''
+      response = @client.call(action, message: {
+        'bcs:Version' => {
+          'majorRelease' => 2,
+          'minorRelease' => 0
+        }
+      }.merge(message))
+      @logger << @logIO.string if @logger
+      yield response
+    rescue
+      raise Dhl::Bcs::RequestError, @logIO.string
+    end
+
+    def clean_response_data(data)
+      data.delete(:@xmlns)
+      data
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/communication.rb

@@ -0,0 +1,18 @@
+module Dhl::Bcs::V2
+  class Communication
+
+    include Buildable
+
+    PROPERTIES = %i(phone email contact_person).freeze
+    attr_accessor(*PROPERTIES)
+
+    def to_soap_hash
+      {}.tap do |h|
+        h['cis:phone'] = phone if phone
+        h['cis:email'] = email if email
+        h['cis:contactPerson'] = contact_person if contact_person
+      end
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/location.rb

@@ -0,0 +1,24 @@
+module Dhl::Bcs::V2
+  # a location is one of Address, Packstation, Postfiliale or ParcelShop
+  # they have some properties in common
+  class Location
+
+    include Buildable
+
+    PROPERTIES = %i(zip city country country_code state).freeze
+    attr_accessor(*PROPERTIES)
+
+    def to_soap_hash
+      {
+        'cis:zip' => zip,
+        'cis:city' => city,
+        'cis:Origin' => {}.tap { |h|
+          h['cis:country'] = country if country
+          h['cis:countryISOCode'] = country_code if country_code
+          h['cis:state'] = state if state
+        }
+      }
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/packstation.rb

@@ -0,0 +1,16 @@
+module Dhl::Bcs::V2
+  class Packstation < Location
+
+    ADD_PROPS = %i(post_number packstation_number).freeze
+    PROPERTIES = Location::PROPERTIES + ADD_PROPS
+    attr_accessor(*ADD_PROPS)
+
+    def to_soap_hash
+      h = {}
+      h['postNumber'] = post_number if post_number
+      h['packstationNumber'] = packstation_number
+      h.merge(super)
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/parcel_shop.rb

@@ -0,0 +1,17 @@
+module Dhl::Bcs::V2
+  class ParcelShop < Location
+
+    ADD_PROPS = %i(parcel_shop_number street_name street_number).freeze
+    PROPERTIES = Location::PROPERTIES + ADD_PROPS
+    attr_accessor(*ADD_PROPS)
+
+    def to_soap_hash
+      h = {}
+      h['parcelShopNumber'] = parcel_shop_number
+      h['cis:streetName'] = street_name if street_name
+      h['cis:streetNumber'] = street_number if street_number
+      h.merge(super)
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/postfiliale.rb

@@ -0,0 +1,16 @@
+module Dhl::Bcs::V2
+  class Postfiliale < Location
+
+    ADD_PROPS = %i(postfilial_number post_number).freeze
+    PROPERTIES = Location::PROPERTIES + ADD_PROPS
+    attr_accessor(*ADD_PROPS)
+
+    def to_soap_hash
+      h = {}
+      h['postfilialNumber'] = postfilial_number
+      h['postNumber'] = post_number
+      h.merge(super)
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/receiver.rb

@@ -0,0 +1,39 @@
+module Dhl::Bcs::V2
+  class Receiver
+
+    # a location is one of Address, Packstation, Postfiliale or ParcelShop
+    PROPERTIES = %i(name communication location).freeze
+
+    attr_accessor(*PROPERTIES)
+
+    def self.build(name: nil, **attributes)
+      communication = Communication.build(attributes)
+      location =
+        if attributes.key?(:packstation_number)
+          Packstation
+        elsif attributes.key?(:postfilial_number)
+          Postfiliale
+        elsif attributes.key?(:parcel_shop_number)
+          ParcelShop
+        else
+          Address
+        end.build(attributes)
+      new(attributes.merge(name: name, communication: communication, location: location))
+    end
+
+    def initialize(**attributes)
+      attributes.each do |property, value|
+        send("#{property}=", value) if PROPERTIES.include?(property)
+      end
+    end
+
+    def to_soap_hash
+      {
+        'cis:name1' => name,
+        'Communication' => communication.to_soap_hash,
+        location.class.name.split('::').last => location.to_soap_hash
+      }
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/service.rb

@@ -0,0 +1,16 @@
+module Dhl::Bcs::V2
+  class Service
+
+    include Buildable
+
+    PROPERTIES = %i(name attributes children).freeze
+    attr_accessor(*PROPERTIES)
+
+    def to_soap_hash
+      # make a self closing tag by appending "/" if no children
+      tag_name = children ? name : "#{name}/"
+      { tag_name => children, attributes!: { tag_name => attributes } }
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/shipment.rb

@@ -0,0 +1,83 @@
+module Dhl::Bcs::V2
+  class Shipment
+
+    attr_accessor :shipper, :receiver, :bank_data, :shipment_date, :product,
+                  :customer_reference, :services, :weight, :length, :height, :width,
+                  :notification_email
+
+    PRODUCT_PROCEDURE_NUMBERS = {
+      'V01PAK' => '01', # Paket National
+      'V53WPAK' => '53', # Weltpaket
+      'V54EPAK' => '54', # Europaket
+      'V06TG' => '01', # Kurier Taggleich
+      'V06WZ' => '01', # Kurier Wunschzeit
+      'V86PARCEL' => '86', # DHL Paket Austria
+      'V87PARCEL' => '87', # DHL PAKET Connect
+      'V82PARCEL' => '82' # DHL PAKET International
+    }.freeze
+    PRODUCTS = PRODUCT_PROCEDURE_NUMBERS.keys.freeze
+
+    # build a shipment from hash data
+    def self.build(shipper:, receiver:, bank_data: nil, **shipment_attributes)
+      shipper = Shipper.build(shipper) if shipper.is_a?(Hash)
+      receiver = Receiver.build(receiver) if receiver.is_a?(Hash)
+      bank_data = BankData.build(bank_data) if bank_data.is_a?(Hash)
+      new({ shipper: shipper, receiver: receiver, bank_data: bank_data }.merge(shipment_attributes))
+    end
+
+    def initialize(attributes = {})
+      assign_attributes(
+        {
+          product: 'V01PAK',
+          shipment_date: Date.today,
+          services: []
+        }.merge(attributes)
+      )
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |key, value|
+        setter = :"#{key}="
+        send(setter, value) if respond_to?(setter)
+      end
+    end
+
+    def product=(product)
+      raise Error, "No valid product code #{product}. Please use one of these: #{PRODUCTS.join(', ')}" unless PRODUCTS.include?(product)
+      @product = product
+    end
+
+    def to_soap_hash(ekp, participation_number)
+      raise Error, 'Packing weight in kilo must be set!' unless weight
+      raise Error, 'Sender address must be set!' unless shipper
+      raise Error, 'Receiver address must be set!' unless receiver
+      raise Error, 'Product must be set!' unless product
+
+      account_number = "#{ekp}#{PRODUCT_PROCEDURE_NUMBERS[product]}#{participation_number}"
+      raise Error, 'Need a 14 character long account number. Check EKP and participation_number' if account_number.size != 14
+      {
+        'ShipmentDetails' => {}.tap { |h|
+          h['product'] = product
+          h['shipmentDate'] = shipment_date.strftime("%Y-%m-%d")
+          h['cis:accountNumber'] = account_number
+          h['customerReference'] = customer_reference if !customer_reference.blank?
+
+          # just one ShipmentItem possible
+          h['ShipmentItem'] = { 'weightInKG' => weight }.tap { |si|
+            si['lengthInCM'] = length if length
+            si['widthInCM'] = width if width
+            si['heightInCM'] = height if height
+          }
+          h['Service'] = services.map(&:to_soap_hash) unless services.empty?
+          h['Notification'] = { 'recipientEmailAddress' => notification_email } if notification_email
+          h['BankData'] = bank_data.to_soap_hash if bank_data
+        },
+        # Shipper information
+        'Shipper' => shipper.to_soap_hash,
+        # Receiver information
+        'Receiver' => receiver.to_soap_hash
+      }
+    end
+
+  end
+end

data/lib/dhl/bcs/v2/shipper.rb

@@ -0,0 +1,32 @@
+module Dhl::Bcs::V2
+  class Shipper
+
+    PROPERTIES = %i(name company company_addition address communication).freeze
+
+    attr_accessor(*PROPERTIES)
+
+    def self.build(company: nil, **attributes)
+      address = Address.build(attributes)
+      communication = Communication.build(attributes)
+      new(attributes.merge(address: address, communication: communication, company: company))
+    end
+
+    def initialize(**attributes)
+      attributes.each do |property, value|
+        send("#{property}=", value) if PROPERTIES.include?(property)
+      end
+    end
+
+    def to_soap_hash
+      {
+        'Name' => { 'cis:name1' => name }.tap { |h|
+          h['cis:name2'] = company if company
+          h['cis:name3'] = company_addition if company_addition
+        },
+        'Address' => address.to_soap_hash,
+        'Communication' => communication.to_soap_hash
+      }
+    end
+
+  end
+end

data/lib/dhl/bcs/version.rb

@@ -0,0 +1,5 @@
+module Dhl
+  module Bcs
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dhl-bcs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Wagner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: This is inspired by the dhl-intraship gem that is a little bit outdated
+  and doesn't support the new DHL API. If you need DHL Express Services this is not
+  for you.
+email:
+- wagner@webit.de
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dhl-bcs.gemspec
+- lib/dhl/bcs.rb
+- lib/dhl/bcs/errors.rb
+- lib/dhl/bcs/v2/address.rb
+- lib/dhl/bcs/v2/bank_data.rb
+- lib/dhl/bcs/v2/buildable.rb
+- lib/dhl/bcs/v2/client.rb
+- lib/dhl/bcs/v2/communication.rb
+- lib/dhl/bcs/v2/location.rb
+- lib/dhl/bcs/v2/packstation.rb
+- lib/dhl/bcs/v2/parcel_shop.rb
+- lib/dhl/bcs/v2/postfiliale.rb
+- lib/dhl/bcs/v2/receiver.rb
+- lib/dhl/bcs/v2/service.rb
+- lib/dhl/bcs/v2/shipment.rb
+- lib/dhl/bcs/v2/shipper.rb
+- lib/dhl/bcs/version.rb
+homepage: https://github.com/webit-de/dhl-bcs
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Client for DHL Business-Customer-Shipping SOAP API 2.0
+test_files: []