adyen-ruby-api-library 6.2.0 → 7.0.0

data/spec/mocks/responses/Webhooks/colon_notification.json

@@ -0,0 +1,41 @@
+{
+    "additionalData": {
+      "acquirerCode": "TestPmmAcquirer",
+      "acquirerReference": "8NQH5BNF58M",
+      "authCode": "039404",
+      "avsResult": "5 No AVS data provided",
+      "avsResultRaw": "5",
+      "cardSummary": "1111",
+      "checkout.cardAddedBrand": "visa",
+      "cvcResult": "1 Matches",
+      "cvcResultRaw": "M",
+      "expiryDate": "03/2030",
+      "hmacSignature": "2EQYm7YJpKO4EtHSPu55SQTyWf8dkW5u2nD1tJFpViA=",
+      "paymentMethod": "visa",
+      "refusalReasonRaw": "AUTHORISED",
+      "retry.attempt1.acquirer": "TestPmmAcquirer",
+      "retry.attempt1.acquirerAccount": "TestPmmAcquirerAccount",
+      "retry.attempt1.avsResultRaw": "5",
+      "retry.attempt1.rawResponse": "AUTHORISED",
+      "retry.attempt1.responseCode": "Approved",
+      "retry.attempt1.scaExemptionRequested": "lowValue",
+      "scaExemptionRequested": "lowValue"
+    },
+    "amount": {
+      "currency": "EUR",
+      "value": 1000
+    },
+    "eventCode": "AUTHORISATION",
+    "eventDate": "2023-01-10T13:40:54+01:00",
+    "merchantAccountCode": "AntoniStroinski",
+    "merchantReference": ":slashes are fun",
+    "operations": [
+      "CANCEL",
+      "CAPTURE",
+      "REFUND"
+    ],
+    "paymentMethod": "visa",
+    "pspReference": "M8NB66SBZSGLNK82",
+    "reason": "039404:1111:03/2030",
+    "success": "true"
+  }

data/spec/mocks/responses/Webhooks/forwardslash_notification.json

@@ -0,0 +1,41 @@
+{
+    "amount": {
+      "value": 1000,
+      "currency": "EUR"
+    },
+    "reason": "087330:1111:03/2030",
+    "success": "true",
+    "eventCode": "AUTHORISATION",
+    "eventDate": "2023-01-10T13:37:30+01:00",
+    "operations": [
+      "CANCEL",
+      "CAPTURE",
+      "REFUND"
+    ],
+    "pspReference": "X3GWNS6KJ8NKGK82",
+    "paymentMethod": "visa",
+    "additionalData": {
+      "authCode": "087330",
+      "avsResult": "5 No AVS data provided",
+      "cvcResult": "1 Matches",
+      "expiryDate": "03/2030",
+      "cardSummary": "1111",
+      "acquirerCode": "TestPmmAcquirer",
+      "avsResultRaw": "5",
+      "cvcResultRaw": "M",
+      "hmacSignature": "9Z0xdpG9Xi3zcmXv14t/BvMBut77O/Xq9D4CQXSDUi4=",
+      "paymentMethod": "visa",
+      "refusalReasonRaw": "AUTHORISED",
+      "acquirerReference": "HHCCC326PH6",
+      "scaExemptionRequested": "lowValue",
+      "checkout.cardAddedBrand": "visa",
+      "retry.attempt1.acquirer": "TestPmmAcquirer",
+      "retry.attempt1.rawResponse": "AUTHORISED",
+      "retry.attempt1.avsResultRaw": "5",
+      "retry.attempt1.responseCode": "Approved",
+      "retry.attempt1.acquirerAccount": "TestPmmAcquirerAccount",
+      "retry.attempt1.scaExemptionRequested": "lowValue"
+    },
+    "merchantReference": "//slashes are fun",
+    "merchantAccountCode": "AntoniStroinski"
+  }

data/spec/mocks/responses/Webhooks/mixed_notification.json

@@ -0,0 +1,41 @@
+{
+    "additionalData": {
+      "acquirerCode": "TestPmmAcquirer",
+      "acquirerReference": "J8DXDJ2PV6P",
+      "authCode": "052095",
+      "avsResult": "5 No AVS data provided",
+      "avsResultRaw": "5",
+      "cardSummary": "1111",
+      "checkout.cardAddedBrand": "visa",
+      "cvcResult": "1 Matches",
+      "cvcResultRaw": "M",
+      "expiryDate": "03/2030",
+      "hmacSignature": "CZErGCNQaSsxbaQfZaJlakqo7KPP+mIa8a+wx3yNs9A=",
+      "paymentMethod": "visa",
+      "refusalReasonRaw": "AUTHORISED",
+      "retry.attempt1.acquirer": "TestPmmAcquirer",
+      "retry.attempt1.acquirerAccount": "TestPmmAcquirerAccount",
+      "retry.attempt1.avsResultRaw": "5",
+      "retry.attempt1.rawResponse": "AUTHORISED",
+      "retry.attempt1.responseCode": "Approved",
+      "retry.attempt1.scaExemptionRequested": "lowValue",
+      "scaExemptionRequested": "lowValue"
+    },
+    "amount": {
+      "currency": "EUR",
+      "value": 1000
+    },
+    "eventCode": "AUTHORISATION",
+    "eventDate": "2023-01-10T13:42:29+01:00",
+    "merchantAccountCode": "AntoniStroinski",
+    "merchantReference": "\\:/\\/slashes are fun",
+    "operations": [
+      "CANCEL",
+      "CAPTURE",
+      "REFUND"
+    ],
+    "paymentMethod": "visa",
+    "pspReference": "ZVWN7D3WSMK2WN82",
+    "reason": "052095:1111:03/2030",
+    "success": "true"
+  }

data/spec/notification_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe Adyen::Payments, service: "marketpay fund service" do
+RSpec.describe Adyen::Payment, service: "marketpay fund service" do
   # client instance to be used in dynamically generated tests
   client = create_client(:basic)
 

data/spec/payments_spec.rb

@@ -1,26 +1,44 @@
 require "spec_helper"
+require "json"
+
+RSpec.describe Adyen::Payment, service: "Payment" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "Payment",
+    }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes an adjust_authorisation POST call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Payment/adjust_authorisation.json"))
+
+    response_body = json_from_file("mocks/responses/Payment/adjust_authorisation.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "adjustAuthorisation", @shared_values[:client].payment.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].payment.adjust_authorisation(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
+  end
 
-RSpec.describe Adyen::Payments, service: "payments 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 = [
-    ["authorise", "resultCode", "Authorised"],
-    ["adjust_authorisation", "response", "[adjustAuthorisation-received]"],
-    ["authorise3d", "resultCode", "Authorised"],
-    ["authorise3ds2", "resultCode", "ChallengeShopper"],
-    ["cancel", "response", "[cancel-received]"],
-    ["cancel_or_refund", "response", "[cancelOrRefund-received]"],
-    ["capture", "response", "[capture-received]"],
-    ["refund", "response", "[refund-received]"],
-    ["donate", "response", "[donation-received]"],
-    ["get_authentication_result", "threeDS2Result", {"transStatus" => "Y"}],
-    ["retrieve_3ds2_result", "threeDS2Result", {"transStatus" => "Y"}],
-    ["technical_cancel", "originalReference", "9914694372990637"],
-    ["void_pending_refund", "pspReference", "9914694372990637"]
-  ]
-
-  generate_tests(client, "Payment", test_sets, client.payments)
 end
+

data/spec/payouts_spec.rb

@@ -1,19 +1,46 @@
 require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::Payout, service: "Payout" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "Payout",
+    }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a business_lines POST call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Payout/confirm_third_party.json"))
+
+    response_body = json_from_file("mocks/responses/Payout/confirm_third_party.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "confirmThirdParty", @shared_values[:client].payout.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].payout.reviewing_api.confirm_third_party(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
+  end
 
-RSpec.describe Adyen::Payments, service: "payouts 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 = [
-    ["store_detail", "resultCode", "Success"],
-    ["store_detail_and_submit_third_party", "resultCode", "[payout-submit-received]"],
-    ["submit_third_party", "resultCode", "[payout-submit-received]"],
-    ["confirm_third_party", "response", "[payout-confirm-received]"],
-    ["decline_third_party", "response", "[payout-decline-received]"],
-    ["payout", "resultCode", "Success"]
-  ]
-
-  generate_tests(client, "Payout", test_sets, client.payouts)
 end
+

data/spec/pos_terminal_management_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::PosTerminalManagement, service: "PosTerminalManagement" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "LegalEntityManagement",
+    }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a assign_terminals POST call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Terminal/assign_terminals.json"))
+
+    response_body = json_from_file("mocks/responses/Terminal/assign_terminals.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "assignTerminals", @shared_values[:client].pos_terminal_management.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].pos_terminal_management.assign_terminals(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
+  end
+
+end
+

data/spec/recurring_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require_relative "../lib/adyen/errors"
 
-RSpec.describe Adyen::Payments, service: "recurring service" do
+RSpec.describe Adyen::Payment, service: "recurring service" do
   # client instance to be used in dynamically generated tests
   client = create_client(:basic)
 
@@ -10,7 +10,7 @@ RSpec.describe Adyen::Payments, service: "recurring service" do
   test_sets = [
     ["list_recurring_details", "creationDate", "2017-03-01T11:53:11+01:00"],
     ["disable", "response", "[detail-successfully-disabled]"],
-    ["store_token", "result", "Success"],
+    ["create_permit", "pspReference", "8815260599791117"],
     ["schedule_account_updater", "result", "Success"]
   ]
 

data/spec/spec_helper.rb

@@ -18,16 +18,6 @@ def create_test(client, service, method_name, parent_object)
   request_body = JSON.parse(json_from_file("mocks/requests/#{service}/#{method_name}.json"))
   response_body = json_from_file("mocks/responses/#{service}/#{method_name}.json")
 
-  with_application_info = [
-    "authorise",
-    "authorise3d",
-    "authorise3ds2",
-    "payments",
-    "payment_session",
-  ]
-  if with_application_info.include?(method_name)
-    client.add_application_info(request_body)
-  end
 
   # client-generated headers
   headers = {

data/spec/stored_value_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+require "json"
+
+RSpec.describe Adyen::BalancePlatform, service: "balancePlatform" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "BalancePlatform",
+    }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a issue POST call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/StoredValue/issue_giftcard.json"))
+
+    response_body = json_from_file("mocks/responses/StoredValue/issue_giftcard.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "issue", @shared_values[:client].stored_value.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].stored_value.issue(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
+  end
+
+end

data/spec/transfers_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::Transfers, service: "transfers" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "Transfers",
+    }
+  end
+
+  it "makes a transfers POST call" do
+
+    request_body = JSON.parse(json_from_file("mocks/requests/Transfers/make_transfer.json"))
+
+    response_body = json_from_file("mocks/responses/Transfers/make_transfer.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "transfers", @shared_values[:client].transfers.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].transfers.transfers_api.transfer_funds(request_body)
+    response_hash = result.response
+
+      expect(result.status).
+      to eq(200)
+  end
+
+  it "makes a transactions GET call" do
+
+    response_body = json_from_file("mocks/responses/Transfers/make_transfer.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "transactions?createdUntil=2021-05-30T15%3A07%3A40Z&createdSince=2021-05-30T15%3A07%3A40Z", @shared_values[:client].transfers.version)
+    WebMock.stub_request(:get, url).
+      with(
+        headers: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].transfers.transactions_api.get_all_transactions(queryParams:{"createdUntil" => "2021-05-30T15:07:40Z", "createdSince" => "2021-05-30T15:07:40Z"})
+    response_hash = result.response
+
+      expect(result.status).
+      to eq(200)
+  end
+
+
+end
+

data/spec/utils/hmac_validator_spec.rb

@@ -28,12 +28,6 @@ RSpec.describe Adyen::Utils::HmacValidator do
       expect(data_to_sign).to eq '7914073381342284::TestMerchant:TestPayment-1407325143704:1130:EUR:AUTHORISATION:true'
     end
 
-    it 'should get correct data with escaped characters' do
-      notification_request_item['merchantAccountCode'] = 'Test:\\Merchant'
-      data_to_sign = validator.data_to_sign(notification_request_item)
-      expect(data_to_sign).to eq '7914073381342284::Test\\:\\Merchant:TestPayment-1407325143704:1130:EUR:AUTHORISATION:true'
-    end
-
     it 'should encrypt properly' do
       encrypted = validator.calculate_notification_hmac(notification_request_item, key)
       expect(encrypted).to eq expected_sign
@@ -48,5 +42,25 @@ RSpec.describe Adyen::Utils::HmacValidator do
 
       expect(validator.valid_notification_hmac?(notification_request_item, key)).to be false
     end
+
+    it 'should validate backslashes correctly' do
+      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/backslash_notification.json"))
+      expect(validator.valid_notification_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
+    end
+
+    it 'should validate colons correctly' do
+      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/colon_notification.json"))
+      expect(validator.valid_notification_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
+    end
+
+    it 'should validate forward slashes correctly' do
+      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/forwardslash_notification.json"))
+      expect(validator.valid_notification_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
+    end
+
+    it 'should validate mix of slashes and colon correctly' do
+      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/mixed_notification.json"))
+      expect(validator.valid_notification_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
+    end
   end
 end

data/templates/api-single.mustache

@@ -0,0 +1,29 @@
+{{#apiInfo}}
+        {{#apis}}
+require_relative '{{serviceName}}/{{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}'
+        {{/apis}}
+    {{/apiInfo}}
+
+module Adyen
+    
+
+    class {{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}}
+        attr_accessor :service, :version
+        
+        DEFAULT_VERSION = {{version}}
+        def initialize(client, version = DEFAULT_VERSION)
+        @service = "{{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}}"
+        @client = client
+        @version = version
+        end
+
+    {{#apiInfo}}
+        {{#apis}}
+        def {{classFilename}}
+            @{{classFilename}} ||= Adyen::{{classname}}.new(@client, @version)
+        end
+
+        {{/apis}}
+    {{/apiInfo}}
+    end
+end

data/templates/api-small.mustache

@@ -0,0 +1,37 @@
+require_relative './service'
+module Adyen
+{{#operations}}
+
+
+  class {{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}} < Service
+    attr_accessor :service, :version
+    DEFAULT_VERSION = {{version}}
+
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "{{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}}"
+      @client = client
+      @version = version
+    end
+
+{{#operation}}
+    def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}, {{/isQueryParam}}{{/requiredParams}}headers: {} {{#queryParams}}{{#-first}}, queryParams: {}{{/-first}}{{/queryParams}})
+      """
+      {{{summary}}}{{^summary}}{{operationId}}{{/summary}}
+      """
+      endpoint = "{{path}}".gsub(/{.+?}/, '%s') 
+      endpoint = endpoint.gsub(/^\//, "")
+      endpoint = endpoint % [{{#pathParams}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}{{^-last}},{{/-last}}{{/pathParams}}]
+      {{#queryParams}}{{#-first}}endpoint = endpoint + create_query_string(queryParams){{/-first}}{{/queryParams}}
+      action = { method: "{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}", url: endpoint}
+  {{#bodyParams}}        
+      @client.call_adyen_api(@service, action, request, headers, @version)
+  {{/bodyParams}}
+  {{^bodyParams}}
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+  {{/bodyParams}}
+    end
+
+{{/operation}}
+{{/operations}}
+  end
+end

data/templates/api.mustache

@@ -0,0 +1,36 @@
+require_relative '../service'
+module Adyen
+{{#operations}}
+
+
+  class {{classname}} < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "{{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}}"
+      @client = client
+      @version = version
+    end
+
+{{#operation}}
+    def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}, {{/isQueryParam}}{{/requiredParams}}headers: {} {{#queryParams}}{{#-first}}, queryParams: {}{{/-first}}{{/queryParams}})
+      """
+      {{{summary}}}{{^summary}}{{operationId}}{{/summary}}
+      """
+      endpoint = "{{path}}".gsub(/{.+?}/, '%s') 
+      endpoint = endpoint.gsub(/^\//, "")
+      endpoint = endpoint % [{{#pathParams}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}{{^-last}},{{/-last}}{{/pathParams}}]
+      {{#queryParams}}{{#-first}}endpoint = endpoint + create_query_string(queryParams){{/-first}}{{/queryParams}}
+      action = { method: "{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}", url: endpoint}
+  {{#bodyParams}}        
+      @client.call_adyen_api(@service, action, request, headers, @version)
+  {{/bodyParams}}
+  {{^bodyParams}}
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+  {{/bodyParams}}
+    end
+
+{{/operation}}
+{{/operations}}
+  end
+end

data/templates/config.yaml

@@ -0,0 +1,10 @@
+templateDir: ./templates
+files:
+  api-single.mustache:
+    folder: api
+    destinationFilename: api-single.rb
+    templateType: SupportingFiles
+  api-small.mustache:
+    folder: api_small
+    destinationFilename: -small.rb
+    templateType: API