dhl-intraship 0.0.8 → 0.1.0

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 Initialize a new API object using
 
 ```ruby
-api = Dhl::Infraship::API.new(config, options)
+api = Dhl::Intraship::API.new(config, options)
 ```
 
 Config is the following hash:

data/lib/dhl-intraship/api.rb

@@ -43,11 +43,10 @@ module Dhl
 
       def createShipmentDD(shipments)
         begin
+          shipments = [shipments] unless shipments.respond_to?('each')
+
           # 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
+	  ekp = @ekp
           partner_id = @partner_id
 
           returnXML = @config && @config[:label_response_type] && @config[:label_response_type] == :xml;
@@ -55,12 +54,7 @@ module Dhl
             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
+                  append_default_header_to_xml(xml)
                 end
                 xml.soapenv(:Body) do |xml|
                   xml.de(:"CreateShipmentDDRequest") do |xml|
@@ -93,12 +87,62 @@ module Dhl
             end
 
           else
-            raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]}"
+            raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]} (Status messages: #{r[:creation_state][:status].to_s})"
           end
         rescue Savon::Error => error
           raise error
         end
       end
+
+      def deleteShipmentDD(shipment_number)
+        begin
+          result = @client.request "de:DeleteShipmentDDRequest" do
+            soap.xml do |xml|
+              xml.soapenv(:Envelope, DEFAULT_NAMESPACES) do |xml|
+                xml.soapenv(:Header) do |xml|
+                  append_default_header_to_xml(xml)
+                end
+                xml.soapenv(:Body) do |xml|
+                  xml.de(:"DeleteShipmentDDRequest") do |xml|
+                    xml.cis(:Version) do |xml|
+                      xml.cis(:majorRelease, '1')
+                      xml.cis(:minorRelease, '0')
+                    end
+                    xml.ShipmentNumber do |xml|
+                      xml.cis(:shipmentNumber, shipment_number)
+                    end
+                  end
+                end
+              end
+	    end
+          end
+          r = result.to_hash[:delete_shipment_response]
+
+	  # Return true if successful
+          raise "Intraship call failed with code #{r[:status][:status_code]}: #{r[:status][:status_message]} (Status messages: #{r[:deletion_state][:status].to_s})" unless r[:status][:status_code] == '0'
+
+	  true
+	rescue Savon::Error => error
+          raise error
+        end
+      end
+
+protected
+      def append_default_header_to_xml(xml)
+          # 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
+
+          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
     end
   end
-end
+end

data/lib/dhl-intraship/shipment.rb

@@ -54,4 +54,4 @@ module Dhl
       end
     end
   end
-end
+end

data/lib/dhl-intraship/version.rb

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

data/spec/dhl-intraship/create_shipment_dd_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Dhl
   module Intraship
 
-    TEST_RESPONSE = <<EOS
+    CREATE_RESPONSE = <<EOS
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
     <ns2:CreateShipmentResponse xmlns:ns2="http://de.ws.intraship">
@@ -43,7 +43,7 @@ EOS
       end
 
       it "should create an API call" do
-        savon.expects("de:CreateShipmentDDRequest" ).returns( code: 200, headers: {},body: TEST_RESPONSE )
+        savon.expects("de:CreateShipmentDDRequest" ).returns( code: 200, headers: {},body: CREATE_RESPONSE )
 
         shipment = Shipment.new(shipment_date: Date.today + 1)
 
@@ -52,7 +52,7 @@ EOS
         shipment.receiver_address=receiver
         shipment.sender_address=sender
 
-        @api.createShipmentDD([shipment]).should_not be_nil
+        @api.createShipmentDD(shipment).should_not be_nil
       end
     end
 

data/spec/dhl-intraship/delete_shipment_dd_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+module Dhl
+  module Intraship
+
+    ERROR_DELETE_RESPONSE = <<EOS
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+   <soapenv:Body>
+      <ns4:DeleteShipmentResponse xmlns:ns4="http://de.ws.intraship">
+         <Version xmlns="http://dhl.de/webservice/cisbase">
+            <majorRelease>1</majorRelease>
+            <minorRelease>0</minorRelease>
+            <build>14</build>
+         </Version>
+         <Status>
+            <StatusCode>1050</StatusCode>
+            <StatusMessage>at least on shipment could not be deleted</StatusMessage>
+         </Status>
+         <DeletionState>
+            <ShipmentNumber>
+               <ns1:shipmentNumber xmlns:ns1="http://dhl.de/webservice/cisbase">123</ns1:shipmentNumber>
+            </ShipmentNumber>
+            <Status>
+               <StatusCode>2000</StatusCode>
+               <StatusMessage>shipment not found or is deleted.</StatusMessage>
+            </Status>
+         </DeletionState>
+      </ns4:DeleteShipmentResponse>
+   </soapenv:Body>
+</soapenv:Envelope>
+EOS
+
+DELETE_RESPONSE = <<EOS
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body>
+    <ns4:DeleteShipmentResponse xmlns:ns4="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>
+      <DeletionState>
+        <StatusCode>0</StatusCode>
+        <StatusMessage>ok</StatusMessage>
+        <ShipmentNumber>
+          <ns1:shipmentNumber xmlns:ns1="http://dhl.de/webservice/cisbase">123</ns1:shipmentNumber>
+        </ShipmentNumber>
+      </DeletionState>
+    </ns4:DeleteShipmentResponse>
+  </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 raise an exception on a failed call" do
+        savon.expects("de:DeleteShipmentDDRequest").returns( code: 200, headers: {},body: ERROR_DELETE_RESPONSE )
+
+        expect { @api.deleteShipmentDD("123") }.should raise_error
+      end
+
+      it "should return true on successful call" do
+        savon.expects("de:DeleteShipmentDDRequest").returns( code: 200, headers: {},body: DELETE_RESPONSE )
+
+	@api.deleteShipmentDD("123").should be_true
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhl-intraship
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -80,6 +80,7 @@ files:
 - lib/dhl-intraship/version.rb
 - spec/dhl-intraship/address_spec.rb
 - spec/dhl-intraship/create_shipment_dd_spec.rb
+- spec/dhl-intraship/delete_shipment_dd_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/teameurope/dhl-intraship
 licenses: []
@@ -101,11 +102,12 @@ 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
 test_files:
 - spec/dhl-intraship/address_spec.rb
 - spec/dhl-intraship/create_shipment_dd_spec.rb
+- spec/dhl-intraship/delete_shipment_dd_spec.rb
 - spec/spec_helper.rb