Merge pull request #137 from Adyen/develop

Release 7.0.0

Author: AlexandrosMor

.gitignore

@@ -15,3 +15,6 @@ design.txt
 .DS_Store
 
 .idea
+main.rb
+build/
+openapi-generator-cli-6.0.1.jar

Makefile

@@ -0,0 +1,72 @@
+generator:=ruby
+openapi-generator-version:=6.4.0
+openapi-generator-url:=https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/$(openapi-generator-version)/openapi-generator-cli-$(openapi-generator-version).jar
+openapi-generator-jar:=build/openapi-generator-cli.jar
+openapi-generator-cli:=java -jar build/openapi-generator-cli.jar
+output:=build/out
+
+services:=balancePlatform checkout legalEntityManagement management payout platformsAccount platformsFund platformsHostedOnboardingPage platformsNotificationConfiguration transfers
+singleFileServices:=balanceControlService binLookup dataProtection recurring storedValue posTerminalManagement payment
+
+binLookup: spec=BinLookupService-v54
+checkout: spec=CheckoutService-v70
+dataProtection: spec=DataProtectionService-v1
+storedValue: spec=StoredValueService-v46
+posTerminalManagement: spec=TfmAPIService-v1
+payment: spec=PaymentService-v68
+recurring: spec=RecurringService-v68
+payout: spec=PayoutService-v68
+management: spec=ManagementService-v1
+legalEntityManagement: spec=LegalEntityService-v3
+balancePlatform: spec=BalancePlatformService-v2
+platformsAccount: spec=AccountService-v6
+platformsFund: spec=FundService-v6
+platformsNotificationConfiguration: spec=NotificationConfigurationService-v6
+platformsHostedOnboardingPage: spec=HopService-v6
+transfers: spec=TransferService-v3
+balanceControlService: spec=BalanceControlService-v1
+
+allServices: $(services) $(singleFileServices)
+
+$(services): build/spec $(openapi-generator-jar)
+	wget $(openapi-generator-url) -O build/openapi-generator-cli.jar
+	rm -rf $(output)
+	$(openapi-generator-cli) generate \
+		-i build/spec/json/$(spec).json \
+		-g $(generator) \
+		-c ./templates/config.yaml \
+		-o $(output) \
+		--global-property apis,apiTests=false,apiDocs=false,supportingFiles=api-single.rb\
+		--additional-properties serviceName=$@\
+		--skip-validate-spec
+	rm -f $(output)/lib/openapi_client/api/*-small.rb
+	mkdir -p lib/adyen/services/$@
+	mv $(output)/lib/openapi_client/api/*.rb lib/adyen/services/$@
+	mv $(output)/api/api-single.rb lib/adyen/services/$@.rb
+	rm -rf $(output)
+
+$(singleFileServices): build/spec
+	wget $(openapi-generator-url) -O build/openapi-generator-cli.jar
+	cat <<< "$$(jq 'del(.paths[][].tags)' build/spec/json/$(spec).json)" > build/spec/json/$(spec).json
+	rm -rf $(output)
+	$(openapi-generator-cli) generate \
+		-i build/spec/json/$(spec).json \
+		-g $(generator) \
+		-c ./templates/config.yaml \
+		-o $(output) \
+		--global-property apis,apiTests=false,apiDocs=false\
+		--additional-properties serviceName=$@\
+		--skip-validate-spec
+	mv $(output)/lib/openapi_client/api/default_api-small.rb lib/adyen/services/$@.rb
+	rm -rf $(output)
+
+templates: $(openapi-generator-jar)
+	$(openapi-generator-cli) author template -g $(generator) -o build/templates
+
+# Download the generator
+$(openapi-generator-jar):
+	wget --quiet -o /dev/null $(openapi-generator-url) -O $(openapi-generator-jar)
+
+build/spec:
+	git clone https://github.com/Adyen/adyen-openapi.git build/spec
+	perl -i -pe's/"openapi" : "3.[0-9].[0-9]"/"openapi" : "3.0.0"/' build/spec/json/*.json

README.md

@@ -1,24 +1,26 @@
+![Ruby](https://user-images.githubusercontent.com/93914435/236416787-3da4dd32-0a7d-43f7-9aa4-8d77697c85f9.png)
 # Adyen API Library for Ruby
 
-
 This is the officially supported Ruby library for using Adyen's APIs.
 
-## Integration
-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**
-
+## Supported APIs
+
+This library supports the following:
+
+| API name | API version | Description | API object |
+|----------|:-----------:|-------------|------------|
+| [BIN lookup API](https://docs.adyen.com/api-explorer/#/BinLookup/v52/overview) | v54 | The BIN Lookup API provides endpoints for retrieving information based on a given BIN. | [BinLookup](lib/adyen/services/binLookup.rb) |
+| [Checkout API](https://docs.adyen.com/api-explorer/#/CheckoutService/v69/overview) | v70 | Our latest integration for accepting online payments. | [CheckoutAPI](lib/adyen/services/checkout.rb) |
+| [Configuration API](https://docs.adyen.com/api-explorer/#/balanceplatform/v2/overview) | v2 | The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. | [BalancePlatform](lib/adyen/services/balancePlatform.rb) |
+| [DataProtection API](https://docs.adyen.com/development-resources/data-protection-api) | v1 | Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email) | [DataProtection](lib/adyen/services/dataProtection.rb) |
+| [Legal Entity Management API](https://docs.adyen.com/api-explorer/#/legalentity/v3/overview) | v3 | Manage legal entities that contain information required for verification. | [LegalEntityManagement](lib/adyen/services/legalEntityManagement.rb) |
+| [Management API](https://docs.adyen.com/api-explorer/#/ManagementService/v1/overview) | v1 | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. | [Management](lib/adyen/services/management.rb) |
+| [Payments API](https://docs.adyen.com/api-explorer/#/Payment/v68/overview) | v68 | Our classic integration for online payments. | [Classic Integration API](lib/adyen/services/payment.rb) |
+| [Payouts API](https://docs.adyen.com/api-explorer/#/Payout/v68/overview) | v68 | Endpoints for sending funds to your customers. | [Payout](lib/adyen/services/payout.rb) |
+| [POS Terminal Management API](https://docs.adyen.com/api-explorer/#/postfmapi/v1/overview) | v1 | Endpoints for managing your point-of-sale payment terminals. | [TerminalManagement](lib/adyen/services/posTerminalManagement.rb) |
+| [Recurring API](https://docs.adyen.com/api-explorer/#/Recurring/v68/overview) | v68 | Endpoints for managing saved payment details. | [Recurring](lib/adyen/services/recurring.rb) |
+| [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api) | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | [StoredValue](lib/adyen/services/storedValue.rb) |
+| [Transfers API](https://docs.adyen.com/api-explorer/transfers/3/overview) | v3 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](lib/adyen/services/transfers.rb) |
 
 For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 
@@ -64,7 +66,7 @@ adyen.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
 
 - Make a Payment
 ~~~~ruby
-response = adyen.checkout.payments({
+response = adyen.checkout.payments_api.payments({
   :amount => {
     :currency => "EUR",
     :value => 1000

lib/adyen-ruby-api-library.rb

@@ -2,14 +2,20 @@
 require_relative "adyen/client"
 require_relative "adyen/errors"
 require_relative "adyen/services/checkout"
-require_relative "adyen/services/payments"
-require_relative "adyen/services/payouts"
+require_relative "adyen/services/payment"
+require_relative "adyen/services/payout"
 require_relative "adyen/services/recurring"
 require_relative "adyen/services/marketpay"
-require_relative "adyen/services/postfmapi"
+require_relative "adyen/services/posTerminalManagement"
 require_relative "adyen/services/service"
-require_relative "adyen/services/data_protection"
+require_relative "adyen/services/dataProtection"
 require_relative "adyen/services/dispute"
-require_relative "adyen/services/bin_lookup"
+require_relative "adyen/services/binLookup"
 require_relative "adyen/hash_with_accessors"
 require_relative "adyen/utils/hmac_validator"
+require_relative "adyen/services/legalEntityManagement"
+require_relative "adyen/services/balancePlatform"
+require_relative "adyen/services/transfers"
+require_relative "adyen/services/management"
+require_relative "adyen/services/storedValue"
+require_relative "adyen/services/balanceControlService"

lib/adyen/client.rb

@@ -35,30 +35,43 @@ def live_url_prefix=(value)
 
     # base URL for API given service and @env
     def service_url_base(service)
-      raise ArgumentError, "Please set Client.live_url_prefix to the portion of your merchant-specific URL prior to '-[service]-live.adyenpayments.com'" if @live_url_prefix.nil? and @env == :live
       if @env == :mock
         @mock_service_url_base
       else
         case service
         when "Checkout"
-          url = "https://checkout-#{@env}.adyen.com/checkout"
+          url = "https://checkout-#{@env}.adyen.com"
           supports_live_url_prefix = true
         when "Account", "Fund", "Notification", "Hop"
-          url = "https://cal-#{@env}.adyen.com/cal/services"
+          url = "https://cal-#{@env}.adyen.com/cal/services/#{service}"
           supports_live_url_prefix = false
-        when "Recurring", "Payment", "Payout", "BinLookup"
-          url = "https://pal-#{@env}.adyen.com/pal/servlet"
+        when "Recurring", "Payment", "Payout", "BinLookup", "StoredValue", "BalanceControlService"
+          url = "https://pal-#{@env}.adyen.com/pal/servlet/#{service}"
           supports_live_url_prefix = true
-        when "Terminal"
+        when "PosTerminalManagement"
           url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
           supports_live_url_prefix = false
         when "DataProtectionService", "DisputeService"
-          url = "https://ca-#{@env}.adyen.com/ca/services"
+          url = "https://ca-#{@env}.adyen.com/ca/services/#{service}"
+          supports_live_url_prefix = false
+        when "LegalEntityManagement"
+          url = "https://kyc-#{@env}.adyen.com/lem"
+          supports_live_url_prefix = false
+        when "BalancePlatform" 
+          url = "https://balanceplatform-api-#{@env}.adyen.com/bcl"
+          supports_live_url_prefix = false
+        when "Transfers"
+          url = "https://balanceplatform-api-#{@env}.adyen.com/btl"
+          supports_live_url_prefix = false
+        when "Management"
+          url = "https://management-#{@env}.adyen.com"
           supports_live_url_prefix = false
         else
           raise ArgumentError, "Invalid service specified"
         end
-
+        
+        raise ArgumentError, "Please set Client.live_url_prefix to the portion of your merchant-specific URL prior to '-[service]-live.adyenpayments.com'" \
+         if @live_url_prefix.nil? and @env == :live and supports_live_url_prefix
         if @env == :live && supports_live_url_prefix
           url.insert(8, "#{@live_url_prefix}-")
           url["adyen.com"] = "adyenpayments.com"
@@ -70,11 +83,7 @@ def service_url_base(service)
 
     # construct full URL from service and endpoint
     def service_url(service, action, version)
-      if service == "Checkout" || service == "Terminal"
-        "#{service_url_base(service)}/v#{version}/#{action}"
-      else
-        "#{service_url_base(service)}/#{service}/v#{version}/#{action}"
-      end
+      "#{service_url_base(service)}/v#{version}/#{action}"
     end
 
     # send request to adyen API
@@ -121,17 +130,17 @@ def call_adyen_api(service, action, request_data, headers, version, with_applica
         headers.map do |key, value|
           faraday.headers[key] = value
         end
+
+        # add library headers
+        faraday.headers["adyen-library-name"] = Adyen::NAME
+        faraday.headers["adyen-library-version"] = Adyen::VERSION
       end
       # if json string convert to hash
       # needed to add applicationInfo
       if request_data.is_a?(String)
         request_data = JSON.parse(request_data)
       end
 
-      # add application only on checkout service
-      if with_application_info
-        add_application_info(request_data)
-      end
 
       # convert to json
       request_data = request_data.to_json
@@ -160,7 +169,7 @@ def call_adyen_api(service, action, request_data, headers, version, with_applica
             raise connection_error, "Connection to #{url} failed"
           end
         end
-      else
+       if action.fetch(:method) == 'post'
         # post request to Adyen
         begin
           response = conn.post do |req|
@@ -169,8 +178,16 @@ def call_adyen_api(service, action, request_data, headers, version, with_applica
         rescue Faraday::ConnectionFailed => connection_error
           raise connection_error, "Connection to #{url} failed"
         end
+       end 
+      else
+        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
       case response.status
       when 401
@@ -189,31 +206,18 @@ def call_adyen_api(service, action, request_data, headers, version, with_applica
       formatted_response
     end
 
-    # add application_info for analytics
-    def add_application_info(request_data)
-      adyenLibrary = {
-        :name => Adyen::NAME,
-        :version => Adyen::VERSION.to_s,
-      }
-
-      if request_data[:applicationInfo].nil?
-        request_data[:applicationInfo] = {}
-      end
-
-      request_data[:applicationInfo][:adyenLibrary] = adyenLibrary
-    end
 
     # services
     def checkout
       @checkout ||= Adyen::Checkout.new(self)
     end
 
-    def payments
-      @payments ||= Adyen::Payments.new(self)
+    def payment
+      @payment ||= Adyen::Payment.new(self)
     end
 
-    def payouts
-      @payouts ||= Adyen::Payouts.new(self)
+    def payout
+      @payout ||= Adyen::Payout.new(self)
     end
 
     def recurring
@@ -224,8 +228,8 @@ def marketpay
       @marketpay ||= Adyen::Marketpay::Marketpay.new(self)
     end
 
-    def postfmapi
-      @postfmapi ||= Adyen::PosTerminalManagement.new(self)
+    def pos_terminal_management
+      @pos_terminal_management ||= Adyen::PosTerminalManagement.new(self)
     end
 
     def data_protection
@@ -239,5 +243,29 @@ def dispute
     def bin_lookup
       @bin_lookup ||= Adyen::BinLookup.new(self)
     end
+
+    def legal_entity_management
+      @legal_entity_management ||= Adyen::LegalEntityManagement.new(self)
+    end
+
+    def balance_platform
+      @balance_platform ||= Adyen::BalancePlatform.new(self)
+    end
+
+    def transfers
+      @transfers ||= Adyen::Transfers.new(self)
+    end
+
+    def management
+      @management ||= Adyen::Management.new(self)
+    end
+    
+    def stored_value
+      @stored_value ||=Adyen::StoredValue.new(self)
+    end
+
+    def balance_control_service
+      @balance_control_service ||=Adyen::BalanceControlService.new(self)
+    end
   end
 end

lib/adyen/services/balanceControlService.rb

@@ -0,0 +1,28 @@
+require_relative './service'
+module Adyen
+
+
+  class BalanceControlService < Service
+    attr_accessor :service, :version
+    DEFAULT_VERSION = 1
+
+    def initialize(client, version = DEFAULT_VERSION)
+      @service = "BalanceControlService"
+      @client = client
+      @version = version
+    end
+
+    def balance_transfer(request, headers: {} )
+      """
+      Start a balance transfer
+      """
+      endpoint = "/balanceTransfer".gsub(/{.+?}/, '%s') 
+      endpoint = endpoint.gsub(/^\//, "")
+      endpoint = endpoint % []
+      
+      action = { method: "post", url: endpoint}
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end