adyen 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc7e880acbef87255749e6de239137a815ce5db
-  data.tar.gz: 5cca9c9e9af626b4f0adfd4626d83212735cb0a2
+  metadata.gz: 455a933ae555a5bdef76141cf1b8ff4d7e44b383
+  data.tar.gz: a6f844a752ce6f69778bd9eba5bcfc86a935404c
 SHA512:
-  metadata.gz: 3e942a606d19d158af7a424a87489c614a42efc909c437cee1cd18c05bd470c9311b38a77dc50b4a85e872fe87b84be6e47bc5b3435e7e7ad9253366051c6f90
-  data.tar.gz: 0b52b3698293f517fae0588a12b9e65016d840670085fb653a3ae715b35e3f18776500760101e5bd23aba72d69d3f2e351a5b70d143739c5524286b21d1639e6
+  metadata.gz: 997202692973d0ab546fca1ee3c343a1e0c7e7809b2f4a8d6cf7636bc34ced06b3d31bcfeae77339472483888d5b0db10a56f70c47a6ddffed49eb6f7c6b0ed5
+  data.tar.gz: b591907d17db7636db322d851c796c6ae6b2b247b3c8cac2fba8d4bee63aa940596469ff9946ce2f818467a4253c53572947381d2eb80994dcb9c61ba11ce399

data/.gitignore

@@ -1,3 +1,6 @@
+.idea
+.gems
+.rbenv-gemsets
 /tmp
 /pkg
 /doc

data/.travis.yml

@@ -18,5 +18,5 @@ before_script:
 env:
   global:
   - ADYEN_MERCHANT_ACCOUNT: "VanBergenORG"
-  - ADYEN_API_USERNAME: "ws_052255@Company.VanBergen"
-  - ADYEN_API_PASSWORD: "xoYyauhxwsgAqs3vNr3h"
+  - ADYEN_API_USERNAME: "ws@Company.VanBergen"
+  - ADYEN_API_PASSWORD: "7phtHzbfnzsp"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 - 2011 
+Copyright (c) 2008 - 2014
 Willem van Bergen, Michel Barbosa, Stefan Borsje & Eloy Duran
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.rdoc

@@ -41,6 +41,10 @@ Contributions are welcomed; this is very much a scratch your own itch project. S
 * All functionality must include tests and preferably documentation.
 * New SOAP API calls should include functional tests that actually test if the call is working. 
   Adyen has a nasty tendency to switch things up every now and then, so this is vital.
+  Note: we use a test account to run the functional specs on CI. Some API calls have to be 
+  enabled on Adyen's side before our test account can use them. If you receive failures with
+  "010 Not allowed" on CI while it works fine with your owen test account, please let us know on
+  the pull request, so I can ask Adyen to enable the feature on the test account as well.
 
 Please visit the changelog at https://github.com/wvanbergen/adyen/wiki/Changelog to see the 
 changes in the different releases.

data/Rakefile

@@ -1,9 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rake/testtask"
 
-Dir['tasks/*.rake'].each { |file| load(file) }
-
-
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = "./spec/**/*_spec.rb"
@@ -22,7 +24,7 @@ end
 
 # Update the cacert.pem file before each release.
 task :build => :update_cacert do
-  sh "git commit #{CACERT_PATH} -m '[API] Update CA root certificates file.'"
+  sh "git diff-index --quiet HEAD #{CACERT_PATH} || (git add #{CACERT_PATH} && git commit -m '[API] Update CA root certificates file.')"
 end
 
 begin
@@ -35,4 +37,4 @@ begin
 rescue LoadError
 end
 
-task :default => [:spec]
+task :default => [:test, :spec]

data/adyen.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec', '~> 2.14')
+  s.add_development_dependency('minitest', '~> 5')
+  s.add_development_dependency('mocha')
   
   s.add_development_dependency('rails', '>= 3.2')
   s.add_development_dependency('nokogiri', '>= 1.6.1')

data/lib/adyen/api.rb

@@ -50,6 +50,63 @@ module Adyen
   module API
     extend self
 
+    # Generate a Billet - *Brazian users only*
+    #
+    # Billet (Boleto Bancário), often simply referred to as Boleto, is an
+    # offline payment method used in Brazil . The consumer will take the Boleto form to
+    # an ATM, bank, an approved facility, or access their online banking system
+    # to complete the payment. Once the Boleto is paid, the bank will send Adyen
+    # a file confirming that the payment was made, this usually takes one day, but
+    # it may occur up to 6 days after the payment. If a Boleto is not paid, the
+    # transaction will expire once the expirationDate is reached. For more
+    # information check the Adyen API Manual - 7 - Boleto Bancário(page 30)
+    #
+    # @example
+    #   response = Adyen::API.generate_billet(
+    #     invoice.id
+    #     { currency: "BRL", value: (invoice.amount).to_i },
+    #     { first_name: "Simon", last_name: "Hopper" },
+    #     document_number,
+    #     selected_brand
+    #   )
+    #   response.success? # => true
+    #
+    #
+    # @param          [Numeric,String] reference        Your reference (ID) for this payment.
+    # @param          [Hash]           amount           A hash describing the money to charge.
+    # @param          [Hash]           shopper          A hash describing the shopper.
+    # @param          [String]         document_number  Social Security
+    # number(CPF in Brazil)
+    # @param          [String]         selected_brand   Billet brand
+    #
+    # @option amount  [String]         :currency      The ISO currency code (EUR, GBP, USD, etc).
+    # @option amount  [Integer]        :value         The value of the payment in discrete cents,
+    #                                                 unless the currency does not have cents.
+    #
+    # @option shopper_name [String]    :first_name    The shopper’s first name
+    # @option shopper_name [String]    :last_name     The shopper’s last name
+    #
+    #
+    # @return [PaymentService::BilletResponse] The response object which holds the billet url.
+    #
+    def generate_billet(reference, amount, shopper_name, social_security_number, selected_brand, delivery_date)
+      params = { :reference              => reference,
+                 :amount                 => amount,
+                 :shopper_name           => shopper_name,
+                 :social_security_number => social_security_number,
+                 :selected_brand         => selected_brand,
+                 :delivery_date          => delivery_date }
+      PaymentService.new(params).generate_billet
+    end
+
+    # Make an instant payment.
+    #
+    # Technically - authorisation with immediate (no delay) capture.
+    # @see authorise_payment
+    def pay_instantly(reference, amount, shopper, card, enable_recurring_contract = false, fraud_offset = nil)
+      authorise_payment(reference, amount, shopper, card, enable_recurring_contract, fraud_offset, true)
+    end
+
     # Authorise a payment.
     #
     # @see capture_payment
@@ -96,13 +153,14 @@ module Adyen
     #
     # @return [PaymentService::AuthorisationResponse] The response object which holds the
     #                                                 authorisation status.
-    def authorise_payment(reference, amount, shopper, card, enable_recurring_contract = false, fraud_offset = nil)
+    def authorise_payment(reference, amount, shopper, card, enable_recurring_contract = false, fraud_offset = nil, instant_capture = false)
       params = { :reference    => reference,
                  :amount       => amount,
                  :shopper      => shopper,
                  :card         => card,
                  :recurring    => enable_recurring_contract,
-                 :fraud_offset => fraud_offset }
+                 :fraud_offset => fraud_offset,
+                 :instant_capture => instant_capture }
       PaymentService.new(params).authorise_payment
     end
 
@@ -143,12 +201,13 @@ module Adyen
     #
     # @return [PaymentService::AuthorisationResponse] The response object which holds the
     #                                                 authorisation status.
-    def authorise_recurring_payment(reference, amount, shopper, recurring_detail_reference = 'LATEST', fraud_offset = nil)
+    def authorise_recurring_payment(reference, amount, shopper, recurring_detail_reference = 'LATEST', fraud_offset = nil, instant_capture = false)
       params = { :reference => reference,
                  :amount    => amount,
                  :shopper   => shopper,
                  :recurring_detail_reference => recurring_detail_reference,
-                 :fraud_offset => fraud_offset }
+                 :fraud_offset => fraud_offset,
+                 :instant_capture => instant_capture }
       PaymentService.new(params).authorise_recurring_payment
     end
 
@@ -194,13 +253,14 @@ module Adyen
     #
     # @return [PaymentService::AuthorisationResponse] The response object which holds the
     #                                                 authorisation status.
-    def authorise_one_click_payment(reference, amount, shopper, card, recurring_detail_reference, fraud_offset = nil)
+    def authorise_one_click_payment(reference, amount, shopper, card, recurring_detail_reference, fraud_offset = nil, instant_capture = false)
       params = { :reference => reference,
                  :amount    => amount,
                  :shopper   => shopper,
                  :card      => card,
                  :recurring_detail_reference => recurring_detail_reference,
-                 :fraud_offset => fraud_offset }
+                 :fraud_offset => fraud_offset,
+                 :instant_capture => instant_capture }
       PaymentService.new(params).authorise_one_click_payment
     end
 

data/lib/adyen/api/payment_service.rb

@@ -40,6 +40,11 @@ module Adyen
       # The Adyen Payment SOAP service endpoint uri.
       ENDPOINT_URI = 'https://pal-%s.adyen.com/pal/servlet/soap/Payment'
 
+      # @see API.generate_billet
+      def generate_billet
+        make_payment_request(generate_billet_request_body, BilletResponse)
+      end
+
       # @see API.authorise_payment
       def authorise_payment
         make_payment_request(authorise_payment_request_body, AuthorisationResponse)
@@ -110,6 +115,17 @@ module Adyen
         content << installments_partial if @params[:installments]
         content << shopper_partial if @params[:shopper]
         content << fraud_offset_partial if @params[:fraud_offset]
+        content << capture_delay_partial if @params[:instant_capture]
+        LAYOUT % [@params[:merchant_account], @params[:reference], content]
+      end
+
+      def generate_billet_request_body
+        validate_parameters!(:merchant_account, :reference, :amount => [:currency, :value])
+        content  =  amount_partial
+        content << social_security_number_partial if @params[:social_security_number]
+        content << shopper_name_partial if @params[:shopper_name]
+        content << delivery_date_partial if @params[:delivery_date]
+        content << selected_brand_partial if @params[:selected_brand]
         LAYOUT % [@params[:merchant_account], @params[:reference], content]
       end
 
@@ -150,13 +166,18 @@ module Adyen
         end
       end
 
+      def shopper_name_partial
+        SHOPPER_NAME_PARTIAL % @params[:shopper_name].values_at(:first_name, :last_name)
+      end
+
       def card_partial
         if @params[:card] && @params[:card][:encrypted] && @params[:card][:encrypted][:json]
           ENCRYPTED_CARD_PARTIAL % [@params[:card][:encrypted][:json]]
         else
-          validate_parameters!(:card => [:holder_name, :number, :cvc, :expiry_year, :expiry_month])
-          card  = @params[:card].values_at(:holder_name, :number, :cvc, :expiry_year)
+          validate_parameters!(:card => [:holder_name, :number, :expiry_year, :expiry_month])
+          card  = @params[:card].values_at(:holder_name, :number, :expiry_year)
           card << @params[:card][:expiry_month].to_i
+          card << (['', nil].include?(@params[:card][:cvc]) ? '' : (CARD_CVC_PARTIAL % @params[:card][:cvc]))
           CARD_PARTIAL % card
         end
       end
@@ -167,6 +188,24 @@ module Adyen
         end
       end
 
+      def social_security_number_partial
+        if @params[:social_security_number]
+          SOCIAL_SECURITY_NUMBER_PARTIAL % @params[:social_security_number]
+        end
+      end
+
+      def selected_brand_partial
+        if @params[:selected_brand]
+          SELECTED_BRAND_PARTIAL % @params[:selected_brand]
+        end
+      end
+
+      def delivery_date_partial
+        if @params[:delivery_date]
+          DELIVERY_DATE_PARTIAL % @params[:delivery_date]
+        end
+      end
+
       def shopper_partial
         @params[:shopper].map { |k, v| SHOPPER_PARTIALS[k] % v }.join("\n")
       end
@@ -176,6 +215,34 @@ module Adyen
         FRAUD_OFFSET_PARTIAL % @params[:fraud_offset]
       end
 
+      def capture_delay_partial(delay = 0)
+        CAPTURE_DELAY_PARTIAL % delay
+      end
+
+      class BilletResponse < Response
+        RECEIVED = "Received"
+
+        response_attrs :result_code, :billet_url, :psp_reference
+
+        def success?
+          super && params[:result_code] == RECEIVED
+        end
+
+        def params
+          @params ||= xml_querier.xpath('//payment:authoriseResponse/payment:paymentResult') do |result|
+            {
+              :psp_reference  => result.text('./payment:pspReference'),
+              :result_code    => result_code = result.text('./payment:resultCode'),
+              :billet_url     => (result_code == RECEIVED) ? result.children[0].children[0].children[1].text : ""
+            }
+          end
+        end
+
+        def invalid_request?
+          !fault_message.nil?
+        end
+      end
+
       class AuthorisationResponse < Response
         ERRORS = {
           "validation 101 Invalid card number"                           => [:number,       'is not a valid creditcard number'],

data/lib/adyen/api/recurring_service.rb

@@ -73,7 +73,7 @@ module Adyen
         content << card_partial unless @params[:card].nil?
         content << elv_partial  unless @params[:elv].nil?    
         raise ArgumentError, "The required parameter 'card' or 'elv' is missing." if content.empty?    
-        STORE_TOKEN_LAYOUT % [@params[:merchant_account], @params[:shopper][:reference], @params[:shopper][:email], content]
+        STORE_TOKEN_LAYOUT % [@params[:merchant_account], @params[:shopper][:reference], @params[:shopper][:email], content.join]
       end
 
       class DisableResponse < Response

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

@@ -59,12 +59,17 @@ module Adyen
         <payment: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>
+          %s
         </payment:card>
       EOXML
 
+      # @private
+      CARD_CVC_PARTIAL = <<-EOXML
+        <payment:cvc>%s</payment:cvc>
+      EOXML
+
       # @private
       ONE_CLICK_CARD_PARTIAL = <<-EOXML
         <payment:card>
@@ -79,6 +84,28 @@ module Adyen
         </payment:installments>
       EOXML
 
+      SOCIAL_SECURITY_NUMBER_PARTIAL = <<-EOXML
+        <payment:socialSecurityNumber>%s</payment:socialSecurityNumber>
+      EOXML
+
+     # @private
+      DELIVERY_DATE_PARTIAL = <<-EOXML
+        <deliveryDate xmlns="http://payment.services.adyen.com">%s</deliveryDate>
+      EOXML
+
+      # @private
+      SELECTED_BRAND_PARTIAL = <<-EOXML
+        <payment:selectedBrand>%s</payment:selectedBrand>
+      EOXML
+
+      # @private
+      SHOPPER_NAME_PARTIAL = <<-EOXML
+        <payment:shopperName>
+          <common:firstName>%s</common:firstName>
+          <common:lastName>%s</common:lastName>
+        </payment:shopperName>
+      EOXML
+
       # @private
       ENCRYPTED_CARD_PARTIAL = <<-EOXML
         <additionalAmount xmlns="http://payment.services.adyen.com" xsi:nil="true" />
@@ -124,6 +151,9 @@ module Adyen
 
       # @private
       FRAUD_OFFSET_PARTIAL = '<payment:fraudOffset>%s</payment:fraudOffset>'
+
+      # @private
+      CAPTURE_DELAY_PARTIAL = '<payment:captureDelayHours>%s</payment:captureDelayHours>'
     end
   end
 end

data/lib/adyen/api/xml_querier.rb

@@ -51,7 +51,7 @@ module Adyen
         end
 
         def perform_xpath(query, root_node)
-          REXML::XPath.match(root_node, query, NS)
+          REXML::XPath.match(root_node, query, NS)          
         end
 
         def stringify_nodeset(nodeset)

data/lib/adyen/form.rb

@@ -103,6 +103,7 @@ module Adyen
     # @return [Hash] The payment parameters with the +:merchant_signature+ parameter set.
     # @raise [ArgumentError] Thrown if some parameter health check fails.
     def payment_parameters(parameters = {}, shared_secret = nil)
+      raise ArgumentError, "Cannot generate form: parameters should be a hash!" unless parameters.is_a?(Hash)
       do_parameter_transformations!(parameters)
 
       raise ArgumentError, "Cannot generate form: :currency code attribute not found!"         unless parameters[:currency_code]
@@ -356,6 +357,8 @@ module Adyen
     #     using the {Adyen::Configuration#register_form_skin} method.
     # @return [true, false] Returns true only if the signature in the parameters is correct.
     def redirect_signature_check(params, shared_secret = nil)
+      raise ArgumentError, "params should be a Hash" unless params.is_a?(Hash)
+      raise ArgumentError, "params should contain :merchantSig" unless params.key?(:merchantSig)
       params[:merchantSig] == redirect_signature(params, shared_secret)
     end
 

data/lib/adyen/formatter.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Adyen
   module Formatter
     module DateTime
@@ -6,9 +8,11 @@ module Adyen
         case date
         when Date, DateTime, Time
           date.strftime('%Y-%m-%d')
-        else
-          raise "Invalid date notation: #{date.inspect}!" unless /^\d{4}-\d{2}-\d{2}$/ =~ date
+        when String
+          raise ArgumentError, "Invalid date notation: #{date.inspect}!" unless /^\d{4}-\d{2}-\d{2}$/ =~ date
           date
+        else
+          raise ArgumentError, "Cannot convert #{date.inspect} to date!"
         end
       end
 
@@ -17,9 +21,11 @@ module Adyen
         case time
         when Date, DateTime, Time
           time.strftime('%Y-%m-%dT%H:%M:%SZ')
-        else
-          raise "Invalid timestamp notation: #{time.inspect}!" unless /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}Z$/ =~ time
+        when String
+          raise ArgumentError, "Invalid timestamp notation: #{time.inspect}!" unless /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}Z$/ =~ time
           time
+        else
+          raise ArgumentError, "Cannot convert #{time.inspect} to timestamp!"
         end
       end
     end

data/lib/adyen/matchers.rb

@@ -21,7 +21,7 @@ module Adyen
 
         # Add a check for all the other fields specified
         checks.each do |key, value|
-          condition  = "descendant::input[@type='hidden'][@name='#{Adyen::Form.camelize(key)}']"
+          condition  = "\n  descendant::input[@type='hidden'][@name='#{Adyen::Form.camelize(key)}']"
           condition << "[@value='#{value}']" unless value == :anything
           xpath_query << "[#{condition}]"
         end
@@ -30,12 +30,9 @@ module Adyen
       end
 
       def self.check(subject, checks = {})
-        found = false
         document = Adyen::API::XMLQuerier.html(subject)
-        document.xpath(build_xpath_query(checks)) do |result|
-          found = true
-        end
-        return found
+        result = document.xpath(build_xpath_query(checks))
+        !result.empty?
       end
     end
 
@@ -91,6 +88,5 @@ module Adyen
       recurring_checks = { :recurring => false }
       assert_adyen_payment_form(subject, recurring_checks.merge(checks))
     end
-
   end
 end