adyen-ruby-api-library 7.0.1 → 7.0.3

data/lib/adyen/services/service.rb

@@ -1,6 +1,6 @@
 module Adyen
   class Service
-    attr_accessor :service, :version, :create_query_string
+    attr_accessor :service, :version
 
     # add snake case to camel case converter to String
     # to convert rubinic method names to Adyen API methods
@@ -11,7 +11,7 @@ module Adyen
       method_name.to_s.gsub(/_./) { |x| x[1].upcase }
     end
 
-    def initialize(client, version, service, method_names, with_application_info = [])
+    def initialize(client, version, service, method_names = [], with_application_info = [])
       @client = client
       @version = version
       @service = service
@@ -20,14 +20,15 @@ module Adyen
       method_names.each do |method_name|
         define_singleton_method method_name do |request, headers = {}|
           action = self.class.action_for_method_name(method_name)
-          @client.call_adyen_api(@service, action, request, headers, @version, with_application_info.include?(method_name))
+          @client.call_adyen_api(@service, action, request, headers, @version,
+                                 _with_application_info: with_application_info.include?(method_name))
         end
       end
     end
 
     # create query parameter from a hash
     def create_query_string(arr)
-      "?" + URI.encode_www_form(arr)
+      "?#{URI.encode_www_form(arr)}"
     end
   end
 end

data/lib/adyen/services/storedValue.rb

@@ -1,86 +1,64 @@
 require_relative './service'
 module Adyen
-
-
   class StoredValue < Service
     attr_accessor :service, :version
-    DEFAULT_VERSION = 46
 
+    DEFAULT_VERSION = 46
     def initialize(client, version = DEFAULT_VERSION)
-      @service = "StoredValue"
-      @client = client
-      @version = version
+      super(client, version, 'StoredValue')
     end
 
-    def change_status(request, headers: {} )
-      """
-      Changes the status of the payment method.
-      """
-      endpoint = "/changeStatus".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def change_status(request, headers: {})
+      endpoint = '/changeStatus'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def check_balance(request, headers: {} )
-      """
-      Checks the balance.
-      """
-      endpoint = "/checkBalance".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def check_balance(request, headers: {})
+      endpoint = '/checkBalance'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def issue(request, headers: {} )
-      """
-      Issues a new card.
-      """
-      endpoint = "/issue".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def issue(request, headers: {})
+      endpoint = '/issue'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def load(request, headers: {} )
-      """
-      Loads the payment method.
-      """
-      endpoint = "/load".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def load(request, headers: {})
+      endpoint = '/load'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def merge_balance(request, headers: {} )
-      """
-      Merge the balance of two cards.
-      """
-      endpoint = "/mergeBalance".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def merge_balance(request, headers: {})
+      endpoint = '/mergeBalance'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def void_transaction(request, headers: {} )
-      """
-      Voids a transaction.
-      """
-      endpoint = "/voidTransaction".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def void_transaction(request, headers: {})
+      endpoint = '/voidTransaction'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 

data/lib/adyen/services/transfers/capital_api.rb

@@ -0,0 +1,38 @@
+require_relative '../service'
+module Adyen
+  class CapitalApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'Transfers')
+    end
+
+    def get_capital_account(headers: {}, query_params: {})
+      endpoint = '/grants'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def get_grant_reference_details(id, headers: {})
+      endpoint = '/grants/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def request_grant_payout(request, headers: {})
+      endpoint = '/grants'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/transfers/transactions_api.rb

@@ -1,37 +1,27 @@
 require_relative '../service'
 module Adyen
-
-
   class TransactionsApi < Service
     attr_accessor :service, :version
 
     def initialize(client, version = DEFAULT_VERSION)
-      @service = "Transfers"
-      @client = client
-      @version = version
+      super(client, version, 'Transfers')
     end
 
-    def get_all_transactions(headers: {} , queryParams: {})
-      """
-      Get all transactions
-      """
-      endpoint = "/transactions".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
-      endpoint = endpoint + create_query_string(queryParams)
-      action = { method: "get", url: endpoint}
+    def get_all_transactions(headers: {}, query_params: {})
+      endpoint = '/transactions'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
-    def get_transaction(id, headers: {} )
-      """
-      Get a transaction
-      """
-      endpoint = "/transactions/{id}".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % [id]
+    def get_transaction(id, headers: {})
+      endpoint = '/transactions/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
       
-      action = { method: "get", url: endpoint}
+      action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 

data/lib/adyen/services/transfers/transfers_api.rb

@@ -1,25 +1,18 @@
 require_relative '../service'
 module Adyen
-
-
   class TransfersApi < Service
     attr_accessor :service, :version
 
     def initialize(client, version = DEFAULT_VERSION)
-      @service = "Transfers"
-      @client = client
-      @version = version
+      super(client, version, 'Transfers')
     end
 
-    def transfer_funds(request, headers: {} )
-      """
-      Transfer funds
-      """
-      endpoint = "/transfers".gsub(/{.+?}/, '%s') 
-      endpoint = endpoint.gsub(/^\//, "")
-      endpoint = endpoint % []
+    def transfer_funds(request, headers: {})
+      endpoint = '/transfers'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
       
-      action = { method: "post", url: endpoint}
+      action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 

data/lib/adyen/services/transfers.rb

@@ -1,26 +1,29 @@
+require_relative 'transfers/capital_api'
 require_relative 'transfers/transactions_api'
 require_relative 'transfers/transfers_api'
 
 module Adyen
-    
+  class Transfers
+    attr_accessor :service, :version
 
-    class Transfers
-        attr_accessor :service, :version
-        
-        DEFAULT_VERSION = 3
-        def initialize(client, version = DEFAULT_VERSION)
-        @service = "Transfers"
-        @client = client
-        @version = version
-        end
+    DEFAULT_VERSION = 3
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = 'Transfers'
+      @client = client
+      @version = version
+    end
 
-        def transactions_api
-            @transactions_api ||= Adyen::TransactionsApi.new(@client, @version)
-        end
+    def capital_api
+      @capital_api ||= Adyen::CapitalApi.new(@client, @version)
+    end
 
-        def transfers_api
-            @transfers_api ||= Adyen::TransfersApi.new(@client, @version)
-        end
+    def transactions_api
+      @transactions_api ||= Adyen::TransactionsApi.new(@client, @version)
+    end
 
+    def transfers_api
+      @transfers_api ||= Adyen::TransfersApi.new(@client, @version)
     end
-end
+
+  end
+end

data/lib/adyen/utils/hmac_validator.rb

@@ -3,28 +3,39 @@ module Adyen
     class HmacValidator
       HMAC_ALGORITHM = 'sha256'.freeze
       DATA_SEPARATOR = ':'.freeze
-      NOTIFICATION_VALIDATION_KEYS = %w[
+      WEBHOOK_VALIDATION_KEYS = %w[
         pspReference originalReference merchantAccountCode merchantReference
         amount.value amount.currency eventCode success
       ].freeze
 
+      # <b>DEPRECATED:</b> Please use valid_webhook_hmac?() instead.
       def valid_notification_hmac?(notification_request_item, hmac_key)
-        expected_sign = calculate_notification_hmac(notification_request_item, hmac_key)
-        merchant_sign = fetch(notification_request_item, 'additionalData.hmacSignature')
+        valid_webhook_hmac?(notification_request_item, hmac_key)
+      end
+
+      def valid_webhook_hmac?(webhook_request_item, hmac_key)
+        expected_sign = calculate_webhook_hmac(webhook_request_item, hmac_key)
+        merchant_sign = fetch(webhook_request_item, 'additionalData.hmacSignature')
 
         expected_sign == merchant_sign
       end
 
+      # <b>DEPRECATED:</b> Please use calculate_webhook_hmac() instead.
       def calculate_notification_hmac(notification_request_item, hmac_key)
-        data = data_to_sign(notification_request_item)
+        calculate_webhook_hmac(notification_request_item, hmac_key)
+      end
+
+    
+      def calculate_webhook_hmac(webhook_request_item, hmac_key)
+        data = data_to_sign(webhook_request_item)
 
         Base64.strict_encode64(OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data))
       end
 
-      def data_to_sign(notification_request_item)
-        data = NOTIFICATION_VALIDATION_KEYS.map { |key| fetch(notification_request_item, key).to_s }
+
+      def data_to_sign(webhook_request_item)
+        data = WEBHOOK_VALIDATION_KEYS.map { |key| fetch(webhook_request_item, key).to_s }
                                     .join(DATA_SEPARATOR)
-        return data
       end
 
       private

data/lib/adyen/version.rb

@@ -1,4 +1,4 @@
 module Adyen
-  NAME = "adyen-ruby-api-library"
-  VERSION = "7.0.1".freeze
-end
+  NAME = 'adyen-ruby-api-library'.freeze
+  VERSION = '7.0.3'.freeze
+end

data/lib/adyen-ruby-api-library.rb

@@ -1,21 +1,21 @@
-require_relative "adyen/version"
-require_relative "adyen/client"
-require_relative "adyen/errors"
-require_relative "adyen/services/checkout"
-require_relative "adyen/services/payment"
-require_relative "adyen/services/payout"
-require_relative "adyen/services/recurring"
-require_relative "adyen/services/marketpay"
-require_relative "adyen/services/posTerminalManagement"
-require_relative "adyen/services/service"
-require_relative "adyen/services/dataProtection"
-require_relative "adyen/services/dispute"
-require_relative "adyen/services/binLookup"
-require_relative "adyen/hash_with_accessors"
-require_relative "adyen/utils/hmac_validator"
-require_relative "adyen/services/legalEntityManagement"
-require_relative "adyen/services/balancePlatform"
-require_relative "adyen/services/transfers"
-require_relative "adyen/services/management"
-require_relative "adyen/services/storedValue"
-require_relative "adyen/services/balanceControlService"
+require_relative 'adyen/version'
+require_relative 'adyen/client'
+require_relative 'adyen/errors'
+require_relative 'adyen/services/checkout'
+require_relative 'adyen/services/payment'
+require_relative 'adyen/services/payout'
+require_relative 'adyen/services/recurring'
+require_relative 'adyen/services/marketpay'
+require_relative 'adyen/services/posTerminalManagement'
+require_relative 'adyen/services/service'
+require_relative 'adyen/services/dataProtection'
+require_relative 'adyen/services/dispute'
+require_relative 'adyen/services/binLookup'
+require_relative 'adyen/hash_with_accessors'
+require_relative 'adyen/utils/hmac_validator'
+require_relative 'adyen/services/legalEntityManagement'
+require_relative 'adyen/services/balancePlatform'
+require_relative 'adyen/services/transfers'
+require_relative 'adyen/services/management'
+require_relative 'adyen/services/storedValue'
+require_relative 'adyen/services/balanceControlService'

data/spec/account_spec.rb

@@ -1,30 +1,30 @@
-require "spec_helper"
+require 'spec_helper'
 
-RSpec.describe Adyen::Payment, service: "marketpay account service" do
+RSpec.describe Adyen::Payment, service: 'marketpay account service' do
   # client instance to be used in dynamically generated tests
   client = create_client(:basic)
 
   # methods / values to test for
   # format is defined in spec_helper
   test_sets = [
-    ["create_account_holder", "accountHolderCode", "TestAccountHolder781664"],
-    ["get_account_holder", "pspReference", "8815263414367329"],
-    ["update_account_holder", "pspReference", "9914762676580105"],
-    ["update_account_holder_state", "pspReference", "8515090175978108"],
-    ["suspend_account_holder", "pspReference", "9914762643560032"],
-    ["un_suspend_account_holder", "pspReference", "9914762644860159"],
-    ["close_account_holder", "pspReference", "9914713476670992"],
-    ["create_account", "status", "Active"],
-    ["update_account", "pspReference", "9914860311410009"],
-    ["close_account", "status", "Closed"],
-    ["upload_document", "pspReference", "9914762681460244"],
-    ["get_uploaded_documents", "pspReference", "9914694369860322"],
-    ["delete_bank_accounts", "pspReference", "9914694372670551"],
-    ["delete_shareholders", "pspReference", "9914694372990637"],
-    ["delete_signatories", "pspReference", "9914694372990637"],
-    ["delete_payout_methods", "pspReference", "9914694372990637"],
-    ["check_account_holder", "pspReference", "9914694372990637"],
+    %w[create_account_holder accountHolderCode TestAccountHolder781664],
+    %w[get_account_holder pspReference 8815263414367329],
+    %w[update_account_holder pspReference 9914762676580105],
+    %w[update_account_holder_state pspReference 8515090175978108],
+    %w[suspend_account_holder pspReference 9914762643560032],
+    %w[un_suspend_account_holder pspReference 9914762644860159],
+    %w[close_account_holder pspReference 9914713476670992],
+    %w[create_account status Active],
+    %w[update_account pspReference 9914860311410009],
+    %w[close_account status Closed],
+    %w[upload_document pspReference 9914762681460244],
+    %w[get_uploaded_documents pspReference 9914694369860322],
+    %w[delete_bank_accounts pspReference 9914694372670551],
+    %w[delete_shareholders pspReference 9914694372990637],
+    %w[delete_signatories pspReference 9914694372990637],
+    %w[delete_payout_methods pspReference 9914694372990637],
+    %w[check_account_holder pspReference 9914694372990637]
   ]
 
-  generate_tests(client, "Account", test_sets, client.marketpay.account)
+  generate_tests(client, 'Account', test_sets, client.marketpay.account)
 end

data/spec/balance_control_spec.rb

@@ -1,44 +1,43 @@
-require "spec_helper"
-require "json"
+require 'spec_helper'
+require 'json'
 
-# rubocop:disable Metrics/BlockLength
-
-RSpec.describe Adyen::BalancePlatform, service: "balancePlatform" do
+RSpec.describe Adyen::BalancePlatform, service: 'balancePlatform' do
   before(:all) do
     @shared_values = {
       client: create_client(:api_key),
-      service: "BalancePlatform",
+      service: 'BalancePlatform'
     }
   end
 
   # must be created manually because every field in the response is an array
-  it "makes a balance transfer POST call" do
-    request_body = JSON.parse(json_from_file("mocks/requests/BalanceControl/balance_transfer.json"))
+  it 'makes a balance transfer POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/BalanceControl/balance_transfer.json'))
 
-    response_body = json_from_file("mocks/responses/BalanceControl/balance_transfer.json")
+    response_body = json_from_file('mocks/responses/BalanceControl/balance_transfer.json')
 
-    url = @shared_values[:client].service_url(@shared_values[:service], "balanceTransfer", @shared_values[:client].balance_control_service.version)
-    WebMock.stub_request(:post, url).
-      with(
-        body: request_body,
-        headers: {
-          "x-api-key" => @shared_values[:client].api_key
-        }
-      ).
-      to_return(
-        body: response_body
-      )
+    url = @shared_values[:client].service_url(@shared_values[:service], 'balanceTransfer',
+                                              @shared_values[:client].balance_control_service.version)
+    WebMock.stub_request(:post, url)
+           .with(
+             body: request_body,
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
 
     result = @shared_values[:client].balance_control_service.balance_transfer(request_body)
     response_hash = result.response
 
-    expect(result.status).
-      to eq(200)
-    expect(response_hash).
-      to eq(JSON.parse(response_body))
-    expect(response_hash).
-      to be_a Adyen::HashWithAccessors
-    expect(response_hash).
-      to be_a_kind_of Hash
+    expect(result.status)
+      .to eq(200)
+    expect(response_hash)
+      .to eq(JSON.parse(response_body))
+    expect(response_hash)
+      .to be_a Adyen::HashWithAccessors
+    expect(response_hash)
+      .to be_a_kind_of Hash
   end
-end
+end