adyen 1.6.0 → 2.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 455a933ae555a5bdef76141cf1b8ff4d7e44b383
-  data.tar.gz: a6f844a752ce6f69778bd9eba5bcfc86a935404c
+  metadata.gz: fd5a2022e170a6376459b9fa48062f85ac05ce97
+  data.tar.gz: dc37f35aa6a2265d467c5ae1dd3d6860cc959894
 SHA512:
-  metadata.gz: 997202692973d0ab546fca1ee3c343a1e0c7e7809b2f4a8d6cf7636bc34ced06b3d31bcfeae77339472483888d5b0db10a56f70c47a6ddffed49eb6f7c6b0ed5
-  data.tar.gz: b591907d17db7636db322d851c796c6ae6b2b247b3c8cac2fba8d4bee63aa940596469ff9946ce2f818467a4253c53572947381d2eb80994dcb9c61ba11ce399
+  metadata.gz: 6928bc0115a69ed05d2be6cd1deccce983bb3bcb53ff34a8e068505bc8d09b82930df245fc96c6e5bd058830e4a92f2f12df352724285b4bab5f7a3684bf11f2
+  data.tar.gz: bcc9cd8995fd9c299a71dcc20ec2415b87038bdf1b8d6eb05177303d1470e38f08ee1e72d54fb1dbbaa3813aa8839b67c3bbabd4f16f3eeba6bc5b73358378d7

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 script: bundle exec rake
 rvm:
 - 1.9.3
@@ -20,3 +21,4 @@ env:
   - ADYEN_MERCHANT_ACCOUNT: "VanBergenORG"
   - ADYEN_API_USERNAME: "ws@Company.VanBergen"
   - ADYEN_API_PASSWORD: "7phtHzbfnzsp"
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,116 @@
+# Changelog
+
+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
+
+- Add `Adyen::REST` to intereact with Adyen's webservices.
+- Add `Adyen::HPP` to integrate with Adyen's Hosted Payment Pages.
+- Make client-side encryption a first class citizen.
+- Add integration test suite that uses a functional example app.
+- Deprecate `Adyen::API` and `Adyen::Form`.
+- DOcumentation updates and improvements.
+
+#### Version 1.6.0
+
+- Make the credit card's CVC not required for authorise calls.
+- Add support for instant payments: authorise & capture in one call.
+- Add support for Billet payments.
+- Fix functional tests in CI, and move to Minitest for unit tests.
+
+#### Version 1.5.0
+
+- Drop support for Ruby 1.8.
+- Add support for SEPA Direct Debit payments
+- Add support for payment in installments.
+- Enable client-side encryption support to one click payments.
+- Add `Adyen::Form.payments_method_url`.
+- Parse additional data in authorisation responses.
+- Add support sending for shopper details as part of `Adyen::Form`.
+- Fixed some XML encoding issues on different Ruby versions.
+
+#### Version 1.4.1
+
+- Improve form matchers for testing
+- Fix some deprecation warnings
+
+#### Version 1.4.0
+
+- Add support for client-side encryption
+- Add support for `fraud_offset`.
+
+#### Version 1.3.2
+
+- Add support sending for billing details as part of `Adyen::Form`.
+- Allow setting a custom domain for the HPP payment flow.
+- Allow setting default parameters on a `Adyen::Form` skin.
+- Fix: recurring contracts without references.
+- Several improvement sin the notification handler template.
+
+#### Version 1.3.1
+
+- Allow sending a shipper's statement as part of the API.
+
+#### Version 1.3.0
+
+- Add support for ELV direct debit payments.
+- Improved error handling on SOAP errors.
+
+#### Version 1.2.0
+
+- Implemented the `RecurringService#store_token` API call to store credit cards for recurring billing.
+- Other fixes in recurring API dure to changes in Adyen backend.
+- Added some new parameters to the signature string calculations.
+- Add support for storing the HTTP basic authentication credentials Adyen uses for notifications in the configuration object. Note that this gem will currently never use these, but you can refer to them when building your integration, and store your configuration in one location.
+
+#### Version 1.1.0
+
+- Add support for different payment flows in the form-based mode.
+- Fixed some encoding issues.
+
+#### Version 1.0.0
+
+- Complete rewrite of the SOAP client.
+- Rails 3 integration for configuration and generators.
+- Removed all dependencies; Nokogiri and Rails 3 are optional.
+- Configuration variables are now integrated in `Adyen.configuration`.
+- Better documentation and improved testsuite.
+
+#### Version 0.3.2
+
+- Fixed Rails 3 ActiveRecord deprecation notice.
+- Implemented the `cancelOrRefund` call for the payment SOAP service as `Adyen::SOAP::PaymentService.cancel_or_refund`
+
+Thanks to [tibastral](https://github.com/tibastral) for implementing this SOAP call.
+
+#### Version 0.3.1
+
+- Implemented the `authorise` call for the payment SOAP service as `Adyen::SOAP::PaymentService.authorise`
+- Implemented the `disable` call for the recurring payment SOAP service as `Adyen::SOAP::RecurringService.disable`
+
+Thanks again to [Stefan Borsje](http://github.com/sborsje) for implementing the SOAP calls.
+
+#### Version 0.3.0
+
+- Switched to Yard for code documentation, which is served on [rdoc.info](http://rdoc.info/projects/wvanbergen/adyen)
+- Authentication now compatible with the latest *handsoap* version 1.1.4. Please update handsoap to this version.
+- Implemented the `listRecurringDetails` call for the recurring payment SOAP service as `Adyen::SOAP::RecurringService.list`
+
+Thanks to [Stefan Borsje](http://github.com/sborsje) for fixing handsoap authentication and implementing the SOAP call.
+
+#### Version  0.2.3
+
+- Implemented `Adyen.load_config` to load configuration values from a Hash or YAML file.
+
+#### Version 0.2.2
+
+- Fixed Curb HTTP backend to handle "101 Continue" responses correctly
+
+#### Version 0.2.1
+
+- Added `Adyen::Form.default_arguments` to store arguments that should be used in every payment form or redirect.
+
+#### Version 0.2.0
+
+- Switched to gemcutter.org for gem releases.
+- Added support for automatically handling skins and their shared secrets by registering them using `Adyen::Form.register_skin`

data/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing
+
+This projects welcomes outside contributions from anyone.
+
+## Reporting issues
+
+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
+  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
+  "010 Not allowed" response.
+- Feature request issues will be closed. This is a scratch your own itch project,
+  so implement it yourself and open a pull request to get it included.
+
+## Pull requests
+
+Pull requests are welcomed; this is very much a scratch your own itch project.
+Fork the project, implement your stuff and issue a pull request.
+
+Some notes:
+
+- Try to follow the coding style of the surrounding code.
+- We prefer to keep the number of dependencies of this library to 0. So we will
+  not accept new runtime dependencies.
+- All changes should be unit tested using Minitest. (Rspec is used only for some
+  of the deprecated functionality)
+- All changes should be documented using
+  [Yardoc](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md) notation.
+- All new functionality that requires interfacing with Adyen should either come with
+  a functional or integration test to prevent regressions.
+- It is possible that something that works with your own account, does not work with
+  the account we are using for CI (e.g. failure with "010 Not allowed". We may have
+  to ask Adyem to enable the functionality on our test account. Please let me know in
+  a PR comment.
+- `Adyen::API` and `Adyen::Form` are deprecated. Only bugfixes to these components
+  will be accepted. Use and improve `Adyen::REST` and `Adyen::HPP` instead, respectively.
+- **DO** add amn entry to [CHANGELOG.md](./CHANGELOG.md).
+- **DO NOT** update `Adyen::VERSION`. This will be done as part of the release process.
+
+### Become contributor
+
+If one of your pull request gets accepted, I will add you as a contributor if you wish.
+Once accepted, please be mindful that this project is used in production in several apps.
+So follow good engineering practices:
+
+- No backwards incompatible changes.
+- No pushing directly to master.
+- Ask for code reviews on larger changes.
+
+### Contributors
+
+- Willem van Bergen
+- Michel Barbosa
+- Stefan Borsje
+- Eloy Durán
+- Tobias Bielohlawek
+- Dimitri Sinitsa
+- Rinaldi Fonseca
+- Joost Hietbrink
+- Daryl Yeo
+- Washington Luiz
+- Lucas Húngaro
+- Richard Bone
+- Benjamin Waldher
+- Martin Beck
+- Paweł Gościcki
+- Priit Hamer
+- Eugene Pimenov
+- Michael Grosser
+- Lukasz Lazewski
+- Thibaut Assus
+- Vinicius Ferriani
+- Timo Rößner
+
+## Release process
+
+Use the following steps to release a new version of this gem.
+
+- Run `git co master && git pull origin master`
+- Update `Adyen::VERSION`
+- Move CHANGELOG items from "Unreleased" section to a new section for the chosen version number.
+- Run `bundle exec rake release`

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
-platform :rbx do 
+platform :rbx do
   gem 'rubysl'
   gem 'racc'
 end

data/README.md

@@ -0,0 +1,33 @@
+# Adyen [![Build Status](https://travis-ci.org/wvanbergen/adyen.svg?branch=master)](https://travis-ci.org/wvanbergen/adyen)
+
+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).
+- Server-to-Adyen communication using their REST webservice.
+- Adyen-to-server communications using notifications.
+
+This library aims to ease the implementation of all these modes into your Rack application. Moreover, it provides matchers, assertions and mocks to make it easier to implement an automated test suite to assert the integration is working correctly.
+
+### Usage
+
+- See the [project wiki](https://github.com/wvanbergen/adyen/wiki) to get started.
+- Check out [the example server](https://github.com/wvanbergen/adyen/blob/master/test/helpers/example_server.rb) for an example implementation of the HPP payment flow, and an implementation of self-hosted a payment flow that uses the REST webservice. To start the example server, run `bundle exec rackup` in the root of this project.
+- Complete RDoc documentation can be found on [rubydoc.info](http://www.rubydoc.info/gems/adyen).
+- For more information about Adyen, see http://www.adyen.com
+- For more information about integrating Adyen, see [their manuals](https://www.adyen.com/home/support/manuals.html). Of primary interest are the HPP integration manual for `Adyen::Form`, and the API integration manual for `Adyen::REST`.
+
+The library doesn't have any dependencies, but making Nokogiri available in your environment will greatly improve the speed of any XML and HTML processing.
+
+### About
+
+This package is written by Michel Barbosa and Willem van Bergen for Floorplanner.com, and
+made public under the MIT license (see LICENSE). It is currently maintained by Willem van
+Bergen, with help from several contributors. We are not affiliated with Adyen B.V. The software
+comes without warranty of any kind, so use at your own risk.
+
+- `CHANGELOG.md` documents the changes between releases.
+- Check out `CONTRIBUTING.md` if you want to help out with this project.

data/Rakefile

@@ -7,6 +7,21 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+Rake::TestTask.new('test:unit') do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+Rake::TestTask.new('test:functional') do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/functional/**/*_test.rb']
+end
+
+Rake::TestTask.new('test:integration') do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/integration/**/*_test.rb']
+end
+
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = "./spec/**/*_spec.rb"
   task.rspec_opts = ['--color']
@@ -22,10 +37,10 @@ task :update_cacert do
   cp tmp, CACERT_PATH
 end
 
-# Update the cacert.pem file before each release.
-task :build => :update_cacert do
-  sh "git diff-index --quiet HEAD #{CACERT_PATH} || (git add #{CACERT_PATH} && git commit -m '[API] Update CA root certificates file.')"
-end
+# # Update the cacert.pem file before each release.
+# task :build => :update_cacert do
+#   sh "git diff-index --quiet HEAD #{CACERT_PATH} || (git add #{CACERT_PATH} && git commit -m '[API] Update CA root certificates file.')"
+# end
 
 begin
   require 'rubygems'

data/adyen.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.summary = "Integrate Adyen payment services in your Ruby on Rails application."
   s.description = <<-EOS
     Package to simplify including the Adyen payments services into a Ruby on Rails application.
-    The package provides functionality to create payment forms, handling and storing notifications 
+    The package provides functionality to create payment forms, handling and storing notifications
     sent by Adyen and consuming the SOAP services provided by Adyen. Moreover, it contains helper
     methods, mocks and matchers to simpify writing tests/specs for your code.
   EOS
@@ -27,14 +27,16 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 2.14')
   s.add_development_dependency('minitest', '~> 5')
   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.requirements << 'Having Nokogiri installed will speed up XML handling when using the SOAP API.'
 
-  s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
-  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options << '--title' << s.name << '--main' << 'README.md' << '--line-numbers' << '--inline-source'
+  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)/})

data/config.ru

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../test', __FILE__))
+
+require 'helpers/example_server'
+run Adyen::ExampleServer.new

data/lib/adyen.rb

@@ -21,9 +21,9 @@ end
 
 require 'adyen/version'
 require 'adyen/configuration'
-require 'adyen/encoding'
-require 'adyen/formatter'
+require 'adyen/util'
 require 'adyen/form'
 require 'adyen/api'
+require 'adyen/rest'
 
 require 'adyen/railtie' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3

data/lib/adyen/configuration.rb

@@ -79,6 +79,12 @@ class Adyen::Configuration
   # @return [Hash]
   attr_accessor :default_api_params
 
+  # The client-side encryption public key that is used to encrypt payment forms. 
+  # You can find the key on the webservice user page in the Adyen settings.
+  #
+  # @return [String]
+  attr_accessor :cse_public_key
+
   # Default arguments that will be used for in every HTML form.
   #
   # @example

data/lib/adyen/form.rb

@@ -86,9 +86,9 @@ module Adyen
       end
 
       parameters[:recurring_contract] = 'RECURRING' if parameters.delete(:recurring) == true
-      parameters[:order_data]         = Adyen::Encoding.gzip_base64(parameters.delete(:order_data_raw)) if parameters[:order_data_raw]
-      parameters[:ship_before_date]   = Adyen::Formatter::DateTime.fmt_date(parameters[:ship_before_date])
-      parameters[:session_validity]   = Adyen::Formatter::DateTime.fmt_time(parameters[:session_validity])
+      parameters[:order_data]         = Adyen::Util.gzip_base64(parameters.delete(:order_data_raw)) if parameters[:order_data_raw]
+      parameters[:ship_before_date]   = Adyen::Util.format_date(parameters[:ship_before_date])
+      parameters[:session_validity]   = Adyen::Util.format_timestamp(parameters[:session_validity])
     end
 
     # Transforms the payment parameters to be in the correct format and calculates the merchant
@@ -133,7 +133,7 @@ module Adyen
     #    {Adyen::Configuration#default_form_params} hash will be included automatically.
     # @return [Hash] The payment parameters flatten, with camelized and prefixed key, stringified value
     def flat_payment_parameters(parameters = {})
-      flatten(payment_parameters(parameters))
+      Adyen::Util.flatten(payment_parameters(parameters))
     end
 
     # Returns an absolute URL to the Adyen payment system, with the payment parameters included
@@ -252,7 +252,7 @@ module Adyen
     def calculate_signature(parameters, shared_secret = nil)
       shared_secret ||= parameters.delete(:shared_secret)
       raise ArgumentError, "Cannot calculate payment request signature with empty shared_secret" if shared_secret.to_s.empty?
-      Adyen::Encoding.hmac_base64(shared_secret, calculate_signature_string(parameters))
+      Adyen::Util.hmac_base64(shared_secret, calculate_signature_string(parameters))
     end
 
     # Generates the string that is used to calculate the request signature. This signature
@@ -282,7 +282,7 @@ module Adyen
     def calculate_billing_address_signature(parameters, shared_secret = nil)
       shared_secret ||= parameters.delete(:shared_secret)
       raise ArgumentError, "Cannot calculate billing address request signature with empty shared_secret" if shared_secret.to_s.empty?
-      Adyen::Encoding.hmac_base64(shared_secret, calculate_billing_address_signature_string(parameters[:billing_address]))
+      Adyen::Util.hmac_base64(shared_secret, calculate_billing_address_signature_string(parameters[:billing_address]))
     end
 
     # shopperSig: shopper.firstName + shopper.infix + shopper.lastName + shopper.gender + shopper.dateOfBirthDayOfMonth + shopper.dateOfBirthMonth + shopper.dateOfBirthYear + shopper.telephoneNumber
@@ -296,7 +296,7 @@ module Adyen
     def calculate_shopper_signature(parameters, shared_secret = nil)
       shared_secret ||= parameters.delete(:shared_secret)
       raise ArgumentError, "Cannot calculate shopper request signature with empty shared_secret" if shared_secret.to_s.empty?
-      Adyen::Encoding.hmac_base64(shared_secret, calculate_shopper_signature_string(parameters[:shopper]))
+      Adyen::Util.hmac_base64(shared_secret, calculate_shopper_signature_string(parameters[:shopper]))
     end
 
     ######################################################
@@ -307,8 +307,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[:merchantReturnData].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
@@ -321,9 +321,9 @@ module Adyen
     # @return [String] The redirect signature
     # @raise [ArgumentError] Thrown if shared_secret is empty
     def redirect_signature(params, shared_secret = nil)
-      shared_secret ||= Adyen.configuration.form_skin_shared_secret_by_code(params[:skinCode])
+      shared_secret ||= Adyen.configuration.form_skin_shared_secret_by_code(params['skinCode'])
       raise ArgumentError, "Cannot compute redirect signature with empty shared_secret" if shared_secret.to_s.empty?
-      Adyen::Encoding.hmac_base64(shared_secret, redirect_signature_string(params))
+      Adyen::Util.hmac_base64(shared_secret, redirect_signature_string(params))
     end
 
     # Checks the redirect signature for this request by calcultating the signature from
@@ -358,43 +358,8 @@ module Adyen
     # @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
-
-    # Returns the camelized version of a string.
-    # @param [:to_s] identifier The identifier to turn to camelcase
-    # @return [String] The camelcase version of the identifier provided.
-    def camelize(identifier)
-      identifier.to_s.gsub(/_(.)/) { $1.upcase }
-    end
-
-    # Transforms the nested parameters Hash into a 'flat' Hash which is understood by adyen. This is:
-    #  * all keys are camelized
-    #  * all keys are  stringified
-    #  * nested hash is flattened, keys are prefixed with root key
-    #
-    # @example
-    #    flatten {:billing_address => { :street => 'My Street'}}
-    #
-    #    # resolves in:
-    #    {'billingAddress.street' =>  'My Street'}
-    #
-    # @param [Hash] parameters The payment parameters which to transform
-    # @param [String] prefix The prefix to add to the key
-    # @param [Hash] return_hash The new hash which is retruned (needed for recursive calls)
-    # @return [Hash] The return_hash filled with camelized and prefixed key, stringified value
-    def flatten(parameters, prefix = "", return_hash = {})
-      parameters ||= {}
-      parameters.inject(return_hash) do |hash, (key, value)|
-        key = "#{prefix}#{camelize(key)}"
-        if value.is_a?(Hash)
-          flatten(value, "#{key}.", return_hash)
-        else
-          hash[key] = value.to_s
-        end
-        hash
-      end
+      raise ArgumentError, "params should contain :merchantSig" unless params.key?('merchantSig')
+      params['merchantSig'] == redirect_signature(params, shared_secret)
     end
   end
 end