wirecard_checkout_page 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc51edcaa21801adf0d37957f3990226d9184b66
-  data.tar.gz: 2a97377d4cee7c220213c2b46f16f0929082b3bf
+  metadata.gz: e9938c8656716ad478ae1decf6e699af89c27a21
+  data.tar.gz: 234cfd69101fb4cd77c68113ff76506b9828a0a4
 SHA512:
-  metadata.gz: 17df65f469ef1335cd5d70617d5922a138a4c860d439774de221b59c57a53fa329292ef74580374258b84239d11340c6581cf933fa0157a3c20d3ca27f10c0c7
-  data.tar.gz: edfea03e52cbb6efd033c0699ca99b8c24802fb31cd24fbc86f6433352d93cd98799d9f7520b85e7e7b4d7804390178e64858fc1a87225309b07411f8fb1ab2a
+  metadata.gz: 46bb266f885eaf7b2b4e02fc158cb4c4c228ee07adce3a6340c3c6d27eca484b7ec83c3c0f8075b6c01cd7c1b6bee1e9aa3a76603b4f8718ddc284ea0e8f78ff
+  data.tar.gz: c707323a6264a864130258e842108c39df9f04084d4495be6ccd9f4dc24e9eb84e40a1eb0b883bf57f3c4a40d2a7818c864fad8111667b96853886d75db0c333

data/.gitignore

@@ -1,6 +1,7 @@
 .*.sw[pon]
 .AppleDouble
 .DS_Store
+.envrc
 .rvmrc
 Gemfile.lock
 coverage

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
-  - 2.0.0
+  - 2.0
   - 2.1
+  - 2.2
   - ruby-head
   - jruby-head
 matrix:

data/Gemfile

@@ -5,3 +5,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem "codeclimate-test-reporter", group: :test, require: nil
+
+gem 'byebug', group: :test, platforms: :mri

data/README.md

@@ -41,3 +41,7 @@ puts response.params
 [![Code Climate](https://codeclimate.com/github/flori/wirecard_checkout_page/badges/gpa.svg)](https://codeclimate.com/github/flori/wirecard_checkout_page)
 
 [![Test Coverage](https://codeclimate.com/github/flori/wirecard_checkout_page/badges/coverage.svg)](https://codeclimate.com/github/flori/wirecard_checkout_page)
+
+
+## TODOS
+[] Document the toolkit features

data/Rakefile

@@ -10,7 +10,7 @@ GemHadar do
   summary     'Library for using Wirecard Checkout Page'
   description 'This library allows you to use the Wirecard Checkout Page service.'
   test_dir    'tests'
-  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc', '.AppleDouble', '.DS_Store'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc', '.AppleDouble', '.DS_Store', '.envrc'
   readme      'README.md'
   title       "#{name.camelize} -- Wirecard Checkout Page implementation"
   licenses    << 'Apache-2.0'
@@ -19,7 +19,6 @@ GemHadar do
   development_dependency 'rake'
   development_dependency 'simplecov'
   development_dependency 'rspec'
-  development_dependency 'byebug'
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/wirecard_checkout_page.rb

@@ -1,13 +1,17 @@
 require 'digest/md5'
-require 'uri'
 require 'typhoeus'
 require 'wirecard_checkout_page/errors'
 require 'wirecard_checkout_page/gateway'
 require 'wirecard_checkout_page/utils'
-require 'wirecard_checkout_page/request_checksum'
 require 'wirecard_checkout_page/response_checksum'
+require 'wirecard_checkout_page/request'
+require 'wirecard_checkout_page/init_request'
 require 'wirecard_checkout_page/init_response'
 require 'wirecard_checkout_page/checked_response'
+require 'wirecard_checkout_page/fingerprint'
+require 'wirecard_checkout_page/toolkit/request'
+require 'wirecard_checkout_page/toolkit/response'
+require 'wirecard_checkout_page/toolkit/recur_payment'
 
 module WirecardCheckoutPage
 end

data/lib/wirecard_checkout_page/errors.rb

@@ -2,4 +2,6 @@ module WirecardCheckoutPage
   class WirecardCheckoutPageError < StandardError; end
 
   class ValueMissing < WirecardCheckoutPageError; end
+  class NotImplementedError < WirecardCheckoutPageError; end
+  class InvalidResponseFingerPrintOrder < WirecardCheckoutPageError; end
 end

data/lib/wirecard_checkout_page/gateway.rb

@@ -1,30 +1,44 @@
 module WirecardCheckoutPage
   class Gateway
-    DEFAULT_INIT_URL = 'https://checkout.wirecard.com/page/init.php'
 
-    attr_accessor :customerId, :secret, :init_url
+    attr_accessor :customer_id, :secret, :toolkit_password, :shop_id
 
-    def initialize(customerId: nil, secret: nil, init_url: nil)
-      @customerId = customerId
-      @secret     = secret
-      @init_url   = init_url || DEFAULT_INIT_URL
+    def initialize(customer_id: nil, secret: nil, toolkit_password: nil, shop_id: nil)
+      @customer_id      = customer_id
+      @secret           = secret
+      @toolkit_password = toolkit_password
+      @shop_id          = shop_id
     end
 
     def init(params = {})
-      checksum = WirecardCheckoutPage::RequestChecksum.new(params.merge(authentication_params))
-      InitResponse.new Typhoeus.post(init_url, body: checksum.request_parameters)
+      params = params.merge(authentication_params).merge( transactionIdentifier: 'SINGLE' )
+      InitRequest.new(params: params).call
+    end
+
+    def recurring_init(params = {})
+      params = params.merge(authentication_params).merge( transactionIdentifier: 'INITIAL' )
+      InitRequest.new(params: params).call
+    end
+
+    def recurring_process(params = {})
+      params = params.merge(toolkit_authentication_params)
+      Toolkit::RecurPayment.new(params: params).call
     end
 
     def check_response(params = {})
-      WirecardCheckoutPage::CheckedResponse.new(
-        params.merge(authentication_params)
-      )
+      CheckedResponse.new params.merge(authentication_params)
     end
 
     private
 
     def authentication_params
-      { secret: secret, customerId: customerId }
+      params = { secret: secret, customerId: customer_id }
+      params[:shopId] = shop_id if shop_id
+      params
+    end
+
+    def toolkit_authentication_params
+      authentication_params.merge( toolkitPassword: toolkit_password )
     end
 
   end

data/lib/wirecard_checkout_page/init_request.rb

@@ -0,0 +1,71 @@
+module WirecardCheckoutPage
+  class InitRequest < Request
+
+    DEFAULT_URL = 'https://checkout.wirecard.com/page/init.php'
+
+    def initialize(url: nil, params: {})
+      super url: url || DEFAULT_URL, params: params
+      self.transactionIdentifier ||= 'SINGLE'
+    end
+
+    # Parameter        Within fingerprint Data type	Short description
+    # customerId       Required           Alphanumeric with a fixed length of 7. Unique ID of merchant.
+    # language         Required           Alphabetic with a fixed length of 2.   Language for displayed texts on payment page.
+    # paymentType      Optional           Enumeration	Selected payment method of your consumer.
+    # amount           Required           Amount                                 Amount of payment.
+    # currency         required           Alphabetic with a fixed length of 3 or numeric with a fixed length of 3.	Currency code of amount.
+    # orderDescription Required           Alphanumeric with a variable length of up to 255.	Unique description of the consumer's order in a human readable form.
+    # successUrl       Required           Alphanumeric with special characters.  URL of your online shop when payment process was successful.
+    # cancelUrl        Optional           Alphanumeric with special characters.  URL of your online shop when payment process has been canceled.
+    # failureUrl       Optional           Alphanumeric with special characters.  URL of your online shop when an error occured within payment process.
+    # serviceUrl       Optional           Alphanumeric with special characters and a variable length of up to 255.	URL of your service page containing contact information.
+
+    param :secret,           required: true
+    param :customerId,       required: true
+    param :language,         required: true
+    param :paymentType,      required: true
+    param :amount,           required: true
+    param :currency,         required: true
+    param :orderDescription, required: true
+    param :successUrl,       required: true
+    param :cancelUrl,        required: true # Seems to be required even if the docs say otherwise
+    param :failureUrl,       required: true # Seems to be required even if the docs say otherwise
+    param :serviceUrl,       required: true # Seems to be required even if the docs say otherwise
+
+    # Parameter             Within fingerprint Data type	Short description
+    # pendingUrl            Optional           Alphanumeric with special characters.	URL of your online shop when result of payment process could not be determined yet.
+    # confirmUrl            Required if used.  Alphanumeric with special characters.	URL of your online shop where Wirecard sends a server-to-server confirmation.
+    # noScriptInfoUrl       Optional           Alphanumeric with special characters.	URL of your online shop where your information page regarding de-activated JavaScript resides.
+    # orderNumber           Required if used.  Numeric with a variable length of up to 9.	Order number of payment.
+    # windowName            Optional           Alphanumeric	Window name of browser window where payment page is opened.
+    # duplicateRequestCheck Required if used.  Boolean (“yes” or “no”).	Check for duplicate requests done by your consumer.
+    # customerStatement     Required if used.  Alphanumeric with a variable length of up to 254 characters, but may differ for specific payment methods.	Text displayed on invoice of financial institution of your consumer.
+    # orderReference        Required if used.  Alphanumeric with a variable length up to 128 characters, but may differ for specific payment methods.	Unique order reference ID sent from merchant to financial institution.
+    # transactionIdentifier Required if used.  Enumeration	Possible values are SINGLE (for one-off transactions) or INITIAL (for the first transaction of a series of recurring transactions).
+
+    param :pendingUrl
+    param :confirmUrl,        required: true # Seems to be required even if the docs say otherwise
+    param :noScriptInfoUrl
+    param :orderNumber
+    param :windowName
+    param :duplicateRequestCheck
+    param :customerStatement
+    param :orderReference
+    param :transactionIdentifier
+    param :shopId
+
+    def fingerprint_order
+      super + [:requestFingerprintOrder]
+    end
+
+    def requestFingerprintOrder
+      fingerprint_order * ','
+    end
+
+    def call
+      raise WirecardCheckoutPage::ValueMissing, errors.join(', ') unless valid?
+      InitResponse.from_typhoeus_response Typhoeus.post(DEFAULT_URL, body: body)
+    end
+
+  end
+end

data/lib/wirecard_checkout_page/init_response.rb

@@ -3,10 +3,20 @@
 
 module WirecardCheckoutPage
   class InitResponse
-    def initialize(response)
-      @original_response = response
+
+    def self.from_typhoeus_response(response)
+      new(response.body, original_response: response)
+    end
+
+    def initialize(body, original_response: nil)
+      @body = body
+      @original_response = original_response
     end
 
+    attr_reader :original_response
+
+    attr_reader :body
+
     def params
       {
         payment_url: @original_response.headers['Location']

data/lib/wirecard_checkout_page/request.rb

@@ -0,0 +1,85 @@
+module WirecardCheckoutPage
+  class Request
+    def self.param(name, options = {})
+      name = name.to_sym
+      params_order << name
+      params[name] = options
+      attr_accessor name
+    end
+
+    def self.params
+      @params ||= {}
+    end
+
+    def self.params_order
+      @params_order ||= []
+    end
+
+    def initialize(url: nil, params: {})
+      @url = url
+      params.each { |param, value| send "#{param}=", value }
+    end
+
+    attr_reader :url
+
+    attr_reader :params
+
+    attr_reader :errors
+
+    def valid?
+      @errors = []
+      attributes.each do |param, options|
+        next unless options[:required] == true
+        val = send param
+        @errors << "#{param} is required" if val.nil? || val == ''
+      end
+      @errors.empty?
+    end
+
+    def body
+      fingerprinted_request_params
+    end
+
+    def call
+      raise NotImplementedError, '#call not implemented'
+    end
+
+    def fingerprint_string
+      fingerprint_order.each_with_object('') { |param, str| str << send(param).to_s }
+    end
+
+    def fingerprint
+      Digest::MD5.hexdigest fingerprint_string
+    end
+
+    def fingerprint_order
+      self.class.params_order.select do |param|
+        attributes[param][:required] || send(param).to_s != ''
+      end
+    end
+
+    def request_params
+      rp = {}
+      attributes.keys.each do |param|
+        next if param == :secret
+        val = send(param).to_s
+        next if val == ''
+        rp[param.to_s] = val
+      end
+      rp
+    end
+
+    def fingerprinted_request_params
+      request_params.merge(
+        'requestFingerprint'      => fingerprint,
+        'requestFingerprintOrder' => fingerprint_order.join(',')
+      )
+    end
+
+    private
+
+    def attributes
+      self.class.params
+    end
+  end
+end

data/lib/wirecard_checkout_page/response_checksum.rb

@@ -1,64 +1,34 @@
 # encoding: utf-8
 
-require 'wirecard_checkout_page/value_handling'
-
 module WirecardCheckoutPage
   class ResponseChecksum
     include WirecardCheckoutPage::Utils
-    include WirecardCheckoutPage::ValueHandling
-
-    def initialize(values = {})
-      @values = stringify_keys(values)
-      @secret = @values.delete('secret') or
-        raise WirecardCheckoutPage::ValueMissing, 'value "secret" is missing'
-      # This rails form value is escaped as an html entity by
-      # WirecardCheckoutPage, so set it back to the original UTF-8 here if it
-      # exists:
-      @values['utf8'] and @values['utf8'] = '✓'
-      @values.freeze
-      reset_missing_keys
-    end
-
-    attr_reader :values
-
-    attr_reader :expected_fingerprint
-
-    attr_reader :computed_fingerprint
 
-    def fingerprint
-      values = @values.dup
-      values['secret'] ||= @secret
-      if seed = responseFingerprintSeed(responseFingerprintOrder(values), values)
-        Digest::MD5.hexdigest seed
+    def initialize(params)
+      @params = stringify_keys(params)
+      unless response_fingerprint_order_parts.include? 'secret'
+        raise InvalidResponseFingerPrintOrder, 'Missing :secret as a part of the responseFingerprintOrder'
       end
     end
 
+    attr_reader :params
+
     def valid?
-      reset_missing_keys
-      @expected_fingerprint = values.fetch('responseFingerprint') do |k|
-        add_missing_key k
-      end
-      @computed_fingerprint = fingerprint
-      !missing_keys? && computed_fingerprint == @expected_fingerprint
+      params['responseFingerprint'] == computed_fingerprint
     end
 
     private
 
-    def responseFingerprintOrder(values)
-      order = values.fetch('responseFingerprintOrder') do |k|
-        add_missing_key k
-        return []
-      end
-      order.split(',')
+    def response_fingerprint_order_parts
+      params['responseFingerprintOrder'].to_s.split(',')
+    end
+
+    def fingerprint_string
+      response_fingerprint_order_parts.map {|key| params[key.to_s] }.join
     end
 
-    def responseFingerprintSeed(keys, values)
-      fingerprint = keys.map do |k|
-        values.fetch(k) do
-          add_missing_key k
-        end
-      end * ''
-      fingerprint unless missing_keys?
+    def computed_fingerprint
+      Digest::MD5.hexdigest fingerprint_string
     end
   end
 end

data/lib/wirecard_checkout_page/toolkit/recur_payment.rb

@@ -0,0 +1,66 @@
+module WirecardCheckoutPage
+  module Toolkit
+    class RecurPayment < Request
+
+      def initialize(params: {})
+        super
+        self.command = 'recurPayment'
+      end
+
+      # Which request parameters are required for all operations?
+      # To start an operation you have to set all required parameters to their corresponding values.
+      # If one or more of these required parameters are missing you will get an error message.
+
+      # Parameter          Data type                               Short description
+      # customerId         Alphanumeric with a fixed length of 7.  Unique ID of merchant.
+      # shopId             Alphanumeric with a variable length of 16. Unique ID of your online shop if several
+      # toolkitPassword    Alphanumeric with special characters.   Your password for Toolkit light operations.
+      # command            Enumeration                             Operation to be executed.
+      # language           Alphabetic with a fixed length of 2.    Language for returned texts and error messages,
+      #                                                            currently only “en” is supported; we are able
+      #                                                            to integrate other languages upon request.
+      # requestFingerprint Alphanumeric with a fixed length of 32. Computed fingerprint of the parameter
+      #                                                            values and the secret.
+      param :customerId,      required: true
+      param :shopId
+      param :toolkitPassword, required: true
+      param :secret,          required: true
+      param :command,         required: true
+      param :language,        required: true
+
+      # Additional required request parameters
+      #
+      # Parameter         Data type                             Short description
+      # amount            Amount                                Debit amount.
+      # currency          Alphabetic with a fixed length of 3   Currency code of amount.
+      #                   or numeric with a fixed length of 3.
+      # orderDescription  Alphanumeric with a variable length   Textual description of order.
+      #                   of up to 255 characters.
+      # sourceOrderNumber Numeric with a variable length of     Original order number used for new payment.
+      #                   up to 9 digits.
+
+      # Additional optional request parameters
+      #
+      # Parameter         Data type                             Short description
+      # autoDeposit       Enumeration                           Possible values are Yes and No.
+      #                                                         Yes is used for enabling and No for
+      #                                                         disabling automated deposit and
+      #                                                         day-end closing of payments.
+      # customerStatement Alphanumeric with a variable length   Text displayed on invoice of
+      #                   of up to 254 characters.              financial institution of your consumer.
+      # orderNumber       Numeric with a variable length        Order number of payment.
+      #                   of up to 9 digits.
+      # orderReference    Alphanumeric with a variable length   Unique order reference ID sent from
+      #                   of up to 128 characters.              merchant to financial institution.
+      param :orderNumber
+      param :sourceOrderNumber, required: true
+      param :autoDeposit
+      param :orderDescription,  required: true
+      param :amount,            required: true
+      param :currency,          required: true
+      param :orderReference
+      param :customerStatement
+
+    end
+  end
+end