adyen-ruby-api-library 4.0.1 → 6.0.0

data/lib/adyen/errors.rb

@@ -3,19 +3,61 @@ module Adyen
     attr_reader :code, :response, :request, :msg
 
     def initialize(request = nil, response = nil, msg = nil, code = nil)
+      mask_fields(request)
+
+      # components of formatted error message
       attributes = {
         code: code,
+        msg: msg,
         request: request,
-        response: response,
-        msg: msg
+        response: response
       }.select { |_k, v| v }.map { |k, v| "#{k}:#{v}" }.join(', ')
       message = "#{self.class.name} #{attributes}"
       super(message)
+
+      # internal variables
       @code = code
       @response = response
       @request = request
       @msg = msg
     end
+
+    # mask PCI data in request
+    def mask_fields(request)
+      return if request.nil?
+
+      # sensitive fields
+      fields_to_mask = [
+        :expiryMonth,
+        :expiryYear,
+        :encryptedCardNumber,
+        :encryptedExpiryMonth,
+        :encryptedExpiryYear,
+        :encryptedSecurityCode
+      ]
+
+      # convert to hash if necessary
+      request = request.is_a?(Hash) ? request : JSON.parse(request)
+
+      # iterate through request to find fields to mask
+      request.each do |k, v|
+        if request[k].is_a?(Hash)
+          # recursively traverse multi-level hashes
+          mask_fields(request[k])
+        else
+          if k == :number
+            # show first 6 and last 4 for cards
+            request[k] = "#{v[0,6]}******#{v[12,16]}"
+          elsif k == :cvc
+            # show length of cvc for debugging
+            request[k] = "*" * v.length
+          elsif fields_to_mask.include? k
+            # generic mask for other fields
+            request[k] = "***"
+          end
+        end
+      end
+    end
   end
 
   class AuthenticationError < AdyenError

data/lib/adyen/services/bin_lookup.rb

@@ -0,0 +1,18 @@
+require_relative 'service'
+
+module Adyen
+  class BinLookup < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 50
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'BinLookup'
+      method_names = [
+        :get_3ds_availability,
+        :get_cost_estimate
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/checkout.rb

@@ -1,17 +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_session,
+        :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
@@ -24,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
@@ -33,7 +71,7 @@ module Adyen
 
   class CheckoutDetail < Service
     def initialize(client, version = DEFAULT_VERSION)
-      @service = 'Checkout'
+      @service = "Checkout"
       @client = client
       @version = version
     end
@@ -48,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/{checkout_utility.rb → data_protection.rb}

@@ -1,13 +1,14 @@
 require_relative 'service'
 
 module Adyen
-  class CheckoutUtility < Service
+  class DataProtection < Service
+    attr_accessor :version
     DEFAULT_VERSION = 1
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Checkout'
+      service = 'DataProtectionService'
       method_names = [
-        :origin_keys
+        :request_subject_erasure
       ]
 
       super(client, version, service, method_names)

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

@@ -21,11 +21,15 @@ module Adyen
       def notification
         @notification ||= Adyen::Marketpay::Notification.new(@client)
       end
+
+      def hop
+        @hop ||= Adyen::Marketpay::Hop.new(@client)
+      end
     end
 
     class Account < Service
       attr_accessor :version
-      DEFAULT_VERSION = 4
+      DEFAULT_VERSION = 6
 
       def initialize(client, version = DEFAULT_VERSION)
         service = 'Account'
@@ -40,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)
@@ -53,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'
@@ -63,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)
@@ -72,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'
@@ -88,5 +95,19 @@ module Adyen
         super(client, version, service, method_names)
       end
     end
+
+    class Hop < Service
+      attr_accessor :version
+      DEFAULT_VERSION = 6
+
+      def initialize(client, version = DEFAULT_VERSION)
+        service = 'Hop'
+        method_names = [
+          :get_onboarding_url
+        ]
+
+        super(client, version, service, method_names)
+      end
+    end
   end
 end

data/lib/adyen/services/payments.rb

@@ -1,12 +1,12 @@
-require_relative 'service'
+require_relative "service"
 
 module Adyen
   class Payments < Service
     attr_accessor :version
-    DEFAULT_VERSION = 50
+    DEFAULT_VERSION = 64
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Payment'
+      service = "Payment"
       method_names = [
         :authorise,
         :authorise3d,
@@ -15,10 +15,20 @@ module Adyen
         :cancel,
         :refund,
         :cancel_or_refund,
-        :adjust_authorisation
+        :adjust_authorisation,
+        :donate,
+        :get_authentication_result,
+        :technical_cancel,
+        :void_pending_refund,
+        :retrieve_3ds2_result
+      ]
+      with_application_info = [
+        :authorise,
+        :authorise3d,
+        :authorise3ds2
       ]
 
-      super(client, version, service, method_names)
+      super(client, version, service, method_names, with_application_info)
     end
   end
 end

data/lib/adyen/services/payouts.rb

@@ -3,7 +3,7 @@ require_relative 'service'
 module Adyen
   class Payouts < Service
     attr_accessor :version
-    DEFAULT_VERSION = 30
+    DEFAULT_VERSION = 64
 
     def initialize(client, version = DEFAULT_VERSION)
       service = 'Payout'
@@ -12,7 +12,8 @@ module Adyen
         :store_detail_and_submit_third_party,
         :submit_third_party,
         :confirm_third_party,
-        :decline_third_party
+        :decline_third_party,
+        :payout
       ]
 
       super(client, version, service, method_names)

data/lib/adyen/services/postfmapi.rb

@@ -0,0 +1,19 @@
+require_relative 'service'
+
+module Adyen
+  class PosTerminalManagement < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 1
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'Terminal'
+      method_names = [
+        :assign_terminals,
+        :find_terminal,
+        :get_terminals_under_account
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/recurring.rb

@@ -3,14 +3,15 @@ require_relative 'service'
 module Adyen
   class Recurring < Service
     attr_accessor :version
-    DEFAULT_VERSION = 30
+    DEFAULT_VERSION = 49
 
     def initialize(client, version = DEFAULT_VERSION)
       service = 'Recurring'
       method_names = [
         :list_recurring_details,
         :disable,
-        :store_token
+        :store_token,
+        :schedule_account_updater
       ]
 
       super(client, version, service, method_names)

data/lib/adyen/services/service.rb

@@ -11,7 +11,7 @@ module Adyen
       method_name.to_s.gsub(/_./) { |x| x[1].upcase }
     end
 
-    def initialize(client, version, service, method_names)
+    def initialize(client, version, service, method_names, with_application_info = [])
       @client = client
       @version = version
       @service = service
@@ -20,7 +20,7 @@ module Adyen
       method_names.each do |method_name|
         define_singleton_method method_name do |request, headers = {}|
           action = self.class.action_for_method_name(method_name)
-          @client.call_adyen_api(@service, action, request, headers, @version)
+          @client.call_adyen_api(@service, action, request, headers, @version, with_application_info.include?(method_name))
         end
       end
     end

data/lib/adyen/version.rb

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

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/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/spec/account_spec.rb

@@ -20,7 +20,10 @@ RSpec.describe Adyen::Payments, service: "marketpay account service" do
     ["upload_document", "pspReference", "9914762681460244"],
     ["get_uploaded_documents", "pspReference", "9914694369860322"],
     ["delete_bank_accounts", "pspReference", "9914694372670551"],
-    ["delete_shareholders", "pspReference", "9914694372990637"]
+    ["delete_shareholders", "pspReference", "9914694372990637"],
+    ["delete_signatories", "pspReference", "9914694372990637"],
+    ["delete_payout_methods", "pspReference", "9914694372990637"],
+    ["check_account_holder", "pspReference", "9914694372990637"],
   ]
 
   generate_tests(client, "Account", test_sets, client.marketpay.account)

data/spec/bin_lookup_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe Adyen::BinLookup, service: "BIN lookup service" do
+  # client instance to be used in dynamically generated tests
+  client = create_client(:basic)
+
+  # methods / values to test for
+  # format is defined in spec_helper
+  test_sets = [
+    ["get_3ds_availability", "threeDS2supported", false],
+    ["get_cost_estimate", "resultCode", "Success"]
+  ]
+
+  generate_tests(client, "BinLookup", test_sets, client.bin_lookup)
+end