adyen-ruby-api-library 4.4.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e483ea1b71301634db57072423fd8cea1483b160eec7c1ba85fcf62ccbac0414
-  data.tar.gz: fa6dd93d1fe95ccf9ce3e9cc4a9956e523e6f25a20ae49fb2529e560c1aec14a
+  metadata.gz: 02ec361baadfa4a0b114ff3f4b162f737775e22ed23b40d79e76fb0dfda3d7e2
+  data.tar.gz: cbffe8658ad929e8e7a7eb210013a43dbf2c58094b46e3c753c4e07ba41f4b43
 SHA512:
-  metadata.gz: 50f51f247bb68817b56ef596ad2b435280fedb1dc06806665a5e48b4c1cfb67fda4c1060f882929c0c40c8b225635cc19d36d6f90be4ae1e0e7149dc8f8638bd
-  data.tar.gz: 15273291ffb0122fab7050dc1263028c6a38d6634519c744057d1b3756b62461c028de7982d5c36adfb04e50f25a7d121541d1ef496a91c3c63bd67ee75c7829
+  metadata.gz: aa6e2f3474c3d4178fd25076994ccb76b034c8976f47f6da749bdda656b2dbc15c18757f2f7339777a15fd67f18c1d0b0b6f31436a5430a84283d6b39f69387d
+  data.tar.gz: 1b13bf85208f2820b7d4bc033a267b1db8dc727c00b64bd2357cc16e1e34398a70c63bb05b8d7559e3bd7b4b6a03307025a7c5d87c59dc71404a460a758b7cd9

data/.github/CODEOWNERS

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

data/README.md

@@ -1,55 +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/v67/overview): Our latest integration for accepting online payments. Current supported version: **v67**
+* [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
-* dispute
-* bin_lookup
 
-## 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",
@@ -58,122 +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
-
-**dispute:**
-- retrieve_applicable_defense_reasons
-- supply_defense_document
-- delete_dispute_defense_document
-- defend_dispute
-
-**bin_lookup:**
-- get_3ds_availability
-- get_cost_estimate
+~~~~
 
-## 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 = 67
+~~~~
+
+### 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/lib/adyen-ruby-api-library.rb

@@ -2,7 +2,6 @@ require_relative "adyen/version"
 require_relative "adyen/client"
 require_relative "adyen/errors"
 require_relative "adyen/services/checkout"
-require_relative "adyen/services/checkout_utility"
 require_relative "adyen/services/payments"
 require_relative "adyen/services/payouts"
 require_relative "adyen/services/recurring"

data/lib/adyen/client.rb

@@ -42,9 +42,6 @@ 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
@@ -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}"
@@ -82,7 +79,7 @@ module Adyen
     # send request to adyen API
     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
@@ -132,13 +129,32 @@ module Adyen
       # 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
@@ -173,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

data/lib/adyen/services/checkout.rb

@@ -2,18 +2,17 @@ require_relative "service"
 
 module Adyen
   class Checkout < Service
-    DEFAULT_VERSION = 50
+    DEFAULT_VERSION = 67
 
     def initialize(client, version = DEFAULT_VERSION)
       service = "Checkout"
       method_names = [
-        :payment_methods,
         :payment_session,
-        :payment_links,
+        :origin_keys,
       ]
+
       with_application_info = [
         :payment_session,
-        :payment_links,
       ]
 
       super(client, version, service, method_names, with_application_info)
@@ -34,6 +33,39 @@ module Adyen
         @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
+    end
   end
 
   class CheckoutDetail < Service
@@ -53,4 +85,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