adyen 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79d7e1124e75e3e161c514b3d4fe8eab7058bec4
-  data.tar.gz: 97a72df3756f9d5ab4385b17f9db517c0c67d762
+  metadata.gz: f8ef547799ff5fa479e0adb223c8e325b394e064
+  data.tar.gz: 964b4e93c00f7448a073aa9423497713ee480dfd
 SHA512:
-  metadata.gz: 870d40ed54714492339b6945c61acf0069d4d90a82e547e8b0c0fc69075e49b2c568b0ab25504e8efdddb7a61126fe4934c776e2003340279970167ad987f46b
-  data.tar.gz: 61da208663797528ecd1c8e2beaf1fd9c3bf895dead0a13833bf27b4114880a799ece1e1fb84dc77356e937fcf01a34817506c2f665099e8f32c88d2ad882ebf
+  metadata.gz: 6c0d7a296dd0697404034dbc655a7b53fb1e3cba9443fe6a821203db33fe307ec4b21b58b1196c853d486eec05b8bf6d15c5f9152078a939d5fca0779664b010
+  data.tar.gz: 62422891b4307c4b6e1a872cfe17223bb323c1163df1ce47920f77bd0990ce4432fd5189ad9e55463dcd10a99d769956c1f4a3f0114134b6c2b80d6322ff1210

data/.gitignore

@@ -10,5 +10,6 @@ adyen-*.gem
 *.swo
 .DS_Store
 t.rb
-spec/functional/initializer.rb
+test/functional/initializer.rb
 Gemfile.lock
+.ruby-*

data/.travis.yml

@@ -1,30 +1,37 @@
+sudo: false
+dist: trusty
 language: ruby
 cache: bundler
-script: bundle exec rake
 rvm:
 - "2.0"
 - "2.1"
 - "2.2"
 - "2.3.1"
+- "2.4.1"
 - "jruby-9.0"
+- "jruby-9.1"
 - "ruby-head"
-- "rbx-2"
+- "rubinius-3"
 - "jruby-head"
 matrix:
   allow_failures:
   - rvm: jruby-head
   - rvm: ruby-head
-  - rvm: rbx-2
+  - rvm: rubinius-3
+
 before_install:
   - bundle --version || gem install bundler
+  - gem update bundler
 before_script:
-- cp spec/functional/initializer.rb.ci spec/functional/initializer.rb
+- cp test/functional/initializer.rb.ci test/functional/initializer.rb
+script: bundle exec rake
+
 env:
   global:
   - ADYEN_MERCHANT_ACCOUNT: "VanBergenORG"
   - ADYEN_API_USERNAME: "ws@Company.VanBergen"
   - ADYEN_API_PASSWORD: "7phtHzbfnzsp"
-sudo: false
+
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -2,9 +2,12 @@
 
 The following changes have been made to the library over the years. Pleae add an entry to this file as part of your pull requests.
 
-#### Unrelease changes
+#### Version 2.3.0
 
-Nothing yet!
+- Add `shopper_statement` option to `Adyen::APP`, allowing to generate Billets with custom payment instructions.
+- Make sure the unique index created by the notification model generator includes `merchant_account_code`
+- Make refusal_reson availble as a response field for failed requests.
+- Updates to the testing in frastructure
 
 #### Version 2.2.0
 

data/CONTRIBUTING.md

@@ -6,7 +6,7 @@ This projects welcomes outside contributions from anyone.
 
 Please report bugs as a [Github issue](https://github.com/wvanbergen/adyen/issues/new).
 
-- We are not associated with Adyen. Please contact Adyen youself if you are having
+- We are not associated with Adyen. Please contact Adyen yourself if you are having
   trouble with your integration.
 - This library supports several features that are not supported by default on a new
   Adyen account. You may have to contact Adyen if you are receiving a

data/Gemfile

@@ -1,6 +1,10 @@
 source 'https://rubygems.org'
 gemspec
 
+ruby RUBY_VERSION
+
+gem 'pry'
+
 platform :rbx do
   gem 'rubysl'
   gem 'racc'

data/README.md

@@ -2,8 +2,6 @@
 
 Package to simplify including Adyen payments services into a Ruby on Rails application.
 
-> Note: this library is corrently undergoing a major rewrite. Information in this README is about the still unreleased version of this library. If you want information about the last released version, check out version [1.6.0](https://github.com/wvanbergen/adyen/tree/v1.6.0).
-
 Adyen integration relies on three modes of communication between Adyen, your server and your client/customer:
 
 - Client-to-Adyen communication using Hosted Payment Pages (HPP).

data/Rakefile

@@ -1,5 +1,4 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 require "rake/testtask"
 
 namespace(:test) do
@@ -12,7 +11,7 @@ namespace(:test) do
   Rake::TestTask.new(:unit) do |t|
     t.description = "Run unit tests"
     t.libs << "test"
-    t.test_files = FileList['test/*_test.rb']
+    t.test_files = FileList['test/unit/**/*_test.rb']
   end
 
   Rake::TestTask.new(:functional) do |t|
@@ -31,11 +30,6 @@ end
 desc "Run unit and functional tests"
 task :test => %w{test:unit test:functional}
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = "./spec/**/*_spec.rb"
-  task.rspec_opts = ['--color']
-end
-
 CACERT_PATH = 'lib/adyen/api/cacert.pem'
 
 desc 'Update CA root certificates for the simple SOAP client'
@@ -51,4 +45,4 @@ end
 #   sh "git diff-index --quiet HEAD #{CACERT_PATH} || (git add #{CACERT_PATH} && git commit -m '[API] Update CA root certificates file.')"
 # end
 
-task :default => %w{test spec}
+task :default => %w{test}

data/adyen.gemspec

@@ -24,14 +24,13 @@ Gem::Specification.new do |s|
   s.license  = 'MIT'
 
   s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', '~> 2.14')
-  s.add_development_dependency('minitest', '~> 5')
+  s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('mocha')
   s.add_development_dependency('sinatra')
   s.add_development_dependency('poltergeist')
 
-  s.add_development_dependency('rails', '>= 3.2')
-  s.add_development_dependency('nokogiri', '>= 1.6.1')
+  s.add_development_dependency('railties', '>= 3.2', '< 5.2')
+  s.add_development_dependency('nokogiri', '>= 1.6.8')
 
   s.requirements << 'Having Nokogiri installed will speed up XML handling when using the SOAP API.'
 
@@ -39,5 +38,5 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'CHANGELOG.md', 'CONTRIBUTING.md']
 
   s.files = `git ls-files`.split($/)
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.test_files = s.files.grep(%r{^test/})
 end

data/lib/adyen/api.rb

@@ -49,7 +49,7 @@ module Adyen
   module API
     extend self
 
-    # Generate a Billet - *Brazian users only*
+    # Generate a Billet - *Brazillian 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
@@ -66,17 +66,20 @@ module Adyen
     #     { currency: "BRL", value: (invoice.amount).to_i },
     #     { first_name: "Simon", last_name: "Hopper" },
     #     document_number,
-    #     selected_brand
+    #     selected_brand,
+    #     "2016-10-29T23:00:00.000Z",
+    #     "Please send payment email to payment@example.com after payment."
     #   )
     #   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
+    # @param          [Numeric,String] reference          Your reference (ID) for this payment.
+    # @param          [Hash]           amount             A hash describing the money to charge.
+    # @param          [Hash]           shopper_name       A hash describing the shopper.
+    # @param          [String]         document_number    Social Security number (CPF in Brazil)
+    # @param          [String]         selected_brand     Billet brand
+    # @param          [String]         delivery_date      Payment date limit in ISO8601 format
+    # @param optional [String]         shopper_statement  Payment instructions to Shopper
     #
     # @option amount  [String]         :currency      The ISO currency code (EUR, GBP, USD, etc).
     # @option amount  [Integer]        :value         The value of the payment in discrete cents,
@@ -88,13 +91,14 @@ module Adyen
     #
     # @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)
+    def generate_billet(reference, amount, shopper_name, social_security_number, selected_brand, delivery_date, shopper_statement = nil)
       params = { :reference              => reference,
                  :amount                 => amount,
                  :shopper_name           => shopper_name,
                  :social_security_number => social_security_number,
                  :selected_brand         => selected_brand,
-                 :delivery_date          => delivery_date }
+                 :delivery_date          => delivery_date,
+                 :shopper_statement      => shopper_statement }
       PaymentService.new(params).generate_billet
     end
 

data/lib/adyen/api/payment_service.rb

@@ -126,6 +126,7 @@ module Adyen
         content << shopper_name_partial if @params[:shopper_name]
         content << delivery_date_partial if @params[:delivery_date]
         content << selected_brand_partial if @params[:selected_brand]
+        content << shopper_statement_partial if @params[:shopper_statement]
         LAYOUT % [@params[:merchant_account], @params[:reference], content]
       end
 
@@ -210,6 +211,12 @@ module Adyen
         @params[:shopper].map { |k, v| SHOPPER_PARTIALS[k] % v }.join("\n")
       end
 
+      def shopper_statement_partial
+        if @params[:shopper_statement]
+          SHOPPER_STATEMENT % @params[:shopper_statement]
+        end
+      end
+
       def fraud_offset_partial
         validate_parameters!(:fraud_offset)
         FRAUD_OFFSET_PARTIAL % @params[:fraud_offset]
@@ -222,7 +229,9 @@ module Adyen
       class BilletResponse < Response
         RECEIVED = "Received"
 
-        response_attrs :result_code, :billet_url, :psp_reference
+        response_attrs :result_code, :billet_url, :psp_reference,
+                       :barcode, :due_date, :expiration_date,
+                       :refusal_reason
 
         def success?
           super && params[:result_code] == RECEIVED
@@ -230,10 +239,24 @@ module Adyen
 
         def params
           @params ||= xml_querier.xpath('//payment:authoriseResponse/payment:paymentResult') do |result|
+            result_code = result.text('./payment:resultCode')
+            attributes = Hash.new('')
+
+            if result_code == RECEIVED
+              attributes = result.children[0].children.map do |child|
+                { child.children[0].text => child.children[1].text }
+              end
+              attributes = attributes.reduce({}, :merge)
+            end
+
             {
-              :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 : ""
+              :psp_reference   => result.text('./payment:pspReference'),
+              :result_code     => result_code,
+              :billet_url      => attributes['boletobancario.url'],
+              :barcode         => attributes['boletobancario.barCodeReference'],
+              :due_date        => convert_to_date(attributes['boletobancario.dueDate']),
+              :expiration_date => convert_to_date(attributes['boletobancario.expirationDate']),
+              :refusal_reason => (invalid_request? ? fault_message : result.text('./payment:refusalReason'))
             }
           end
         end
@@ -241,6 +264,14 @@ module Adyen
         def invalid_request?
           !fault_message.nil?
         end
+
+        private
+
+        def convert_to_date(value)
+          Date.parse(value)
+        rescue ArgumentError
+          nil
+        end
       end
 
       class AuthorisationResponse < Response

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

@@ -106,6 +106,11 @@ module Adyen
         </payment:shopperName>
       EOXML
 
+      # @private
+      SHOPPER_STATEMENT = <<-EOXML
+        <payment:shopperStatement>%s</payment:shopperStatement>
+      EOXML
+
       # @private
       ENCRYPTED_CARD_PARTIAL = <<-EOXML
         <additionalAmount xmlns="http://payment.services.adyen.com" xsi:nil="true" />

data/lib/adyen/form.rb

@@ -47,7 +47,7 @@ module Adyen
     # @see Adyen::Form.redirect_url
     def domain(environment = nil)
       environment  ||= Adyen.configuration.environment
-      (Adyen.configuration.payment_flow_domain || ACTION_DOMAIN) % [environment.to_s]
+      Adyen.configuration.payment_flow_domain || ACTION_DOMAIN % [environment.to_s]
     end
 
     # Returns the URL of the Adyen payment system, adjusted for an Adyen environment.

data/lib/adyen/hpp/request.rb

@@ -1,4 +1,5 @@
 require 'adyen/hpp/signature'
+require 'adyen/util'
 require 'cgi'
 
 module Adyen
@@ -8,6 +9,8 @@ module Adyen
       attr_accessor :parameters
       attr_writer :skin, :environment, :shared_secret
 
+      MANDATORY_ATTRIBUTES = %i(currency_code payment_amount merchant_account skin_code ship_before_date session_validity).freeze
+
       # Initialize the HPP request
       #
       # @param [Hash] parameters The payment parameters
@@ -52,7 +55,7 @@ module Adyen
       #    for payment forms or redirects.
       # @see Adyen::HPP::Request.redirect_url
       def domain
-        (Adyen.configuration.payment_flow_domain || HPP_DOMAIN) % [environment.to_s]
+        Adyen.configuration.payment_flow_domain || HPP_DOMAIN % [environment.to_s]
       end
 
       # Returns the URL of the Adyen payment system, adjusted for an Adyen environment.
@@ -87,10 +90,9 @@ module Adyen
         end
         formatted_parameters = default_form_parameters.merge(formatted_parameters)
 
-        raise ArgumentError, "Cannot generate request: :currency code attribute not found!"         unless formatted_parameters[:currency_code]
-        raise ArgumentError, "Cannot generate request: :payment_amount code attribute not found!"   unless formatted_parameters[:payment_amount]
-        raise ArgumentError, "Cannot generate request: :merchant_account attribute not found!"      unless formatted_parameters[:merchant_account]
-        raise ArgumentError, "Cannot generate request: :skin_code attribute not found!"             unless formatted_parameters[:skin_code]
+        MANDATORY_ATTRIBUTES.each do |attribute|
+          raise ArgumentError, "Cannot generate request: :#{attribute} attribute not found!" unless formatted_parameters[attribute]
+        end
 
         formatted_parameters[:recurring_contract] = 'RECURRING' if formatted_parameters.delete(:recurring) == true
         formatted_parameters[:order_data]         = Adyen::Util.gzip_base64(formatted_parameters.delete(:order_data_raw)) if formatted_parameters[:order_data_raw]
@@ -189,4 +191,4 @@ module Adyen
       end
     end
   end
-end
+end

data/lib/adyen/rest.rb

@@ -9,7 +9,11 @@ module Adyen
   # The primary method here is {Adyen::REST.session}, which will yield a
   # {Adyen::REST::Client} which you can use to send API requests.
   #
-  # @example
+  # If you need more than one client instance, for instance because you
+  # have multiple acounts set up with different permissions, you can instantiate
+  # clients yourself using {Adyen::REST::Client.new}
+  #
+  # @example Using the singleton Client instance
   #
   #     Adyen::REST.session do |client|
   #       client.http.read_timeout = 5
@@ -17,14 +21,26 @@ module Adyen
   #       # ...
   #     end
   #
+  # @example Using a your own Client instance
+  #
+  #     Adyen::REST::Client.new('test', 'username', 'password').session do |client|
+  #       client.http.read_timeout = 5
+  #       response = client.api_request(...)
+  #       # ...
+  #     end
+  #
+  #
   # @see Adyen::REST.session Use Adyen::REST.session to run code against the API.
   # @see Adyen::REST::Client Adyen::REST::Client implements the actual API calls.
   module REST
 
-    # Provides a REST API client this is configured using the values in <tt>Adyen.configuration</tt>.
+    # Provides a singelton REST API client this is configured using the values in
+    # <tt>Adyen.configuration</tt>.
+    #
     # @param options [Hash] (see Adyen::REST::Client#initialize)
     # @return [Adyen::REST::Client] A configured client instance
     # @see .session
+    # @see Adyen::REST::Client.new To instantiate Clients yourself, in case you need more than one.
     def self.client
       Adyen::REST::Client.new(
         Adyen.configuration.environment,
@@ -43,12 +59,9 @@ module Adyen
     #   the provided client. The client will be closed after the block returns.
     # @yieldparam client [Adyen::REST::Client] The REST client to use for the session.
     # @return [void]
-    # @see Adyen::REST::Client
-    def self.session(client = nil)
-      client ||= self.client
-      yield(client)
-    ensure
-      client.close
+    # @see Adyen::REST::Client#session
+    def self.session(client = self.client, &block)
+      client.session(&block)
     end
   end
 end

data/lib/adyen/rest/client.rb

@@ -42,6 +42,19 @@ module Adyen
         @http = nil
       end
 
+      # Runs a client session against the Adyen REST service for the duration of the block,
+      # and closes the connection afterwards.
+      #
+      # @yield The provided block will be called in which you can interact with the API using
+      #   the provided client. The client will be closed after the block returns.
+      # @return [void]
+      def session
+        yield(self)
+      ensure
+        close
+      end
+
+
       # The underlying <tt>Net::HTTP</tt> instance that is used to execute HTTP
       # request against the API.
       #

data/lib/adyen/templates/notification_migration.rb

@@ -20,7 +20,7 @@ class CreateAdyenNotifications < ActiveRecord::Migration
       t.timestamps
     end
      
-    add_index :adyen_notifications, [:psp_reference, :event_code, :success], :unique => true, :name => 'adyen_notification_uniqueness'
+    add_index :adyen_notifications, [:merchant_account_code, :psp_reference, :event_code, :success], :unique => true, :name => 'adyen_notification_uniqueness'
   end
 
   def self.down