docdata 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5271138fe601489cd244592780fc9f386673c7cc
-  data.tar.gz: c60ccad98f4ae791df1e84608047a4e71e8ab7ab
+  metadata.gz: 583612f0f3405d88e304b04589e08faa14fc873c
+  data.tar.gz: e846c3af8a8be9caec3bddb1ca375565feb9e7e3
 SHA512:
-  metadata.gz: eaa1d9dac46967a8e34d13e1a9435dcd72b6ec49134a83c49f7b5d10c6f7e01050af98a18d9a24824cb35f3881d766d6a4e997fe3232a83e8997c2e03988f34c
-  data.tar.gz: b7f90e1cfe8c8284e8bec9fce47256c67e32c8f87ef0438e29d88b6ded7efa917e06d1267c56a20be4d351bb46325864b69682bf1f55f0eb22980b23603c89ae
+  metadata.gz: 4f78048e064e074ffc7e343267d94b45b54d9ef81bbab5a34fd535466557f89746d80d23e3c027d195fa19388588c22a7305d374dd14b8df6c812b137fafcb82
+  data.tar.gz: c039738e8915fa272fd01ea4c95e4e0df54f9823ba89febe6831f67a685f49018b68b8ee6594b930efc301188652b34701cda63a973039c4cf54a56e08e2fa97

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.1.5
+* Fixed a bug that occured when docdata reponded with multiple 'payment' nodes in the return object.
+
 ## v0.1.0
 * truncated description down to 50 characters in create xml
 

data/README.md

@@ -126,6 +126,35 @@ end
 
 ```
 
+After a payment is completed, Docdata Payments will do two things:
+
+1. Sends a GET request to your 'Update URL' (you can set this in the back office) with an 'id' parameter, containing your order_reference. This allows you to check the status of the transaction, before the user gets redirected back to your website.
+2. Redirects the consumer back to the `return_url`.
+
+```ruby
+def check_transaction
+	# find the order from your database
+  # https://www.example.com/docdata/update?id=12345
+	@order = Order.find_by_order_reference(params[:id])
+
+	# Find this payment via the Docdata API,
+	# using the previously set 'docdata_key' attribute.
+  payment = Docdata::Payment.find(@order.docdata_key)
+  response = payment.status
+  if response.paid
+    # use your own methods to handle a paid order
+    # for example:
+    @order.mark_as_paid(response.payment_method)
+  else
+  	# TODO: create logic to handle failed payments
+  end
+
+  # This action doesn't need a view template. It only needs to have a status 200 (OK)
+	render :nothing => true, :status => 200, :content_type => 'text/html'
+end
+
+```
+
 ## Ideal
 
 For transactions in the Netherlands, iDeal is the most common option. To redirect a user directly to the bank page (skipping the Docdata web menu page), you can ask your user to choose a bank from any of the banks listed in the `Docdata::Ideal.banks` method.
@@ -222,7 +251,7 @@ To cancel an existing Payment, you can do one of the following:
 
 
 ## Contributing
-Want to contribute? Greate!
+Want to contribute? Great!
 
 
 1. Fork it

data/lib/docdata/response.rb

@@ -61,7 +61,7 @@ module Docdata
     # Set the attributes based on the API response
     def set_attributes
       self.paid     = is_paid?
-      self.amount   = report[:payment][:authorization][:amount].to_i if (report && report[:payment] && report[:payment][:authorization] && report[:payment][:authorization][:amount].present?)
+      self.amount   = Response.payment_node(report)[:authorization][:amount].to_i if (report && Response.payment_node(report) && Response.payment_node(report)[:authorization] && Response.payment_node(report)[:authorization][:amount].present?)
       self.status   = capture_status if capture_status
       self.currency = currency_to_set
     end
@@ -80,6 +80,7 @@ module Docdata
         m = body["#{method_name}_response".to_sym]["#{method_name}_success".to_sym]
         r = self.new(key: m[:key], message: m[:success], success: true)
         r.xml    = xml #save the raw xml
+        # puts m[:report]
         if m[:report]
           r.report = m[:report]
         end
@@ -112,8 +113,8 @@ module Docdata
     # @return [String] the payment method of this transaction
     def payment_method
       begin
-        if report && report[:payment].present? && report[:payment][:payment_method].present?
-          report[:payment][:payment_method].to_s
+        if report && Response.payment_node(report).present? && Response.payment_node(report)[:payment_method].present?
+          Response.payment_node(report)[:payment_method].to_s
         else
           nil
         end
@@ -122,10 +123,11 @@ module Docdata
       end
     end
 
+
     # @return [String] the status string provided by the API. One of [AUTHORIZED, CANCELED]
     def payment_status
-      if report && report[:payment] && report[:payment][:authorization]
-        report[:payment][:authorization][:status]
+      if report && Response.payment_node(report) && Response.payment_node(report)[:authorization]
+        Response.payment_node(report)[:authorization][:status]
       else
         nil
       end
@@ -176,8 +178,8 @@ module Docdata
 
     # @return [String] the status of the capture, if exists
     def capture_status
-      if report && report[:payment] && report[:payment][:authorization] && report[:payment][:authorization][:capture]
-        report[:payment][:authorization][:capture][:status]
+      if report && Response.payment_node(report) && Response.payment_node(report)[:authorization] && Response.payment_node(report)[:authorization][:capture]
+        Response.payment_node(report)[:authorization][:capture][:status]
       else
         nil
       end
@@ -207,5 +209,19 @@ module Docdata
       @status_xml ||= Nokogiri.XML(doc.xpath("//S:Body").first.children.first.children.first.to_xml)
     end
 
+    private
+
+    # Sometimes a single response has multiple payment nodes. When a payment fails first and 
+    # succeeds later, for example. In that case, always use the last (== newest) node.
+    def self.payment_node(hash)
+      if hash[:payment] && hash[:payment].is_a?(Hash)
+        hash[:payment]
+      elsif hash[:payment] && hash[:payment].is_a?(Array)
+        hash[:payment].last
+      else
+        false
+      end
+    end
+
   end
 end

data/lib/docdata/version.rb

@@ -1,3 +1,3 @@
 module Docdata
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/response_spec.rb

@@ -17,6 +17,22 @@ describe Docdata::Response do
     end
   end
 
+  describe "response with multiple payment nodes" do
+    before(:each) do
+      file = "#{File.dirname(__FILE__)}/xml/status-paid-ideal-multiple.xml"
+      @xml = open(file)
+      @response = Docdata::Response.parse(:status, @xml)
+    end    
+
+    it "returs a response object" do
+      expect(@response).to be_kind_of(Docdata::Response)
+    end
+
+    it "is paid" do
+      expect(@response.paid).to eq(true)
+    end
+  end
+
   describe "different payment methods" do
     context ":status, paid iDeal" do
       before(:each) do

data/spec/xml/status-paid-ideal-multiple.xml

@@ -0,0 +1,42 @@
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+   <S:Body>
+      <statusResponse xmlns="http://www.docdatapayments.com/services/paymentservice/1_1/">
+         <statusSuccess>
+            <success code="SUCCESS">Operation successful.</success>
+            <report>
+               <approximateTotals exchangedTo="EUR" exchangeRateDate="2014-08-22 09:57:18">
+                  <totalRegistered>2200</totalRegistered>
+                  <totalShopperPending>0</totalShopperPending>
+                  <totalAcquirerPending>0</totalAcquirerPending>
+                  <totalAcquirerApproved>2200</totalAcquirerApproved>
+                  <totalCaptured>2200</totalCaptured>
+                  <totalRefunded>0</totalRefunded>
+                  <totalChargedback>0</totalChargedback>
+               </approximateTotals>
+               <payment>
+                  <id>2492860866</id>
+                  <paymentMethod>IDEAL</paymentMethod>
+                  <authorization>
+                     <status>CANCELED</status>
+                     <amount currency="EUR">2200</amount>
+                     <confidenceLevel/>
+                  </authorization>
+               </payment>
+               <payment>
+                  <id>2492861418</id>
+                  <paymentMethod>IDEAL</paymentMethod>
+                  <authorization>
+                     <status>AUTHORIZED</status>
+                     <amount currency="EUR">2200</amount>
+                     <confidenceLevel>ACQUIRER_APPROVED</confidenceLevel>
+                     <capture>
+                        <status>CAPTURED</status>
+                        <amount currency="EUR">2200</amount>
+                     </capture>
+                  </authorization>
+               </payment>
+            </report>
+         </statusSuccess>
+      </statusResponse>
+   </S:Body>
+</S:Envelope>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docdata
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Henk Meijer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -284,6 +284,7 @@ files:
 - spec/xml/status-canceled-ideal.xml
 - spec/xml/status-new.xml
 - spec/xml/status-paid-creditcard.xml
+- spec/xml/status-paid-ideal-multiple.xml
 - spec/xml/status-paid-ideal.xml
 - spec/xml/status-paid-sofort.xml
 homepage: http://rdoc.info/github/henkm/docdata/
@@ -324,6 +325,7 @@ test_files:
 - spec/xml/status-canceled-ideal.xml
 - spec/xml/status-new.xml
 - spec/xml/status-paid-creditcard.xml
+- spec/xml/status-paid-ideal-multiple.xml
 - spec/xml/status-paid-ideal.xml
 - spec/xml/status-paid-sofort.xml
 has_rdoc: