adyen-ruby-api-library 7.2.0 → 7.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc8273f0430a4f263253bff4a97356616958dbabea34e1bb46de537ee8ddc244
-  data.tar.gz: 3e538becadaa36c48aa4c1af68543601be2deca4dba36ec144792e68104a65a3
+  metadata.gz: 5f92203448587aeac3de504e35af2298e7b279dbec39272caf1b3502f79a6f77
+  data.tar.gz: 2366da0ada0249bbeae5d3f21f051150f2e687054122e782e4f671128a8fb471
 SHA512:
-  metadata.gz: 55ee3ccc92e7615e05329cbc12439aa6862b277db43bd4d33a9b97d9baa22843d31b8e816cc970a4636db7698487baa5f423b37de25c3bae2363c18e4dedbc6e
-  data.tar.gz: 9c8d918b1790baf72aa4da31df12f87d6f90b97ed806d181dc32051d6f36f7a555d59bfc1e0def1fa3299f87d8494ae2d855a7a7871ddbfc485c43e7afb8eddc
+  metadata.gz: f10ac14eb9a75e8fd4c587f0419503982e59bcb5344c3a5bc771110bead40b163cd6d1051dc5fbe17cb1ccfd4e8021206f74e0bc057a1b1504a75489c8ad5b22
+  data.tar.gz: 6fdc37b92694ef969c8dce58fd1a89fa9a6e1e8c3b033ceb48532a5c452a8f28d484e9f6869ac55c4c9f18b3ecc5417090dd1c90bc41152a1034a1c091bd80c8

data/README.md

@@ -215,6 +215,18 @@ statusRequest =
 response = adyen.terminal_cloud_api.sync(statusRequest)
 ```
 
+## OAuth usage (for Partners)
+If you are using our OAuth service to make API requests on your customer's behalf, and you already got your Access Token as explained in the [OAuth Integration Guide](https://docs.adyen.com/development-resources/oauth/integration/#page-introduction), you can setup your Client like in the following example:
+
+~~~~ruby
+adyen = Adyen::Client.new
+
+adyen.oauth_token = "oauth_token"
+
+~~~~
+
+The APIs available to use through OAuth in this library depend on the [OAuth Scopes](https://docs.adyen.com/development-resources/oauth/scopes/) defined when [Registering your OAuth client](https://docs.adyen.com/development-resources/oauth/integration/#step-1-register-your-client).
+
 ## Feedback
 We value your input! Help us enhance our API Libraries and improve the integration experience by providing your feedback. Please take a moment to fill out [our feedback form](https://forms.gle/A4EERrR6CWgKWe5r9) to share your thoughts, suggestions or ideas.
 

data/lib/adyen/client.rb

@@ -12,16 +12,24 @@ require_relative './result'
 
 module Adyen
   class Client
-    attr_accessor :ws_user, :ws_password, :api_key, :client, :adapter
-    attr_reader :env, :connection_options
+    attr_accessor :ws_user, :ws_password, :api_key, :oauth_token, :client, :adapter
+    attr_reader :env, :connection_options, :adapter_options
 
-    def initialize(ws_user: nil, ws_password: nil, api_key: nil, env: :live, adapter: nil, mock_port: 3001,
-                   live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil)
+    def initialize(ws_user: nil, ws_password: nil, api_key: nil, oauth_token: nil, env: :live, adapter: nil, mock_port: 3001,
+                   live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil)
       @ws_user = ws_user
       @ws_password = ws_password
       @api_key = api_key
+      @oauth_token = oauth_token
       @env = env
       @adapter = adapter || Faraday.default_adapter
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.1')
+        # for faraday 2.1 and higher
+        @adapter_options = adapter_options || Faraday.default_adapter_options
+      else
+        # for faraday 1.x and 2.0
+        @adapter_options = adapter_options || {}
+      end
       @mock_service_url_base = mock_service_url_base || "http://localhost:#{mock_port}"
       @live_url_prefix = live_url_prefix
       @connection_options = connection_options || Faraday::ConnectionOptions.new
@@ -113,44 +121,16 @@ module Adyen
       # get URL for requested endpoint
       url = service_url(service, action.is_a?(String) ? action : action.fetch(:url), version)
 
-      # make sure right authentication has been provided
-      # will use api_key if present, otherwise ws_user and ws_password
-      if @api_key.nil?
-        if service == 'PaymentSetupAndVerification'
-          raise Adyen::AuthenticationError.new('Checkout service requires API-key', request_data),
-                'Checkout service requires API-key'
-        elsif @ws_password.nil? || @ws_user.nil?
-          raise Adyen::AuthenticationError.new(
-            'No authentication found - please set api_key or ws_user and ws_password',
-            request_data
-          ),
-                'No authentication found - please set api_key or ws_user and ws_password'
-        else
-          auth_type = 'basic'
-        end
-      else
-        auth_type = 'api-key'
-      end
+      auth_type = auth_type(service, request_data)
 
       # initialize Faraday connection object
       conn = Faraday.new(url, @connection_options) do |faraday|
-        faraday.adapter @adapter
+        faraday.adapter @adapter, **@adapter_options
         faraday.headers['Content-Type'] = 'application/json'
         faraday.headers['User-Agent'] = "#{Adyen::NAME}/#{Adyen::VERSION}"
 
-        # set auth type based on service
-        case auth_type
-        when 'basic'
-          if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-            # for faraday 2.0 and higher
-            faraday.request :authorization, :basic, @ws_user, @ws_password
-          else
-            # for faraday 1.x
-            faraday.basic_auth(@ws_user, @ws_password)
-          end
-        when 'api-key'
-          faraday.headers['x-api-key'] = @api_key
-        end
+        # set header based on auth_type and service
+        auth_header(auth_type, faraday)
 
         # add optional headers if specified in request
         # will overwrite default headers if overlapping
@@ -298,6 +278,49 @@ module Adyen
     def terminal_cloud_api
       @terminal_cloud_api ||= Adyen::TerminalCloudAPI.new(self)
     end
+
+    private
+
+    def auth_header(auth_type, faraday)
+      case auth_type
+      when "basic"
+        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+          # for faraday 2.0 and higher
+          faraday.request :authorization, :basic, @ws_user, @ws_password
+        else
+          # for faraday 1.x
+          faraday.basic_auth(@ws_user, @ws_password)
+        end
+      when "api-key"
+        faraday.headers["x-api-key"] = @api_key
+      when "oauth"
+        faraday.headers["Authorization"] = "Bearer #{@oauth_token}"
+      end
+    end
+
+    def auth_type(service, request_data)
+      # make sure valid authentication has been provided
+      validate_auth_type(service, request_data)
+      # Will prioritize authentication methods in this order:
+      # api-key, oauth, basic
+      return "api-key" unless @api_key.nil?
+      return "oauth" unless @oauth_token.nil?
+      "basic"
+    end
+
+    def validate_auth_type(service, request_data)
+      # ensure authentication has been provided
+      if @api_key.nil? && @oauth_token.nil? && (@ws_password.nil? || @ws_user.nil?)
+        raise Adyen::AuthenticationError.new(
+          'No authentication found - please set api_key, oauth_token, or ws_user and ws_password',
+          request_data
+        )
+      end
+      if service == "PaymentSetupAndVerification" && @api_key.nil? && @oauth_token.nil? && @ws_password.nil? && @ws_user.nil?
+        raise Adyen::AuthenticationError.new('Checkout service requires API-key or oauth_token', request_data),
+              'Checkout service requires API-key or oauth_token'
+      end
+    end
   end
 end
 # rubocop:enable all

data/lib/adyen/version.rb

@@ -1,4 +1,4 @@
 module Adyen
   NAME = 'adyen-ruby-api-library'.freeze
-  VERSION = '7.2.0'.freeze
+  VERSION = '7.3.1'.freeze
 end

data/spec/checkout-oauth_spec.rb

@@ -0,0 +1,621 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+RSpec.describe "Adyen::Checkout OAuth authentication", service: "checkout" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:oauth),
+      service: "Checkout",
+    }
+    @auth_header = { "Authorization": "Bearer #{@shared_values[:client].oauth_token}"  }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a payment_methods call", focus: true do
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payments_api.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"))
+
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.orders_api.get_balance_of_gift_card(request_body)
+    # result.response is already a Ruby hash (rather than an unparsed JSON string)
+    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["balance"]).
+      to eq("100")
+  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"))
+
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payments_api.payments_details(request_body)
+    # result.response is already a Ruby hash (rather than an unparsed JSON string)
+    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("RedirectShopper")
+    expect(response_hash.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"))
+
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.classic_checkout_sdk_api.verify_payment_result(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("Authorised")
+    expect(response_hash.resultCode).
+      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"))
+
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payment_links_api.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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payment_links_api.get_payment_link("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",
+    }
+
+    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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.payment_links_api.update_payment_link(request_body, "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("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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.orders_api.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: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.orders_api.cancel_order(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 an applePay/sessions call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/apple_pay_sessions.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/apple_pay_sessions.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "applePay/sessions", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.utility_api.get_apple_pay_session(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["data"]).
+      to eq("LARGE_BLOB_HERE")
+  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: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.payments_api.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
+
+  it "makes a capture call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/capture.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/capture.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/12345/captures", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.capture_authorised_payment(request_body, "12345")
+    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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a psp specific cancel call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/psp_cancel.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/psp_cancel.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/12345/cancels", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.cancel_authorised_payment_by_psp_reference(request_body, "12345")
+    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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a psp specific refunds call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/refund.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/refund.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/12345/refunds", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.refund_captured_payment(request_body, "12345")
+    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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a psp specific reversals call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/psp_cancel.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/psp_cancel.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/12345/reversals", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.refund_or_cancel_payment(request_body, "12345")
+    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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a psp specific amountUpdates call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/amount_updates.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/amount_updates.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "payments/12345/amountUpdates", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.update_authorised_amount(request_body, "12345")
+    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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a generic cancel call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/generic_cancel.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/generic_cancel.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "cancels", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      )
+      .to_return(body: response_body, status: 201)
+
+    result = @shared_values[:client].checkout.modifications_api.cancel_authorised_payment(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
+    expect(response_hash.reference).
+      to eq("123456789")
+    expect(response_hash.pspReference).
+      to eq("12345")
+  end
+
+  it "makes a get storedPaymentMethods call" do
+    response_body = json_from_file("mocks/responses/Checkout/stored_payment_methods.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "storedPaymentMethods?merchantAccount=TestMerchantAccount&shopperReference=test-1234", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:get, url).
+      with(
+        headers: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.recurring_api.get_tokens_for_stored_payment_details(query_params: {"merchantAccount" => "TestMerchantAccount", "shopperReference" => "test-1234"})
+    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["shopperReference"]).
+      to eq("test-1234")
+  end
+
+  it "makes a delete storedPaymentMethods call" do
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "storedPaymentMethods/RL8FW7WZM6KXWD82?merchantAccount=TestMerchantAccount&shopperReference=test-1234", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:delete, url).
+      with(
+        headers: @auth_header
+      ).
+      to_return(
+        body: "{}"
+      )
+
+    result = @shared_values[:client].checkout.recurring_api.delete_token_for_stored_payment_details("RL8FW7WZM6KXWD82", query_params:{"merchantAccount" => "TestMerchantAccount", "shopperReference" => "test-1234"})
+    response_hash = result.response
+
+    expect(result.status).
+      to eq(200)
+  end
+
+  it "tests sending the application headers" do
+    response_body = json_from_file("mocks/responses/Checkout/stored_payment_methods.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "storedPaymentMethods?merchantAccount=TestMerchantAccount&shopperReference=test-1234", @shared_values[:client].checkout.version)
+    WebMock.stub_request(:get, url).
+      with(
+        headers: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].checkout.recurring_api.get_tokens_for_stored_payment_details(query_params:{"merchantAccount" => "TestMerchantAccount", "shopperReference" => "test-1234"})
+    expect(
+      a_request(:get, "http://localhost:3001/v70/storedPaymentMethods?merchantAccount=TestMerchantAccount&shopperReference=test-1234")
+        .with(headers: {
+                'Accept' => '*/*',
+                'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                'Adyen-Library-Name' => 'adyen-ruby-api-library',
+                'Adyen-Library-Version' => Adyen::VERSION,
+                'Content-Type' => 'application/json',
+                'User-Agent' => 'adyen-ruby-api-library/' + Adyen::VERSION,
+                'Authorization'=>'Bearer oauth_token'
+              })
+    ).to have_been_made.once
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a LIVE paymentMethods call" do
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment_methods.json"))
+
+    response_body = json_from_file("mocks/responses/Checkout/payment_methods.json")
+
+    adyen = Adyen::Client.new
+    adyen.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
+    adyen.env = :live
+    adyen.live_url_prefix = "prefix"
+    url = adyen.service_url("Checkout", "paymentMethods", @shared_values[:client].checkout.version)
+
+    expect(url).
+      to eq("https://prefix-checkout-live.adyenpayments.com/checkout/v70/paymentMethods")
+
+  end
+end
+
+# rubocop:enable Metrics/BlockLength

data/spec/client_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 RSpec.describe Adyen do
-  before(:all) do
+  before(:each) do
     @shared_values = {
-      client: nil
+      client: Adyen::Client.new(env: :test)
     }
   end
 
@@ -32,6 +32,11 @@ RSpec.describe Adyen do
       .to raise_error(Adyen::AuthenticationError)
   end
 
+  it "fails a checkout call without oauth token" do
+    expect{ @shared_values[:client].checkout.payments_api.payment_methods("{}") }.
+      to raise_error(Adyen::AuthenticationError)
+  end
+
   it 'fails a checkout call without api key' do
     expect { @shared_values[:client].checkout.payments_api.payment_methods('{}') }
       .to raise_error(Adyen::AuthenticationError)
@@ -125,52 +130,52 @@ RSpec.describe Adyen do
     client.checkout.payments_api.payments_details(request_body)
   end
 
-  it "checks the creation of checkout url" do 
+  it "checks the creation of checkout url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("Checkout", "paymentMethods", "70")).
     to eq("https://checkout-test.adyen.com/v70/paymentMethods")
-  end 
+  end
 
-  it "checks the creation of checkout url" do 
+  it "checks the creation of checkout url" do
     client = Adyen::Client.new(api_key: "api_key", env: :live, live_url_prefix: "YourLiveUrlPrefix")
     expect(client.service_url("Checkout", "paymentMethods", "70")).
     to eq("https://YourLiveUrlPrefix-checkout-live.adyenpayments.com/checkout/v70/paymentMethods")
-  end 
-  it "checks the creation of lem url" do 
+  end
+  it "checks the creation of lem url" do
     client = Adyen::Client.new(api_key: "api_key", env: :live)
     expect(client.service_url("LegalEntityManagement", "businessLines", "3")).
     to eq("https://kyc-live.adyen.com/lem/v3/businessLines")
-  end 
+  end
 
-  it "checks the creation of balancePlatform url" do 
+  it "checks the creation of balancePlatform url" do
     client = Adyen::Client.new(api_key: "api_key", env: :live)
     expect(client.service_url("BalancePlatform", "legalEntities", "1")).
     to eq("https://balanceplatform-api-live.adyen.com/bcl/v1/legalEntities")
-  end 
+  end
 
-  it "checks the creation of balancePlatform url" do 
+  it "checks the creation of balancePlatform url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("BalancePlatform", "legalEntities", "1")).
     to eq("https://balanceplatform-api-test.adyen.com/bcl/v1/legalEntities")
-  end 
+  end
 
-  it "checks the creation of transfers url" do 
+  it "checks the creation of transfers url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("Transfers", "transactions", "1")).
     to eq("https://balanceplatform-api-test.adyen.com/btl/v1/transactions")
-  end 
+  end
 
-  it "checks the creation of management url" do 
+  it "checks the creation of management url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("Management", "companies", "1")).
     to eq("https://management-test.adyen.com/v1/companies")
-  end 
+  end
 
-  it "checks the creation of binLookup url" do 
+  it "checks the creation of binLookup url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("BinLookup", "getCostEstimate", "54")).
     to eq("https://pal-test.adyen.com/pal/servlet/BinLookup/v54/getCostEstimate")
-  end 
+  end
 
   it "check the creation of storedValue url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
@@ -253,6 +258,6 @@ RSpec.describe Adyen do
     client = Adyen::Client.new(api_key: 'api_key', env: :test)
     expect(client.service_url('TerminalCloudAPI', 'connectedTerminals', nil))
       .to eq('https://terminal-api-test.adyen.com/connectedTerminals')
-      
+
   end
 end

data/spec/management-oauth_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe "Adyen::Management OAuth Authentication", service: "Management" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:oauth),
+      service: "Management",
+    }
+    @auth_header = { "Authorization": "Bearer #{@shared_values[:client].oauth_token}"  }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a companies GET call" do
+    response_body = json_from_file("mocks/responses/Management/get_companies.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "companies", @shared_values[:client].management.version)
+    WebMock.stub_request(:get, url).
+      with(
+        headers: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].management.account_company_level_api.list_company_accounts()
+    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 create_store POST call" do
+    request_body = JSON.parse(json_from_file("mocks/responses/LegalEntityManagement/create_business_line.json"))
+
+    response_body = json_from_file("mocks/responses/LegalEntityManagement/create_business_line.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "merchants/merchantID/stores", @shared_values[:client].management.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: @auth_header
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].management.account_store_level_api.create_store_by_merchant_id(request_body, 'merchantID')
+    response_hash = result.response
+
+      expect(result.status).
+      to eq(200)
+  end
+end

data/spec/spec_helper.rb

@@ -29,6 +29,8 @@ def create_test(client, service, method_name, parent_object)
   # authentication headers
   if !client.api_key.nil?
     headers['x-api-key'] = client.api_key
+  elsif !client.oauth_token.nil?
+    headers["Authorization"] = "Bearer #{client.oauth_token}"
   elsif !client.ws_user.nil? && !client.ws_password.nil?
     auth_header = "Basic #{Base64.encode64("#{client.ws_user}:#{client.ws_password}")}"
     headers['Authorization'] = auth_header.strip
@@ -79,13 +81,15 @@ def generate_tests(client, service, test_sets, parent_object)
 end
 
 # create and return a client for testing
-# auth_type must be one of [:basic, :api_key]
+# auth_type must be one of [:basic, :api_key, :oauth]
 def create_client(auth_type)
   client = Adyen::Client.new
   client.env = :mock
   if auth_type == :basic
     client.ws_user = 'user'
     client.ws_password = 'password'
+  elsif auth_type == :oauth
+    client.oauth_token = 'oauth_token'
   elsif auth_type == :api_key
     client.api_key = 'api_key'
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.3.1
 platform: ruby
 authors:
 - Adyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -203,6 +203,7 @@ files:
 - spec/balance_control_spec.rb
 - spec/balance_platform_spec.rb
 - spec/bin_lookup_spec.rb
+- spec/checkout-oauth_spec.rb
 - spec/checkout_spec.rb
 - spec/client_spec.rb
 - spec/data_protection_spec.rb
@@ -212,6 +213,7 @@ files:
 - spec/hash_with_accessors_spec.rb
 - spec/hop_spec.rb
 - spec/lem_spec.rb
+- spec/management-oauth_spec.rb
 - spec/management_spec.rb
 - spec/mocks/requests/Account/check_account_holder.json
 - spec/mocks/requests/Account/close_account.json