adyen 0.3.8 → 1.0.0

data/lib/adyen/form.rb

@@ -1,4 +1,4 @@
-require 'action_view'
+require 'cgi'
 
 module Adyen
 
@@ -7,100 +7,22 @@ module Adyen
   # or a HTTP redirect (see {Adyen::Form.redirect_url}).
   #
   # Moreover, this module contains the method {Adyen::Form.redirect_signature_check} to
-  # check the request that is made to your website after the visitor has made his payment
-  # on the Adyen system for genuinity.
+  # check the request, that is made to your website after the visitor has made his payment
+  # on the Adyen system, for genuinity.
   #
   # You can use different skins in Adyen to define different payment environments. You can
   # register these skins under a custom name in the module. The other methods will automatically
   # use this information (i.e. the skin code and the shared secret) if it is available. 
   # Otherwise, you have to provide it yourself for every method call you make. See
-  # {Adyen::Form.register_skin} for more information.
+  # {Adyen::Configuration#register_form_skin} for more information.
   #
-  # @see Adyen::Form.register_skin
+  # @see Adyen::Configuration#register_form_skin
   # @see Adyen::Form.hidden_fields
   # @see Adyen::Form.redirect_url
   # @see Adyen::Form.redirect_signature_check
   module Form
-    include ActionView::Helpers::TagHelper
     extend self
 
-    ######################################################
-    # SKINS
-    ######################################################
-
-    # Returns all registered skins and their accompanying skin code and shared secret.
-    # @return [Hash] The hash of registered skins.
-    def skins
-      @skins ||= {}
-    end
-    
-    # Sets the registered skins.
-    # @param [Hash<Symbol, Hash>] hash A hash with the skin name as key and the skin parameter hash 
-    #    (which should include +:skin_code+ and +:shared_secret+) as value.
-    # @see Adyen::Form.register_skin
-    def skins=(hash)
-      @skins = hash.inject({}) do |skins, (name, skin)|
-        skins[name.to_sym] = skin.merge(:name => name.to_sym)
-        skins
-      end
-    end
-
-    # Registers a skin for later use.
-    #
-    # You can store a skin using a self defined symbol. Once the skin is registered,
-    # you can refer to it using this symbol instead of the hard-to-remember skin code.
-    # Moreover, the skin's shared_secret will be looked up automatically for calculting
-    # signatures.
-    #
-    # @example
-    #   Adyen::Form.register_skin(:my_skin, 'dsfH67PO', 'Dfs*7uUln9')
-    # @param [Symbol] name The name of the skin.
-    # @param [String] skin_code The skin code for this skin, as defined by Adyen.
-    # @param [String] shared_secret The shared secret used for signature calculation.
-    # @see Adyen.load_config
-    def register_skin(name, skin_code, shared_secret)
-      skins[name.to_sym] = {:name => name.to_sym, :skin_code => skin_code, :shared_secret => shared_secret }
-    end
-
-    # Returns skin information given a skin name.
-    # @param [Symbol] skin_name The name of the skin
-    # @return [Hash, nil] A hash with the skin information, or nil if not found.
-    def skin_by_name(skin_name)
-      skins[skin_name.to_sym]
-    end
-
-    # Returns skin information given a skin code.
-    # @param [String] skin_code The skin code of the skin
-    # @return [Hash, nil] A hash with the skin information, or nil if not found.
-    def skin_by_code(skin_code)
-      skins.detect { |(name, skin)| skin[:skin_code] == skin_code }.last rescue nil
-    end
-
-    # Returns the shared secret belonging to a skin code.
-    # @param [String] skin_code The skin code of the skin
-    # @return [String, nil] The shared secret for the skin, or nil if not found. 
-    def lookup_shared_secret(skin_code)
-      skin = skin_by_code(skin_code)[:shared_secret] rescue nil
-    end
-
-    ######################################################
-    # DEFAULT FORM / REDIRECT PARAMETERS
-    ######################################################
-
-    # Returns the default parameters to use, unless they are overridden.
-    # @see Adyen::Form.default_parameters
-    # @return [Hash] The hash of default parameters
-    def default_parameters
-      @default_arguments ||= {}
-    end
-    
-    # Sets the default parameters to use.
-    # @see Adyen::Form.default_parameters
-    # @param [Hash] hash The hash of default parameters
-    def default_parameters=(hash)
-      @default_arguments = hash
-    end
-
     ######################################################
     # ADYEN FORM URL
     ######################################################
@@ -118,7 +40,7 @@ module Adyen
     # @see Adyen::Form.environment
     # @see Adyen::Form.redirect_url
     def url(environment = nil)
-      environment ||= Adyen.environment
+      environment ||= Adyen.configuration.environment
       Adyen::Form::ACTION_URL % environment.to_s
     end
 
@@ -126,24 +48,22 @@ module Adyen
     # POSTING/REDIRECTING TO ADYEN
     ######################################################
 
-    # Transforms the payment parameters hash to be in the correct format.
-    # It will also include the default_parameters hash. Finally, switches 
-    # the +:skin+ parameter out for the +:skin_code+ and +:shared_secret+ 
-    # parameter using the list of registered skins. 
+    # Transforms the payment parameters hash to be in the correct format. It will also
+    # include the Adyen::Configuration#default_form_params hash. Finally, switches the
+    # +:skin+ parameter out for the +:skin_code+ and +:shared_secret+  parameter using
+    # the list of registered skins.
     #
     # @private
     # @param [Hash] parameters The payment parameters hash to transform
     def do_parameter_transformations!(parameters = {})
-      raise "YENs are not yet supported!" if parameters[:currency_code] == 'JPY' # TODO: fixme
-
-      parameters.replace(default_parameters.merge(parameters))
+      parameters.replace(Adyen.configuration.default_form_params.merge(parameters))
       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])
       
       if parameters[:skin]
-        skin = Adyen::Form.skin_by_name(parameters.delete(:skin))
+        skin = Adyen.configuration.form_skin_by_name(parameters.delete(:skin))
         parameters[:skin_code]     ||= skin[:skin_code]
         parameters[:shared_secret] ||= skin[:shared_secret]
       end
@@ -153,24 +73,24 @@ module Adyen
     # signature parameter. It also does some basic health checks on the parameters hash.
     #
     # @param [Hash] parameters The payment parameters. The parameters set in the 
-    #    {Adyen::Form.default_parameters} hash will be included automatically.
+    #    {Adyen::Configuration#default_form_params} hash will be included automatically.
     # @param [String] shared_secret The shared secret that should be used to calculate
     #    the payment request signature. This parameter can be left if the skin that is
-    #    used is registered (see {Adyen::Form.register_skin}), or if the shared secret 
-    #    is provided as the +:shared_secret+ parameter.
+    #    used is registered (see {Adyen::Configuration#register_form_skin}), or if the
+    #    shared secret is provided as the +:shared_secret+ parameter.
     # @return [Hash] The payment parameters with the +:merchant_signature+ parameter set.
-    # @raise [StandardError] Thrown if some parameter health check fails.
+    # @raise [ArgumentError] Thrown if some parameter health check fails.
     def payment_parameters(parameters = {}, shared_secret = nil)
       do_parameter_transformations!(parameters)
       
-      raise "Cannot generate form: :currency code attribute not found!"         unless parameters[:currency_code]
-      raise "Cannot generate form: :payment_amount code attribute not found!"   unless parameters[:payment_amount]
-      raise "Cannot generate form: :merchant_account attribute not found!"      unless parameters[:merchant_account]
-      raise "Cannot generate form: :skin_code attribute not found!"             unless parameters[:skin_code]
+      raise ArgumentError, "Cannot generate form: :currency code attribute not found!"         unless parameters[:currency_code]
+      raise ArgumentError, "Cannot generate form: :payment_amount code attribute not found!"   unless parameters[:payment_amount]
+      raise ArgumentError, "Cannot generate form: :merchant_account attribute not found!"      unless parameters[:merchant_account]
+      raise ArgumentError, "Cannot generate form: :skin_code attribute not found!"             unless parameters[:skin_code]
 
       # Calculate the merchant signature using the shared secret.
       shared_secret ||= parameters.delete(:shared_secret)
-      raise "Cannot calculate payment request signature without shared secret!" unless shared_secret
+      raise ArgumentError, "Cannot calculate payment request signature without shared secret!" unless shared_secret
       parameters[:merchant_sig] = calculate_signature(parameters, shared_secret)
       
       return parameters
@@ -180,8 +100,8 @@ module Adyen
     # as GET parameters in the URL. The URL also depends on the current Adyen enviroment.
     #
     # The payment parameters that are provided to this method will be merged with the 
-    # {Adyen::Form.default_parameters} hash. The default parameter values will be overrided
-    # if another value is provided to this method.
+    # {Adyen::Configuration#default_form_params} hash. The default parameter values will be
+    # overrided if another value is provided to this method.
     #
     # You do not have to provide the +:merchant_sig+ parameter: it will be calculated automatically
     # if you provide either a registered skin name as the +:skin+ parameter or provide both the
@@ -206,15 +126,15 @@ module Adyen
     # @return [String] An absolute URL to redirect to the Adyen payment system.
     def redirect_url(parameters = {})
       url + '?' + payment_parameters(parameters).map { |(k, v)| 
-        "#{k.to_s.camelize(:lower)}=#{CGI.escape(v.to_s)}" }.join('&')
+        "#{camelize(k)}=#{CGI.escape(v.to_s)}" }.join('&')
     end
     
     # Returns a HTML snippet of hidden INPUT tags with the provided payment parameters. 
     # The snippet can be included in a payment form that POSTs to the Adyen payment system.
     #
     # The payment parameters that are provided to this method will be merged with the 
-    # {Adyen::Form.default_parameters} hash. The default parameter values will be overrided
-    # if another value is provided to this method.
+    # {Adyen::Configuration#default_form_params} hash. The default parameter values will be
+    # overrided if another value is provided to this method.
     #
     # You do not have to provide the +:merchant_sig+ parameter: it will be calculated automatically
     # if you provide either a registered skin name as the +:skin+ parameter or provide both the
@@ -234,7 +154,7 @@ module Adyen
       
       # Generate a hidden input tag per parameter, join them by newlines.
       form_str = payment_parameters(parameters).map { |key, value|
-        tag(:input, :type => 'hidden', :name => key.to_s.camelize(:lower), :value => value)
+        "<input type=\"hidden\" name=\"#{CGI.escapeHTML(camelize(key))}\" value=\"#{CGI.escapeHTML(value.to_s)}\" />"
       }.join("\n")
       
       form_str.respond_to?(:html_safe) ? form_str.html_safe : form_str
@@ -297,7 +217,7 @@ module Adyen
     #     using the {Adyen::Form.register_skin} method.
     # @return [String] The redirect signature
     def redirect_signature(params, shared_secret = nil)
-      shared_secret ||= lookup_shared_secret(params[:skinCode])
+      shared_secret ||= Adyen.configuration.form_skin_shared_secret_by_code(params[:skinCode])
       Adyen::Encoding.hmac_base64(shared_secret, redirect_signature_string(params))
     end
 
@@ -329,10 +249,18 @@ module Adyen
     #      should include the +:merchantSig+ parameter, which contains the signature.
     # @param [String] shared_secret The shared secret for the Adyen skin that was used for
     #     the original payment form. You can leave this out of the skin is registered 
-    #     using the {Adyen::Form.register_skin} method.
+    #     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)
       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
+    
   end
 end

data/lib/adyen/formatter.rb

@@ -23,15 +23,5 @@ module Adyen
         end
       end
     end
-
-    module Price
-      def self.in_cents(price)
-        ((price * 100).round).to_i
-      end
-
-      def self.from_cents(price)
-        BigDecimal.new(price.to_s) / 100
-      end
-    end
   end
 end

data/lib/adyen/matchers.rb

@@ -22,7 +22,7 @@ module Adyen
 
         # Add a check for all the other fields specified
         checks.each do |key, value|
-          condition  = "descendant::input[@type='hidden'][@name='#{key.to_s.camelize(:lower)}']"
+          condition  = "descendant::input[@type='hidden'][@name='#{Adyen::Form.camelize(key)}']"
           condition << "[@value='#{value}']" unless value == :anything
           xpath_query << "[#{condition}]"
         end

data/lib/adyen/notification_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+# @private
+class Adyen::NotificationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  # Create a migration file for the adyen_notifications table
+  def create_migration_file
+    migration_template 'notification_migration.rb', 'db/migrate/create_adyen_notifications.rb'
+  end
+  
+  def create_model_file
+    template 'notification_model.rb', 'app/models/adyen_notification.rb'
+  end
+end

data/lib/adyen/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+# @private
+class Adyen::Railtie < ::Rails::Railtie
+  
+  generators do
+    require 'adyen/notification_generator'
+  end
+  
+  config.before_configuration do
+    config.adyen = Adyen.configuration
+  end
+end

data/lib/adyen/templates/notification_migration.rb

@@ -0,0 +1,29 @@
+# @private
+class CreateAdyenNotifications < ActiveRecord::Migration
+  
+  def self.up
+    create_table :adyen_notifications do |t|
+      t.boolean  :live,                  :null => false, :default => false
+      t.string   :event_code,            :null => false
+      t.string   :psp_reference,         :null => false
+      t.string   :original_reference,    :null => true
+      t.string   :merchant_reference,    :null => false
+      t.string   :merchant_account_code, :null => false
+      t.datetime :event_date,            :null => false
+      t.boolean  :success,               :null => false, :default => false
+      t.string   :payment_method,        :null => true
+      t.string   :operations,            :null => true
+      t.text     :reason,                :null => true
+      t.string   :currency,              :null => true, :limit => 3
+      t.integer  :value,                 :null => true
+      t.boolean  :processed,             :null => false, :default => false
+      t.timestamps
+    end
+     
+    add_index :adyen_notifications, [:psp_reference, :event_code, :success], :unique => true, :name => 'adyen_notification_uniqueness'
+  end
+
+  def self.down
+    drop_table :adyen_notifications
+  end
+end

data/lib/adyen/templates/notification_model.rb

@@ -0,0 +1,70 @@
+# The +AdyenNotification+ class handles notifications sent by Adyen to your servers.
+#
+# Because notifications contain important payment status information, you should store
+# these notifications in your database. For this reason, +AdyenNotification+ inherits
+# from +ActiveRecord::Base+, and a migration is included to simply create a suitable table
+# to store the notifications in.
+#
+# Adyen can either send notifications to you via HTTP POST requests, or SOAP requests.
+# Because SOAP is not really well supported in Rails and setting up a SOAP server is
+# not trivial, only handling HTTP POST notifications is currently supported.
+#
+# @example
+#    @notification = AdyenNotification.log(request)
+#    if @notification.successful_authorisation?
+#      @invoice = Invoice.find(@notification.merchant_reference)
+#      @invoice.set_paid!
+#    end
+class AdyenNotification < ActiveRecord::Base
+  
+  # A notification should always include an event_code
+  validates_presence_of :event_code
+  
+  # A notification should always include a psp_reference
+  validates_presence_of :psp_reference
+  
+  # A notification should be unique using the composed key of
+  # [:psp_reference, :event_code, :success]
+  validates_uniqueness_of :success, :scope => [:psp_reference, :event_code]
+  
+  # Make sure we don't end up with an original_reference with an empty string
+  before_validation { |notification| notification.original_reference = nil if notification.original_reference.blank? }
+  
+  # Logs an incoming notification into the database.
+  #
+  # @param [Hash] params The notification parameters that should be stored in the database.
+  # @return [Adyen::Notification] The initiated and persisted notification instance.
+  # @raise This method will raise an exception if the notification cannot be stored.
+  # @see Adyen::Notification::HttpPost.log
+  def self.log(params)
+    converted_params = {}
+    
+    # Convert each attribute from CamelCase notation to under_score notation
+    # For example, merchantReference will be converted to merchant_reference
+    params.each do |key, value|
+      column_name = key.to_s.underscore
+      converted_params[column_name] = value if self.column_names.include?(column_name)
+    end
+    
+    self.create!(converted_params)
+  end
+
+  # Returns true if this notification is an AUTHORISATION notification
+  # @return [true, false] true iff event_code == 'AUTHORISATION'
+  # @see Adyen.notification#successful_authorisation?
+  def authorisation?
+    event_code == 'AUTHORISATION'
+  end
+
+  alias :authorization? :authorisation?
+  
+  # Returns true if this notification is an AUTHORISATION notification and
+  # the success status indicates that the authorization was successfull.
+  # @return [true, false] true iff  the notification is an authorization
+  #   and the authorization was successful according to the success field.
+  def successful_authorisation?
+    event_code == 'AUTHORISATION' && success?
+  end
+  
+  alias :successful_authorization? :successful_authorisation?
+end

data/spec/adyen_spec.rb

@@ -1,41 +1,9 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 
 describe Adyen do
-  
-  describe '.load_config' do
-    
-    it "should set the environment correctly from the gonfiguration" do
-      Adyen.load_config(:environment => 'from_config')
-      Adyen.environment.should == 'from_config'
-    end
-    
-    it "should recursively set settings for submodules" do
-      Adyen.load_config(:SOAP => { :username => 'foo', :password => 'bar' },
-        :Form => { :default_parameters => { :merchant_account => 'us' }})
-      Adyen::SOAP.username.should == 'foo'
-      Adyen::SOAP.password.should == 'bar'
-      Adyen::Form.default_parameters.should == { :merchant_account => 'us' }
-    end
-    
-    it "should raise an error when using a non-existing module" do
-      lambda { Adyen.load_config(:Unknown => { :a => 'b' }) }.should raise_error
-    end
-    
-    it "should raise an error when using a non-existing setting" do
-      lambda { Adyen.load_config(:blah => 1234) }.should raise_error
-    end
-    
-    it "should set skins from a hash configuration" do
-      Adyen.load_config(:Form => {:skins => {
-              :first  => { :skin_code => '1234', :shared_secret => 'abcd' }, 
-              :second => { :skin_code => '5678', :shared_secret => 'efgh' }}})
-              
-      Adyen::Form.skins.should == {
-          :first  => {:skin_code => "1234", :name => :first,  :shared_secret => "abcd" }, 
-          :second => {:skin_code => "5678", :name => :second, :shared_secret => "efgh" }}
-    end
-  end
-  
+
   describe Adyen::Encoding do
     it "should a hmac_base64 correcly" do
       encoded_str = Adyen::Encoding.hmac_base64('bla', 'bla')
@@ -73,14 +41,4 @@ describe Adyen do
       lambda { Adyen::Formatter::DateTime.fmt_date('2009-1-1') }.should raise_error
     end
   end
-
-  describe Adyen::Formatter::Price do
-    it "should return a Fixnum with digits only when converting to cents" do
-      Adyen::Formatter::Price.in_cents(33.76).should be_kind_of(Fixnum)
-    end
-
-    it "should return a BigDecimal when converting from cents" do
-      Adyen::Formatter::Price.from_cents(1234).should be_kind_of(BigDecimal)
-    end
-  end
 end