buckaroo-ideal 0.0.1

data/lib/buckaroo-ideal/response_signature.rb

@@ -0,0 +1,54 @@
+require 'digest/md5'
+require 'active_support/core_ext/module/delegation'
+
+module Buckaroo
+  module Ideal
+    class ResponseSignature
+      
+      # @return [String] The configured merchant_key in +Buckaroo::Ideal::Config+
+      delegate :merchant_key, to: Config
+      
+      # @return [String] The configured secret_key in +Buckaroo::Ideal::Config+
+      delegate :secret_key,   to: Config
+      
+      # @return [String] The signature that was given in the response
+      attr_reader :signature
+      
+      # @return [Buckaroo::Ideal::Response] The response that was signed.
+      attr_reader :response
+      
+      # @return [String] The secret key that is used to sign the order.
+      attr_reader :secret
+      
+      def initialize(response, signature = '')
+        @response  = response
+        @signature = signature
+      end
+      
+      def valid?
+        signature == generate_signature
+      end
+      
+      def generate_signature
+        salt = [
+          response.transaction_id,
+          response.timestamp,
+          merchant_key,
+          response.invoice_number,
+          response.reference,
+          response.currency,
+          to_cents(response.amount),
+          response.status.code,
+          to_numeric_boolean(response.test_mode),
+          secret_key
+        ].join
+        
+        Digest::MD5.hexdigest(salt)
+      end
+      
+      private
+      
+      include Util
+    end
+  end
+end

data/lib/buckaroo-ideal/status.rb

@@ -0,0 +1,67 @@
+require 'csv'
+
+module Buckaroo
+  module Ideal
+    class Status
+      class UnknownStatusCode < StandardError; end
+      
+      STATES = {
+        completed: %w(071 121 151 171 190 242 243 244 245 246 247 254 255 301
+                      401 461 462 463 464 551 601 701 801),
+        pending:   %w(000 001 070 090 091 100 105 120 126 135 136 150 156 157
+                      170 176 177 253 300 400 460 500 550 600 700 710 790 791
+                      792 793 800 811 814 815 831 834),
+        failed:    %w(072 073 074 075 076 101 102 103 104 106 122 123 124 125
+                      137 138 139 152 153 155 158 159 172 173 175 178 179 201
+                      203 204 205 206 207 251 252 260 261 262 302 303 304 305
+                      306 309 402 409 410 411 414 421 422 425 466 468 490 491
+                      492 501 552 553 554 555 556 560 581 590 602 605 609 610
+                      612 690 702 703 704 705 706 707 708 711 712 720 721 802
+                      803 804 810 812 813 816 820 821 822 823 824 830 833 835
+                      836 890 891 900 901 910 931 932 933 934 935 940 941 942
+                      943 944 945 946 947 948 949 950 951 952 953 954 955 956
+                      960 961 962 963 964 971 972 973 974 975 976 977 978 980
+                      981 982 983 990 991 992 993 999)
+      }
+      
+      CSV_FILE = File.expand_path('../../../files/statuscodes.csv', __FILE__)
+      
+      attr_reader :code, :message
+      
+      def self.status_codes(csv_file = CSV_FILE)
+        codes = {}
+        
+        CSV.foreach(csv_file, col_sep: ';') do |row|
+          codes[row[0]] = row[1]
+        end
+        
+        codes
+      end
+      
+      def initialize(code)
+        if message = self.class.status_codes[code]
+          @code    = code
+          @message = message
+        else
+          raise UnknownStatusCode
+        end
+      end
+      
+      def state
+        STATES.each do |state, codes|
+          return state if codes.include? @code
+        end
+        
+        :unknown
+      end
+      
+      def completed?; state == :completed; end
+      def pending?;   state == :pending;   end
+      def failed?;    state == :failed;    end
+      
+      def ==(other)
+        other.respond_to?(:code) && other.code == code
+      end
+    end
+  end
+end

data/lib/buckaroo-ideal/util.rb

@@ -0,0 +1,41 @@
+require 'transliterator'
+
+module Buckaroo
+  module Ideal
+    module Util
+      extend self
+      
+      def to_normalized_string(string)
+        Transliterator.asciify(string.to_s)
+      end
+      
+      def to_cents(amount)
+        (amount.to_f * 100).round
+      end
+      
+      def from_cents(cents)
+        cents.to_f / 100
+      end
+      
+      def to_numeric_boolean(boolean)
+        boolean ? 1 : 0
+      end
+      
+      def from_numeric_boolean(number)
+        number.to_i == 1
+      end
+      
+      def compact(subject)
+        subject = subject.dup
+        
+        if subject.is_a?(Hash)
+          subject.each do |key, value|
+            subject.delete(key) unless value
+          end
+        end
+        
+        subject
+      end
+    end
+  end
+end

data/lib/buckaroo-ideal/version.rb

@@ -0,0 +1,5 @@
+module Buckaroo
+  module Ideal
+    VERSION = "0.0.1"
+  end
+end

data/spec/buckaroo-ideal/config_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Buckaroo::Ideal::Config do
+  before do
+    Buckaroo::Ideal::Config.configure(
+      merchant_key:   'merchant_key',
+      secret_key:     'secret_key',
+      test_mode:      true,
+      success_url:    'http://example.com/transaction/success',
+      reject_url:     'http://example.com/transaction/reject',
+      error_url:      'http://example.com/transaction/error',
+      return_method:  'GET',
+      style:          'POPUP',
+      autoclose_popup: true
+    )
+  end
+  
+  subject { Buckaroo::Ideal::Config }
+  
+  it 'has a gateway_url' do
+    subject.gateway_url.should == 'https://payment.buckaroo.nl/gateway/payment.asp'
+  end
+  
+  it 'has a merchant_key' do
+    subject.merchant_key.should == 'merchant_key'
+  end
+  
+  it 'has a secret_key' do
+    subject.secret_key.should == 'secret_key'
+  end
+  
+  it 'has a test_mode' do
+    subject.test_mode.should be_true
+  end
+  
+  it 'has a success_url' do
+    subject.success_url.should == 'http://example.com/transaction/success'
+  end
+  
+  it 'has a reject_url' do
+    subject.reject_url.should == 'http://example.com/transaction/reject'
+  end
+  
+  it 'has a error_url' do
+    subject.error_url.should == 'http://example.com/transaction/error'
+  end
+  
+  it 'has a return_method' do
+    subject.return_method.should == 'GET'
+  end
+  
+  it 'has a style' do
+    subject.style.should == 'POPUP'
+  end
+  
+  it 'has a autoclose_popup setting' do
+    subject.autoclose_popup.should be_true
+  end
+  
+  it 'can be reset to default values' do
+    subject.reset
+    subject.merchant_key.should    be_nil
+    subject.secret_key.should      be_nil
+    subject.test_mode.should       be_false
+    subject.success_url.should     be_nil
+    subject.reject_url.should      be_nil
+    subject.error_url.should       be_nil
+    subject.return_method.should   == 'POST'
+    subject.style.should           == 'PAGE'
+    subject.autoclose_popup.should be_false
+  end
+end

data/spec/buckaroo-ideal/order_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Buckaroo::Ideal::Order do
+  let(:order) { Buckaroo::Ideal::Order.new }
+  
+  before do
+    Buckaroo::Ideal::Config.configure(
+      merchant_key:   'merchant_key',
+      secret_key:     'secret_key',
+      test_mode:      true,
+      success_url:    'http://example.com/transaction/success',
+      reject_url:     'http://example.com/transaction/reject',
+      error_url:      'http://example.com/transaction/error',
+      return_method:  'GET',
+      style:          'POPUP',
+      autoclose_popup: true
+    )
+  end
+  
+  it 'has a default currency' do
+    order.currency.should == 'EUR'
+  end
+  
+  it 'does not have a default amount' do
+    order.amount.should be_nil
+  end
+  
+  it 'does not have a default bank' do
+    order.bank.should be_nil
+  end
+  
+  it 'does not have a default description' do
+    order.description.should be_nil
+  end
+  
+  it 'does not have a default reference' do
+    order.reference.should be_nil
+  end
+  
+  it 'does not have a default invoice_number' do
+    order.invoice_number.should be_nil
+  end
+end

data/spec/buckaroo-ideal/request_signature_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Buckaroo::Ideal::RequestSignature do
+  it 'generates a signature for the given order' do
+    order  = mock invoice_number: 'EETNU-12345',
+                  amount:         12.50,
+                  currency:       'EUR'
+    
+    Buckaroo::Ideal::Config.stub(:test_mode)
+                           .and_return(true)
+    
+    Buckaroo::Ideal::Config.stub(:merchant_key)
+                           .and_return('merchant_key')
+    
+    Buckaroo::Ideal::Config.stub(:secret_key)
+                           .and_return('secret_key')
+    
+    signature = Buckaroo::Ideal::RequestSignature.new(order)
+    
+    expected_salt = [
+      'merchant_key', # config.merchant_key
+      'EETNU-12345',  # order.invoice_number
+      1250,           # order.amount in cents
+      'EUR',          # order.currency
+      1,              # config.test_mode
+      'secret_key'    # config.secret_key
+    ].join
+    
+    Digest::MD5.should_receive(:hexdigest)
+               .with(expected_salt)
+    
+    signature.to_s
+  end
+end

data/spec/buckaroo-ideal/request_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe Buckaroo::Ideal::Request do
+  let(:order)   { Buckaroo::Ideal::Order.new          }
+  let(:request) { Buckaroo::Ideal::Request.new(order) }
+  
+  before do
+    Buckaroo::Ideal::Config.configure(
+      merchant_key:   'merchant_key',
+      secret_key:     'secret_key',
+      test_mode:      true,
+      success_url:    'http://example.com/transaction/success',
+      reject_url:     'http://example.com/transaction/reject',
+      error_url:      'http://example.com/transaction/error',
+      return_method:  'GET',
+      style:          'POPUP',
+      autoclose_popup: true
+    )
+  end
+  
+  it 'has a default language' do
+    request.language.should == 'NL'
+  end
+  
+  it 'has a default success_url from the configuration' do
+    request.success_url.should == 'http://example.com/transaction/success'
+  end
+  
+  it 'has a default reject_url from the configuration' do
+    request.reject_url.should == 'http://example.com/transaction/reject'
+  end
+  
+  it 'has a default error_url from the configuration' do
+    request.error_url.should == 'http://example.com/transaction/error'
+  end
+  
+  it 'has a default return_method from the configuration' do
+    request.return_method.should == 'GET'
+  end
+  
+  it 'has a default style from the configuration' do
+    request.style.should == 'POPUP'
+  end
+  
+  it 'has a default autoclose_popup from the configuration' do
+    request.autoclose_popup.should be_true
+  end
+  
+  describe '#gateway_url' do
+    it 'returns the configured gateway_url' do
+      request.gateway_url.should == Buckaroo::Ideal::Config.gateway_url
+    end
+  end
+  
+  describe '#parameters' do
+    def parameters; request.parameters; end
+    
+    it 'has a BPE_Merchant with the configured merchant_key' do
+      parameters['BPE_Merchant'].should == 'merchant_key'
+      
+      Buckaroo::Ideal::Config.merchant_key = 'new_merchant_key'
+      parameters['BPE_Merchant'].should == 'new_merchant_key'
+    end
+    
+    it "has a BPE_Amount with the order's amount in cents" do
+      order.amount = 19.95
+      parameters['BPE_Amount'].should == 1995
+    end
+    
+    it "has a BPE_Currency with the order's currency" do
+      parameters['BPE_Currency'].should == 'EUR'
+      
+      order.currency = 'BHT'
+      parameters['BPE_Currency'].should == 'BHT'
+    end
+    
+    it "has a BPE_Invoice with the order's invoice_number" do
+      order.invoice_number = 'INV001'
+      parameters['BPE_Invoice'].should == 'INV001'
+    end
+    
+    it 'has a BPE_Return_Method with the return_method' do
+      parameters['BPE_Return_Method'].should == 'GET'
+      
+      request.return_method = 'POST'
+      parameters['BPE_Return_Method'].should == 'POST'
+    end
+    
+    it 'has a BPE_Style if the style is set' do
+      parameters['BPE_Style'].should == 'POPUP'
+      
+      request.style = 'PAGE'
+      parameters['BPE_Style'].should == 'PAGE'
+    end
+    
+    it 'has a BPE_Autoclose_Popup if autoclose_popup is set' do
+      parameters['BPE_Autoclose_Popup'].should == 1
+      
+      request.autoclose_popup = false
+      parameters['BPE_Autoclose_Popup'].should == 0
+    end
+    
+    it 'has a generated BPE_Signature2' do
+      parameters['BPE_Signature2'].length.should == 32
+      
+      request.stub(:signature).and_return('signature')
+      
+      parameters['BPE_Signature2'].should == 'signature'
+    end
+    
+    it 'has a BPE_Language with the language' do
+      parameters['BPE_Language'].should == 'NL'
+      
+      request.language = 'DE'
+      parameters['BPE_Language'].should == 'DE'
+    end
+    
+    it 'has a BPE_Mode with the configured test_mode' do
+      parameters['BPE_Mode'].should == 1
+      
+      Buckaroo::Ideal::Config.test_mode = false
+      parameters['BPE_Mode'].should == 0
+    end
+    
+    it "has a BPE_Issuer if the order's bank is set" do
+      parameters.keys.should_not include 'BPE_Issuer'
+      
+      order.bank = 'ABNAMRO'
+      parameters['BPE_Issuer'].should == 'ABNAMRO'
+    end
+    
+    it "has a BPE_Description if the order's description is set" do
+      parameters.keys.should_not include 'BPE_Description'
+      
+      order.description = 'Your Order Description'
+      parameters['BPE_Description'].should == 'Your Order Description'
+    end
+    
+    it 'has a BPE_Reference if the reference is set' do
+      parameters.keys.should_not include 'BPE_Reference'
+      
+      order.reference = 'Reference'
+      parameters['BPE_Reference'].should == 'Reference'
+    end
+    
+    it 'has a BPE_Return_Success if the success_url is set' do
+      request.success_url = nil
+      parameters.keys.should_not include 'BPE_Return_Success'
+      
+      request.success_url = 'http://example.org/'
+      parameters['BPE_Return_Success'].should == 'http://example.org/'
+    end
+    
+    it 'has a BPE_Return_Reject if the reject_url is set' do
+      request.reject_url = nil
+      parameters.keys.should_not include 'BPE_Return_Reject'
+      
+      request.reject_url = 'http://example.org/'
+      parameters['BPE_Return_Reject'].should == 'http://example.org/'
+    end
+    
+    it 'has a BPE_Return_Error if the error_url is set' do
+      request.error_url = nil
+      parameters.keys.should_not include 'BPE_Return_Error'
+      
+      request.error_url = 'http://example.org/'
+      parameters['BPE_Return_Error'].should == 'http://example.org/'
+    end
+  end
+end