adyen-ruby-api-library 4.0.1 → 6.0.0

data/spec/checkout_spec.rb

@@ -13,9 +13,79 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
 
   # must be created manually because every field in the response is an array
   it "makes a payment_methods call" do
-    parsed_body = create_test(@shared_values[:client], @shared_values[:service], "payment_methods", @shared_values[:client].checkout)
-    expect(parsed_body["paymentMethods"].class).
-      to be Array
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment_methods.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/payment_methods.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "paymentMethods", @shared_values[:client].checkout.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].checkout.payment_methods(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
+
+  it "makes a paymentMethods/balance call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment_methods_balance.json"))
+    request_body[:applicationInfo] = {}
+    request_body[:applicationInfo][:adyenPaymentSource] = {
+      :name => "adyen-test",
+      :version => "1.0.0",
+    }
+
+    @shared_values[:client].add_application_info(request_body)
+
+    response_body = json_from_file("mocks/responses/Checkout/payment_methods_balance.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "paymentMethods/balance", @shared_values[:client].checkout.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].checkout.payment_methods.balance(request_body)
+    # result.response is already a Ruby hash (rather than an unparsed JSON string)
+    response_hash = result.response
+
+    expect(request_body[:applicationInfo][:adyenLibrary][:name]).
+      to eq(Adyen::NAME)
+    expect(request_body[:applicationInfo][:adyenLibrary][:version]).
+      to eq(Adyen::VERSION)
+    expect(request_body[:applicationInfo][:adyenPaymentSource][:name]).
+      to eq("adyen-test")
+    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(response_hash["balance"]).
+      to eq("100")
   end
 
   # must be created manually due to payments/details format
@@ -103,6 +173,206 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
       to eq("Authorised")
   end
 
+  # must be created manually due to paymentsLinks format
+  it "makes a paymentLinks call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment_links.json"))
+    request_body[:applicationInfo] = {}
+    request_body[:applicationInfo][:adyenPaymentSource] = {
+      :name => "adyen-test",
+      :version => "1.0.0",
+    }
+
+    @shared_values[:client].add_application_info(request_body)
+
+    response_body = json_from_file("mocks/responses/Checkout/payment_links.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "paymentLinks", @shared_values[:client].checkout.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].checkout.payment_links(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
+
+  # must be created manually due to paymentsLinks/{linkId} format
+  it "makes a get paymentLinks/{linkId} call" do
+    response_body = json_from_file("mocks/responses/Checkout/get-payment-link.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "paymentLinks/1", @shared_values[:client].checkout.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].checkout.payment_links.get("1")
+    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(response_hash["status"]).
+      to eq("active")
+    expect(response_hash.id).
+      to eq("MockId")
+  end
+
+  # must be created manually due to paymentsLinks/{linkId} format
+  it "makes a patch paymentLinks/{linkId} call" do
+    request_body = {
+      :status => "expired",
+    }
+
+    @shared_values[:client].add_application_info(request_body)
+    response_body = json_from_file("mocks/responses/Checkout/update-payment-link.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "paymentLinks/1", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:patch, url).
+      with(
+        body: request_body,
+        headers: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payment_links.update("1", 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(response_hash["status"]).
+      to eq("expired")
+    expect(response_hash.id).
+      to eq("MockId")
+  end
+
+  it "makes an orders call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/orders.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/orders.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "orders", @shared_values[:client].checkout.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].checkout.orders(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(response_hash["remainingAmount"]["value"]).
+      to eq(100)
+  end
+
+  it "makes an orders/cancel call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/orders_cancel.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/orders_cancel.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "orders/cancel", @shared_values[:client].checkout.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].checkout.orders.cancel(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(response_hash["resultCode"]).
+      to eq("cancelled")
+  end
+
+  it "makes a sessions call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/sessions.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/sessions-success.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "sessions", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.sessions(request_body)
+    response_hash = result.response
+
+    expect(result.status).
+      to eq(201)
+    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
+
   # create client for automated tests
   client = create_client(:api_key)
 
@@ -110,7 +380,8 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
   # format is defined in spec_helper
   test_sets = [
     ["payment_session", "publicKeyToken", "8115054323780109"],
-    ["payments", "resultCode", "Authorised"]
+    ["payments", "resultCode", "Authorised"],
+    ["origin_keys", "originKeys", { "https://adyen.com" => "mocked_origin_key" }]
   ]
 
   generate_tests(client, "Checkout", test_sets, client.checkout)

data/spec/data_protection_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Adyen::DataProtection, service: "Data Protection 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 = [
+    ["request_subject_erasure", "result", "SUCCESS"],
+  ]
+
+  generate_tests(client, "DataProtectionService", test_sets, client.data_protection)
+end

data/spec/dispute_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Dispute, service: "dispute 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 = [
+    ["retrieve_applicable_defense_reasons", "disputeServiceResult", { "success" => true }],
+    ["supply_defense_document", "disputeServiceResult", { "success" => true }],
+    ["delete_dispute_defense_document", "disputeServiceResult", { "success" => true }],
+    ["defend_dispute", "disputeServiceResult", { "success" => true }],
+  ]
+
+  generate_tests(client, "DisputeService", test_sets, client.dispute)
+end

data/spec/errors_spec.rb

@@ -3,15 +3,45 @@
 require 'spec_helper'
 
 RSpec.describe Adyen::AdyenError do
+  before(:all) do
+    @shared_values = {
+      request: {
+        amount: {
+          currency: "USD",
+          value: 1000
+        },
+        reference: "Your order number",
+        paymentMethod: {
+          type: "scheme",
+          number: "4111111111111111",
+          expiryMonth: "10",
+          expiryYear: "2020",
+          holderName: "John Smith",
+          cvc: "737"
+        },
+        returnUrl: "https://your-company.com/",
+        merchantAccount: "YOUR_MERCHANT_ACCOUNT"
+      }
+    }
+  end
+
   describe '#to_s' do
     it 'describes using the error properties' do
-      expect(Adyen::AdyenError.new('request', 'response', 'message', 'code').to_s).to eq('Adyen::AdyenError code:code, request:request, response:response, msg:message')
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').to_s).to eq("Adyen::AdyenError code:code, msg:message, request:#{@shared_values[:request]}, response:response")
     end
     it 'skips the null properties' do
-      expect(Adyen::AdyenError.new('request', nil, nil, 'code').to_s).to eq('Adyen::AdyenError code:code, request:request')
+      expect(Adyen::AdyenError.new(@shared_values[:request], nil, nil, 'code').to_s).to eq("Adyen::AdyenError code:code, request:#{@shared_values[:request]}")
     end
     it 'uses the proper error class name' do
-      expect(Adyen::PermissionError.new('a message', 'a request').to_s).to eq('Adyen::PermissionError code:403, request:a request, msg:a message')
+      expect(Adyen::PermissionError.new('message', @shared_values[:request]).to_s).to eq("Adyen::PermissionError code:403, msg:message, request:#{@shared_values[:request]}")
+    end
+  end
+  describe '#masking' do
+    it 'masks card number when logging request in errors' do
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').request[:paymentMethod][:number]).to eq('411111******1111')
+    end
+    it 'masks CVC when logging request in errors' do
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').request[:paymentMethod][:cvc]).to eq('***')
     end
   end
 end

data/spec/fund_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe Adyen::Payments, service: "marketpay fund service" do
     ["account_holder_transaction_list", "pspReference", "9914721175530029"],
     ["refund_not_paid_out_transfers", "pspReference", "9915090894215323"],
     ["setup_beneficiary", "pspReference", "9914860354282596"],
-    ["transfer_funds", "pspReference", "9915090893984580"]
+    ["transfer_funds", "pspReference", "9915090893984580"],
+    ["refund_funds_transfer", "pspReference", "9915090893984580"]
   ]
 
   generate_tests(client, "Fund", test_sets, client.marketpay.fund)

data/spec/hop_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Payments, service: "marketpay hop 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 = [
+    ["get_onboarding_url", "pspReference", "8815850625171183"]
+  ]
+
+  generate_tests(client, "Hop", test_sets, client.marketpay.hop)
+end

data/spec/mocks/requests/Account/check_account_holder.json

@@ -0,0 +1,5 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "accountStateType": "Payout",
+  "tier": "2"
+}

data/spec/mocks/requests/Account/delete_payout_methods.json

@@ -0,0 +1,6 @@
+{
+    "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+    "payoutMethodCodes": [
+        "mock_code"
+    ]
+}

data/spec/mocks/requests/Account/delete_signatories.json

@@ -0,0 +1,6 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "signatoryCodes": [
+    "9188218c-576e-4cbe-8e86-72722f453920"
+  ]
+}

data/spec/mocks/requests/BinLookup/get_3ds_availability.json

@@ -0,0 +1,4 @@
+{
+  "merchantAccount": "TestMerchant",
+  "cardNumber": "4111111111111111"
+}

data/spec/mocks/requests/BinLookup/get_cost_estimate.json

@@ -0,0 +1,8 @@
+{
+  "amount": {
+    "currency": "EUR",
+    "value": 1000
+  },
+  "cardNumber": "5101180000000007",
+  "merchantAccount": "TestMerchant"
+}

data/spec/mocks/requests/Checkout/orders.json

@@ -0,0 +1,6 @@
+{
+    "amount": {
+        "currency":"USD",
+        "value": "1000"
+    }
+}

data/spec/mocks/requests/Checkout/orders_cancel.json

@@ -0,0 +1,7 @@
+{
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "order": {
+        "orderData": "mocked_order_data",
+        "pspReference": "mocked_psp_ref"
+    }
+}

data/spec/mocks/requests/Checkout/origin_keys.json

@@ -0,0 +1,3 @@
+{
+    "originDomains": "https://adyen.com"
+}

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

@@ -0,0 +1,9 @@
+{
+  "amount": {
+    "currency": "USD",
+    "value": 1000
+  },
+  "countryCode": "US",
+  "merchantAccount": "TestMerchant",
+  "reference": "Merchant Reference"
+}

data/spec/mocks/requests/Checkout/payment_methods_balance.json

@@ -0,0 +1,9 @@
+
+{
+  "paymentMethod": {
+    "type": "givex",
+    "number": "4126491073027401",
+    "cvc": "737"
+  },
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}

data/spec/mocks/requests/Checkout/sessions.json

@@ -0,0 +1,10 @@
+{
+  "merchantAccount": "YourMerchantAccount",
+  "amount": {
+    "value": 100,
+    "currency": "EUR"
+  },
+  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
+  "reference": "YOUR_PAYMENT_REFERENCE",
+  "countryCode": "NL"
+}

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/DisputeService/defend_dispute.json

@@ -0,0 +1,5 @@
+{
+  "disputePspReference": "9913486733050065",
+  "defenseReasonCode": "SupplyDefenseMaterial",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT"
+}

data/spec/mocks/requests/DisputeService/delete_dispute_defense_document.json

@@ -0,0 +1,5 @@
+{
+  "disputePspReference": "9913486733050065",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT",
+  "defenseDocumentType": "MerchandiseDescription"
+}

data/spec/mocks/requests/DisputeService/retrieve_applicable_defense_reasons.json

@@ -0,0 +1,4 @@
+{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "disputePspReference": "9913486733050065"
+}

data/spec/mocks/requests/DisputeService/supply_defense_document.json

@@ -0,0 +1,11 @@
+{
+  "defenseDocuments": [
+    {
+      "content": "JVBERi0xLjMKJcTl8uXrp...",
+      "contentType": "application/pdf",
+      "defenseDocumentTypeCode": "MerchandiseDescription"
+    }
+  ],
+  "disputePspReference": "9913486733050065",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT"
+}

data/spec/mocks/requests/Fund/refund_funds_transfer.json

@@ -0,0 +1,7 @@
+{
+  "originalReference": "190324759",
+  "amount": {
+    "currency": "EUR",
+    "value": 2000
+  }
+}

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/Payment/get_authentication_result.json

@@ -0,0 +1,4 @@
+{
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "pspReference": "9914694372990637"
+}

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

@@ -0,0 +1,4 @@
+{
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "pspReference": "9914694372990637"
+}

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

@@ -0,0 +1,4 @@
+{
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "originalReference": "9914694372990637"
+}

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

@@ -0,0 +1,4 @@
+{
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "originalReference": "9914694372990637"
+}

data/spec/mocks/requests/Payout/payout.json

@@ -0,0 +1,8 @@
+{
+    "amount": {
+        "currency": "USD",
+        "value": 1000
+    },
+    "merchantAccount": "MERCHANT_ACCOUNT",
+    "reference": "9876543210"
+}

data/spec/mocks/requests/Recurring/schedule_account_updater.json

@@ -0,0 +1,12 @@
+{
+  "card": {
+    "number": "4111111111111111",
+    "expiryMonth": "8",
+    "expiryYear": "2018",
+    "cvc": "737",
+    "holderName": "John Smith"
+  },
+  "reference": "Merchant Reference",
+  "merchantAccount": "TestMerchant",
+  "shopperReference": "shopperReference"
+}

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/Account/check_account_holder.json

@@ -0,0 +1,3 @@
+{
+  "pspReference":"9914694372990637"
+}

data/spec/mocks/responses/Account/delete_payout_methods.json

@@ -0,0 +1,3 @@
+{
+    "pspReference": "9914694372990637"
+}

data/spec/mocks/responses/Account/delete_signatories.json

@@ -0,0 +1,3 @@
+{
+  "pspReference":"9914694372990637"
+}

data/spec/mocks/responses/BinLookup/get_3ds_availability.json

@@ -0,0 +1,8 @@
+{
+  "binDetails": {
+    "issuerCountry": "NL"
+  },
+  "threeDS1Supported": true,
+  "threeDS2CardRangeDetails": [],
+  "threeDS2supported": false
+}