adyen-ruby-api-library 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e1e891caf5313d525a5cc00bfa709e032684bb84383944357c9ed709b7c517d
-  data.tar.gz: 6fe18663705bb0ca470d6d9ed0e506a59c5521ccbd7ec9637c653e4b39ea5223
+  metadata.gz: 02ec361baadfa4a0b114ff3f4b162f737775e22ed23b40d79e76fb0dfda3d7e2
+  data.tar.gz: cbffe8658ad929e8e7a7eb210013a43dbf2c58094b46e3c753c4e07ba41f4b43
 SHA512:
-  metadata.gz: 001454cc1d12e9c6920744a9f8ae34b08f8d9dedddd99795a11372b8b2a6015047957c5f7e81eb8eed970df956fb75cdd46f3c7ca40ed26b8cb5246af0ba5ee4
-  data.tar.gz: 051c5988b2fd0eb10c0879465c2b67a59f1ada3b0324a02e65b91c9d56e1ff1ff28354cf748e03066a18e50bb2dbc371877c97f871f838910043792973fca3da
+  metadata.gz: aa6e2f3474c3d4178fd25076994ccb76b034c8976f47f6da749bdda656b2dbc15c18757f2f7339777a15fd67f18c1d0b0b6f31436a5430a84283d6b39f69387d
+  data.tar.gz: 1b13bf85208f2820b7d4bc033a267b1db8dc727c00b64bd2357cc16e1e34398a70c63bb05b8d7559e3bd7b4b6a03307025a7c5d87c59dc71404a460a758b7cd9

data/.github/CODEOWNERS

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

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**How to reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - ruby Version: [x.y.z]
+ - Library Version: [x.y.z]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**ruby version**: x.y.z
+**Library version**: x.y.z
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+**Description**
+<!-- Please provide a description of the changes proposed in the Pull Request -->
+
+**Tested scenarios**
+<!-- Description of tested scenarios -->
+
+**Fixed issue**:  <!-- #-prefixed issue number -->

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

data/.gitignore

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

data/README.md

@@ -1,51 +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
 
-## 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",
@@ -54,101 +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
-
-**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
+~~~~
 
-## Support
+- Change API Version
+~~~~ruby
+adyen.checkout.version = 67
+~~~~
 
-If you have any problems, questions or suggestions, create an issue here or send your inquiry to support@adyen.com.
+### 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,22 +2,14 @@ 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"
 require_relative "adyen/services/marketpay"
+require_relative "adyen/services/postfmapi"
 require_relative "adyen/services/service"
+require_relative "adyen/services/data_protection"
+require_relative "adyen/services/dispute"
+require_relative "adyen/services/bin_lookup"
 require_relative "adyen/hash_with_accessors"
 require_relative "adyen/utils/hmac_validator"
-
-# add snake case to camel case converter to String
-# to convert rubinic method names to Adyen API methods
-#
-# i.e. snake_case -> snakeCase
-# note that the first letter is not capitalized as normal
-class String
-  def to_camel_case
-    split("_").collect.with_index{ |x, i| i > 0 ? x.capitalize : x }.join
-  end
-end

data/lib/adyen/client.rb

@@ -42,15 +42,18 @@ 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"
+        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", "DisputeService"
+          url = "https://ca-#{@env}.adyen.com/ca/services"
+          supports_live_url_prefix = false
         else
           raise ArgumentError, "Invalid service specified"
         end
@@ -66,7 +69,7 @@ module Adyen
 
     # construct full URL from service and endpoint
     def service_url(service, action, version)
-      if service == "Checkout" || service == "CheckoutUtility"
+      if service == "Checkout" || service == "Terminal"
         "#{service_url_base(service)}/v#{version}/#{action}"
       else
         "#{service_url_base(service)}/#{service}/v#{version}/#{action}"
@@ -74,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
@@ -119,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
@@ -151,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
@@ -168,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
@@ -187,5 +204,21 @@ module Adyen
     def marketpay
       @marketpay ||= Adyen::Marketpay::Marketpay.new(self)
     end
+
+    def postfmapi
+      @postfmapi ||= Adyen::PosTerminalManagement.new(self)
+    end
+
+    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