adyen-ruby-api-library 4.0.0 → 4.3.0

data/spec/mocks/requests/DataProtectionService/request_subject_erasure.json

@@ -0,0 +1,5 @@
+{
+  "merchantAccount": "test_merchant",
+  "pspReference": "test_reference",
+  "forceErasure": true
+}

data/spec/mocks/requests/Hop/get_onboarding_url.json

@@ -0,0 +1,4 @@
+{
+  "accountHolderCode": "YourUniqueAccountHolderCode",
+  "returnUrl": "https://your.return-url.com/?submerchant=123"
+}

data/spec/mocks/requests/Payment/donate.json

@@ -0,0 +1,10 @@
+{
+  "originalReference": "882594077439995E",
+  "modificationAmount": {
+    "value": 100,
+    "currency": "USD"
+  },
+  "reference": "Donation",
+  "donationAccount": "TestMerchantDonations",
+  "merchantAccount": "TestMerchant"
+}

data/spec/mocks/requests/Terminal/assign_terminals.json

@@ -0,0 +1,6 @@
+{
+	"companyAccount": "TestCompany",
+	"merchantAccount": "TestMerchant",
+	"merchantInventory": false,
+	"terminals": ["e285-123456789"]
+}

data/spec/mocks/requests/Terminal/find_terminal.json

@@ -0,0 +1,3 @@
+{
+	"terminal": "e285-123456789"
+}

data/spec/mocks/requests/Terminal/get_terminals_under_account.json

@@ -0,0 +1,4 @@
+{
+	"companyAccount" : "TestCompany",
+	"merchantAccount" : "TestMerchant"
+}

data/spec/mocks/responses/Checkout/payment_links.json

@@ -0,0 +1,9 @@
+{
+  "amount": {
+    "currency": "USD",
+    "value": 1000
+  },
+  "expiresAt": "2019-12-14T10:05:29Z",
+  "reference": "Merchant Reference",
+  "url": "https://checkoutshopper-test.adyen.com"
+}

data/spec/mocks/responses/DataProtectionService/request_subject_erasure.json

@@ -0,0 +1,3 @@
+{
+  "result": "SUCCESS"
+}

data/spec/mocks/responses/Hop/get_onboarding_url.json

@@ -0,0 +1,7 @@
+{
+  "pspReference": "8815850625171183",
+  "resultCode": "Success",
+  "submittedAsync": "false",
+  "invalidFields": [],
+  "redirectUrl": "https://hop-test.adyen.com/hop/view/?token=BQABAQANDBQftSiV8pqlYYFRjIZmBIhE3Ls%2FgdLQ3kcTbflt4FDPves0B9kq7aSZUqKwRciwBEN3PX23ZPqGmYXTb7QklLY5YdEXvUdEgtFnJl9uDWK09texQ3djnTPW6JKrok5svw%2FGZyGHqF1NAbuqPPPLF8o5Jzzri8AqyQKig%2BtMmEibuCuZrIvMbJjcINfDk0OBHir8bNjHgMGFiDBOXdkiww%2FB1VXP2MMqSB1yqcXiKL1o%2B12czdB9wJ5wwsQLGlcuE2Z0%2BZNIQL3MdRomkphpkIWBPFN9YmyGS0Wel6trve6ghBl4q4e1C%2B9BMQKc4P0jrC9FrkBZvhtBYoN%2BfUfrEDbgXpXjXYa1tlfU53XoD%2FsAAA1n2PuQSyfTxEf8qpwAcB9oDN%2BrbpwxYwIk42kCGztAQShTwZzx%2B4VifKpjBdtHA4bSHEqOzGPvpQ6bk4viluLn9Ealv0ylf%2FC3w%2BZCmThg8%2B2EIiABmMK8Jbfijl%2FM%2FqE43F0QN9SveJjwkN5IYGra5QbErUdAPDMfDksPjy%2FY8j%2B2XT1kMwSOLbWTCfhP%2FM%2F68Ll50RuhfJOkgfdP%2BfSxbK9i9uAmEsJ980cABWPpB4MH27asGfZ17mCM3TavaiI9d9Gs3X1HIoEZehFKWEhoaGsEaoSBQ6ut6VnZoOCCBsvssg9aqi1LJKpwwWg4CjS9Ygrw1dnSYjyFO2HeKGXf4TUS7DSCF7tpUJlBen69Xaqbwg%2BHfNfmgcCoZwSgvg%3D%3D"
+}

data/spec/mocks/responses/Payment/donate.json

@@ -0,0 +1,4 @@
+{
+    "pspReference": "882594132885209C",
+    "response": "[donation-received]"
+}

data/spec/mocks/responses/Terminal/assign_terminals.json

@@ -0,0 +1,5 @@
+{
+    "results": {
+        "e285-123456789": "Done"
+    }
+}

data/spec/mocks/responses/Terminal/find_terminal.json

@@ -0,0 +1,6 @@
+{
+    "companyAccount": "TestCompany",
+    "merchantAccount": "TestMerchant",
+    "merchantInventory": false,
+    "terminal": "e285-123456789"
+}

data/spec/mocks/responses/Terminal/get_terminals_under_account.json

@@ -0,0 +1,11 @@
+{
+    "companyAccount": "TestCompany",
+    "merchantAccounts": [
+        {
+            "merchantAccount": "TestMerchant",
+            "inStoreTerminals": [
+                "P400Plus-123456789"
+            ]
+        }
+    ]
+}

data/spec/payments_spec.rb

@@ -14,7 +14,8 @@ RSpec.describe Adyen::Payments, service: "payments service" do
     ["cancel", "response", "[cancel-received]"],
     ["cancel_or_refund", "response", "[cancelOrRefund-received]"],
     ["capture", "response", "[capture-received]"],
-    ["refund", "response", "[refund-received]"]
+    ["refund", "response", "[refund-received]"],
+    ["donate", "response", "[donation-received]"]
   ]
 
   generate_tests(client, "Payment", test_sets, client.payments)

data/spec/postfmapi_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+RSpec.describe Adyen::PosTerminalManagement, service: "POS Terminal Management 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 = [
+    ["find_terminal", "merchantAccount", "TestMerchant"],
+    ["get_terminals_under_account", "merchantAccounts", [{ "merchantAccount" => "TestMerchant", "inStoreTerminals" => ["P400Plus-123456789"] }]],
+    ["assign_terminals", "results", { "e285-123456789" => "Done" }]
+  ]
+
+  generate_tests(client, "Terminal", test_sets, client.postfmapi)
+end

data/spec/service_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe Adyen::Service do
+  describe '.action_for_method_name' do
+    it 'handles all methods that exist currently' do
+      expect(described_class.action_for_method_name(:adjust_authorisation)).to eq 'adjustAuthorisation'
+      expect(described_class.action_for_method_name(:authorise)).to eq 'authorise'
+      expect(described_class.action_for_method_name(:authorise3d)).to eq 'authorise3d'
+      expect(described_class.action_for_method_name(:authorise3ds2)).to eq 'authorise3ds2'
+      expect(described_class.action_for_method_name(:cancel)).to eq 'cancel'
+      expect(described_class.action_for_method_name(:cancel_or_refund)).to eq 'cancelOrRefund'
+      expect(described_class.action_for_method_name(:capture)).to eq 'capture'
+      expect(described_class.action_for_method_name(:close_account)).to eq 'closeAccount'
+      expect(described_class.action_for_method_name(:close_account_holder)).to eq 'closeAccountHolder'
+      expect(described_class.action_for_method_name(:confirm_third_party)).to eq 'confirmThirdParty'
+      expect(described_class.action_for_method_name(:create_account)).to eq 'createAccount'
+      expect(described_class.action_for_method_name(:create_account_holder)).to eq 'createAccountHolder'
+      expect(described_class.action_for_method_name(:decline_third_party)).to eq 'declineThirdParty'
+      expect(described_class.action_for_method_name(:delete_bank_accounts)).to eq 'deleteBankAccounts'
+      expect(described_class.action_for_method_name(:delete_shareholders)).to eq 'deleteShareholders'
+      expect(described_class.action_for_method_name(:disable)).to eq 'disable'
+      expect(described_class.action_for_method_name(:donate)).to eq 'donate'
+      expect(described_class.action_for_method_name(:get_account_holder)).to eq 'getAccountHolder'
+      expect(described_class.action_for_method_name(:get_tier_configuration)).to eq 'getTierConfiguration'
+      expect(described_class.action_for_method_name(:get_uploaded_documents)).to eq 'getUploadedDocuments'
+      expect(described_class.action_for_method_name(:list_recurring_details)).to eq 'listRecurringDetails'
+      expect(described_class.action_for_method_name(:origin_keys)).to eq 'originKeys'
+      expect(described_class.action_for_method_name(:payment_methods)).to eq 'paymentMethods'
+      expect(described_class.action_for_method_name(:payment_session)).to eq 'paymentSession'
+      expect(described_class.action_for_method_name(:payment_links)).to eq 'paymentLinks'
+      expect(described_class.action_for_method_name(:refund)).to eq 'refund'
+      expect(described_class.action_for_method_name(:store_detail)).to eq 'storeDetail'
+      expect(described_class.action_for_method_name(:store_detail_and_submit_third_party)).to eq 'storeDetailAndSubmitThirdParty'
+      expect(described_class.action_for_method_name(:store_token)).to eq 'storeToken'
+      expect(described_class.action_for_method_name(:submit_third_party)).to eq 'submitThirdParty'
+      expect(described_class.action_for_method_name(:suspend_account_holder)).to eq 'suspendAccountHolder'
+      expect(described_class.action_for_method_name(:un_suspend_account_holder)).to eq 'unSuspendAccountHolder'
+      expect(described_class.action_for_method_name(:update_account)).to eq 'updateAccount'
+      expect(described_class.action_for_method_name(:update_account_holder)).to eq 'updateAccountHolder'
+      expect(described_class.action_for_method_name(:update_account_holder_state)).to eq 'updateAccountHolderState'
+      expect(described_class.action_for_method_name(:upload_document)).to eq 'uploadDocument'
+      expect(described_class.action_for_method_name(:get_onboarding_url)).to eq 'getOnboardingUrl'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -39,7 +39,8 @@ def create_test(client, service, method_name, parent_object)
   end
 
   # stub request
-  url = client.service_url(service, method_name.to_camel_case, parent_object.version)
+  action = Adyen::Service.action_for_method_name(method_name)
+  url = client.service_url(service, action, parent_object.version)
   WebMock.stub_request(:post, url).
     with(
       body: request_body,
@@ -50,7 +51,7 @@ def create_test(client, service, method_name, parent_object)
     )
   result = parent_object.public_send(method_name, request_body)
 
-  # result.response is already a Ruby hash (rather than an unparsed JSON string)
+  # result.response is already a Ruby object (Adyen::HashWithAccessors) (rather than an unparsed JSON string)
   response_hash = result.response
 
   # boilerplate error checks
@@ -58,8 +59,10 @@ def create_test(client, service, method_name, parent_object)
     to eq(200)
   expect(response_hash).
     to eq(JSON.parse(response_body))
-  expect(response_hash.class).
-    to be Hash
+  expect(response_hash).
+    to be_a Adyen::HashWithAccessors
+  expect(response_hash).
+    to be_a_kind_of Hash
 
   response_hash
 end

data/spec/utils/hmac_validator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe Adyen::Utils::HmacValidator do
+  let(:validator) { described_class.new }
+  let(:key) { '44782DEF547AAA06C910C43932B1EB0C71FC68D9D0C057550C48EC2ACF6BA056' }
+  let(:expected_sign) { 'coqCmt/IZ4E3CzPvMY8zTjQVL5hYJUiBRg8UU+iCWo0=' }
+  let(:notification_request_item) do
+    {
+      additionalData: {
+        hmacSignature: expected_sign
+      },
+      amount: {
+        value: 1130,
+        currency: 'EUR'
+      },
+      pspReference: '7914073381342284',
+      eventCode: 'AUTHORISATION',
+      merchantAccountCode: 'TestMerchant',
+      merchantReference: 'TestPayment-1407325143704',
+      paymentMethod: 'visa',
+      success: 'true'
+    }
+  end
+
+  describe 'HMAC Validator' do
+    it 'should get correct data' do
+      data_to_sign = validator.data_to_sign(notification_request_item)
+      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
+    end
+
+    it 'should have a valid hmac' do
+      expect(validator.valid_notification_hmac?(notification_request_item, key)).to be true
+    end
+
+    it 'should have an invalid hmac' do
+      notification_request_item['additionalData'] = { 'hmacSignature' => 'invalidHMACsign' }
+
+      expect(validator.valid_notification_hmac?(notification_request_item, key)).to be false
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Adyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,8 +76,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -103,22 +109,29 @@ files:
 - lib/adyen-ruby-api-library.rb
 - lib/adyen/client.rb
 - lib/adyen/errors.rb
+- lib/adyen/hash_with_accessors.rb
 - lib/adyen/result.rb
 - lib/adyen/services/checkout.rb
 - lib/adyen/services/checkout_utility.rb
+- lib/adyen/services/data_protection.rb
 - lib/adyen/services/marketpay.rb
 - lib/adyen/services/payments.rb
 - lib/adyen/services/payouts.rb
+- lib/adyen/services/postfmapi.rb
 - lib/adyen/services/recurring.rb
 - lib/adyen/services/service.rb
-- lib/adyen/util.rb
+- lib/adyen/utils/hmac_validator.rb
 - lib/adyen/version.rb
+- renovate.json
 - spec/account_spec.rb
 - spec/checkout_spec.rb
 - spec/checkout_utility_spec.rb
 - spec/client_spec.rb
+- spec/data_protection_spec.rb
 - spec/errors_spec.rb
 - spec/fund_spec.rb
+- spec/hash_with_accessors_spec.rb
+- spec/hop_spec.rb
 - spec/mocks/requests/Account/close_account.json
 - spec/mocks/requests/Account/close_account_holder.json
 - spec/mocks/requests/Account/create_account.json
@@ -135,17 +148,20 @@ files:
 - spec/mocks/requests/Account/upload_document.json
 - spec/mocks/requests/Checkout/payment-details.json
 - spec/mocks/requests/Checkout/payment-result.json
+- spec/mocks/requests/Checkout/payment_links.json
 - spec/mocks/requests/Checkout/payment_methods.json
 - spec/mocks/requests/Checkout/payment_session.json
 - spec/mocks/requests/Checkout/payments.json
 - spec/mocks/requests/Checkout/verify.json
 - spec/mocks/requests/CheckoutUtility/origin_keys.json
+- spec/mocks/requests/DataProtectionService/request_subject_erasure.json
 - spec/mocks/requests/Fund/account_holder_balance.json
 - spec/mocks/requests/Fund/account_holder_transaction_list.json
 - spec/mocks/requests/Fund/payout_account_holder.json
 - spec/mocks/requests/Fund/refund_not_paid_out_transfers.json
 - spec/mocks/requests/Fund/setup_beneficiary.json
 - spec/mocks/requests/Fund/transfer_funds.json
+- spec/mocks/requests/Hop/get_onboarding_url.json
 - spec/mocks/requests/Notification/create_notification_configuration.json
 - spec/mocks/requests/Notification/delete_notification_configurations.json
 - spec/mocks/requests/Notification/get_notification_configuration.json
@@ -159,6 +175,7 @@ files:
 - spec/mocks/requests/Payment/cancel.json
 - spec/mocks/requests/Payment/cancel_or_refund.json
 - spec/mocks/requests/Payment/capture.json
+- spec/mocks/requests/Payment/donate.json
 - spec/mocks/requests/Payment/refund.json
 - spec/mocks/requests/Payout/confirm_third_party.json
 - spec/mocks/requests/Payout/decline_third_party.json
@@ -168,6 +185,9 @@ files:
 - spec/mocks/requests/Recurring/disable.json
 - spec/mocks/requests/Recurring/list_recurring_details.json
 - spec/mocks/requests/Recurring/store_token.json
+- spec/mocks/requests/Terminal/assign_terminals.json
+- spec/mocks/requests/Terminal/find_terminal.json
+- spec/mocks/requests/Terminal/get_terminals_under_account.json
 - spec/mocks/responses/Account/close_account.json
 - spec/mocks/responses/Account/close_account_holder.json
 - spec/mocks/responses/Account/create_account.json
@@ -184,17 +204,20 @@ files:
 - spec/mocks/responses/Account/upload_document.json
 - spec/mocks/responses/Checkout/payment-details.json
 - spec/mocks/responses/Checkout/payment-result.json
+- spec/mocks/responses/Checkout/payment_links.json
 - spec/mocks/responses/Checkout/payment_methods.json
 - spec/mocks/responses/Checkout/payment_session.json
 - spec/mocks/responses/Checkout/payments.json
 - spec/mocks/responses/Checkout/verify.json
 - spec/mocks/responses/CheckoutUtility/origin_keys.json
+- spec/mocks/responses/DataProtectionService/request_subject_erasure.json
 - spec/mocks/responses/Fund/account_holder_balance.json
 - spec/mocks/responses/Fund/account_holder_transaction_list.json
 - spec/mocks/responses/Fund/payout_account_holder.json
 - spec/mocks/responses/Fund/refund_not_paid_out_transfers.json
 - spec/mocks/responses/Fund/setup_beneficiary.json
 - spec/mocks/responses/Fund/transfer_funds.json
+- spec/mocks/responses/Hop/get_onboarding_url.json
 - spec/mocks/responses/Notification/create_notification_configuration.json
 - spec/mocks/responses/Notification/delete_notification_configurations.json
 - spec/mocks/responses/Notification/get_notification_configuration.json
@@ -208,6 +231,7 @@ files:
 - spec/mocks/responses/Payment/cancel.json
 - spec/mocks/responses/Payment/cancel_or_refund.json
 - spec/mocks/responses/Payment/capture.json
+- spec/mocks/responses/Payment/donate.json
 - spec/mocks/responses/Payment/refund.json
 - spec/mocks/responses/Payout/confirm_third_party.json
 - spec/mocks/responses/Payout/decline_third_party.json
@@ -217,11 +241,17 @@ files:
 - spec/mocks/responses/Recurring/disable.json
 - spec/mocks/responses/Recurring/list_recurring_details.json
 - spec/mocks/responses/Recurring/store_token.json
+- spec/mocks/responses/Terminal/assign_terminals.json
+- spec/mocks/responses/Terminal/find_terminal.json
+- spec/mocks/responses/Terminal/get_terminals_under_account.json
 - spec/notification_spec.rb
 - spec/payments_spec.rb
 - spec/payouts_spec.rb
+- spec/postfmapi_spec.rb
 - spec/recurring_spec.rb
+- spec/service_spec.rb
 - spec/spec_helper.rb
+- spec/utils/hmac_validator_spec.rb
 homepage: https://www.adyen.com
 licenses:
 - MIT
@@ -244,8 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Official Adyen  Ruby API Library

data/lib/adyen/util.rb

@@ -1,21 +0,0 @@
-# This utility method monkey-patches Ruby's Hash class to allow keys to be read
-# and updated with dot notation. Usage is entirely optional (i.e.,  hash values
-# can still be accessed via symbol and string keys).
-#
-# Credit: https://gist.github.com/winfred/2185384#file-ruby-dot-hash-access-rb
-
-class Hash
-  class NoKeyOrMethodError < NoMethodError; end
-  def method_missing(method,*args)
-    m = method.to_s
-    string_key = m.gsub(/=$/,'')
-    sym_key = string_key.to_sym
-    if self.has_key? string_key
-      m.match(/=$/) ? self.send("[#{string_key}]=", *args) : self[string_key]
-    elsif self.has_key? sym_key
-      m.match(/=$/) ? self.send("[#{sym_key}]=", *args) : self[sym_key]
-    else
-      raise NoKeyOrMethodError
-    end
-  end
-end