buckaroo_client 0.0.1.pre

data/lib/buckaroo_client/service.rb

@@ -0,0 +1,8 @@
+require 'buckaroo_client/service/credit_management'
+require 'buckaroo_client/service/invoice_specification'
+require 'buckaroo_client/service/pay_per_email'
+
+module BuckarooClient
+  module Service
+  end
+end

data/lib/buckaroo_client/service/credit_management.rb

@@ -0,0 +1,71 @@
+module BuckarooClient
+  module Service
+    class CreditManagement
+
+      # Source: Credit Management BPE 3.0 documentation v1.03
+      # Some values need 'service_creditmanagement_' prefix, some don't.
+      # This is based on trail-and-error and example request as given in
+      # document "Bestand aanbieden in BPE 3.0" v2.14 on page 16.
+      ATTRIBUTE_MAPPING = {
+        invoice_date: 'InvoiceDate',
+        date_due: 'DateDue',
+        amount_vat: 'AmountVat',
+        max_reminder_level: 'service_creditmanagement_MaxReminderLevel',
+        payment_methods_allowed: 'service_creditmanagement_PaymentMethodsAllowed',
+        customer_type: 'CustomerType',
+        customer_code: 'CustomerCode',
+        customer_title: 'CustomerTitle',
+        customer_initials: 'CustomerInitials',
+        customer_first_name: 'CustomerFirstName',
+        customer_last_name_prefix: 'CustomerLastNamePrefix',
+        customer_last_name: 'CustomerLastName',
+        customer_gender: 'CustomerGender',
+        customer_birth_date: 'service_creditmanagement_CustomerBirthDate',
+        customer_email: 'CustomerEmail',
+        phone_number: 'PhoneNumber',
+        mobile_phone_number: 'MobilePhoneNumber',
+        fax_number: 'FaxNumber',
+        street: 'Address_Street_1',
+        house_number: 'Address_HouseNumber_1',
+        house_number_suffix: 'Address_HouseNumberSuffix_1',
+        zip_code: 'Address_ZipCode_1',
+        city: 'Address_City_1',
+        state: 'Address_State_1',
+        country: 'Address_Country_1',
+        customer_account_number: 'service_creditmanagement_CustomerAccountNumber',
+        company_name: 'service_creditmanagement_CompanyName',
+        company_coc_registration: 'service_creditmanagement_CompanyCOCRegistration',
+        company_vat_applicable: 'service_creditmanagement_CompanyVATApplicable',
+      }
+
+      attr_accessor *ATTRIBUTE_MAPPING.keys
+
+      def initialize(args = {})
+        args.each do |key, value|
+          self.send "#{key}=", value
+        end
+      end
+
+      def servicecode
+        'creditmanagement'
+      end
+
+      def action
+        'invoice'
+      end
+
+      def gateway_attributes
+        output = { 'service_creditmanagement_action' => action }
+        ATTRIBUTE_MAPPING.each do |name, gateway_name|
+          value = self.send(name)
+          next if value.nil? # Ignore unspecified values to keep BuckarooClient happy
+          if value == true or value == false
+            value = value.to_s.upcase
+          end
+          output[gateway_name] = value.to_s
+        end
+        output
+      end
+    end
+  end
+end

data/lib/buckaroo_client/service/invoice_specification.rb

@@ -0,0 +1,92 @@
+require 'forwardable'
+
+module BuckarooClient
+  module Service
+    class InvoiceSpecification
+
+      def servicecode
+        'InvoiceSpecification'
+      end
+
+      def action
+        'ExtraInfo'
+      end
+
+      def add_invoice_line(data)
+        invoice_lines.add_line('InvoiceLine', data)
+      end
+
+      def add_sub_total_line(data)
+        invoice_lines.add_line('SubTotalLine', data)
+      end
+
+      def add_total_line(data)
+        invoice_lines.add_line('TotalLine', data)
+      end
+
+      def invoice_lines
+        @invoice_lines ||= InvoiceLines.new
+      end
+
+      def gateway_attributes
+        output = {
+          'service_InvoiceSpecification_action' => action,
+        }
+        output.merge(invoice_lines.gateway_attributes)
+      end
+
+      class InvoiceLines
+        extend Forwardable
+        def_delegators :@lines, :size, :each
+
+        attr_accessor :lines
+
+        def initialize
+          @lines = []
+        end
+
+        def add_line(type, data)
+          # Auto-increment line order value if not set by user
+          data[:lineordering] ||= size + 1
+          lines << [type, InvoiceLineData.new(data)]
+        end
+
+        def gateway_attributes
+          output = {}
+          line_type_count = Hash.new(0)
+          lines.each do |type, line_data|
+            output.store("service_InvoiceSpecification_#{type}_#{line_type_count[type] += 1}", line_data.gateway_string)
+          end
+          output
+        end
+      end
+
+      class InvoiceLineData
+        ATTRIBUTES = [
+          :lineordering,
+          :description,
+          :currency,
+          :amount,
+          :tax,
+          :numberofunits,
+          :unitprice,
+          :unitname
+        ]
+        attr_accessor *ATTRIBUTES
+
+        def initialize(args = {})
+          ATTRIBUTES.each do |name|
+            self.send "#{name}=", args.delete(name)
+          end
+          unless args.empty?
+            raise ArgumentError.new("Illegal attributes given: #{args.keys.join(',')}")
+          end
+        end
+
+        def gateway_string
+          ATTRIBUTES.map {|a| self.send(a) }.join('|')
+        end
+      end
+    end
+  end
+end

data/lib/buckaroo_client/service/pay_per_email.rb

@@ -0,0 +1,40 @@
+module BuckarooClient
+  module Service
+    class PayPerEmail
+
+      attr_accessor :customergender, :customeremail, :customerfirstname, :customerlastname,
+        :merchantsendsemail, :paymentmethodsallowed, :expirationdate
+
+      def initialize(args = {})
+        @customergender = args.fetch(:customergender, 0)
+        @customeremail = args[:customeremail]
+        @customerfirstname = args[:customerfirstname]
+        @customerlastname = args[:customerlastname]
+        @merchantsendsemail = args.fetch(:merchantsendsemail, false)
+        @paymentmethodsallowed = args[:paymentmethodsallowed]
+        @expirationdate = args[:expirationdate]
+      end
+
+      def servicecode
+        'payperemail'
+      end
+
+      def action
+        'paymentinvitation'
+      end
+
+      def gateway_attributes
+        {
+          'service_payperemail_action' => action,
+          'service_payperemail_customergender' => customergender.to_s,
+          'service_payperemail_customeremail' => customeremail,
+          'service_payperemail_customerfirstname' => customerfirstname,
+          'service_payperemail_customerlastname' => customerlastname,
+          'service_payperemail_merchantsendsemail' => merchantsendsemail.to_s.upcase,
+          'service_payperemail_paymentmethodsallowed' => paymentmethodsallowed,
+          'service_payperemail_expirationdate' => expirationdate,
+        }.select { |_, value| !value.nil? }
+      end
+    end
+  end
+end

data/lib/buckaroo_client/transaction.rb

@@ -0,0 +1,39 @@
+module BuckarooClient
+  class Transaction
+    attr_accessor :websitekey, :amount, :culture, :currency, :description, :invoicenumber
+    attr_accessor :service, :additional_services
+
+    def initialize(args = {})
+      @websitekey = args[:websitekey]
+      @amount = args[:amount]
+      @culture = args.fetch(:culture, 'nl-NL')
+      @currency = args.fetch(:currency, 'EUR')
+      @description = args[:description]
+      @invoicenumber = args[:invoicenumber]
+      @service = args[:service]
+      @additional_services = args.fetch(:additional_services, [])
+    end
+
+    def gateway_attributes
+      output = {
+        'websitekey' => websitekey,
+        'amount' => amount,
+        'culture' => culture,
+        'currency' => currency,
+        'description' => description,
+        'invoicenumber' => invoicenumber,
+      }
+      if service
+        output['service'] = service.servicecode
+        output.merge!(service.gateway_attributes)
+      end
+      if additional_services.count > 0
+        output['additional_service'] = additional_services.map(&:servicecode).join(',')
+        additional_services.each do |a|
+          output.merge!(a.gateway_attributes)
+        end
+      end
+      output
+    end
+  end
+end

data/lib/buckaroo_client/version.rb

@@ -0,0 +1,3 @@
+module BuckarooClient
+  VERSION = "0.0.1.pre"
+end

data/spec/buckaroo_client/gateway/batch_spec.rb

@@ -0,0 +1,54 @@
+require 'buckaroo_client/gateway/batch'
+
+describe BuckarooClient::Gateway::Batch do
+  INPUT_HASH = {
+    'websitekey' => 'xxx',
+    'amount' => '10.00',
+    'culture' => 'nl-NL',
+    'currency' => 'EUR',
+    'description' => 'test PPE 1',
+    'invoicenumber' => 'test01923r4a1',
+    'service' => 'payperemail',
+    'service_payperemail_action' => 'paymentinvitation',
+    'service_payperemail_customergender' => '1',
+    'service_payperemail_customeremail' => 'support@buckaroo.nl',
+    'service_payperemail_customerfirstname' => 'test',
+    'service_payperemail_customerlastname' => 'Tester',
+    'service_payperemail_merchantsendsemail' => 'FALSE',
+    'service_payperemail_paymentmethodsallowed' => 'ideal;transfer',
+    'service_payperemail_expirationdate' => '13-1-2012'
+  }
+  OUTPUT_CSV = <<CSV
+websitekey;amount;culture;currency;description;invoicenumber;service;service_payperemail_action;service_payperemail_customergender;service_payperemail_customeremail;service_payperemail_customerfirstname;service_payperemail_customerlastname;service_payperemail_merchantsendsemail;service_payperemail_paymentmethodsallowed;service_payperemail_expirationdate
+xxx;10.00;nl-NL;EUR;test PPE 1;test01923r4a1;payperemail;paymentinvitation;1;support@buckaroo.nl;test;Tester;FALSE;"ideal;transfer";13-1-2012
+CSV
+
+  describe '#size' do
+    it 'defaults to 0' do
+      expect(subject.size).to eq 0
+    end
+  end
+
+  describe '#each' do
+    it 'responds to method' do
+      expect { subject.each }.not_to raise_error
+    end
+  end
+
+  describe '<<' do
+    it 'stores object in transactions' do
+      expect(subject.size).to eq 0
+      mock_transaction = double()
+      subject << mock_transaction
+      expect(subject.size).to eq 1
+    end
+  end
+
+  describe '#to_csv' do
+    it 'converts Gateway-prepared data to valid CSV output' do
+      subject << double(gateway_attributes: INPUT_HASH)
+      expect(subject.to_csv).to eq OUTPUT_CSV
+    end
+  end
+
+end

data/spec/buckaroo_client/gateway/nvp_spec.rb

@@ -0,0 +1,173 @@
+require 'buckaroo_client/gateway/nvp'
+require 'dotenv'
+
+describe BuckarooClient::Gateway::NVP do
+
+  before :all do
+    Dotenv.load
+    ENV['BUCKAROO_CLIENT_WEBSITEKEY'] || raise("Please set BUCKAROO_CLIENT_WEBSITEKEY ENV variable")
+    ENV['BUCKAROO_CLIENT_SECRET'] || raise("Please set BUCKAROO_CLIENT_SECRET ENV variable")
+  end
+
+  def random_invoice_number
+    "TEST#{rand(100000000000000000000000000)}"
+  end
+
+  TRANSACTION_REQUEST_ATTRIBUTES = {
+    'channel' => 'BACKOFFICE',
+    'payment_method' => 'payperemail',
+    'amount' => '99.99',
+    'currency' => 'EUR',
+    'culture' => 'nl-NL',
+    'invoicenumber' => '0000',
+    'description' => 'Test payperemail transaction',
+    'service_payperemail_action' => 'paymentinvitation',
+    'service_payperemail_customergender' => '1',
+    'service_payperemail_customeremail' => 'example@example.com',
+    'service_payperemail_customerfirstname' => 'Cus',
+    # Set value below to TRUE to skip sending e-mails.
+    # Otherwise, Buckaroo sends an actual mail for test transactions.
+    'service_payperemail_merchantsendsemail' => 'TRUE',
+    'service_payperemail_customerlastname' => 'Tomer'
+  }
+
+  INVOICE_INFO_ATTRIBUTES = {
+    'invoicenumber' => '0000'
+  }
+
+  INVOICE_REQUEST_ATTRIBUTES = {
+    "brq_amount" =>  '120.9978',
+    "brq_culture" => "nl-NL",
+    "brq_currency" => "EUR",
+    "brq_description" => "Testfactuur",
+    # Don't use hard-coded invoicenumber, let spec generate random one.
+    # Buckaroo rejects duplicate invoicenumbers for Credit Management invoices.
+    # "brq_invoicenumber" => "123467898",
+    "brq_service" => "payperemail",
+    "brq_service_payperemail_action" => "paymentinvitation",
+    "brq_service_payperemail_customergender" => "9",
+    "brq_service_payperemail_customeremail" => 'example@example.com',
+    "brq_service_payperemail_customerfirstname" => "Cus",
+    "brq_service_payperemail_customerlastname" => "Tomer",
+    # Set value below to TRUE to skip sending e-mails.
+    # Otherwise, Buckaroo sends an actual mail for test transactions.
+    "brq_service_payperemail_merchantsendsemail" => "TRUE",
+    # "brq_service_payperemail_paymentmethodsallowed" => nil,
+    # "brq_service_payperemail_expirationdate" => nil,
+
+    "brq_additional_service" => "creditmanagement,invoicespecification",
+
+    "brq_service_InvoiceSpecification_action" => "ExtraInfo",
+    "brq_service_InvoiceSpecification_InvoiceLine_1" =>
+      "1|Factuurregelomschrijving|€|99.99|20.9979|||",
+    "brq_service_InvoiceSpecification_SubTotalLine_1" =>
+      "2|Totaal exclusief BTW|€|99.99||||",
+    "brq_service_InvoiceSpecification_InvoiceLine_2" =>
+      "3|Totaal BTW|€|20.9979||||",
+    "brq_service_InvoiceSpecification_TotalLine_1" =>
+      "4|Totaal inclusief BTW|€|120.9879||||",
+
+    "brq_service_creditmanagement_action" => "invoice",
+    "brq_InvoiceDate" => "2014-11-20",
+    "brq_DateDue" => "2014-12-04",
+    "brq_AmountVat" => "20.9979",
+    "brq_service_creditmanagement_MaxReminderLevel" => "3",
+    # "brq_service_creditmanagement_PaymentMethodsAllowed" => "",
+    "brq_CustomerType" => "2",
+    "brq_CustomerCode" => "14342",
+    "brq_CustomerTitle" => "",
+    "brq_CustomerInitials" => "",
+    "brq_CustomerFirstName" => "Cus",
+    "brq_CustomerLastNamePrefix" => "",
+    "brq_CustomerLastName" => "Tomer",
+    "brq_CustomerGender" => "9",
+    "brq_service_creditmanagement_CustomerBirthDate" => "",
+    "brq_CustomerEmail" => "example@example.com",
+    "brq_PhoneNumber" => "+31999999999",
+    "brq_MobilePhoneNumber" => "",
+    "brq_FaxNumber" => "",
+    "brq_Address_Street_1" => "Straatlaan",
+    "brq_Address_HouseNumber_1" => "999",
+    "brq_Address_HouseNumberSuffix_1" => "",
+    "brq_Address_ZipCode_1" => "9999 ZZ",
+    "brq_Address_City_1" => "Stad",
+    "brq_Address_State_1" => "",
+    "brq_Address_Country_1" => "NL",
+    "brq_service_creditmanagement_CustomerAccountNumber" => "",
+    "brq_service_creditmanagement_CompanyName" => "Organization1",
+    "brq_service_creditmanagement_CompanyCOCRegistration" => "A99",
+    "brq_service_creditmanagement_CompanyVATApplicable" => "TRUE"
+  }
+
+  describe '.websitekey' do
+    it 'raises error if not set' do
+      old_value = ENV.delete('BUCKAROO_CLIENT_WEBSITEKEY')
+      expect { described_class.websitekey }.to raise_error
+      ENV['BUCKAROO_CLIENT_WEBSITEKEY'] = old_value
+    end
+  end
+
+  describe '.secret_key' do
+    it 'raises error if not set' do
+      old_value = ENV.delete('BUCKAROO_CLIENT_SECRET')
+      expect { described_class.secret_key }.to raise_error
+      ENV['BUCKAROO_CLIENT_SECRET'] = old_value
+    end
+  end
+
+  describe '.url' do
+    it 'defaults to test location' do
+      expect(ENV['BUCKAROO_CLIENT_ENVIRONMENT']).to eq nil
+      expect(described_class.url.to_s).to eq 'https://testcheckout.buckaroo.nl/nvp/'
+    end
+
+    it 'returns live location if live mode enabled' do
+      expect(ENV['BUCKAROO_CLIENT_ENVIRONMENT']).to eq nil
+      ENV['BUCKAROO_CLIENT_ENVIRONMENT'] = 'production'
+      expect(described_class.url.to_s).to eq 'https://checkout.buckaroo.nl/nvp/'
+      ENV.delete('BUCKAROO_CLIENT_ENVIRONMENT')
+    end
+  end
+
+  describe '.transaction_request' do
+    it 'returns a success response' do
+      response = described_class.transaction_request(TRANSACTION_REQUEST_ATTRIBUTES)
+      # Success response code for PayPerEmail: 792 Awaiting Consumer
+      expect(response.body).to include('BRQ_STATUSCODE=792')
+      expect(response.verified?).to eq true
+      expect(response.success).to eq true
+    end
+
+    it 'returns success for valid PayPerEmail request with InvoiceSpecification and CreditManagement' do
+      variables = INVOICE_REQUEST_ATTRIBUTES.merge('brq_invoicenumber' => random_invoice_number)
+      response = described_class.transaction_request(variables)
+      # Success response code for PayPerEmail: 792 Awaiting Consumer
+      expect(response.body).to include('BRQ_STATUSCODE=792')
+      expect(response.verified?).to eq true
+      expect(response.success).to eq true
+    end
+  end
+
+  describe '.transaction_status' do
+    pending 'not yet implemented'
+  end
+
+  describe '.invoice_info' do
+    it 'returns a success response for an existing transaction' do
+      described_class.transaction_request(TRANSACTION_REQUEST_ATTRIBUTES)
+      response = described_class.invoice_info(INVOICE_INFO_ATTRIBUTES)
+      expect(response.body).to include('BRQ_APIRESULT=Success')
+    end
+  end
+
+  describe '.transaction_request_specification' do
+    it 'returns a succesful response' do
+      params = {
+        'channel' => 'BACKOFFICE',
+        'services' => 'payperemail'
+      }
+      response = described_class.transaction_request_specification(params)
+      expect(response.body).to include('BRQ_APIRESULT=Success')
+    end
+  end
+end