adyen-ruby-api-library 1.2.0

data/lib/adyen/services/payments.rb

@@ -0,0 +1,23 @@
+require_relative 'service'
+
+module Adyen
+  class Payments < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 40
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'Payment'
+      method_names = [
+        :authorise,
+        :authorise3d,
+        :capture,
+        :cancel,
+        :refund,
+        :cancel_or_refund,
+        :adjust_authorisation
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/payouts.rb

@@ -0,0 +1,21 @@
+require_relative 'service'
+
+module Adyen
+  class Payouts < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 30
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'Payout'
+      method_names = [
+        :store_detail,
+        :store_detail_and_submit_third_party,
+        :submit_third_party,
+        :confirm_third_party,
+        :decline_third_party
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/recurring.rb

@@ -0,0 +1,19 @@
+require_relative 'service'
+
+module Adyen
+  class Recurring < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 25
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'Recurring'
+      method_names = [
+        :list_recurring_details,
+        :disable,
+        :store_token
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/service.rb

@@ -0,0 +1,19 @@
+module Adyen
+  class Service
+    attr_accessor :service, :version
+
+    def initialize(client, version, service, method_names)
+      @client = client
+      @version = version
+      @service = service
+
+      # dynamically create API methods
+      method_names.each do |method_name|
+        define_singleton_method method_name do |request|
+          action = method_name.to_s.to_camel_case
+          @client.call_adyen_api(@service, action, request, @version)
+        end
+      end
+    end
+  end
+end

data/lib/adyen/version.rb

@@ -0,0 +1,4 @@
+module Adyen
+  NAME = "adyen-ruby-api-library"
+  VERSION = "1.2.0".freeze
+end

data/spec/account_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Payments, 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"]
+  ]
+
+  generate_tests(client, "Account", test_sets, client.marketpay.account)
+end

data/spec/checkout_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::Checkout, service: "checkout" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "Checkout",
+    }
+  end
+
+  # 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
+  end
+
+  # must be created manually due to payments/details format
+  it "makes a payments/details call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment-details.json"))
+    @shared_values[:client].add_application_info(request_body)
+
+    response_body = json_from_file("mocks/responses/Checkout/payment-details.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/details", @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
+      )
+    response = @shared_values[:client].checkout.payments.details(request_body)
+
+    expect(response.status).
+      to eq(200)
+    expect(response.body).
+      to eq(response_body)
+    expect((parsed_body = JSON.parse(response.body)).class).
+      to be Hash
+    expect(parsed_body["resultCode"]).
+      to eq("RedirectShopper")
+  end
+
+  # must be created manually due to payments/result format
+  it "makes a payments/result call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment-result.json"))
+    @shared_values[:client].add_application_info(request_body)
+
+    response_body = json_from_file("mocks/responses/Checkout/payment-result.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/result", @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
+      )
+    response = @shared_values[:client].checkout.payments.result(request_body)
+
+    expect(response.status).
+      to eq(200)
+    expect(response.body).
+      to eq(response_body)
+    expect((parsed_body = JSON.parse(response.body)).class).
+      to be Hash
+    expect(parsed_body["resultCode"]).
+      to eq("Authorised")
+  end
+
+  # create client for automated tests
+  client = create_client(:api_key)
+
+  # methods / fields to test on
+  # format is defined in spec_helper
+  test_sets = [
+    ["payment_session", "publicKeyToken", "8115054323780109"],
+    ["payments", "resultCode", "Authorised"]
+  ]
+
+  generate_tests(client, "Checkout", test_sets, client.checkout)
+end
+
+# rubocop:enable Metrics/BlockLength

data/spec/checkout_utility_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::CheckoutUtility, service: "checkout utility" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "CheckoutUtility",
+    }
+  end
+
+  it "sets the correct service URL base" do
+    client = Adyen::Client.new(env: :test)
+    expect(client.service_url_base(@shared_values[:service])).to eq("https://checkout-test.adyen.com")
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes an origin_keys call" do
+    parsed_body = create_test(@shared_values[:client], @shared_values[:service], "origin_keys", @shared_values[:client].checkout_utility)
+    expect(parsed_body["originKeys"].class).
+      to be Hash
+  end
+end
+
+# rubocop:enable Metrics/BlockLength

data/spec/client_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe Adyen do
+  before(:all) do
+    @shared_values = {
+      client: nil
+    }
+  end
+
+  it "creates Adyen client" do
+    @shared_values[:client] = Adyen::Client.new
+    expect(@shared_values[:client]).is_a? Adyen::Client
+  end
+
+  it "sets env to :mock" do
+    @shared_values[:client].env = :test
+    expect(@shared_values[:client].env).
+      to eq(:test)
+  end
+
+  it "sets the version number" do
+    @shared_values[:client].checkout.version = @shared_values[:version]
+    expect(@shared_values[:client].checkout.version).
+      to eq(@shared_values[:version])
+  end
+
+  it "fails payments call without WS user and password" do
+    expect{ @shared_values[:client].payments.authorise("{}") }.
+      to raise_error(Adyen::AuthenticationError)
+    @shared_values[:client].ws_user = @shared_values[:ws_user]
+    expect{ @shared_values[:client].payments.authorise("{}") }.
+      to raise_error(Adyen::AuthenticationError)
+  end
+
+  it "fails a checkout call without api key" do
+    expect{ @shared_values[:client].checkout.payment_methods("{}") }.
+      to raise_error(Adyen::AuthenticationError)
+    @shared_values[:client].api_key = "api_key"
+  end
+end

data/spec/fund_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Payments, service: "marketpay fund 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 = [
+    ["payout_account_holder", "pspReference", "9915090894325643"],
+    ["account_holder_balance", "pspReference", "9914719436100053"],
+    ["account_holder_transaction_list", "pspReference", "9914721175530029"],
+    ["refund_not_paid_out_transfers", "pspReference", "9915090894215323"],
+    ["setup_beneficiary", "pspReference", "9914860354282596"],
+    ["transfer_funds", "pspReference", "9915090893984580"]
+  ]
+
+  generate_tests(client, "Fund", test_sets, client.marketpay.fund)
+end

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

@@ -0,0 +1,3 @@
+{
+  "accountCode": "CODE_OF_ACCOUNT"
+}

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

@@ -0,0 +1,3 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER"
+}

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

@@ -0,0 +1,3 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER"
+}

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

@@ -0,0 +1,15 @@
+{
+  "accountHolderCode": "GENERATE_CODE",
+  "accountHolderDetails": {
+    "email": "tim@green.com",
+    "individualDetails": {
+      "name": {
+        "firstName": "Tim",
+        "gender": "MALE",
+        "lastName": "Green"
+      }
+    }
+  },
+  "legalEntity": "Individual",
+  "description": "Test Account Holder"
+}

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

@@ -0,0 +1,6 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "bankAccountUUIDs": [
+    "eeb6ed22-3bae-483c-83b9-bc2097a75d40"
+  ]
+}

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

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

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

@@ -0,0 +1,3 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER"
+}

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

@@ -0,0 +1,4 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "bankAccountUUID": "EXAMPLE_UUID"
+}

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

@@ -0,0 +1,3 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER"
+}

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

@@ -0,0 +1,3 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER"
+}

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

@@ -0,0 +1,7 @@
+{
+  "accountCode": "CODE_OF_ACCOUNT",
+  "payoutSchedule": {
+    "schedule": "WEEKLY",
+    "action": "CLOSE"
+  }
+}

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

@@ -0,0 +1,33 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "accountHolderDetails": {
+    "address": {
+      "city": "Amsterdam",
+      "country": "NL",
+      "postalCode": "12345",
+      "stateOrProvince": "NH",
+      "street": "Teststreet 1"
+    },
+    "bankAccountDetails": [],
+    "email": "test@adyen.com",
+    "individualDetails": {
+      "name": {
+        "firstName": "First name",
+        "gender": "MALE",
+        "lastName": "Last Name"
+      },
+      "personalData": {
+        "dateOfBirth": "1970-01-01",
+        "idNumber": "1234567890",
+        "nationality": "NL"
+      }
+    },
+    "merchantCategoryCode": "7999",
+    "phoneNumber": {
+      "phoneCountryCode": "NL",
+      "phoneNumber": "0612345678",
+      "phoneType": "Mobile"
+    },
+    "webAddress": "http://www.accountholderwebsite.com"
+  }
+}

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

@@ -0,0 +1,6 @@
+{
+  "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+  "disable": "true",
+  "reason": "test reason payout",
+  "stateType": "Payout"
+}

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

@@ -0,0 +1,9 @@
+{
+  "documentContent": "dGVzdCBkb2N1bWVudCBjb250ZW50",
+  "documentDetail": {
+    "accountHolderCode": "CODE_OF_ACCOUNT_HOLDER",
+    "documentType": "PASSPORT",
+    "filename": "passport.png",
+    "description": "test passport description"
+  }
+}

data/spec/mocks/requests/Checkout/payment-details.json

@@ -0,0 +1,18 @@
+{
+	"amount": {
+		"currency": "USD",
+		"value": 1000
+	},
+		"paymentMethod": {
+		"type": "ideal",
+		"idealIssuer": 1155
+	},
+	"paymentData": "Hee57361f99ddcf4!ZW5jcnlwdGVkPUJRQUJBZ0JvNGhIUnFUcUxwMVYxY0JJb0R2Sk5lWmQzVDZZckdGSTNRU2hrRnFkUGhzSiUyQmY3ZzJJd1hTa2hVYXZlUUFIT1ExZnNQbzRYVzV4YUFydnplRFdNYTQ5ZHhnbDNHbzNGM2RHTnAlMkJvSGhzM1hIQXZZNHc4UjhGMDVWdHNWR0hSek1qeW1TT291MGp6TnlqUU80cWpDeGNQQlF4bVVyUU1CeDhBVU9COXlWRlRhaFNwM1N5RlprZ3FOZkpjcTdxMVhycFJ3SENkamdZJTJCd1lWcmtMeEN3MmpuYmQ4N2JwazRicE45QjNJYXp0bkszY05USW5qWnZXQTc3MmdMTVRaTjJWTHgyNm4lMkI5ZDA3akdxSkpsUG5xSndBdkFEdzh2OXd4aHRyTXhXbGFYemxJejNuc2NWY05zR3JDNUFZVExtaXRTazB2eVRKUXNqRlNKTXltTG1IdmppcXFmR3JrY0glMkJzWWpiQ1M5dTB3TlN4OFQlMkJJRTN6a2VuMGZ3Ylo4RHE2M21NdGZ3WURkRDNGbjJMUnJvT0oxN3pTTWRXSmtoUjdLTVo1OXRERE1VWlBEajNWWHRMY29MNUF0dWtLTlFQTEFENWdBOEppdmZCc0h5YlBPY25ZOVpzc291TTJQVjBLcWtldk0xMUdHZlgwYiUyQmdHcjB6NHQxOE9LM25weHVIdXJoNzV0T3oyJTJGUHRTSnBkT2lKOGo2Z0F1Q1JQdFh4ZHZBT0NMaldwQ210Smg2Wmw5VGYwZXdFREhFelN6NnQ3N2pleWpnOTFMaVRZQkhHMDBvSkJyWk0lMkJvOVliJTJCM0JYcFFQVzNwVThKSGdKbWJJUVFEenpCNyUyQnFiMHBRQ1FDam1xelJkSUx1UDQzOW82ZHFNS1hyMFhjSEpkNkNxMmtRaUxNNk1xcmJUYjZkMmhDNUFlcE1ZSEs5NVFzJTJCS1dzNU1FajdBRXA3SW10bGVTSTZJa0ZHTUVGQlFURXdNME5CTlRNM1JVRkZSRGczUXpJMFJFUTFNemt3T1VJNE1FRTNPRUU1TWpORk16Z3lNMFEyT0VSQlEwTTVORUk1UmtZNE16QTFSRU1pZll0MWhDUUREenpiSiUyRkV6NGJXdHdSNEQ0VjZ5JTJCWVVuTHNVc1NsbGZsJTJGV1Fka2ZmU0t5d1E2Z0RKY2tJUlBuelpvREhZSHUwVDdPd2gycHk5VyUyQjBmMXRISTJRYnZvdnBNR0tQRHdndSUyQkUlMkZaM0JvTm9xYTlEMiUyRmNrcTdSZ0RXMmdqMFpiYXplbk5oQ2hMaTJ3YjBlampMYzR6cHJhJTJGellmUkVVM0ZCSUJmdzBKeEtWVzU1NENxUEJvSGlIU3c2Sml5MlE3cnhjSjJSc3FiJTJCR25zTnRIYjN4c3NyMiUyQjRMTjYyZXZ3ciUyQiUyQk5ITEVLejVHSWxKMERJdG1JT1VWR1U1YlA4a2M1a0ZGR1JQYzNNODh4MCUyRlpVVG54bVlscVR1MDg0Mm1MUlh3WnJPaUoySlVXY3QlMkIzdDNlb1p6UG1jV0VZdkhZRG1OJTJCd2J0WXVRcmhIdWFrTVpCeGdRWjczeGd4WUZoaUZUMnYyQmFDT2pSZyUyQjBiMGJhZ3BEU1R1dVJQRFg2b0txa3ZYb0h2MFhqcGRHWUR4VmMlMkZ5SWxtMXp0WmNVcmo3Z1FqTkVvNjE1b2F3UmhxZTJyOXlTdTdCZ2FLQXJ4UjEzSDBRZzVIQlJJT0g5Zk92MnV6Vk5zNFZGMEYzcDhmJTJGdnBsMXlBcnZaRzFkWm5VYkZ1c092bVdIM2hyRDgwQVdzczRlJTJGYW5HMUxOaXhYSEVlUyUyRmEyQUxIcXp6THVHakZsRHZXZ2prQjNrU2t5S3d4ZVlQb284dk03cHFhTEFKV010T2ZtbnZUd1pqUVJUTnp1V0NSbjBwbHU3QVF2Q3hPZXMzRFg5ZTR3WDZBd1FhaXhIUjRQbXM2TnJxMVFuRkZLNHNrMW5kRGZqRTdEaXhGdlVpWlhUOHklMkZGcEFFMENPR0VhRCUyQmpGR1ZDYVI0NkVuMEo2RmJkOGFyQVYxaGJSNGZ5cFlaMFFuNFF6dE1MTWtpWW4xR0NQeWZyTjJxZEJ1aExmNFBqeUtSeFRLa2x6JTJGTmVvSnM1Smc2dVJiNVA0eiUyQiUyQkhlMUZqWFlUMXBXRzBnaDZtSDNvakttQyUyRmdOSTV3cHFlWDRpY2ZIb2t3RVB0VXAyTDFKYWNjd2xlZkU5dGlMZGZlQXJEbVZGJTJGRGp6UjE2S0JPNW1VMUR4R2dnd09DRDMzRkVqSCUyRjVERDklMkZwSW5IU0lSZFpmZDlRN2E1b1VwYmFFbFdhV2dxZjBEQ3RwWmluU2ZCWUZMNFBKeTAlMkZEdWd0VWZuWHdCVFNJV045c1lVYmFxODRMZXhkbVBHeFBwWUUyVHFaUWluVmRMTmtLbEJhQUpjUDV0JTJGTWQ4Nk5HM0lLVDZzalozJTJCVWxkMXRyNWIxVW8xbThCaSZ2ZXJzaW9uPTI=",
+	"details": {
+		"key": "returnUrlQueryString",
+		"type": "text"
+	},
+	"returnUrl": "",
+	"reference": "Merchant Reference",
+	"merchantAccount": "TestMerchant"
+}