adyen 1.1.0 → 1.2.0

data/TODO

@@ -1,11 +1,3 @@
-1.0
-===
-
-* Screen documentation
-
-Possible/Later
-==============
-
 * Add a capture! method to an authorisation response from the PaymentService.
 
 * Add iDEAL API. To get started, see the `iDEAL' topic-branch which contains `ideal-scratchpad.rb' and a stub for a functional spec.
@@ -18,3 +10,7 @@ Possible/Later
   * adyen-soap
   * adyen-railtie
   * adyen-activemerchant
+
+* Add mocks for notification requests in order to test your app
+
+* Add more mock SOAP responses for testing your app.

data/adyen.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name    = 'adyen'
-  s.version = "1.1.0"
-  s.date    = "2011-03-21"
+  s.version = "1.2.0"
+  s.date    = "2011-05-12"
 
   s.summary = "Integrate Adyen payment services in your Ruby on Rails application."
   s.description = <<-EOS

data/lib/adyen.rb

@@ -12,7 +12,7 @@ module Adyen
   # Version constant for the Adyen plugin.
   # DO NOT CHANGE THIS VALUE BY HAND. It will be updated automatically by
   # the gem:release rake task.
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
   # @return [Configuration] The configuration singleton.
   def self.configuration

data/lib/adyen/api.rb

@@ -277,5 +277,46 @@ module Adyen
         :recurring_detail_reference => recurring_detail_reference
       }).disable
     end
+
+    # Stores and tokenises the creditcard details so that recurring payments can be made in the
+    # future.
+    #
+    # You do *not* have to include the card's CVC, because it won't be stored anyway.
+    #
+    # # @example
+    #   response = Adyen::API.store_recurring_token(
+    #     { :reference => user.id, :email => user.email, :ip => '8.8.8.8' },
+    #     { :holder_name => "Simon Hopper", :number => '4444333322221111', :expiry_month => 12, :expiry_year => 2012 }
+    #   )
+    #   response.stored? # => true
+    #
+    #   # Now we can authorize a payment with the token.
+    #   authorize_response = Adyen::API.authorise_recurring_payment(
+    #     invoice.id,
+    #     { :currency => 'EUR', :value => invoice.amount },
+    #     { :reference => user.id, :email => user.email, :ip => '8.8.8.8' },
+    #     response.recurring_detail_reference
+    #   )
+    #   authorize_response.authorised? # => true
+    #
+    # @param          [Hash]           shopper        A hash describing the shopper.
+    # @param          [Hash]           card           A hash describing the creditcard details.
+    #
+    # @option shopper [Numeric,String] :reference     The shopper’s reference (ID).
+    # @option shopper [String]         :email         The shopper’s email address.
+    # @option shopper [String]         :ip            The shopper’s IP address.
+    #
+    # @option card    [String]         :holder_name   The full name on the card.
+    # @option card    [String]         :number        The card number.
+    # @option card    [Numeric,String] :expiry_month  The month in which the card expires.
+    # @option card    [Numeric,String] :expiry_year   The year in which the card expires.
+    #
+    # @return [RecurringService::StoreTokenResponse] The response object
+    def store_recurring_token(shopper, card)
+      RecurringService.new({
+        :shopper   => shopper,
+        :card      => card
+      }).store_token
+    end
   end
 end

data/lib/adyen/api/recurring_service.rb

@@ -31,8 +31,21 @@ module Adyen
         call_webservice_action('disable', disable_request_body, DisableResponse)
       end
 
+      # @see API.store_recurring_token
+      def store_token
+        call_webservice_action('storeToken', store_token_request_body, StoreTokenResponse)
+      end
+
       private
 
+      # The card's CVC isn't needed when tokenising details, so insert `nil'.
+      def card_partial
+        validate_parameters!(:card => [:holder_name, :number, :expiry_year, :expiry_month])
+        card  = @params[:card].values_at(:holder_name, :number, :cvc, :expiry_year)
+        card << @params[:card][:expiry_month].to_i
+        CARD_PARTIAL % card
+      end
+
       def list_request_body
         validate_parameters!(:merchant_account, :shopper => [:reference])
         LIST_LAYOUT % [@params[:merchant_account], @params[:shopper][:reference]]
@@ -46,6 +59,12 @@ module Adyen
         DISABLE_LAYOUT % [@params[:merchant_account], @params[:shopper][:reference], reference || '']
       end
 
+      def store_token_request_body
+        validate_parameters!(:merchant_account, :shopper => [:email, :reference])
+        content = card_partial
+        STORE_TOKEN_LAYOUT % [@params[:merchant_account], @params[:shopper][:reference], @params[:shopper][:email], content]
+      end
+
       class DisableResponse < Response
         DISABLED_RESPONSES = %w{ [detail-successfully-disabled] [all-details-successfully-disabled] }
 
@@ -121,6 +140,26 @@ module Adyen
           }
         end
       end
+
+      class StoreTokenResponse < Response
+        response_attrs :response, :recurring_detail_reference
+
+        def recurring_detail_reference
+          params[:recurring_detail_reference]
+        end
+
+        def success?
+          super && params[:response] == 'Success'
+        end
+
+        alias stored? success?
+
+        def params
+          @params ||= { :response => xml_querier.text('//recurring:storeTokenResponse/recurring:result/recurring:result'),
+            :reference =>  xml_querier.text('//recurring:storeTokenResponse/recurring:result/recurring:rechargeReference'),
+            :recurring_detail_reference => xml_querier.text('//recurring:storeTokenResponse/recurring:result/recurring:recurringDetailReference')}
+        end
+      end
     end
   end
 end

data/lib/adyen/api/simple_soap_client.rb

@@ -32,6 +32,16 @@ EOS
         end
       end
 
+      class ServerError < StandardError
+        def initialize(response, action, endpoint)
+          @response, @action, @endpoint = response, action, endpoint
+        end
+
+        def message
+          "[#{@response.code} #{@response.message}] A server error occurred while calling SOAP action `#{@action}' on endpoint `#{@endpoint}'."
+        end
+      end
+
       class << self
         # When a response instance has been assigned, the subsequent call to
         # {SimpleSOAPClient#call_webservice_action} will not make a remote call, but simply return
@@ -109,6 +119,7 @@ EOS
           request.start do |http|
             http_response = http.request(post)
             raise ClientError.new(http_response, action, endpoint) if http_response.is_a?(Net::HTTPClientError)
+            raise ServerError.new(http_response, action, endpoint) if http_response.is_a?(Net::HTTPServerError)
             response_class.new(http_response)
           end
         end

data/lib/adyen/api/templates/recurring_service.rb

@@ -3,10 +3,10 @@ module Adyen
     class RecurringService < SimpleSOAPClient
       # @private
       LIST_LAYOUT = <<EOS
-    <recurring:listRecurringDetails xmlns:recurring="http://recurring.services.adyen.com">
+    <recurring:listRecurringDetails xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com">
       <recurring:request>
         <recurring:recurring>
-          <recurring:contract>RECURRING</recurring:contract>
+          <payment:contract>RECURRING</payment:contract>
         </recurring:recurring>
         <recurring:merchantAccount>%s</recurring:merchantAccount>
         <recurring:shopperReference>%s</recurring:shopperReference>
@@ -29,6 +29,31 @@ EOS
       RECURRING_DETAIL_PARTIAL = <<EOS
         <recurring:recurringDetailReference>%s</recurring:recurringDetailReference>
 EOS
+
+      STORE_TOKEN_LAYOUT = <<EOS
+    <recurring:storeToken xmlns:recurring="http://recurring.services.adyen.com" xmlns:payment="http://payment.services.adyen.com">
+      <recurring:request>
+        <recurring:recurring>
+          <payment:contract>RECURRING</payment:contract>
+        </recurring:recurring>
+        <recurring:merchantAccount>%s</recurring:merchantAccount>
+        <recurring:shopperReference>%s</recurring:shopperReference>
+        <recurring:shopperEmail>%s</recurring:shopperEmail>
+        %s
+      </recurring:request>
+    </recurring:storeToken>
+EOS
+
+      # @private
+      CARD_PARTIAL = <<EOS
+        <recurring:card>
+          <payment:holderName>%s</payment:holderName>
+          <payment:number>%s</payment:number>
+          <payment:cvc>%s</payment:cvc>
+          <payment:expiryYear>%s</payment:expiryYear>
+          <payment:expiryMonth>%02d</payment:expiryMonth>
+        </recurring:card>
+EOS
     end
   end
 end

data/lib/adyen/configuration.rb

@@ -78,6 +78,17 @@ class Adyen::Configuration
   #
   # @return [Hash]
   attr_accessor :default_form_params
+  
+  # Username that's set in Notification settings screen in Adyen PSP system and used by notification service to 
+  # authenticate instant payment notification requests.
+  #
+  # @return [String]
+  attr_accessor :ipn_username
+  
+  # Password used to authenticate notification requests together with '+ipn_username+' configuration attribute.
+  #
+  # @return [String]
+  attr_accessor :ipn_password
 
   ######################################################
   # SKINS

data/lib/adyen/form.rb

@@ -126,7 +126,7 @@ module Adyen
     # @param [Hash] parameters The payment parameters to include in the payment request.
     # @return [String] An absolute URL to redirect to the Adyen payment system.
     def redirect_url(parameters = {})
-      url + '?' + payment_parameters(parameters).map { |(k, v)| 
+      url + '?' + payment_parameters(parameters).map{|k,v| [k.to_s,v] }.sort.map { |(k, v)| 
         "#{camelize(k)}=#{CGI.escape(v.to_s)}" }.join('&')
     end
     
@@ -171,13 +171,14 @@ module Adyen
     # @return [String] The string for which the siganture is calculated.
     def calculate_signature_string(parameters)
       merchant_sig_string = ""
-      merchant_sig_string << parameters[:payment_amount].to_s    << parameters[:currency_code].to_s      <<
-                             parameters[:ship_before_date].to_s  << parameters[:merchant_reference].to_s <<
-                             parameters[:skin_code].to_s         << parameters[:merchant_account].to_s   <<
-                             parameters[:session_validity].to_s  << parameters[:shopper_email].to_s      <<
-                             parameters[:shopper_reference].to_s << parameters[:recurring_contract].to_s <<
-                             parameters[:allowed_methods].to_s   << parameters[:blocked_methods].to_s    <<
-                             parameters[:shopper_statement].to_s << parameters[:billing_address_type].to_s
+      merchant_sig_string << parameters[:payment_amount].to_s       << parameters[:currency_code].to_s        <<
+                             parameters[:ship_before_date].to_s     << parameters[:merchant_reference].to_s   <<
+                             parameters[:skin_code].to_s            << parameters[:merchant_account].to_s     <<
+                             parameters[:session_validity].to_s     << parameters[:shopper_email].to_s        <<
+                             parameters[:shopper_reference].to_s    << parameters[:recurring_contract].to_s   <<
+                             parameters[:allowed_methods].to_s      << parameters[:blocked_methods].to_s      <<
+                             parameters[:shopper_statement].to_s    << parameters[:merchant_return_data].to_s <<
+                             parameters[:billing_address_type].to_s << parameters[:offset].to_s
     end
 
     # Calculates the payment request signature for the given payment parameters. 
@@ -206,7 +207,8 @@ module Adyen
     # @param [Hash] params A hash of HTTP GET parameters for the redirect request.
     # @return [String] The signature string.
     def redirect_signature_string(params)
-      params[:authResult].to_s + params[:pspReference].to_s + params[:merchantReference].to_s + params[:skinCode].to_s
+      params[:authResult].to_s + params[:pspReference].to_s + params[:merchantReference].to_s + 
+        params[:skinCode].to_s + params[:merchantReturnData].to_s
     end
     
     # Computes the redirect signature using the request parameters, so that the 

data/spec/api/api_spec.rb

@@ -120,6 +120,17 @@ describe Adyen::API do
         @recurring.should_receive(method)
       end
 
+      it "performs a `tokenize creditcard details' request" do
+        should_map_shortcut_to(:store_token,
+          :shopper => { :reference => 'user-id', :email => 's.hopper@example.com' },
+          :card => { :expiry_month => 12, :expiry_year => 2012, :holder_name => "Simon Hopper", :number => '4444333322221111' }
+        )
+        Adyen::API.store_recurring_token(
+          { :reference => 'user-id', :email => 's.hopper@example.com' },
+          { :expiry_month => 12, :expiry_year => 2012, :holder_name => "Simon Hopper", :number => '4444333322221111' }
+        )
+      end
+
       it "preforms a `list recurring details' request" do
         should_map_shortcut_to(:list, :shopper => { :reference => 'user-id' })
         Adyen::API.list_recurring_details('user-id')

data/spec/api/recurring_service_spec.rb

@@ -6,7 +6,29 @@ describe Adyen::API::RecurringService do
   include APISpecHelper
 
   before do
-    @params = { :shopper => { :reference => 'user-id' } }
+    @params = {
+      :reference => 'order-id',
+      :amount => {
+        :currency => 'EUR',
+        :value => '1234',
+      },
+      :shopper => {
+        :email => 's.hopper@example.com',
+        :reference => 'user-id',
+        :ip => '61.294.12.12',
+      },
+      :card => {
+        :expiry_month => 12,
+        :expiry_year => 2012,
+        :holder_name => 'Simon わくわく Hopper',
+        :number => '4444333322221111',
+        :cvc => '737',
+        # Maestro UK/Solo only
+        #:issue_number => ,
+        #:start_month => ,
+        #:start_year => ,
+      }
+    }
     @recurring = @object = Adyen::API::RecurringService.new(@params)
   end
 
@@ -23,7 +45,7 @@ describe Adyen::API::RecurringService do
     end
 
     it "includes the type of contract, which is always `RECURRING'" do
-      text('./recurring:recurring/recurring:contract').should == 'RECURRING'
+      text('./recurring:recurring/payment:contract').should == 'RECURRING'
     end
   end
 
@@ -102,4 +124,55 @@ describe Adyen::API::RecurringService do
 
     it_should_return_params_for_each_xml_backend(:response => '[detail-successfully-disabled]')
   end
+
+  describe_request_body_of :store_token, '//recurring:storeToken/recurring:request' do
+    it_should_validate_request_parameters :merchant_account,
+                                          :shopper => [:email, :reference]
+
+    it "includes the merchant account handle" do
+      text('./recurring:merchantAccount').should == 'SuperShopper'
+    end
+
+    it "includes the shopper’s reference" do
+      text('./recurring:shopperReference').should == 'user-id'
+    end
+
+    it "includes the shopper’s email" do
+      text('./recurring:shopperEmail').should == 's.hopper@example.com'
+    end
+
+    it "includes the creditcard details" do
+      xpath('./recurring:card') do |card|
+        # there's no reason why Nokogiri should escape these characters, but as long as they're correct
+        card.text('./payment:holderName').should == 'Simon わくわく Hopper'
+        card.text('./payment:number').should == '4444333322221111'
+        card.text('./payment:cvc').should == '737'
+        card.text('./payment:expiryMonth').should == '12'
+        card.text('./payment:expiryYear').should == '2012'
+      end
+    end
+
+    it "formats the creditcard’s expiry month as a two digit number" do
+      @recurring.params[:card][:expiry_month] = 6
+      text('./recurring:card/payment:expiryMonth').should == '06'
+    end
+
+    it "includes the necessary recurring and one-click contract info if the `:recurring' param is truthful" do
+      text('./recurring:recurring/payment:contract').should == 'RECURRING'
+    end
+  end
+
+  describe_response_from :disable, (DISABLE_RESPONSE % '[detail-successfully-disabled]'), 'disable' do
+    it "returns whether or not it was disabled" do
+      @response.should be_success
+      @response.should be_disabled
+
+      stub_net_http(DISABLE_RESPONSE % '[all-details-successfully-disabled]')
+      @response = @recurring.disable
+      @response.should be_success
+      @response.should be_disabled
+    end
+
+    it_should_return_params_for_each_xml_backend(:response => '[detail-successfully-disabled]')
+  end
 end

data/spec/form_spec.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+require 'date'
 require 'spec_helper'
 require 'adyen/form'
 
@@ -63,6 +64,8 @@ describe Adyen::Form do
 
     it "should calculate the signature string correctly" do
       Adyen::Form.redirect_signature_string(@params).should == 'AUTHORISED1211992213193029Internet Order 123454aD37dJA'
+      params = @params.merge(:merchantReturnData => 'testing1234')
+      Adyen::Form.redirect_signature_string(params).should == 'AUTHORISED1211992213193029Internet Order 123454aD37dJAtesting1234'
     end
 
     it "should calculate the signature correctly" do
@@ -142,9 +145,13 @@ describe Adyen::Form do
       Adyen::Form.do_parameter_transformations!(@parameters)
     end
 
-    it "should construct the signature string correctly" do
+    it "should construct the signature base string correctly" do
       signature_string = Adyen::Form.calculate_signature_string(@parameters)
       signature_string.should == "10000GBP2007-10-20Internet Order 123454aD37dJATestMerchant2007-10-11T11:00:00Z"
+      
+      signature_string = Adyen::Form.calculate_signature_string(@parameters.merge(:merchant_return_data => 'testing123'))
+      signature_string.should == "10000GBP2007-10-20Internet Order 123454aD37dJATestMerchant2007-10-11T11:00:00Ztesting123"
+      
     end
     
     it "should calculate the signature correctly" do
@@ -152,7 +159,7 @@ describe Adyen::Form do
       signature.should == 'x58ZcRVL1H6y+XSeBGrySJ9ACVo='
     end
 
-    it "should calculate the signature correctly for a recurring payment" do
+    it "should calculate the signature base string correctly for a recurring payment" do
       # Add the required recurrent payment attributes
       @parameters.merge!(:recurring_contract => 'DEFAULT', :shopper_reference => 'grasshopper52', :shopper_email => 'gras.shopper@somewhere.org')
 

data/spec/functional/api_spec.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
-require 'spec_helper'
-
-require 'rubygems'
+require 'api/spec_helper'
 require 'nokogiri'
 
 API_SPEC_INITIALIZER = File.expand_path("../initializer.rb", __FILE__)
@@ -9,6 +7,7 @@ API_SPEC_INITIALIZER = File.expand_path("../initializer.rb", __FILE__)
 if File.exist?(API_SPEC_INITIALIZER)
 
   describe Adyen::API, "with an actual remote connection" do
+
     before :all do
       require API_SPEC_INITIALIZER
       Net::HTTP.stubbing_enabled = false
@@ -58,6 +57,15 @@ if File.exist?(API_SPEC_INITIALIZER)
       response.psp_reference.should_not be_empty
     end
 
+    it "stores the provided creditcard details" do
+      response = Adyen::API.store_recurring_token(
+        { :email => "#{@user_id}@example.com", :reference => @user_id },
+        { :expiry_month => 12, :expiry_year => 2012, :holder_name => "Simon #{@user_id} Hopper", :number => '4111111111111111' }
+      )
+      response.should be_stored
+      response.recurring_detail_reference.should_not be_empty
+    end
+
     it "captures a payment" do
       response = Adyen::API.capture_payment(@payment_response.psp_reference, { :currency => 'EUR', :value => '1234' })
       response.should be_success

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 -04:00
+date: 2011-05-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency