fingertips-adyen 0.3.7.20100917

data/.gitignore

@@ -0,0 +1,8 @@
+/tmp
+/pkg
+/doc
+adyen-*.gem
+.yardoc
+*.swp
+.DS_Store
+spec/functional/initializer.rb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 - 2009 Willem van Bergen and Michel Barbosa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Adyen
+
+Package to simplify including the Adyen payments services into a Ruby on Rails application.
+
+Adyen integration relies on three modes of communication between Adyen, your server and
+your client/customer:
+
+* Client-to-Adyen communication using forms and redirects.
+* Adyen-to-server communications using notifications.
+* Server-to-Adyen communication using SOAP services.
+
+This library aims to ease the implementation of all these modes into your 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.
+
+== Installation
+
+Add the following line to your <tt>environment.rb</tt> and run <tt>rake gems:install</tt>
+to make the Adyen functionality available in your Rails project:
+
+    config.gem 'adyen', :source => 'http://gemcutter.org
+
+You can also install it as a Rails plugin (*deprecated*):
+
+    script/plugin install git://github.com/wvanbergen/adyen.git
+
+== Usage
+
+See the project wiki on http://wiki.github.com/wvanbergen/adyen to get started. Complete
+RDoc documentation for the project can be found on http://rdoc.info/projects/wvanbergen/adyen.
+
+* For more information about Adyen, see http://www.adyen.com
+* For more information about integrating Adyen, see their manuals at
+  http://support.adyen.com/links/documentation
+
+== 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 comes without warranty of any kind, so
+use at your own risk.

data/Rakefile

@@ -0,0 +1,5 @@
+Dir[File.dirname(__FILE__) + "/tasks/*.rake"].each { |file| load(file) }
+
+GithubGem::RakeTasks.new(:gem)
+
+task :default => "spec:specdoc"

data/adyen.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name    = 'fingertips-adyen'
+  s.version = "0.3.7.20100917"
+  s.date    = "2010-07-21"
+
+  s.summary = "Integrate Adyen payment services in you 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 
+    sent by Adyen and consuming the SOAP services provided by Adyen. Moreover, it contains helper
+    methods, mocks and matchers to simpify writing tests/specsfor your code.
+  EOS
+
+  s.authors  = ['Willem van Bergen', 'Michel Barbosa', 'Eloy Duran']
+  s.email    = ['willem@vanbergen.org', 'cicaboo@gmail.com', 'eloy.de.enige@gmail.com']
+  s.homepage = 'http://wiki.github.com/wvanbergen/adyen'
+
+  s.add_development_dependency('rspec', '>= 1.1.4')
+  s.add_development_dependency('git', '>= 1.1.0')
+
+  s.requirements << 'Handsoap is required for accessing the SOAP services. See http://github.com/troelskn/handsoap.'
+  s.requirements << 'LibXML is required for using the RSpec matchers.'
+  s.requirements << 'ActiveRecord is required for storing the notifications in your database.'
+
+  s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
+  s.extra_rdoc_files = ['README.rdoc']
+
+  s.files = %w(spec/spec_helper.rb spec/adyen_spec.rb lib/adyen/form.rb .gitignore spec/notification_spec.rb lib/adyen/api.rb LICENSE spec/api_spec.rb init.rb adyen.gemspec Rakefile spec/form_spec.rb README.rdoc lib/adyen/notification.rb lib/adyen/formatter.rb tasks/github-gem.rake lib/adyen/encoding.rb lib/adyen/matchers.rb lib/adyen.rb)
+  s.test_files = %w(spec/adyen_spec.rb spec/notification_spec.rb spec/api_spec.rb spec/form_spec.rb)
+end

data/init.rb

@@ -0,0 +1 @@
+require 'adyen'

data/lib/adyen.rb

@@ -0,0 +1,77 @@
+# The Adyen module is the container module for all Adyen related functionality, 
+# which is implemented in submodules. This module only contains some global 
+# configuration methods.
+#
+# The most important submodules are:
+# * {Adyen::Form} for generating payment form fields, generating redirect URLs 
+#   to the Adyen payment system, and generating and checking of signatures.
+# * {Adyen::Notification} for handling notifications sent by Adyen to your servers.
+# * {Adyen::SOAP} for communicating with the Adyen SOAP services for payment
+#   maintenance and issuing recurring payments.
+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 = "0.3.7.20100917"
+
+  # Loads configuration settings from a Hash.
+  #
+  # @param [Hash] hash The (nested Hash) with configuration variables.
+  # @param [Module] mod The current working module. This parameter is used
+  #    to recursively traverse the hash for submodules.
+  # @raise [StandardError] An exception is raised of an unkown configuration 
+  #    setting is encountered in the hash.
+  def self.load_config(hash, mod = Adyen)
+    hash.each do |key, value|
+      if key.to_s =~ /^[a-z]/ && mod.respond_to?(:"#{key}=")
+        mod.send(:"#{key}=", value)
+      elsif key.to_s =~ /^[A-Z]/
+        self.load_config(value, mod.const_get(key))
+      else
+        raise "Unknown configuration variable: '#{key}' for #{mod}"
+      end
+    end
+  end
+
+  # The Rails environment for which to use to Adyen "live" environment.
+  LIVE_RAILS_ENVIRONMENTS = ['production']
+
+  # Setter voor the current Adyen environment.
+  # @param ['test', 'live'] env The Adyen environment to use
+  def self.environment=(env)
+    @environment = env
+  end
+
+  # Returns the current Adyen environment, either test or live.
+  #
+  # It will return the +override+ value if set, it will return the value set
+  # using {Adyen.environment=} otherwise. If this value also isn't set, the
+  # environment is determined with {Adyen.autodetect_environment}.
+  #
+  # @param ['test', 'live'] override An environment to override the default with.
+  # @return ['test', 'live'] The Adyen environment that is currently being used.
+  def self.environment(override = nil)
+    override || @environment || Adyen.autodetect_environment
+  end
+
+  # Autodetects the Adyen environment based on the RAILS_ENV constant.
+  # @return ['test', 'live'] The Adyen environment that corresponds to the Rails environment
+  def self.autodetect_environment
+    (defined?(RAILS_ENV) && Adyen::LIVE_RAILS_ENVIRONMENTS.include?(RAILS_ENV.to_s.downcase)) ? 'live' : 'test'
+  end
+
+  # Loads submodules on demand, so that dependencies are not required.
+  # @param [Symbol] sym The name of the submodule
+  # @return [Module] The actual loaded submodule.
+  # @raise [LoadError, NameError] If the submodule cannot be loaded
+  def self.const_missing(sym)
+    require "adyen/#{sym.to_s.downcase}"
+    return Adyen.const_get(sym)
+  rescue Exception
+    super(sym)
+  end
+end
+
+require 'adyen/encoding'
+require 'adyen/formatter'

data/lib/adyen/api.rb

@@ -0,0 +1,343 @@
+require "net/https"
+
+module Adyen
+  module API
+    class << self
+      # Username for the HTTP Basic Authentication that Adyen uses. Your username
+      # should be something like +ws@Company.MyAccount+
+      # @return [String]
+      attr_accessor :username
+
+      # Password for the HTTP Basic Authentication that Adyen uses. You can choose
+      # your password yourself in the user management tool of the merchant area.
+      # @return [String] 
+      attr_accessor :password
+
+      attr_accessor :default_params
+    end
+
+    self.default_params = {}
+
+    #
+    # Shortcut methods
+    #
+
+    def self.authorise_payment(params = {})
+      PaymentService.new(params).authorise_payment
+    end
+
+    def self.authorise_recurring_payment(params = {})
+      PaymentService.new(params).authorise_recurring_payment
+    end
+
+    # TODO: the rest
+
+    #
+    # The actual classes
+    #
+
+    class SimpleSOAPClient
+      # from http://curl.haxx.se/ca/cacert.pem
+      CACERT = File.expand_path('../../../support/cacert.pem', __FILE__)
+
+      def self.endpoint
+        @endpoint ||= URI.parse(const_get('ENDPOINT_URI') % Adyen.environment)
+      end
+
+      attr_reader :params
+
+      def initialize(params = {})
+        @params = API.default_params.merge(params)
+      end
+
+      def call_webservice_action(action, data)
+        endpoint = self.class.endpoint
+
+        post = Net::HTTP::Post.new(endpoint.path, 'Accept' => 'text/xml', 'Content-Type' => 'text/xml; charset=utf-8', 'SOAPAction' => action)
+        post.basic_auth(API.username, API.password)
+        post.body = data
+
+        request = Net::HTTP.new(endpoint.host, endpoint.port)
+        request.use_ssl = true
+        request.ca_file = CACERT
+        request.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+        request.start do |http|
+          response = http.request(post)
+          # TODO: handle not 2xx responses
+          #p response
+          XMLQuerier.new(response.body)
+        end
+      end
+    end
+
+    class PaymentService < SimpleSOAPClient
+      ENDPOINT_URI = 'https://pal-%s.adyen.com/pal/servlet/soap/Payment'
+
+      def authorise_payment
+        make_payment_request(authorise_payment_request_body)
+      end
+
+      def authorise_recurring_payment
+        make_payment_request(authorise_recurring_payment_request_body)
+      end
+
+      private
+
+      def make_payment_request(data)
+        response = call_webservice_action('authorise', data)
+        response.xpath('//payment:authoriseResponse/payment:paymentResult') do |result|
+          {
+            :psp_reference  => result.text('./payment:pspReference'),
+            :result_code    => result.text('./payment:resultCode'),
+            :auth_code      => result.text('./payment:authCode'),
+            :refusal_reason => result.text('./payment:refusalReason')
+          }
+        end
+      end
+
+      def authorise_payment_request_body
+        content = card_partial
+        content << RECURRING_PARTIAL if @params[:recurring]
+        payment_request_body(content)
+      end
+
+      def authorise_recurring_payment_request_body
+        content = RECURRING_PAYMENT_BODY_PARTIAL % (@params[:recurring_detail_reference] || 'LATEST')
+        payment_request_body(content)
+      end
+
+      def payment_request_body(content)
+        content << amount_partial
+        content << shopper_partial if @params[:shopper]
+        LAYOUT % [@params[:merchant_account], @params[:reference], content]
+      end
+
+      def amount_partial
+        AMOUNT_PARTIAL % @params[:amount].values_at(:currency, :value)
+      end
+
+      def card_partial
+        card  = @params[:card].values_at(:holder_name, :number, :cvc, :expiry_year)
+        card << @params[:card][:expiry_month].to_i
+        CARD_PARTIAL % card
+      end
+
+      def shopper_partial
+        @params[:shopper].map { |k, v| SHOPPER_PARTIALS[k] % v }.join("\n")
+      end
+    end
+
+    class RecurringService < SimpleSOAPClient
+      ENDPOINT_URI = 'https://pal-%s.adyen.com/pal/servlet/soap/Recurring'
+
+      # TODO: rename to list_details and make shortcut method take the only necessary param
+      def list
+        response = call_webservice_action('listRecurringDetails', list_request_body)
+        response.xpath('//recurring:listRecurringDetailsResponse/recurring:result') do |result|
+          {
+            :creation_date            => DateTime.parse(result.text('./recurring:creationDate')),
+            :details                  => result.xpath('.//recurring:RecurringDetail').map { |node| parse_recurring_detail(node) },
+            :last_known_shopper_email => result.text('./recurring:lastKnownShopperEmail'),
+            :shopper_reference        => result.text('./recurring:shopperReference')
+          }
+        end
+      end
+
+      private
+
+      def list_request_body
+        LAYOUT % [@params[:merchant_account], @params[:shopper][:reference]]
+      end
+
+      # @todo add support for elv
+      def parse_recurring_detail(node)
+        result = {
+          :recurring_detail_reference => node.text('./recurring:recurringDetailReference'),
+          :variant                    => node.text('./recurring:variant'),
+          :creation_date              => DateTime.parse(node.text('./recurring:creationDate'))
+        }
+
+        card = node.xpath('./recurring:card')
+        if card.children.empty?
+          result[:bank] = parse_bank_details(node.xpath('./recurring:bank'))
+        else
+          result[:card] = parse_card_details(card)
+        end
+
+        result
+      end
+
+      def parse_card_details(card)
+        {
+          :expiry_date => Date.new(card.text('./payment:expiryYear').to_i, card.text('./payment:expiryMonth').to_i, -1),
+          :holder_name => card.text('./payment:holderName'),
+          :number      => card.text('./payment:number')
+        }
+      end
+
+      def parse_bank_details(bank)
+        {
+          :bank_account_number => bank.text('./payment:bankAccountNumber'),
+          :bank_location_id    => bank.text('./payment:bankLocationId'),
+          :bank_name           => bank.text('./payment:bankName'),
+          :bic                 => bank.text('./payment:bic'),
+          :country_code        => bank.text('./payment:countryCode'),
+          :iban                => bank.text('./payment:iban'),
+          :owner_name          => bank.text('./payment:ownerName')
+        }
+      end
+    end
+
+    class XMLQuerier
+      NS = {
+        'payment'   => 'http://payment.services.adyen.com',
+        'recurring' => 'http://recurring.services.adyen.com',
+        'common'    => 'http://common.services.adyen.com'
+      }
+
+      class << self
+        attr_accessor :backend
+
+        def backend=(backend)
+          @backend = backend
+          class_eval do
+            private
+            if backend == :nokogiri
+              def document_for_xml(xml)
+                Nokogiri::XML::Document.parse(xml)
+              end
+              def perform_xpath(query)
+                @node.xpath(query, NS)
+              end
+            else
+              def document_for_xml(xml)
+                REXML::Document.new(xml)
+              end
+              def perform_xpath(query)
+                REXML::XPath.match(@node, query, NS)
+              end
+            end
+          end
+        end
+      end
+
+      begin
+        require 'nokogiri'
+        self.backend = :nokogiri
+      rescue LoadError
+        require 'rexml/document'
+        self.backend = :rexml
+      end
+
+      def initialize(data)
+        @node = data.is_a?(String) ? document_for_xml(data) : data
+      end
+
+      def xpath(query)
+        result = self.class.new(perform_xpath(query))
+        block_given? ? yield(result) : result
+      end
+
+      def text(query)
+        xpath("#{query}/text()").to_s
+      end
+
+      def children
+        @node.first.children
+      end
+
+      def empty?
+        @node.empty?
+      end
+
+      def to_s
+        @node.to_s
+      end
+
+      def map(&block)
+        @node.map { |n| self.class.new(n) }.map(&block)
+      end
+    end
+  end
+end
+
+########################
+#
+# XML template constants
+#
+########################
+
+module Adyen
+  module API
+    class PaymentService
+      LAYOUT = <<EOS
+<?xml version="1.0"?>
+<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:authorise xmlns:ns1="http://payment.services.adyen.com">
+      <ns1:paymentRequest>
+        <merchantAccount xmlns="http://payment.services.adyen.com">%s</merchantAccount>
+        <reference xmlns="http://payment.services.adyen.com">%s</reference>
+%s
+      </ns1:paymentRequest>
+    </ns1:authorise>
+  </soap:Body>
+</soap:Envelope>
+EOS
+
+      AMOUNT_PARTIAL = <<EOS
+        <amount xmlns="http://payment.services.adyen.com">
+          <currency xmlns="http://common.services.adyen.com">%s</currency>
+          <value xmlns="http://common.services.adyen.com">%s</value>
+        </amount>
+EOS
+
+      CARD_PARTIAL = <<EOS
+        <card xmlns="http://payment.services.adyen.com">
+          <holderName>%s</holderName>
+          <number>%s</number>
+          <cvc>%s</cvc>
+          <expiryYear>%s</expiryYear>
+          <expiryMonth>%02d</expiryMonth>
+        </card>
+EOS
+
+      RECURRING_PARTIAL = <<EOS
+        <recurring xmlns="http://recurring.services.adyen.com">
+          <contract xmlns="http://payment.services.adyen.com">RECURRING</contract>
+        </recurring>
+EOS
+
+      RECURRING_PAYMENT_BODY_PARTIAL = RECURRING_PARTIAL + <<EOS
+        <ns1:selectedRecurringDetailReference>%s</ns1:selectedRecurringDetailReference>
+        <ns1:shopperInteraction>ContAuth</ns1:shopperInteraction>
+EOS
+
+      SHOPPER_PARTIALS = {
+        :reference => '        <shopperReference xmlns="http://payment.services.adyen.com">%s</shopperReference>',
+        :email     => '        <shopperEmail xmlns="http://payment.services.adyen.com">%s</shopperEmail>',
+        :ip        => '        <shopperIP xmlns="http://payment.services.adyen.com">%s</shopperIP>',
+      }
+    end
+
+    class RecurringService
+      LAYOUT = <<EOS
+<?xml version="1.0"?>
+<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:listRecurringDetails xmlns:ns1="http://recurring.services.adyen.com">
+      <ns1:request>
+        <ns1:recurring>
+          <ns1:contract>RECURRING</ns1:contract>
+        </ns1:recurring>
+        <ns1:merchantAccount>%s</ns1:merchantAccount>
+        <ns1:shopperReference>%s</ns1:shopperReference>
+      </ns1:request>
+    </ns1:listRecurringDetails>
+  </soap:Body>
+</soap:Envelope>
+EOS
+    end
+  end
+end