dhl-bcs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 266d8258d3a8678be51463d1148afd001473943e
-  data.tar.gz: a9feb88be17f8acf306b66363fc869aae592f919
+SHA256:
+  metadata.gz: '08009611f405006ad59d2fac8990162898692cab2f7e02f4f7840327b64204fe'
+  data.tar.gz: 31e0b88042b710331d0b96a177ef42977c656b165d319ccf309cc87b81ed69eb
 SHA512:
-  metadata.gz: c5863fa920acf37223595ef5c16b5f779e2b2505f91abc9c6895d1abc895a020c85d18ac8023ab76a853ed11402bd3d65c1b0d82320bc9cdcfbabde5e7fe8f6f
-  data.tar.gz: 314a2e6fe4ecebbb1a47f933ac82af1d8b102bb82852906f9de2ea06be728e3e67a38d5f02253896fbbc18de489e299542d3dadc6eb577a160772848d04248f1
+  metadata.gz: 349f7a9c8cc4675ad17b9703eaf09894982ba97882f5159081f6b6184570226ee2a491720c4bc716d1fd600f2389d17a971e72c7041dc1d30ef0e85d31f390ae
+  data.tar.gz: c4060bd137c262e0ab29fff8eb45e93a93ba843fd1bd7ceccbd12b27231c226f53c81621e1c6c33fac8be1d88c7982bd20f2b06b54dce9912721a9ba3b14efa0

data/README.md

@@ -148,6 +148,59 @@ shipment3 = Dhl::Bcs.build_shipment(shipper: shipper, receiver: receiver, weight
 
 client.create_shipment_order(shipment1, shipment2, shipment3)
 ```
+### International Shipments
+
+In order to send parcels outside of the EU, one should provide information about the content of the shipment.   
+Dhl offers cn23 document, which is data for the Customs as this kind of shipment is considered Export of goods.
+As an output one gets, in addition to the label, a url for the document in an A4-format ready to be printed.
+
+The way to implement that is identical of shipper's and receiver's ones.
+
+```ruby
+export_document = {
+  invoice_number = 'ABCDEF...',
+  export_type = 'Document',  #  could be one of these ['RETURN_OF_GOODS','PRESENT','COMMERCIAL_SAMPLE','DOCUMENT','OTHER']
+  export_type_description = 'some desc', # should be set if `export_type` was set to 'OTHER'
+  terms_of_trade = 'DDP', # could be one of these ['DDP','DXV','DDU','DDX']
+  place_of_commital= 'Bern',
+  permit_number = 1232135,
+  attestation_number = 1234345,
+  with_electronic_export_notification = true, # true|false
+  export_doc_positions: [
+    {
+      description: 'content1',
+      country_code_origing: 'CN',
+      customs_tariff_number: '1234567',
+      ammount: 1,
+      net_weight_in_kg: 0.2,
+      customs_value: 25.00
+    },
+    {
+      description: 'content2',
+      country_code_origing: 'DE',
+      customs_tariff_number: '00222011',
+      ammount: 1,
+      net_weight_in_kg: 1.2,
+      customs_value: 112.00
+    }
+  ]
+}
+
+shipment = Dhl::Bcs.build_shipment(export_document: export_document, shipper: shipper, receiver: receiver)
+```
+
+and then one gets a result 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',
+    export_label_url: 'https://cig.dhl.de/gkvlabel/SANDBOX/dhl-vls/gw/shpmntws/printShipment?token=Vfov%2BMinVhMH6nQVfvSCmNUSRNnaQNHKPaiLiWtXsqm%2BENCM6wnStB2C44rl6BEmSxbrPeaTQwBhoHBr802FnuftGVJ9uVM0C0ztLpxNfyc%3D',
+  }
+]
+```
 
 ### Validate shipments
 

data/dhl-bcs.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "savon", "~> 2.11"
+  spec.add_dependency "savon", "~> 2.12"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "minitest", "~> 5.10"
-  spec.add_development_dependency "webmock", "~> 3.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
 end

data/lib/dhl/bcs.rb

@@ -13,6 +13,8 @@ require 'dhl/bcs/v2/parcel_shop'
 require 'dhl/bcs/v2/postfiliale'
 require 'dhl/bcs/v2/bank_data'
 require 'dhl/bcs/v2/service'
+require 'dhl/bcs/v2/locator'
+require 'dhl/bcs/v2/export_document'
 
 module Dhl
   module Bcs

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

@@ -0,0 +1,84 @@
+module Dhl::Bcs::V2
+  class ExportDocument
+    include Buildable
+
+    PROPERTIES = %i(invoice_number export_type export_type_description terms_of_trade place_of_commital additional_fee permit_number attestation_number with_electronic_export_notification export_doc_positions).freeze
+    attr_accessor(*PROPERTIES)
+
+    EXPORT_TYPES = %w(OTHER PRESENT COMMERCIAL_SAMPLE DOCUMENT RETURN_OF_GOODS).freeze
+    TERMS_OF_TRADES = %w(DDP DXV DDU DDX).freeze
+
+    def self.build(export_doc_positions = [], **attributes)
+      array_of_export_doc_positions = []
+      export_doc_positions.each do |export_doc_position|
+        array_of_export_doc_positions << ExportDocPosition.build(export_doc_position) if export_doc_position.is_a?(Hash)
+      end
+      new({ export_doc_positions: array_of_export_doc_positions }.merge(attributes))
+    end
+
+    def initialize(**attributes)
+      attributes.each do |property, value|
+        send("#{property}=", value) if PROPERTIES.include?(property)
+      end
+    end
+
+    def export_type=(export_type)
+      raise Dhl::Bcs::Error, "No Valid export_type #{export_type}, Please use one of these: #{EXPORT_TYPES.join(',')}" unless EXPORT_TYPES.include?(export_type)
+      @export_type = export_type
+    end
+
+    def terms_of_trade=(terms_of_trade)
+      raise Dhl::Bcs::Error, "No Valid terms_of_trade #{terms_of_trade}, Please use one of these: #{TERMS_OF_TRADES.join(',')}" unless TERMS_OF_TRADES.include?(terms_of_trade)
+      @terms_of_trade = terms_of_trade
+    end
+
+    def to_soap_hash
+      raise Dhl::Bcs::Error, "export_doc_position must be set as an array." unless export_doc_positions
+      raise Dhl::Bcs::Error, "export_type_desription must be set, as export_type is set to OTHER." unless !((export_type == 'OTHER') ^ export_type_description)
+      raise Dhl::Bcs::Error, "place_of_commital must be set" unless place_of_commital
+      h = {}
+      h['invoiceNumber'] = invoice_number if invoice_number
+      h['exportType'] = export_type
+      h['exportTypeDescription'] = export_type_description if export_type_description
+      h['termsOfTrade'] = terms_of_trade if terms_of_trade
+      h['placeOfCommital'] = place_of_commital
+      h['additionalFee'] = additional_fee if additional_fee
+      h['permitNumber'] = permit_number if permit_number
+      h['attestationNumber'] = attestation_number if attestation_number
+      h['WithElectronicExportNtfctn/'] = {'@active': 1} if with_electronic_export_notification
+      h['ExportDocPosition'] = self.export_doc_positions.map { |e| e.to_soap_hash }
+      h
+    end
+  end
+
+  class ExportDocPosition
+    PROPERTIES = %i(description country_code_origin customs_tariff_number amount net_weight_in_kg customs_value).freeze
+    attr_accessor(*PROPERTIES)
+
+    include Buildable
+
+    def initialize(**attributes)
+      attributes.each do |property, value|
+        send("#{property}=", value) if PROPERTIES.include?(property)
+      end
+    end
+
+    def to_soap_hash
+      raise Dhl::Bcs::Error, 'export doc position description must be set' unless description
+      raise Dhl::Bcs::Error, 'export doc position country_code_origin must be set'  unless country_code_origin
+      raise Dhl::Bcs::Error, 'export doc position customs_tariff_number must be set' unless customs_tariff_number
+      raise Dhl::Bcs::Error, 'export doc position amount must be set' unless amount
+      raise Dhl::Bcs::Error, 'export doc position net_weight_in_kg must be set' unless net_weight_in_kg
+      raise Dhl::Bcs::Error, 'export doc position customs_value must be set' unless customs_value
+      {
+        'description' => description,
+        'countryCodeOrigin' => country_code_origin,
+        'customsTariffNumber' => customs_tariff_number,
+        'amount' => amount,
+        'netWeightInKG' => net_weight_in_kg,
+        'customsValue' => customs_value
+      }
+    end
+
+  end
+end

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

@@ -0,0 +1,27 @@
+module Dhl::Bcs::V2
+  # finds proper class from attributes and builds object
+  class Locator
+
+    def self.for(attributes = {})
+      location_class = location_class_finder(attributes)
+      location_builder(attributes, location_class: location_class)
+    end
+
+    def self.location_class_finder(attributes)
+      if attributes.key?(:packstation_number)
+        Packstation
+      elsif attributes.key?(:postfilial_number)
+        Postfiliale
+      elsif attributes.key?(:parcel_shop_number)
+        ParcelShop
+      else
+        Address
+      end
+    end
+
+    def self.location_builder(attributes = {}, location_class: Address)
+      location_class.build(attributes)
+    end
+
+  end
+end

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

@@ -8,16 +8,7 @@ module Dhl::Bcs::V2
 
     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)
+      location = Locator.for(attributes)
       new(attributes.merge(name: name, communication: communication, location: location))
     end
 

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

@@ -1,16 +1,20 @@
 module Dhl::Bcs::V2
   class Shipment
 
-    attr_accessor :shipper, :receiver, :bank_data, :shipment_date, :product,
+    attr_accessor :shipper, :receiver, :bank_data, :shipment_date,
                   :customer_reference, :services, :weight, :length, :height, :width,
-                  :notification_email
+                  :notification_email, :export_document
+    attr_reader :product
 
     PRODUCT_PROCEDURE_NUMBERS = {
-      'V01PAK' => '01', # Paket National
-      'V53WPAK' => '53', # Weltpaket
-      'V54EPAK' => '54', # Europaket
-      'V06TG' => '01', # Kurier Taggleich
-      'V06WZ' => '01', # Kurier Wunschzeit
+      'V01PAK' => '01', # DHL Paket
+      'V01PRIO' => '01', # DHL Paket Prio
+      'V06PAK' => '06', # DHL Paket Taggleich
+      'V53WPAK' => '53', # DHL Paket International
+      'V54EPAK' => '54', # DHL Europaket
+      'V55PAK' => '55', # DHL Paket Connect
+      'V06TG' => '01', # DHL Kurier Taggleich
+      'V06WZ' => '01', # DHL Kurier Wunschzeit
       'V86PARCEL' => '86', # DHL Paket Austria
       'V87PARCEL' => '87', # DHL PAKET Connect
       'V82PARCEL' => '82' # DHL PAKET International
@@ -18,11 +22,12 @@ module Dhl::Bcs::V2
     PRODUCTS = PRODUCT_PROCEDURE_NUMBERS.keys.freeze
 
     # build a shipment from hash data
-    def self.build(shipper:, receiver:, bank_data: nil, **shipment_attributes)
+    def self.build(shipper:, receiver:, bank_data: nil, export_document: 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))
+      export_document = ExportDocument.build(export_document.delete(:export_doc_positions),export_document) if export_document.is_a?(Hash)
+      new({ shipper: shipper, receiver: receiver, bank_data: bank_data, export_document: export_document }.merge(shipment_attributes))
     end
 
     def initialize(attributes = {})
@@ -52,6 +57,7 @@ module Dhl::Bcs::V2
       raise Dhl::Bcs::Error, 'Sender address must be set!' unless shipper
       raise Dhl::Bcs::Error, 'Receiver address must be set!' unless receiver
       raise Dhl::Bcs::Error, 'Product must be set!' unless product
+      raise Dhl::Bcs::Error, 'In order to do an international shipment --product:V53WPAK--, :export_document muse be set!' unless !((product == 'V53WPAK') ^ export_document  )
 
       account_number = "#{ekp}#{PRODUCT_PROCEDURE_NUMBERS[product]}#{participation_number}"
       raise Dhl::Bcs::Error, 'Need a 14 character long account number. Check EKP and participation_number' if account_number.size != 14
@@ -76,6 +82,9 @@ module Dhl::Bcs::V2
         'Shipper' => shipper.to_soap_hash,
         # Receiver information
         'Receiver' => receiver.to_soap_hash
+      }.tap{|h|
+          #ExportDocuemnt information
+        h['ExportDocument'] = export_document.to_soap_hash if export_document
       }
     end
 

data/lib/dhl/bcs/version.rb

@@ -1,5 +1,5 @@
 module Dhl
   module Bcs
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhl-bcs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Christoph Wagner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 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.
@@ -122,7 +122,9 @@ files:
 - lib/dhl/bcs/v2/buildable.rb
 - lib/dhl/bcs/v2/client.rb
 - lib/dhl/bcs/v2/communication.rb
+- lib/dhl/bcs/v2/export_document.rb
 - lib/dhl/bcs/v2/location.rb
+- lib/dhl/bcs/v2/locator.rb
 - lib/dhl/bcs/v2/packstation.rb
 - lib/dhl/bcs/v2/parcel_shop.rb
 - lib/dhl/bcs/v2/postfiliale.rb
@@ -151,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Client for DHL Business-Customer-Shipping SOAP API 2.0