dhl-intraship 0.2.0 → 0.3.0

data/README.md

@@ -87,6 +87,23 @@ shipment_number = result[:shipment_number]
 label_url = result[:label_url] # Or result[:xml_label] in case XML label was set in the options
 ```
 
+#### Add cash on delivery
+
+For the "cash on delivery" service you need to create a Bankdata object with the payee information.
+Give that together with the amount and the currency to a CODService object. Finally add the service to your shipment:
+
+```ruby
+bankdata = Dhl::Intraship::Bankdata.new(owner: 'John Smith',
+                                        account_number: '1212121212',
+                                        bank_code: '12345679',
+                                        bank_name: 'Testbank 2',
+                                        note: 'OrderID 12345')
+cod_service = Dhl::Intraship::CODService.new(amount:  15.00,
+                                             currency: 'EUR',
+                                             bankdata: bankdata)
+shipment.add_service(cod_service)
+```
+
 ### Delete a shipment
 
 You can create and delete shipments as much as you like, they will not get into the "real" DHL system until you manifest them.

data/lib/dhl-intraship.rb

@@ -3,5 +3,9 @@ require "dhl-intraship/api"
 require "dhl-intraship/address"
 require "dhl-intraship/person_address"
 require "dhl-intraship/company_address"
+require "dhl-intraship/packstation_address"
 require "dhl-intraship/shipment"
-require "dhl-intraship/product_code"
+require "dhl-intraship/product_code"
+require "dhl-intraship/bankdata"
+require "dhl-intraship/service"
+require "dhl-intraship/service/cod_service"

data/lib/dhl-intraship/address.rb

@@ -1,11 +1,10 @@
 module Dhl
   module Intraship
     class Address
-      attr_accessor :street, :house_number, :street_additional, :street_additional_above_street,
-      :zip, :city, :country_code, :email, :phone
+      attr_accessor :street, :house_number, :street_additional,
+      :zip, :city, :country_code, :contact_person, :email, :phone
 
       def initialize(attributes = {})
-        self.street_additional_above_street = true
         attributes.each do |key, value|
           setter = :"#{key.to_s}="
           if self.respond_to?(setter)
@@ -18,10 +17,6 @@ module Dhl
         !self.company.blank?
       end
       
-      def street_additional_above_street?
-        self.street_additional_above_street
-      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
@@ -34,7 +29,7 @@ module Dhl
         xml.Address do |xml|
           xml.cis(:streetName, street)
           xml.cis(:streetNumber, house_number)
-          xml.cis(:careOfName, street_additional) if !street_additional.blank? && !street_additional_above_street?
+          xml.cis(:careOfName, street_additional) unless street_additional.blank?
           xml.cis(:Zip) do |xml|
             if country_code == 'DE'
               xml.cis(:germany, zip)
@@ -52,7 +47,7 @@ module Dhl
         xml.Communication do |xml|
           xml.cis(:phone, self.phone) unless self.phone.blank?
           xml.cis(:email, self.email) unless self.email.blank?
-          communication_xml(xml)
+          xml.cis(:contactPerson, contact_person.blank? ? "" : contact_person)
         end
       end
       

data/lib/dhl-intraship/api.rb

@@ -84,7 +84,7 @@ module Dhl
             end
 
           else
-            raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]} (Status messages: #{r[:creation_state][:status].to_s})"
+            raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]} (Status messages: #{r[:creation_state][:status_message].to_s})"
           end
         rescue Savon::Error => error
           raise error

data/lib/dhl-intraship/bankdata.rb

@@ -0,0 +1,28 @@
+module Dhl
+  module Intraship
+    class Bankdata
+      attr_accessor :owner, :account_number, :bank_code, :bank_name, :iban, :bic, :note
+
+      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 append_to_xml(xml)
+        xml.BankData do |xml|
+          xml.cis(:accountOwner, owner)
+          xml.cis(:accountNumber, account_number) unless account_number.blank?
+          xml.cis(:bankCode, bank_code) unless bank_code.blank?
+          xml.cis(:bankName, bank_name) unless bank_name.blank?
+          xml.cis(:iban, iban) unless iban.blank?
+          xml.cis(:note, note) unless note.blank?
+          xml.cis(:bic, bic) unless bic.blank?
+        end
+      end
+    end
+  end
+end

data/lib/dhl-intraship/company_address.rb

@@ -1,20 +1,15 @@
 module Dhl
   module Intraship
     class CompanyAddress < Address
-      attr_accessor :company, :contact_person
+      attr_accessor :company
 
       protected
       
       def company_xml(xml)
         xml.cis(:Company) do |xml|
           xml.cis(:name1, company)
-          xml.cis(:name2, street_additional) if !street_additional.blank? && street_additional_above_street?
         end
       end
-      
-      def communication_xml(xml)
-        xml.cis(:contactPerson, contact_person)
-      end
     end
   end
 end

data/lib/dhl-intraship/packstation_address.rb

@@ -0,0 +1,25 @@
+module Dhl
+  module Intraship
+    class PackstationAddress < CompanyAddress
+      attr_accessor :packstation, :postnumber
+
+      def append_to_xml(xml)
+        xml.Company do |xml|
+          company_xml(xml)
+        end
+        # this element has no namespace
+        xml.Packstation do |xml|
+          xml.PackstationNumber packstation
+          xml.PostNumber postnumber
+          xml.Zip zip
+          xml.City city
+        end
+        xml.Communication do |xml|
+          xml.cis(:phone, phone) unless phone.blank?
+          xml.cis(:email, email) unless email.blank?
+          xml.cis(:contactPerson, contact_person.blank? ? "" : contact_person)
+        end
+      end
+    end
+  end
+end

data/lib/dhl-intraship/person_address.rb

@@ -12,14 +12,6 @@ module Dhl
           xml.cis(:lastname, lastname)
         end
       end
-
-      def communication_xml(xml)
-        if !self.street_additional.blank? && street_additional_above_street?
-          xml.cis(:contactPerson, street_additional)
-        else
-          xml.cis(:contactPerson, "") # This line is hiding the contact person line for receivers
-        end
-      end
     end
   end
 end

data/lib/dhl-intraship/service.rb

@@ -0,0 +1,16 @@
+module Dhl
+  module Intraship
+    class Service
+
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          setter = :"#{key.to_s}="
+          if self.respond_to?(setter)
+            self.send(setter, value)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dhl-intraship/service/cod_service.rb

@@ -0,0 +1,20 @@
+module Dhl
+  module Intraship
+    class CODService < Service
+      attr_accessor :amount, :currency, :bankdata
+
+      def append_to_xml(xml)
+        xml.Service do |xml|
+          xml.ServiceGroupOther do |xml|
+            xml.COD do |xml|
+              xml.CODAmount(amount)
+              xml.CODCurrency(currency)
+            end
+          end
+        end
+        bankdata.append_to_xml(xml)
+      end
+
+    end
+  end
+end

data/lib/dhl-intraship/shipment.rb

@@ -5,10 +5,12 @@ module Dhl
     class Shipment
       PACKAGE_TYPE = 'PK'
 
-      attr_accessor :sender_address, :receiver_address, :shipment_date, :weight, :length, :height, :width, :product_code
+      attr_accessor :sender_address, :receiver_address, :shipment_date, :weight, :length, :height, :width, :product_code,
+                    :customer_reference, :services
 
       def initialize(attributes = {})
         self.product_code = ProductCode::DHL_PACKAGE
+        self.services = []
         attributes.each do |key, value|
           setter = :"#{key.to_s}="
           if self.respond_to?(setter)
@@ -17,6 +19,10 @@ module Dhl
         end
       end
 
+      def add_service(newservice)
+        @services << newservice
+      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
@@ -34,6 +40,7 @@ module Dhl
             xml.Attendance do |xml|
               xml.cis(:partnerID, partner_id)
             end
+            xml.CustomerReference(customer_reference) unless customer_reference.blank?
             xml.ShipmentItem do |xml|
               xml.WeightInKG(weight)
               xml.LengthInCM(length) unless length.nil?
@@ -41,6 +48,9 @@ module Dhl
               xml.HeightInCM(height) unless height.nil?
               xml.PackageType(PACKAGE_TYPE)
             end
+            services.each do |service|
+              service.append_to_xml(xml)
+            end
           end
           # Shipper information
           xml.Shipper do |xml|

data/lib/dhl-intraship/version.rb

@@ -1,5 +1,5 @@
 module Dhl
   module Intraship
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhl-intraship
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -75,10 +75,14 @@ files:
 - lib/dhl-intraship.rb
 - lib/dhl-intraship/address.rb
 - lib/dhl-intraship/api.rb
+- lib/dhl-intraship/bankdata.rb
 - lib/dhl-intraship/booking_information.rb
 - lib/dhl-intraship/company_address.rb
+- lib/dhl-intraship/packstation_address.rb
 - lib/dhl-intraship/person_address.rb
 - lib/dhl-intraship/product_code.rb
+- lib/dhl-intraship/service.rb
+- lib/dhl-intraship/service/cod_service.rb
 - lib/dhl-intraship/shipment.rb
 - lib/dhl-intraship/version.rb
 - spec/dhl-intraship/book_pickup_spec.rb
@@ -106,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: This wraps the DHL Intraship SOAP Interface for creating shipments