adyen-ruby-api-library 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2156b9db20964cb7f43be56c19a462ccc091e42fdcecd887c9da04dc880116
-  data.tar.gz: 47cb2a027baa58061a6eb46e5c703ff7bc18b05002e5a7c0c5b9d9e9d68616fd
+  metadata.gz: 1b091a2aaf201f3a22b41a22c069321d1d181daee6e33da275d94ab970b9b9ab
+  data.tar.gz: 1806d42c9f609c9ff3b6e84e31ff1be9f4d4503d15f5a0c300a664a779a5c295
 SHA512:
-  metadata.gz: a1e4c4a2fd0b91b3e375a66a59910548a9e272beb8940e2ecf6432593e2c14494006d7d6387020245fea48af0f24b50b7803d135db654294e9079c842f818390
-  data.tar.gz: de54e9a6c6da6a49b922d26cb6197651f59f145fef43412bfdf50863097f287d8139dd1647e6efd585d1c08d8dbffaca845f16e0e46ec49334e323f73ade74d1
+  metadata.gz: f9c9221b5d0c164cd4a90c5d7e6531e6361c116e00139662fcff37588309c07c21740d8a3c277ec4b7febbad4d5af752a772eab0df5625430f66b3b47fcbfc92
+  data.tar.gz: 4b89bec481b6b2e900325a9f9bc11a69e87b42d61a1358205e53d3a17f90c722377e4fdf7accafc11124ac2e4d70d88b36cdd214cb5f9b7d576e216d9ca6b31b

data/.github/workflows/rubygems_release.yml

@@ -0,0 +1,19 @@
+name: Publish Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Release Gem on RubyGems
+        if: contains(github.ref, 'refs/tags/v')
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.TOKEN_RUBYGEMS_RELEASES_WITH_EXPIRATION}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/lib/adyen/client.rb

@@ -6,9 +6,9 @@ require_relative "./result"
 module Adyen
   class Client
     attr_accessor :ws_user, :ws_password, :api_key, :client, :adapter, :live_url_prefix
-    attr_reader :env
+    attr_reader :env, :connection_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)
+    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)
       @ws_user = ws_user
       @ws_password = ws_password
       @api_key = api_key
@@ -16,6 +16,7 @@ module Adyen
       @adapter = adapter || Faraday.default_adapter
       @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
     end
 
     # make sure that env can only be :live, :test, or :mock
@@ -96,7 +97,7 @@ module Adyen
       end
 
       # initialize Faraday connection object
-      conn = Faraday.new(url: url) do |faraday|
+      conn = Faraday.new(url, @connection_options) do |faraday|
         faraday.adapter @adapter
         faraday.headers["Content-Type"] = "application/json"
         faraday.headers["User-Agent"] = Adyen::NAME + "/" + Adyen::VERSION

data/lib/adyen/services/checkout.rb

@@ -71,6 +71,10 @@ module Adyen
     def apple_pay
       @apple_pay ||= Adyen::CheckoutApplePay.new(@client, @version)
     end
+
+    def modifications
+      @modifications ||= Adyen::Modifications.new(@client, @version)
+    end
   end
 
   class CheckoutDetail < Service
@@ -147,4 +151,42 @@ module Adyen
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
   end
+
+  class Modifications < Service
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "Checkout"
+      @client = client
+      @version = version
+    end
+
+    def capture(linkId, request, headers = {})
+      action = "payments/" + linkId + "/captures"
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+
+    def cancel(linkId, request, headers = {})
+      action = "payments/" + linkId + "/cancels"
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+
+    def genericCancel(request, headers = {})
+      action = "cancels"
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+  
+    def refund(linkId, request, headers = {})
+      action = "payments/" + linkId + "/refunds"
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+
+    def reversal(linkId, request, headers = {})
+      action = "payments/" + linkId + "/reversals"
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+
+    def amountUpdate(linkId, request, headers = {})
+      action = "payments/" + linkId + "/amountUpdates"
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+  end
 end

data/lib/adyen/version.rb

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

data/spec/checkout_spec.rb

@@ -405,6 +405,198 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
       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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.capture("12345", 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 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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.cancel("12345", 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 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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.refund("12345", 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 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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.reversal("12345", 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 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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.amountUpdate("12345", 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 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: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      )
+      .to_return(body: response_body, status: 201)
+  
+    result = @shared_values[:client].checkout.modifications.genericCancel(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
+
   # create client for automated tests
   client = create_client(:api_key)
 

data/spec/client_spec.rb

@@ -83,4 +83,31 @@ RSpec.describe Adyen do
     expect(client.service_url_base("Payment")).
       to eq("https://abcdef1234567890-TestCompany-pal-live.adyenpayments.com/pal/servlet")
   end
+
+  it "generates a new set of ConnectionOptions when none are provided" do
+    expect(Faraday::ConnectionOptions).to receive(:new).and_call_original
+    client = Adyen::Client.new(env: :test)
+  end
+
+  it "uses the ConnectionOptions provided" do
+    connection_options = Faraday::ConnectionOptions.new
+    expect(Faraday::ConnectionOptions).not_to receive(:new)
+    client = Adyen::Client.new(env: :test, connection_options: connection_options)
+  end
+
+  it "initiates a Faraday connection with the provided options" do
+    connection_options = Faraday::ConnectionOptions.new
+    expect(Faraday::ConnectionOptions).not_to receive(:new)
+    client = Adyen::Client.new(api_key: "api_key", env: :mock, connection_options: connection_options)
+
+    mock_faraday_connection = double(Faraday::Connection)
+    url = client.service_url(@shared_values[:service], "payments/details", client.checkout.version)
+    request_body = JSON.parse(json_from_file("mocks/requests/Checkout/payment-details.json"))
+    mock_response = Faraday::Response.new(status: 200)
+
+    expect(Adyen::AdyenResult).to receive(:new)
+    expect(Faraday).to receive(:new).with("http://localhost:3001/v68/payments/details", connection_options).and_return(mock_faraday_connection)
+    expect(mock_faraday_connection).to receive(:post).and_return(mock_response)
+    client.checkout.payments.details(request_body)
+  end
 end

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

@@ -0,0 +1,22 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "merchantAccount": "TestMerchant",
+    "reason": "delayedCharge",
+    "reference": "123456789",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ]
+}
+  

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

@@ -0,0 +1,34 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "lineItems": [
+      {
+        "amountExcludingTax": 0,
+        "amountIncludingTax": 0,
+        "description": "string",
+        "id": "string",
+        "imageUrl": "string",
+        "itemCategory": "string",
+        "productUrl": "string",
+        "quantity": 0,
+        "taxAmount": 0,
+        "taxPercentage": 0
+      }
+    ],
+    "merchantAccount": "string",
+    "reference": "string",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ]
+}

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

@@ -0,0 +1,5 @@
+{
+    "merchantAccount": "TestMerchant",
+    "paymentReference": "12345",
+    "reference": "123456789"
+}

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

@@ -0,0 +1,4 @@
+{
+    "merchantAccount": "TestMerchant",
+    "reference": "123456789"
+}

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

@@ -0,0 +1,34 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "lineItems": [
+      {
+        "amountExcludingTax": 0,
+        "amountIncludingTax": 0,
+        "description": "string",
+        "id": "string",
+        "imageUrl": "string",
+        "itemCategory": "string",
+        "productUrl": "string",
+        "quantity": 0,
+        "taxAmount": 0,
+        "taxPercentage": 0
+      }
+    ],
+    "merchantAccount": "TestMerchant",
+    "reference": "123456789",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ]
+}

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

@@ -0,0 +1,24 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "merchantAccount": "TestMerchant",
+    "paymentPspReference": "123456789",
+    "pspReference": "12345",
+    "reason": "delayedCharge",
+    "reference": "123456789",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ],
+    "status": "received"
+}

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

@@ -0,0 +1,37 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "lineItems": [
+      {
+        "amountExcludingTax": 0,
+        "amountIncludingTax": 0,
+        "description": "string",
+        "id": "string",
+        "imageUrl": "string",
+        "itemCategory": "string",
+        "productUrl": "string",
+        "quantity": 0,
+        "taxAmount": 0,
+        "taxPercentage": 0
+      }
+    ],
+    "merchantAccount": "string",
+    "paymentPspReference": "string",
+    "pspReference": "12345",
+    "reference": "123456789",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ],
+    "status": "received"
+}

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

@@ -0,0 +1,7 @@
+{
+    "merchantAccount": "string",
+    "paymentReference": "123456789",
+    "pspReference": "12345",
+    "reference": "123456789",
+    "status": "received"
+}

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

@@ -0,0 +1,7 @@
+{
+    "merchantAccount": "TestMerchant",
+    "paymentPspReference": "string",
+    "pspReference": "12345",
+    "reference": "123456789",
+    "status": "received"
+}

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

@@ -0,0 +1,37 @@
+{
+    "amount": {
+      "currency": "str",
+      "value": 0
+    },
+    "lineItems": [
+      {
+        "amountExcludingTax": 0,
+        "amountIncludingTax": 0,
+        "description": "string",
+        "id": "string",
+        "imageUrl": "string",
+        "itemCategory": "string",
+        "productUrl": "string",
+        "quantity": 0,
+        "taxAmount": 0,
+        "taxPercentage": 0
+      }
+    ],
+    "merchantAccount": "TestMerchant",
+    "paymentPspReference": "123456789",
+    "pspReference": "12345",
+    "reference": "123456789",
+    "splits": [
+      {
+        "account": "string",
+        "amount": {
+          "currency": "str",
+          "value": 0
+        },
+        "description": "string",
+        "reference": "string",
+        "type": "BalanceAccount"
+      }
+    ],
+    "status": "received"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Adyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -82,6 +82,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
 - ".github/workflows/ruby.yml"
+- ".github/workflows/rubygems_release.yml"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -153,7 +154,11 @@ files:
 - spec/mocks/requests/Account/upload_document.json
 - spec/mocks/requests/BinLookup/get_3ds_availability.json
 - spec/mocks/requests/BinLookup/get_cost_estimate.json
+- spec/mocks/requests/Checkout/amount_updates.json
 - spec/mocks/requests/Checkout/apple_pay_sessions.json
+- spec/mocks/requests/Checkout/capture.json
+- spec/mocks/requests/Checkout/generic_cancel.json
+- spec/mocks/requests/Checkout/modifications_request.json
 - spec/mocks/requests/Checkout/orders.json
 - spec/mocks/requests/Checkout/orders_cancel.json
 - spec/mocks/requests/Checkout/origin_keys.json
@@ -164,6 +169,8 @@ files:
 - spec/mocks/requests/Checkout/payment_methods_balance.json
 - spec/mocks/requests/Checkout/payment_session.json
 - spec/mocks/requests/Checkout/payments.json
+- spec/mocks/requests/Checkout/psp_cancel.json
+- spec/mocks/requests/Checkout/refund.json
 - spec/mocks/requests/Checkout/sessions.json
 - spec/mocks/requests/Checkout/verify.json
 - spec/mocks/requests/DataProtectionService/request_subject_erasure.json
@@ -230,8 +237,12 @@ files:
 - spec/mocks/responses/Account/upload_document.json
 - spec/mocks/responses/BinLookup/get_3ds_availability.json
 - spec/mocks/responses/BinLookup/get_cost_estimate.json
+- spec/mocks/responses/Checkout/amount_updates.json
 - spec/mocks/responses/Checkout/apple_pay_sessions.json
+- spec/mocks/responses/Checkout/capture.json
+- spec/mocks/responses/Checkout/generic_cancel.json
 - spec/mocks/responses/Checkout/get-payment-link.json
+- spec/mocks/responses/Checkout/modifications.json
 - spec/mocks/responses/Checkout/orders.json
 - spec/mocks/responses/Checkout/orders_cancel.json
 - spec/mocks/responses/Checkout/origin_keys.json
@@ -242,6 +253,8 @@ files:
 - spec/mocks/responses/Checkout/payment_methods_balance.json
 - spec/mocks/responses/Checkout/payment_session.json
 - spec/mocks/responses/Checkout/payments.json
+- spec/mocks/responses/Checkout/psp_cancel.json
+- spec/mocks/responses/Checkout/refund.json
 - spec/mocks/responses/Checkout/sessions-success.json
 - spec/mocks/responses/Checkout/update-payment-link.json
 - spec/mocks/responses/Checkout/verify.json
@@ -320,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Official Adyen  Ruby API Library