adyen-ruby-api-library 4.3.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d77315c126cb7ae2f8600f5bc8e853fd868a6bc6c30c36add08cfbe93285488
-  data.tar.gz: bf4c1f6498020da769aecba45b4fe6ce43f017ca71e083723b2bfa8903d3932e
+  metadata.gz: 61215b9de7ba034430b475ae7e70caaf9e28403e9932d7dee5c2092cab206843
+  data.tar.gz: e0363ffc4090d847ecc2e1a7c976a91adf58d3f70d75d88609a51aee5f4dc518
 SHA512:
-  metadata.gz: dd3c31163dae11854ef0d921ff772ddd3d5b526c2bef106a26edd150e2f517fd306cde43e7839313e134dd72f86eb6f0c37a2a19cb52efc169892e8849b9ceb0
-  data.tar.gz: c51e518693653f525a5dc06ee71d859614f5a741b4109ded91a29e9327c768c9b7c0c5f1783fdceeb740b1e6f95074bfc7f0336b7228eb1a3e66a34bd3730bd1
+  metadata.gz: 2dc2019edf4bb02922b573b45e151a472cb3cb178b55677ffbb52d3867fb3514b1aabf76458338a8d832d1116a215fa0286c963a086c8ed2fd156ee94b4e5422
+  data.tar.gz: 45dee79d7372364092e9b3a9fd789d2b7553ac4052ebf0d6701bed7f2c62ad0772b7eb25702233feffe9ed13d158af7c958fa0a71f07a5740e869dda88402351

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @crrood @hbkwong @KadoBOT @Aleffio @rikterbeek
+* @crrood @Aleffio @wboereboom @cyattilakiss

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rspec

data/.gitignore

@@ -11,3 +11,7 @@ design.txt
 
 .bundle
 .ruby-version
+
+.DS_Store
+
+.idea

data/README.md

@@ -1,53 +1,69 @@
 # Adyen API Library for Ruby
 
-The Adyen API Library for Ruby lets you easily work with Adyen's API.
+
+This is the officially supported Ruby library for using Adyen's APIs.
 
 ## Integration
+The library supports all APIs under the following services:
 
-The Library supports all APIs under the following services:
+* [Checkout API](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/overview): Our latest integration for accepting online payments. Current supported version: **v68**
+* [Payments API](https://docs.adyen.com/api-explorer/#/Payment/v64/overview): Our classic integration for online payments. Current supported version: **v64**
+* [Recurring API](https://docs.adyen.com/api-explorer/#/Recurring/v49/overview): Endpoints for managing saved payment details. Current supported version: **v49**
+* [Payouts API](https://docs.adyen.com/api-explorer/#/Payout/v64/overview): Endpoints for sending funds to your customers. Current supported version: **v64**
+* [Platforms APIs](https://docs.adyen.com/platforms/api): Set of APIs when using Adyen for Platforms. 
+  * [Account API](https://docs.adyen.com/api-explorer/#/Account/v6/overview) Current supported version: **v6**
+  * [Fund API](https://docs.adyen.com/api-explorer/#/Fund/v6/overview) Current supported version: **v6**
+  * [Notification Configuration API](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/v6/overview) Current supported version: **v6**
+* [POS Terminal Management API](https://docs.adyen.com/api-explorer/#/postfmapi/v1/overview): Current supported version: **v1**
+* [Adyen BinLookup API](https://docs.adyen.com/api-explorer/#/BinLookup/v50/overview): Current supported version: **v50**
+* [Data Protection API](https://docs.adyen.com/development-resources/data-protection-api): Current supported version: **v1**
+* [Disputes API](https://docs.adyen.com/risk-management/disputes-api): Current supported version: **v50**
 
-* checkout
-* checkout utility
-* payments
-* modifications
-* payouts
-* recurring
-* marketpay
-* postfmapi
-* data_protection
 
-## Requirements
+For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 
-Built for Ruby >= 2.1
+## Prerequisites
+- [Adyen test account](https://docs.adyen.com/get-started-with-adyen)
+- [API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). For testing, your API credential needs to have the [API PCI Payments role](https://docs.adyen.com/development-resources/api-credentials#roles).
+- Ruby >= 2.1
 
 ## Installation
 
-The sole dependency is faraday for http communication - run `bundle install` to install faraday if you don't already have it
+The sole dependency is faraday for HTTP communication.  Run the following command to install faraday if you don't already have it:
+
+~~~~bash 
+bundle install
+~~~~
 
-To validate functionality of client, use `bundle install --with development` and `rspec` to run mock API tests.
+To validate functionality of client and run mock API tests use
 
+~~~~bash  
+bundle install --with development 
+~~~~
+and
+~~~~bash 
+rspec
+~~~~
 ## Documentation
 
 Follow the rest of our guides from the [documentation](https://adyen.github.io/adyen-ruby-api-library/) on how to use this library.
 
-## Usage
+## Using the library
 
-### Create a client to connect to the Adyen API
-```ruby
-require 'adyen-ruby-api-library'
+### General use with API key
 
+~~~~bash 
+require 'adyen-ruby-api-library'
+~~~~
+~~~~ruby
 adyen = Adyen::Client.new
 
-# for API-key based implementations
 adyen.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
 
-# for basic-auth based implementations
-adyen.ws_user = 'ws@Company.Adyen'
-adyen.ws_password = 'super_secure_password123'
-```
+~~~~
 
-### Make a Payment
-```ruby
+- Make a Payment
+~~~~ruby
 response = adyen.checkout.payments({
   :amount => {
     :currency => "EUR",
@@ -56,112 +72,45 @@ response = adyen.checkout.payments({
   :reference => "Your order number",
   :paymentMethod => {
     :type => "scheme",
-    :encryptedCardNumber => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
-    :encryptedExpiryMonth => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
-    :encryptedExpiryYear => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
-    :encryptedSecurityCode => "adyenjs_0_1_18$MT6ppy0FAMVMLH..."
+    :encryptedCardNumber => "test_4111111111111111",
+    :encryptedExpiryMonth => "test_03",
+    :encryptedExpiryYear => "test_2030",
+    :encryptedSecurityCode => "test_737"
   },
   :returnUrl => "https://your-company.com/checkout/",
   :merchantAccount => "YourMerchantAccount"
 })
-```
-
-### Change API Version
-```ruby
-adyen.checkout.version = 50
-```
-
-## List of supported methods
-
-**checkout:**
-- payment_session
-- payments.result
-- payment_methods
-- payments
-- payments.details
-- payment_links
-
-**checkout utility:**
-- origin_keys
-
-**payments:**
-- authorise
-- authorise3d
-
-**modifications:**
-- capture
-- cancel
-- refund
-- cancel_or_refund
-- adjust_authorisation
-- donate
-
-**payouts:**
-- confirm_third_party
-- decline_third_party
-- store_detail
-- submit_third_party
-- store_detail_and_submit_third_party
-
-**recurring:**
-- list_recurring_details
-- disable
-- store_token
-
-**marketpay.account:**
-- create_account_holder
-- get_account_holder
-- update_account_holder
-- update_account_holder_state
-- suspend_account_holder
-- un_suspend_account_holder
-- close_account_holder
-- create_account
-- update_account
-- close_account
-- upload_document
-- get_uploaded_documents
-- delete_bank_accounts
-- delete_shareholders
-
-**marketpay.fund:**
-- account_holder_balance
-- account_holder_transaction_list
-- payout_account_holder
-- transfer_funds
-- setup_beneficiary
-- refund_not_paid_out_transfers
-
-**marketpay.notification:**
-- create_notification_configuration
-- get_notification_configuration
-- get_notification_configuration_list
-- test_notification_configuration
-- update_notification_configuration
-- delete_notification_configurations
-
-**marketpay.hop:**
-- get_onboarding_url
-
-**postfmapi:**
-- assign_terminals
-- find_terminal
-- get_terminals_under_account
-
-**data_protection:**
-- request_subject_erasure
+~~~~
 
-## Support
-If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420).
+- Change API Version
+~~~~ruby
+adyen.checkout.version = 68
+~~~~
+
+### Example integration
+
+For a closer look at how our Ruby library works, clone our [example integration](https://github.com/adyen-examples/adyen-rails-online-payments). This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.
+
+### Running the tests
+To run the tests use : 
+~~~~bash  
+bundle install --with development 
+~~~~
 
 ## Contributing
-We strongly encourage you to join us in contributing to this repository so everyone can benefit from:
-* New features and functionality
-* Resolved bug fixes and issues
-* Any general improvements
 
-Read our [**contribution guidelines**](CONTRIBUTING.md) to find out how.
+We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements.
+Have a look at our [contributing guidelines](https://github.com/Adyen/adyen-ruby-api-library/blob/develop/CONTRIBUTING.md) to find out how to raise a pull request.
+
+## Support
+If you have a feature request, or spotted a bug or a technical problem, [create an issue here](https://github.com/Adyen/adyen-ruby-api-library/issues/new/choose).
+
+For other questions, [contact our Support Team](https://www.adyen.help/hc/en-us/requests/new?ticket_form_id=360000705420).
 
 ## Licence
+This repository is available under the [MIT license](https://github.com/Adyen/adyen-ruby-api-library/blob/master/LICENSE).
 
-MIT license. For more information, see the LICENSE file.
+## See also
+* [Example integration](https://github.com/adyen-examples/adyen-rails-online-payments)
+* [Adyen docs](https://docs.adyen.com/)
+* [API Explorer](https://docs.adyen.com/api-explorer/)

data/docs/marketpay.html

@@ -61,6 +61,8 @@
         <li>delete_bank_accounts</li>
 
         <li>delete_shareholders</li>
+
+        <li>delete_signatories</li>
         </ul>
 
         <h4 id="marketpayfund">marketpay.fund:</h4>

data/lib/adyen/client.rb

@@ -42,19 +42,16 @@ module Adyen
         when "Checkout"
           url = "https://checkout-#{@env}.adyen.com/checkout"
           supports_live_url_prefix = true
-        when "CheckoutUtility"
-          url = "https://checkout-#{@env}.adyen.com/checkout"
-          supports_live_url_prefix = true
         when "Account", "Fund", "Notification", "Hop"
           url = "https://cal-#{@env}.adyen.com/cal/services"
           supports_live_url_prefix = false
-        when "Recurring", "Payment", "Payout"
+        when "Recurring", "Payment", "Payout", "BinLookup"
           url = "https://pal-#{@env}.adyen.com/pal/servlet"
           supports_live_url_prefix = true
         when "Terminal"
           url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
           supports_live_url_prefix = false
-        when "DataProtectionService"
+        when "DataProtectionService", "DisputeService"
           url = "https://ca-#{@env}.adyen.com/ca/services"
           supports_live_url_prefix = false
         else
@@ -72,7 +69,7 @@ module Adyen
 
     # construct full URL from service and endpoint
     def service_url(service, action, version)
-      if service == "Checkout" || service == "CheckoutUtility" || service == "Terminal"
+      if service == "Checkout" || service == "Terminal"
         "#{service_url_base(service)}/v#{version}/#{action}"
       else
         "#{service_url_base(service)}/#{service}/v#{version}/#{action}"
@@ -80,9 +77,9 @@ module Adyen
     end
 
     # send request to adyen API
-    def call_adyen_api(service, action, request_data, headers, version)
+    def call_adyen_api(service, action, request_data, headers, version, with_application_info = false)
       # get URL for requested endpoint
-      url = service_url(service, action, version)
+      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
@@ -125,20 +122,39 @@ module Adyen
       end
 
       # add application only on checkout service
-      if service == 'Checkout' || service == 'CheckoutUtility'
+      if with_application_info
         add_application_info(request_data)
       end
 
       # convert to json
       request_data = request_data.to_json
 
-      # post request to Adyen
-      begin
-        response = conn.post do |req|
-          req.body = request_data
-        end # handle client errors
-      rescue Faraday::ConnectionFailed => connection_error
-        raise connection_error, "Connection to #{url} failed"
+      if action.is_a?(::Hash)
+        if action.fetch(:method) == "get"
+          begin
+            response = conn.get 
+          rescue Faraday::ConnectionFailed => connection_error
+            raise connection_error, "Connection to #{url} failed"
+          end
+        end
+        if action.fetch(:method) == "patch"
+          begin
+            response = conn.patch do |req|
+              req.body = request_data
+            end
+          rescue Faraday::ConnectionFailed => connection_error
+            raise connection_error, "Connection to #{url} failed"
+          end
+        end
+      else
+        # post request to Adyen
+        begin
+          response = conn.post do |req|
+            req.body = request_data
+          end # handle client errors
+        rescue Faraday::ConnectionFailed => connection_error
+          raise connection_error, "Connection to #{url} failed"
+        end
       end
 
       # check for API errors
@@ -157,16 +173,15 @@ module Adyen
     # add application_info for analytics
     def add_application_info(request_data)
       adyenLibrary = {
-          :name => Adyen::NAME,
-          :version => Adyen::VERSION.to_s
+        :name => Adyen::NAME,
+        :version => Adyen::VERSION.to_s,
       }
 
       if request_data[:applicationInfo].nil?
-        request_data[:applicationInfo] = {};
+        request_data[:applicationInfo] = {}
       end
 
       request_data[:applicationInfo][:adyenLibrary] = adyenLibrary
-      request_data[:applicationInfo][:adyenLibraryTest] = adyenLibrary
     end
 
     # services
@@ -174,10 +189,6 @@ module Adyen
       @checkout ||= Adyen::Checkout.new(self)
     end
 
-    def checkout_utility
-      @checkout_utility ||= Adyen::CheckoutUtility.new(self)
-    end
-
     def payments
       @payments ||= Adyen::Payments.new(self)
     end
@@ -201,5 +212,13 @@ module Adyen
     def data_protection
       @data_protection ||= Adyen::DataProtection.new(self)
     end
+
+    def dispute
+      @dispute ||= Adyen::Dispute.new(self)
+    end
+
+    def bin_lookup
+      @bin_lookup ||= Adyen::BinLookup.new(self)
+    end
   end
 end

data/lib/adyen/services/{checkout_utility.rb → bin_lookup.rb}

@@ -1,13 +1,15 @@
 require_relative 'service'
 
 module Adyen
-  class CheckoutUtility < Service
-    DEFAULT_VERSION = 1
+  class BinLookup < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 50
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Checkout'
+      service = 'BinLookup'
       method_names = [
-        :origin_keys
+        :get_3ds_availability,
+        :get_cost_estimate
       ]
 
       super(client, version, service, method_names)

data/lib/adyen/services/checkout.rb

@@ -1,18 +1,22 @@
-require_relative 'service'
+require_relative "service"
 
 module Adyen
   class Checkout < Service
-    DEFAULT_VERSION = 50
+    DEFAULT_VERSION = 68
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Checkout'
+      service = "Checkout"
       method_names = [
-        :payment_methods,
         :payment_session,
-        :payment_links
+        :origin_keys,
+        :sessions
       ]
 
-      super(client, version, service, method_names)
+      with_application_info = [
+        :payment_session,
+      ]
+
+      super(client, version, service, method_names, with_application_info)
     end
 
     # This method can't be dynamically defined because
@@ -25,7 +29,40 @@ module Adyen
       when 0
         Adyen::CheckoutDetail.new(@client, @version)
       else
-        action = 'payments'
+        action = "payments"
+        args[1] ||= {}  # optional headers arg
+        @client.call_adyen_api(@service, action, args[0], args[1], @version, true)
+      end
+    end
+
+    def payment_links(*args)
+      case args.size
+      when 0
+        Adyen::CheckoutLink.new(@client, @version)
+      else
+        action = "paymentLinks"
+        args[1] ||= {}  # optional headers arg
+        @client.call_adyen_api(@service, action, args[0], args[1], @version, true)
+      end
+    end
+
+    def payment_methods(*args)
+      case args.size
+      when 0
+        Adyen::CheckoutMethod.new(@client, @version)
+      else
+        action = "paymentMethods"
+        args[1] ||= {}  # optional headers arg
+        @client.call_adyen_api(@service, action, args[0], args[1], @version)
+      end
+    end
+
+    def orders(*args)
+      case args.size
+      when 0
+        Adyen::CheckoutOrder.new(@client, @version)
+      else
+        action = "orders"
         args[1] ||= {}  # optional headers arg
         @client.call_adyen_api(@service, action, args[0], args[1], @version)
       end
@@ -34,7 +71,7 @@ module Adyen
 
   class CheckoutDetail < Service
     def initialize(client, version = DEFAULT_VERSION)
-      @service = 'Checkout'
+      @service = "Checkout"
       @client = client
       @version = version
     end
@@ -49,4 +86,48 @@ module Adyen
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
   end
+
+  class CheckoutLink < Service
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "Checkout"
+      @client = client
+      @version = version
+    end
+
+    def get(linkId, headers = {})
+      action = { method: 'get', url: "paymentLinks/" + linkId }
+      @client.call_adyen_api(@service, action, {}, headers, @version, true)
+    end
+
+    def update(linkId, request, headers = {})
+      action = { method: 'patch', url: "paymentLinks/" + linkId }
+      @client.call_adyen_api(@service, action, request, headers, @version, false)
+    end
+  end
+
+  class CheckoutMethod < Service
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "Checkout"
+      @client = client
+      @version = version
+    end
+
+    def balance(request, headers = {})
+      action = "paymentMethods/balance"
+      @client.call_adyen_api(@service, action, request, headers, @version, true)
+    end
+  end
+
+  class CheckoutOrder < Service
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "Checkout"
+      @client = client
+      @version = version
+    end
+
+    def cancel(request, headers = {})
+      action = "orders/cancel"
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+  end
 end

data/lib/adyen/services/dispute.rb

@@ -0,0 +1,20 @@
+require_relative 'service'
+
+module Adyen
+  class Dispute < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 30
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'DisputeService'
+      method_names = [
+        :retrieve_applicable_defense_reasons,
+        :supply_defense_document,
+        :delete_dispute_defense_document,
+        :defend_dispute,
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/marketpay.rb

@@ -29,7 +29,7 @@ module Adyen
 
     class Account < Service
       attr_accessor :version
-      DEFAULT_VERSION = 4
+      DEFAULT_VERSION = 6
 
       def initialize(client, version = DEFAULT_VERSION)
         service = 'Account'
@@ -44,11 +44,13 @@ module Adyen
           :update_account_holder_state,
           :delete_bank_accounts,
           :delete_shareholders,
+          :delete_signatories,
           :close_account,
           :close_account_holder,
-          :get_tier_configuration,
           :suspend_account_holder,
-          :un_suspend_account_holder
+          :un_suspend_account_holder,
+          :delete_payout_methods,
+          :check_account_holder
         ]
 
         super(client, version, service, method_names)
@@ -57,7 +59,7 @@ module Adyen
 
     class Fund < Service
       attr_accessor :version
-      DEFAULT_VERSION = 3
+      DEFAULT_VERSION = 6
 
       def initialize(client, version = DEFAULT_VERSION)
         service = 'Fund'
@@ -67,7 +69,8 @@ module Adyen
           :account_holder_transaction_list,
           :refund_not_paid_out_transfers,
           :setup_beneficiary,
-          :transfer_funds
+          :transfer_funds,
+          :refund_funds_transfer
         ]
 
         super(client, version, service, method_names)
@@ -76,7 +79,7 @@ module Adyen
 
     class Notification < Service
       attr_accessor :version
-      DEFAULT_VERSION = 5
+      DEFAULT_VERSION = 6
 
       def initialize(client, version = DEFAULT_VERSION)
         service = 'Notification'
@@ -95,7 +98,7 @@ module Adyen
 
     class Hop < Service
       attr_accessor :version
-      DEFAULT_VERSION = 1
+      DEFAULT_VERSION = 6
 
       def initialize(client, version = DEFAULT_VERSION)
         service = 'Hop'