adyen_hpp_hmac_calculator 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b1be53b37437d64f8bc5ec0f8db578c8d29fb57
+  data.tar.gz: 50e9d526eab72dadcae12d8306f32fa3b8c472cd
+SHA512:
+  metadata.gz: 70f5dd042cfa42531e944f3f426dcfd635f66d706c0ef9bb9f8745b8019a8020f6630695e6f82c0a9bedc1b7771139a0459158b2bc86d50f8f1d37e2f273eb7c
+  data.tar.gz: 31aea3e4151af05e585a5384a491290035c19b99d1251aed531bf8f9ef2223fe4847abfee927f4a1fac7c087893641c38cf6337ad0a80a7796f8c2384c80e416

data/lib/adyen_hpp_hmac_calculator.rb

@@ -0,0 +1,61 @@
+require 'base64'
+
+# Calculates merchant signature for Adyen payment serivce (http://www.adyen.com).
+# It is based on documentation from:
+# https://docs.adyen.com/pages/viewpage.action?pageId=5376964
+#
+# @example Calculating merchant signature using AdyenHppHmacCalculator::calculate:
+#   hmac_key = "4468D9782DEF54FCD706C9100C71EC43932B1EBC2ACF6BA0560C05AAA7550C48"
+#   params = { 
+#     "merchantAccount"   => "TestMerchant",
+#     "currencyCode"      => "EUR",
+#     "paymentAmount"     => "199",
+#     "sessionValidity"   => "2015-06-25T10:31:06Z",
+#     "shipBeforeDate"    => "2015-07-01",
+#     "shopperLocale"     => "en_GB",
+#     "merchantReference" => "SKINTEST-1435226439255",
+#     "skinCode"          => "X7hsNDWp"
+#   }
+#   AdyenHppHmacCalculator.calculate(hamc_key, params) #=> "GJ1asjR5VmkvihDJxCd8yE2DGYOKwWwJCBiV3R51NFg="
+class AdyenHppHmacCalculator
+  def initialize hmac_key
+    @hmac_key = hmac_key.clone.freeze
+  end
+
+  # Calculates merchant signature for specified params using hmac key specified on initialization
+  #
+  # @param params [Hash] key/value pairs to calculate merchant signature
+  # @return [String] HMAC SHA-256 Base64 signature encoded
+  def calculate params
+    merchant_string = generate_merchant_string params
+    hmac = hmac_calculator.calculate merchant_string
+    base64_encode hmac
+  end
+
+  # Calculates merchant signatre for specified hmac key and params
+  # https://docs.adyen.com/pages/viewpage.action?pageId=5376964
+  #
+  # @param hmac_key [String] key for HMAC algorithm
+  # @param params [Hash] key/value pairs to calculate merchant signature
+  # @return [String] HMAC SHA-256 Base64 signature encoded
+  def self.calculate hmac_key, params
+    self.new(hmac_key).calculate params
+  end
+  
+  private
+
+  def generate_merchant_string params
+    MerchantStringGenerator.generate params
+  end
+
+  def hmac_calculator
+    @hmac_calculator ||= HmacCalculator.new @hmac_key
+  end
+
+  def base64_encode string
+    Base64.strict_encode64 string
+  end
+end
+
+require 'adyen_hpp_hmac_calculator/merchant_string_generator'
+require 'adyen_hpp_hmac_calculator/hmac_calculator'

data/lib/adyen_hpp_hmac_calculator/hmac_calculator.rb

@@ -0,0 +1,23 @@
+require 'openssl'
+
+class AdyenHppHmacCalculator::HmacCalculator
+  DIGEST = OpenSSL::Digest.new('sha256')
+
+  def initialize hmac_key
+    @hmac_key_hex = string_to_hex hmac_key
+  end
+
+  # Calculates HMAC SHA-256 from string 
+  #
+  # @param string [String] string to calculate HMAC SHA-256
+  # @return [String] HMAC SHA-256 string
+  def calculate string
+    OpenSSL::HMAC.digest(DIGEST, @hmac_key_hex, string)
+  end
+
+  private
+
+  def string_to_hex string
+    Array(string).pack('H*')
+  end
+end

data/lib/adyen_hpp_hmac_calculator/merchant_string_generator.rb

@@ -0,0 +1,49 @@
+module AdyenHppHmacCalculator::MerchantStringGenerator
+  # Generates concatenated key/value paris
+  #
+  # @param params [Hash] key/value pairs to generate the signing string
+  # @return [String] concatenated key/value pairs
+  def self.generate params
+    pairs = create_pairs params
+    remove_unnecessary_keys pairs
+    sort_key_value_pairs_by_key pairs
+    delimit_pairs pairs
+    concatenate_pairs pairs
+  end
+
+  private
+  
+  def self.create_pairs params
+    params.map{ |key, value| [key.to_s.dup, value.to_s.dup] }
+  end
+
+  def self.remove_unnecessary_keys pairs
+    pairs.reject! { |key, _| ignored_key? key }
+  end
+
+  def self.ignored_key? key
+    key == 'sig' or key == 'merchantSig' or key.start_with? 'ignore.' 
+  end
+
+  def self.sort_key_value_pairs_by_key pairs
+    pairs.sort_by!{ |key, _| key }
+  end
+
+  def self.delimit_pairs pairs
+    pairs.each do |key, value|
+      escape! key
+      escape! value
+    end
+  end
+
+  def self.escape! string
+    string.gsub!('\\'){ '\\\\' }
+    string.gsub!(':'){ '\:' }
+  end
+
+  def self.concatenate_pairs pairs
+    keys = pairs.collect(&:first)
+    values = pairs.collect(&:last)
+    (keys + values).join(':')
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: adyen_hpp_hmac_calculator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Krzysztof Zielonka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: Merchant signature calculator for Adyen (https://www.adyen.com) payments
+  service. It is implementation of HPP HMAC (SHA-256) algorithm from Adyen documentation
+  (https://docs.adyen.com/display/TD/HPP+HMAC+calculation).
+email: aknolezik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/adyen_hpp_hmac_calculator.rb
+- lib/adyen_hpp_hmac_calculator/hmac_calculator.rb
+- lib/adyen_hpp_hmac_calculator/merchant_string_generator.rb
+homepage: https://rubygems.org/gems/adyen_hpp_hmac_calculator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adyen HPP HMAC calculator
+test_files: []
+has_rdoc: