dhl-intraship 0.1.0 → 0.1.1

data/README.md

@@ -46,23 +46,24 @@ options = {test: true, # If test is set, all API calls go against the Intraship
 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')
+sender_address = Dhl::Intraship::CompanyAddress.new(company: 'Team Europe Ventures',
+                                                    contact_person: 'John Smith',
+                                                    street: 'Mohrenstraße',
+                                                    house_number: '60',
+                                                    zip: '10117',
+                                                    city: 'Berlin',
+                                                    country_code: 'DE',
+                                                    email: 'info@teameurope.net')
+
+receiver_address = Dhl::Intraship::PersonAddress.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,
@@ -73,8 +74,9 @@ shipment = Dhl::Intraship::Shipment.new(sender_address: sender_address,
                                         height:15,
                                         width: 25)
 ```
-
-Note that the actual api-call takes an array of shipments
+Beware, that due to DHL Intraship restrictions, the sender address must be a 
+CompanyAddress and requires a contact_person.
+Also, note that the actual api-call takes an array of shipments:
 
 ```ruby
 result = api.createShipmentDD([shipment])

data/lib/dhl-intraship.rb

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

data/lib/dhl-intraship/address.rb

@@ -1,10 +1,11 @@
 module Dhl
   module Intraship
     class Address
-      attr_accessor :company, :salutation, :firstname, :lastname, :street, :house_number, :street_additional,
+      attr_accessor :street, :house_number, :street_additional, :street_additional_above_street,
       :zip, :city, :country_code, :email
 
       def initialize(attributes = {})
+        self.street_additional_above_street = true
         attributes.each do |key, value|
           setter = :"#{key.to_s}="
           if self.respond_to?(setter)
@@ -16,6 +17,10 @@ module Dhl
       def company?
         !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
@@ -32,28 +37,15 @@ module Dhl
 
         @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
+          company_xml(xml)
         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(:careOfName, street_additional) if !street_additional.blank? && !street_additional_above_street?
           xml.cis(:Zip) do |xml|
             if country_code == 'DE'
               xml.cis(:germany, zip)
@@ -69,10 +61,20 @@ module Dhl
           end
         end
         xml.Communication do |xml|
-          xml.cis(:email, self.email)
-          xml.cis(:contactPerson, "#{firstname} #{lastname}")
+          xml.cis(:email, self.email) unless self.email.blank?
+          communication_xml(xml)
         end
       end
+      
+      protected
+      
+      def company_xml(xml)
+        raise "Use one of the two subclasses: PersonAddress or CompanyAddress!"
+      end
+      
+      def communication_xml(xml)
+        raise "Use one of the two subclasses: PersonAddress or CompanyAddress!"
+      end
     end
   end
 end

data/lib/dhl-intraship/company_address.rb

@@ -0,0 +1,20 @@
+module Dhl
+  module Intraship
+    class CompanyAddress < Address
+      attr_accessor :company, :contact_person
+
+      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/person_address.rb

@@ -0,0 +1,25 @@
+module Dhl
+  module Intraship
+    class PersonAddress < Address
+      attr_accessor :salutation, :firstname, :lastname
+      
+      protected
+      
+      def company_xml(xml)
+        xml.cis(:Person) do |xml|
+          xml.cis(:salutation, salutation)
+          xml.cis(:firstname, firstname)
+          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/version.rb

@@ -1,5 +1,5 @@
 module Dhl
   module Intraship
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/dhl-intraship/create_shipment_dd_spec.rb

@@ -47,8 +47,8 @@ EOS
 
         shipment = Shipment.new(shipment_date: Date.today + 1)
 
-        sender = Address.new
-        receiver = Address.new
+        sender = CopmanyAddress.new
+        receiver = PersonAddress.new
         shipment.receiver_address=receiver
         shipment.sender_address=sender
 

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'savon/spec'
 require 'dhl-intraship/api'
 require 'dhl-intraship/shipment'
 require 'dhl-intraship/address'
+require 'dhl-intraship/person_address'
+require 'dhl-intraship/company_address'
 
 RSpec.configure do |config|
   config.include Savon::Spec::Macros

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhl-intraship
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-06-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -75,6 +75,8 @@ files:
 - lib/dhl-intraship.rb
 - lib/dhl-intraship/address.rb
 - lib/dhl-intraship/api.rb
+- lib/dhl-intraship/company_address.rb
+- lib/dhl-intraship/person_address.rb
 - lib/dhl-intraship/product_code.rb
 - lib/dhl-intraship/shipment.rb
 - lib/dhl-intraship/version.rb
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: This wraps the DHL Intraship SOAP Interface for creating shipments