adyen 0.3.5 → 0.3.6

data/adyen.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name    = 'adyen'
-  s.version = "0.3.5"
-  s.date    = "2010-02-09"
+  s.version = "0.3.6"
+  s.date    = "2010-03-27"
 
   s.summary = "Integrate Adyen payment services in you Ruby on Rails application."
   s.description = <<-EOS

data/lib/adyen/soap.rb

@@ -177,6 +177,65 @@ module Adyen
         parse_authorise(response)
       end
 
+      # Submits a direct debit recurring payment.
+      #
+      # @example 
+      #   Adyen::SOAP::PaymentService.directdebit(
+      #     :merchant_account => 'MyAccount', :selected_recurring_detail_reference => 'LATEST',
+      #     :shopper_reference => user.id, :shopper_email => user.email,
+      #     :reference => invoice.id, :currency => invoice.currency, :value => invoice.amount)
+      #
+      # @param [Hash] args The paramaters to use for this call. These will be merged by any default
+      #       parameters set using {Adyen::SOAP.default_arguments}. Note that every option defined below
+      #       is required by the Adyen SOAP service, so please provide a value for all options.
+      # @option args [String] :selected_recurring_detail_reference ('LATEST') This is the
+      #       recurringDetailReference you want to use for this payment. You can use the
+      #       value "LATEST" to select the most recently used recurring detail, which is the default. 
+      # @option args [String] :merchant_account The merchant account you want to process this payment
+      #       with.
+      # @option args [String] :currency The currency code (EUR, GBP, USD, etc).
+      # @option args [Integer] :value The value of the payment in cents.
+      # @option args [String] :reference Your reference for this payment. This (merchant) reference
+      #       will be used in all communication to you about the status of the payment.
+      #       Although it is a good idea to make sure it is unique, this is not a requirement.
+      # @option args [String] :shopper_email The email address of the shopper. This does not have to
+      #       match the email address supplied with the initial payment, since it may have
+      #       changed in the mean time.
+      # @option args [String] :shopper_reference The reference of the shopper. This should be
+      #       the same as the reference that was used to create the recurring contract.
+      #
+      # @return [nil] This action returns nothing of interest. The result of the authorization 
+      #   will be communicated using a {Adyen::Notification notification}.
+      #
+      # @see https://support.adyen.com/index.php?_m=downloads&_a=viewdownload&downloaditemid=1
+      #       The Adyen integration manual
+      # @see https://support.adyen.com/index.php?_m=downloads&_a=viewdownload&downloaditemid=7&nav=0,3 
+      #       The Adyen recurring payments manual.
+      def directdebit(args = {})
+        invoke_args = Adyen::SOAP.default_arguments.merge(args)
+        invoke_args[:selected_recurring_detail_reference] ||= 'LATEST'
+
+        response = invoke('payment:directdebit') do |message|
+          message.add('payment:paymentRequest') do |req|
+            req.add('payment:selectedRecurringDetailReference', invoke_args[:selected_recurring_detail_reference])
+            req.add('payment:recurring') do |recurring|
+              recurring.add('payment:contract', 'RECURRING')
+            end
+            req.add('payment:merchantAccount', invoke_args[:merchant_account])
+            req.add('payment:amount') do |amount|
+              amount.add('common:currency', invoke_args[:currency])
+              amount.add('common:value', invoke_args[:value])
+            end
+            req.add('payment:reference', invoke_args[:reference])
+            req.add('payment:shopperEmail', invoke_args[:shopper_email])
+            req.add('payment:shopperReference', invoke_args[:shopper_reference])
+            req.add('payment:shopperInteraction', 'ContAuth')
+          end
+        end
+
+        parse_directdebit(response)
+      end
+
       # Capture a payment.
       #
       # @param [Hash] args The paramaters to use for this call. These will be merged by any default
@@ -305,6 +364,16 @@ module Adyen
         }
       end
 
+      def parse_directdebit(response)
+        response = response.xpath('//payment:directdebitResponse/payment:response')
+        {
+          :psp_reference => response.xpath('./payment:pspReference/text()').to_s,
+          :result_code => response.xpath('./payment:resultCode/text()').to_s,
+          :auth_code => response.xpath('./payment:authCode/text()').to_s,
+          :refusal_reason => response.xpath('./payment:refusalReason/text()').to_s
+        }
+      end
+
       def parse_capture(response)
         response = response.xpath('//payment:captureResponse/payment:captureResult')
         {
@@ -514,12 +583,23 @@ module Adyen
         }
       end
 
-      # @todo add support for elv and bank
+      # @todo add support for elv
       def parse_recurring_detail(node)
-        {
+        result = if(not node.xpath('./recurring:card').to_s.nil?)
+          parse_card(node)
+        elsif(not node.xpath('./recurring:bank').to_s.nil?)
+          parse_bank(node)
+        end
+
+        result.merge({
           :recurring_detail_reference => node.xpath('./recurring:recurringDetailReference/text()').to_s,
           :variant => node.xpath('./recurring:variant/text()').to_s,
-          :creation_date => node.xpath('./recurring:creationDate/text()').to_date,
+          :creation_date => node.xpath('./recurring:creationDate/text()').to_date
+        })
+      end
+
+      def parse_card(node)
+        {
           :card => {
             :expiry_date => Date.new(node.xpath('./recurring:card/payment:expiryYear/text()').to_i, node.xpath('recurring:card/payment:expiryMonth').to_i, -1),
             :holder_name => node.xpath('./recurring:card/payment:holderName/text()').to_s,
@@ -528,6 +608,20 @@ module Adyen
         }
       end
 
+      def parse_bank(node)
+        {
+          :bank => {
+            :bank_account_number => node.xpath('./recurring:bank/payment:bankAccountNumber/text()').to_s,
+            :bank_location_id => node.xpath('./recurring:bank/payment:bankLocationId/text()').to_s,
+            :bank_name => node.xpath('./recurring:bank/payment:bankName/text()').to_s,
+            :bic => node.xpath('./recurring:bank/payment:bic/text()').to_s,
+            :country_code => node.xpath('./recurring:bank/payment:countryCode/text()').to_s,
+            :iban => node.xpath('./recurring:bank/payment:iban/text()').to_s,
+            :owner_name => node.xpath('./recurring:bank/payment:ownerName/text()').to_s
+          }
+        }
+      end
+
       def parse_disable(response)
         response = response.xpath('//recurring:disableResponse/recurring:result')
         {

data/spec/soap_spec.rb

@@ -1,5 +1,340 @@
 require "#{File.dirname(__FILE__)}/spec_helper.rb"
 
-describe Adyen::SOAP do
+describe Adyen::SOAP::PaymentService do
+
+  describe '#authorise' do
+    before(:all) do
+      setup_mock_driver(<<EOF)
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <ns1:authoriseResponse xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:paymentResult>
+        <additionalData xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <authCode xmlns="http://payment.services.adyen.com">1234</authCode>
+        <dccAmount xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <dccSignature xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <fraudResult xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <issuerUrl xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <md xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <paRequest xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+        <refusalReason xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+        <resultCode xmlns="http://payment.services.adyen.com">Authorised</resultCode>
+      </ns1:paymentResult>
+    </ns1:authoriseResponse>
+  </soap:Body>
+</soap:Envelope>
+EOF
+
+      @response = Adyen::SOAP::PaymentService.authorise({
+        :selected_recurring_detail_reference => '6543210987654321',
+        :merchant_account => 'YourMerchantAccount',
+        :currency => 'EUR',
+        :value => '1000',
+        :reference => '1234567890123456',
+        :shopper_email => 'user@example.com',
+        :shopper_reference => '1'
+      })
+    end
+
+    context 'request' do
+      before(:all) do
+        @root_node = get_last_request_body.xpath('//payment:authorise/payment:paymentRequest', ns)
+      end
+
+      it 'should setup a paymentRequest' do
+        @root_node.should_not be_empty
+      end
+
+      it 'should provide an selectedRecurringDetailReference' do
+        @root_node.xpath('./payment:selectedRecurringDetailReference/text()', ns).to_s.should == '6543210987654321'
+      end
+
+      it 'should provide a merchantAccount' do
+        @root_node.xpath('./payment:merchantAccount/text()', ns).to_s.should == 'YourMerchantAccount'
+      end
+
+      it 'should provide a currency' do
+        @root_node.xpath('./payment:amount/common:currency/text()', ns).to_s.should == 'EUR'
+      end
+
+      it 'should provide a value' do
+        @root_node.xpath('./payment:amount/common:value/text()', ns).to_s.should == '1000'
+      end
+
+      it 'should provide a reference' do
+        @root_node.xpath('./payment:reference/text()', ns).to_s.should == '1234567890123456'
+      end
+
+      it 'should provide a shopperEmail' do
+        @root_node.xpath('./payment:shopperEmail/text()', ns).to_s.should == 'user@example.com'
+      end
+
+      it 'should provide a shopperReference' do
+        @root_node.xpath('./payment:shopperReference/text()', ns).to_s.should == '1'
+      end
+    end
+
+    context 'response' do
+      it 'should get a authorised resultcode' do
+        @response[:result_code].should == 'Authorised'
+      end
+
+      it 'should get a new psp reference' do
+        @response[:psp_reference].should == '9876543210987654'
+      end
+
+      it 'should get an authCode' do
+        @response[:auth_code].should == '1234'
+      end
+    end
+  end
+
+  describe '#capture' do
+    before(:all) do
+      setup_mock_driver(<<EOF)
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <ns1:captureResponse xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:captureResult>
+        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+        <response xmlns="http://payment.services.adyen.com">[capture-received]</response>
+      </ns1:captureResult>
+    </ns1:captureResponse>
+  </soap:Body>
+</soap:Envelope>
+EOF
+
+      @response = Adyen::SOAP::PaymentService.capture({
+        :merchant_account => 'YourMerchantAccount',
+        :original_reference => '1234567890123456',
+        :currency => 'EUR',
+        :value => '1000'
+      })
+    end
+
+    context 'request' do
+      before(:all) do
+        @root_node = get_last_request_body.xpath('//payment:capture/payment:modificationRequest', ns)
+      end
+
+      it 'should setup a modificationRequest' do
+        @root_node.should_not be_empty
+      end
+
+      it 'should provide a merchantAccount' do
+        @root_node.xpath('./payment:merchantAccount/text()', ns).to_s.should == 'YourMerchantAccount'
+      end
+
+      it 'should provide an originalReference' do
+        @root_node.xpath('./payment:originalReference/text()', ns).to_s.should == '1234567890123456'
+      end
+
+      it 'should provide a currency' do
+        @root_node.xpath('./payment:modificationAmount/common:currency/text()', ns).to_s.should == 'EUR'
+      end
+
+      it 'should provide a value' do
+        @root_node.xpath('./payment:modificationAmount/common:value/text()', ns).to_s.should == '1000'
+      end
+    end
+
+    context 'response' do
+      it 'should get a capture-received message' do
+        @response[:response].should == '[capture-received]'
+      end
+
+      it 'should get a new psp reference' do
+        @response[:psp_reference].should == '9876543210987654'
+      end
+    end
+  end
+
+  describe "#cancel" do
+    before(:all) do
+      setup_mock_driver(<<EOF)
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <ns1:cancelResponse xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:cancelResult>
+        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+        <response xmlns="http://payment.services.adyen.com">[cancel-received]</response>
+      </ns1:cancelResult>
+    </ns1:cancelResponse>
+  </soap:Body>
+</soap:Envelope>
+EOF
+
+      @response = Adyen::SOAP::PaymentService.cancel({
+        :merchant_account => 'YourMerchantAccount',
+        :original_reference => '1234567890123456'
+      })
+    end
+
+    context 'request' do
+      before(:all) do
+        @root_node = get_last_request_body.xpath('//payment:cancel/payment:modificationRequest', ns)
+      end
+
+      it 'should setup a modificationRequest' do
+        @root_node.should_not be_empty
+      end
+
+      it 'should provide a merchantAccount' do
+        @root_node.xpath('./payment:merchantAccount/text()', ns).to_s.should == 'YourMerchantAccount'
+      end
+
+      it 'should provide an originalReference' do
+        @root_node.xpath('./payment:originalReference/text()', ns).to_s.should == '1234567890123456'
+      end
+    end
+
+    context 'response' do
+      it 'should get a cancel-received message' do
+        @response[:response].should == '[cancel-received]'
+      end
+
+      it 'should get a new psp reference' do
+        @response[:psp_reference].should == '9876543210987654'
+      end
+    end
+  end
+
+  describe "#refund" do
+    before(:all) do
+      setup_mock_driver(<<EOF)
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <ns1:refundResponse xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:refundResult>
+        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+        <response xmlns="http://payment.services.adyen.com">[refund-received]</response>
+      </ns1:refundResult>
+    </ns1:refundResponse>
+  </soap:Body>
+</soap:Envelope>
+EOF
+
+      @response = Adyen::SOAP::PaymentService.refund({
+        :merchant_account => 'YourMerchantAccount',
+        :currency => 'EUR',
+        :value => '1000'
+      })
+    end
+
+    context 'request' do
+      before(:all) do
+        @root_node = get_last_request_body.xpath('//payment:refund/payment:modificationRequest', ns)
+      end
+
+      it 'should setup a modificationRequest' do
+        @root_node.should_not be_empty
+      end
+
+      it 'should provide a merchantAccount' do
+        @root_node.xpath('./payment:merchantAccount/text()', ns).to_s.should == 'YourMerchantAccount'
+      end
+
+      it 'should provide a currency' do
+        @root_node.xpath('./payment:modificationAmount/common:currency/text()', ns).to_s.should == 'EUR'
+      end
+
+      it 'should provide a value' do
+        @root_node.xpath('./payment:modificationAmount/common:value/text()', ns).to_s.should == '1000'
+      end
+    end
+
+    context 'response' do
+      it 'should get a refund-received message' do
+        @response[:response].should == '[refund-received]'
+      end
+
+      it 'should get a new psp reference' do
+        @response[:psp_reference].should == '9876543210987654'
+      end
+    end
+  end
+
+  describe "#cancel_or_refund" do
+    before(:all) do
+      setup_mock_driver(<<EOF)
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <ns1:cancelOrRefundResponse xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:cancelOrRefundResult>
+        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+        <response xmlns="http://payment.services.adyen.com">[cancelOrRefund-received]</response>
+      </ns1:cancelOrRefundResult>
+    </ns1:cancelOrRefundResponse>
+  </soap:Body>
+</soap:Envelope>
+EOF
+
+      @response = Adyen::SOAP::PaymentService.cancel_or_refund({
+        :merchant_account => 'YourMerchantAccount',
+        :original_reference => '1234567890123456'
+      })
+    end
+
+    context 'request' do
+      before(:all) do
+        @root_node = get_last_request_body.xpath('//payment:cancelOrRefund/payment:modificationRequest', ns)
+      end
+
+      it 'should setup a modificationRequest' do
+        @root_node.should_not be_empty
+      end
+
+      it 'should provide a merchantAccount' do
+        @root_node.xpath('./payment:merchantAccount/text()', ns).to_s.should == 'YourMerchantAccount'
+      end
+
+      it 'should provide an originalReference' do
+        @root_node.xpath('./payment:originalReference/text()', ns).to_s.should == '1234567890123456'
+      end
+    end
+
+    context 'response' do
+      it 'should get a cancelOrRefund-received message' do
+        @response[:response].should == '[cancelOrRefund-received]'
+      end
+
+      it 'should get a new psp reference' do
+        @response[:psp_reference].should == '9876543210987654'
+      end
+    end
+  end
+
+private
+
+  def setup_mock_driver(content)
+    Handsoap::Http.drivers[:mock] = Handsoap::Http::Drivers::MockDriver.new({
+      :status => 200,
+      :headers => [
+        'Date: Sat, 09 Jan 2010 01:14:41 GMT',
+        'Server: Apache',
+        'Content-Type: text/xml;charset=UTF-8'
+      ].join("\r\n"),
+      :content => content
+    })
+    Handsoap.http_driver = :mock
+  end
+
+  def get_last_request_body
+    Nokogiri::XML::Document.parse(Handsoap::Http.drivers[:mock].last_request.body)
+  end
+
+  def ns
+    {
+      'payment'   => 'http://payment.services.adyen.com',
+      'recurring' => 'http://recurring.services.adyen.com',
+      'common'    => 'http://common.services.adyen.com'
+    }
+  end
 
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: adyen
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -10,29 +15,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-09 00:00:00 +01:00
+date: 2010-03-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 4
         version: 1.1.4
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: git
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-    version: 
+  type: :development
+  version_requirements: *id002
 description: "    Package to simplify including the Adyen payments services into a Ruby on Rails application.\n    The package provides functionality to create payment forms, handling and storing notifications \n    sent by Adyen and consuming the SOAP services provided by Adyen. Moreover, it contains helper\n    methods, mocks and matchers to simpify writing tests/specsfor your code.\n"
 email: 
 - willem@vanbergen.org
@@ -81,20 +94,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: 
 - Handsoap is required for accessing the SOAP services. See http://github.com/troelskn/handsoap.
 - LibXML is required for using the RSpec matchers.
 - ActiveRecord is required for storing the notifications in your database.
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Integrate Adyen payment services in you Ruby on Rails application.