adyen-ruby-api-library 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d77315c126cb7ae2f8600f5bc8e853fd868a6bc6c30c36add08cfbe93285488
-  data.tar.gz: bf4c1f6498020da769aecba45b4fe6ce43f017ca71e083723b2bfa8903d3932e
+  metadata.gz: e483ea1b71301634db57072423fd8cea1483b160eec7c1ba85fcf62ccbac0414
+  data.tar.gz: fa6dd93d1fe95ccf9ce3e9cc4a9956e523e6f25a20ae49fb2529e560c1aec14a
 SHA512:
-  metadata.gz: dd3c31163dae11854ef0d921ff772ddd3d5b526c2bef106a26edd150e2f517fd306cde43e7839313e134dd72f86eb6f0c37a2a19cb52efc169892e8849b9ceb0
-  data.tar.gz: c51e518693653f525a5dc06ee71d859614f5a741b4109ded91a29e9327c768c9b7c0c5f1783fdceeb740b1e6f95074bfc7f0336b7228eb1a3e66a34bd3730bd1
+  metadata.gz: 50f51f247bb68817b56ef596ad2b435280fedb1dc06806665a5e48b4c1cfb67fda4c1060f882929c0c40c8b225635cc19d36d6f90be4ae1e0e7149dc8f8638bd
+  data.tar.gz: 15273291ffb0122fab7050dc1263028c6a38d6634519c744057d1b3756b62461c028de7982d5c36adfb04e50f25a7d121541d1ef496a91c3c63bd67ee75c7829

data/.gitignore

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

data/README.md

@@ -15,6 +15,8 @@ The Library supports all APIs under the following services:
 * marketpay
 * postfmapi
 * data_protection
+* dispute
+* bin_lookup
 
 ## Requirements
 
@@ -151,6 +153,16 @@ adyen.checkout.version = 50
 **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).
 

data/lib/adyen-ruby-api-library.rb

@@ -10,5 +10,7 @@ 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"

data/lib/adyen/client.rb

@@ -48,13 +48,13 @@ module Adyen
         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
@@ -80,7 +80,7 @@ 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)
 
@@ -125,7 +125,7 @@ module Adyen
       end
 
       # add application only on checkout service
-      if service == 'Checkout' || service == 'CheckoutUtility'
+      if with_application_info
         add_application_info(request_data)
       end
 
@@ -157,16 +157,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
@@ -201,5 +200,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/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,18 +1,22 @@
-require_relative 'service'
+require_relative "service"
 
 module Adyen
   class Checkout < Service
     DEFAULT_VERSION = 50
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Checkout'
+      service = "Checkout"
       method_names = [
         :payment_methods,
         :payment_session,
-        :payment_links
+        :payment_links,
+      ]
+      with_application_info = [
+        :payment_session,
+        :payment_links,
       ]
 
-      super(client, version, service, method_names)
+      super(client, version, service, method_names, with_application_info)
     end
 
     # This method can't be dynamically defined because
@@ -25,16 +29,16 @@ 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)
+        @client.call_adyen_api(@service, action, args[0], args[1], @version, true)
       end
     end
   end
 
   class CheckoutDetail < Service
     def initialize(client, version = DEFAULT_VERSION)
-      @service = 'Checkout'
+      @service = "Checkout"
       @client = client
       @version = version
     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/payments.rb

@@ -1,4 +1,4 @@
-require_relative 'service'
+require_relative "service"
 
 module Adyen
   class Payments < Service
@@ -6,7 +6,7 @@ module Adyen
     DEFAULT_VERSION = 50
 
     def initialize(client, version = DEFAULT_VERSION)
-      service = 'Payment'
+      service = "Payment"
       method_names = [
         :authorise,
         :authorise3d,
@@ -16,10 +16,15 @@ module Adyen
         :refund,
         :cancel_or_refund,
         :adjust_authorisation,
-        :donate
+        :donate,
+      ]
+      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/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.3.0".freeze
+  VERSION = "4.4.0".freeze
 end

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

data/spec/dispute_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Dispute, service: "dispute 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 = [
+    ["retrieve_applicable_defense_reasons", "disputeServiceResult", { "success" => true }],
+    ["supply_defense_document", "disputeServiceResult", { "success" => true }],
+    ["delete_dispute_defense_document", "disputeServiceResult", { "success" => true }],
+    ["defend_dispute", "disputeServiceResult", { "success" => true }],
+  ]
+
+  generate_tests(client, "DisputeService", test_sets, client.dispute)
+end

data/spec/mocks/requests/BinLookup/get_3ds_availability.json

@@ -0,0 +1,4 @@
+{
+  "merchantAccount": "TestMerchant",
+  "cardNumber": "4111111111111111"
+}

data/spec/mocks/requests/BinLookup/get_cost_estimate.json

@@ -0,0 +1,8 @@
+{
+  "amount": {
+    "currency": "EUR",
+    "value": 1000
+  },
+  "cardNumber": "5101180000000007",
+  "merchantAccount": "TestMerchant"
+}

data/spec/mocks/requests/DisputeService/defend_dispute.json

@@ -0,0 +1,5 @@
+{
+  "disputePspReference": "9913486733050065",
+  "defenseReasonCode": "SupplyDefenseMaterial",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT"
+}

data/spec/mocks/requests/DisputeService/delete_dispute_defense_document.json

@@ -0,0 +1,5 @@
+{
+  "disputePspReference": "9913486733050065",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT",
+  "defenseDocumentType": "MerchandiseDescription"
+}

data/spec/mocks/requests/DisputeService/retrieve_applicable_defense_reasons.json

@@ -0,0 +1,4 @@
+{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "disputePspReference": "9913486733050065"
+}

data/spec/mocks/requests/DisputeService/supply_defense_document.json

@@ -0,0 +1,11 @@
+{
+  "defenseDocuments": [
+    {
+      "content": "JVBERi0xLjMKJcTl8uXrp...",
+      "contentType": "application/pdf",
+      "defenseDocumentTypeCode": "MerchandiseDescription"
+    }
+  ],
+  "disputePspReference": "9913486733050065",
+  "merchantAccountCode": "YOUR_MERCHANT_ACCOUNT"
+}

data/spec/mocks/responses/BinLookup/get_3ds_availability.json

@@ -0,0 +1,8 @@
+{
+  "binDetails": {
+    "issuerCountry": "NL"
+  },
+  "threeDS1Supported": true,
+  "threeDS2CardRangeDetails": [],
+  "threeDS2supported": false
+}

data/spec/mocks/responses/BinLookup/get_cost_estimate.json

@@ -0,0 +1,8 @@
+{
+  "costEstimateAmount": {
+    "currency": "EUR",
+    "value": 1000
+  },
+  "resultCode": "Success",
+  "surchargeType": "PASSTHROUGH"
+}

data/spec/mocks/responses/DisputeService/defend_dispute.json

@@ -0,0 +1,5 @@
+{
+  "disputeServiceResult": {
+    "success": true
+  }
+}

data/spec/mocks/responses/DisputeService/delete_dispute_defense_document.json

@@ -0,0 +1,5 @@
+{
+  "disputeServiceResult": {
+    "success": true
+  }
+}

data/spec/mocks/responses/DisputeService/retrieve_applicable_defense_reasons.json

@@ -0,0 +1,28 @@
+{
+  "defenseReasons": [
+    {
+      "defenseDocumentTypes": [
+        {
+          "available": false,
+          "defenseDocumentTypeCode": "TIDorInvoice",
+          "requirementLevel": "Optional"
+        },
+        {
+          "available": false,
+          "defenseDocumentTypeCode": "DefenseMaterial",
+          "requirementLevel": "Required"
+        },
+        {
+          "available": false,
+          "defenseDocumentTypeCode": "AlternativeDefenseMaterial",
+          "requirementLevel": "AlternativeRequired"
+        }
+      ],
+      "defenseReasonCode": "SupplyDefenseMaterial",
+      "satisfied": false
+    }
+  ],
+  "disputeServiceResult": {
+    "success": true
+  }
+}

data/spec/mocks/responses/DisputeService/supply_defense_document.json

@@ -0,0 +1,5 @@
+{
+  "disputeServiceResult": {
+    "success": true
+  }
+}

data/spec/spec_helper.rb

@@ -18,20 +18,27 @@ def create_test(client, service, method_name, parent_object)
   request_body = JSON.parse(json_from_file("mocks/requests/#{service}/#{method_name}.json"))
   response_body = json_from_file("mocks/responses/#{service}/#{method_name}.json")
 
-
-  if service == 'Checkout' || service == 'CheckoutUtility'
+  with_application_info = [
+    "authorise",
+    "authorise3d",
+    "authorise3ds2",
+    "payments",
+    "payment_session",
+    "payment_links",
+  ]
+  if with_application_info.include?(method_name)
     client.add_application_info(request_body)
   end
 
   # client-generated headers
   headers = {
-    'Content-Type'.to_sym => 'application/json'
+    "Content-Type".to_sym => "application/json",
   }
 
   # authentication headers
-  if not client.api_key.nil? then
+  if not client.api_key.nil?
     headers["x-api-key"] = client.api_key
-  elsif not client.ws_user.nil? and not client.ws_password.nil? then
+  elsif not client.ws_user.nil? and not client.ws_password.nil?
     auth_header = "Basic " + Base64::encode64("#{client.ws_user}:#{client.ws_password}")
     headers["Authorization"] = auth_header.strip
   else
@@ -43,12 +50,12 @@ def create_test(client, service, method_name, parent_object)
   url = client.service_url(service, action, parent_object.version)
   WebMock.stub_request(:post, url).
     with(
-      body: request_body,
-      headers: headers
-    ).
+    body: request_body,
+    headers: headers,
+  ).
     to_return(
-      body: response_body
-    )
+    body: response_body,
+  )
   result = parent_object.public_send(method_name, request_body)
 
   # result.response is already a Ruby object (Adyen::HashWithAccessors) (rather than an unparsed JSON string)
@@ -86,10 +93,10 @@ def create_client(auth_type)
   client = Adyen::Client.new
   client.env = :mock
 
-  if auth_type == :basic then
+  if auth_type == :basic
     client.ws_user = "user"
     client.ws_password = "password"
-  elsif auth_type == :api_key then
+  elsif auth_type == :api_key
     client.api_key = "api_key"
   else
     raise ArgumentError "Invalid auth type for test client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Adyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -111,9 +111,11 @@ files:
 - lib/adyen/errors.rb
 - lib/adyen/hash_with_accessors.rb
 - lib/adyen/result.rb
+- lib/adyen/services/bin_lookup.rb
 - lib/adyen/services/checkout.rb
 - lib/adyen/services/checkout_utility.rb
 - lib/adyen/services/data_protection.rb
+- lib/adyen/services/dispute.rb
 - lib/adyen/services/marketpay.rb
 - lib/adyen/services/payments.rb
 - lib/adyen/services/payouts.rb
@@ -124,10 +126,12 @@ files:
 - lib/adyen/version.rb
 - renovate.json
 - spec/account_spec.rb
+- spec/bin_lookup_spec.rb
 - spec/checkout_spec.rb
 - spec/checkout_utility_spec.rb
 - spec/client_spec.rb
 - spec/data_protection_spec.rb
+- spec/dispute_spec.rb
 - spec/errors_spec.rb
 - spec/fund_spec.rb
 - spec/hash_with_accessors_spec.rb
@@ -146,6 +150,8 @@ files:
 - spec/mocks/requests/Account/update_account_holder.json
 - spec/mocks/requests/Account/update_account_holder_state.json
 - spec/mocks/requests/Account/upload_document.json
+- spec/mocks/requests/BinLookup/get_3ds_availability.json
+- spec/mocks/requests/BinLookup/get_cost_estimate.json
 - spec/mocks/requests/Checkout/payment-details.json
 - spec/mocks/requests/Checkout/payment-result.json
 - spec/mocks/requests/Checkout/payment_links.json
@@ -155,6 +161,10 @@ files:
 - spec/mocks/requests/Checkout/verify.json
 - spec/mocks/requests/CheckoutUtility/origin_keys.json
 - spec/mocks/requests/DataProtectionService/request_subject_erasure.json
+- spec/mocks/requests/DisputeService/defend_dispute.json
+- spec/mocks/requests/DisputeService/delete_dispute_defense_document.json
+- spec/mocks/requests/DisputeService/retrieve_applicable_defense_reasons.json
+- spec/mocks/requests/DisputeService/supply_defense_document.json
 - spec/mocks/requests/Fund/account_holder_balance.json
 - spec/mocks/requests/Fund/account_holder_transaction_list.json
 - spec/mocks/requests/Fund/payout_account_holder.json
@@ -202,6 +212,8 @@ files:
 - spec/mocks/responses/Account/update_account_holder.json
 - spec/mocks/responses/Account/update_account_holder_state.json
 - spec/mocks/responses/Account/upload_document.json
+- spec/mocks/responses/BinLookup/get_3ds_availability.json
+- spec/mocks/responses/BinLookup/get_cost_estimate.json
 - spec/mocks/responses/Checkout/payment-details.json
 - spec/mocks/responses/Checkout/payment-result.json
 - spec/mocks/responses/Checkout/payment_links.json
@@ -211,6 +223,10 @@ files:
 - spec/mocks/responses/Checkout/verify.json
 - spec/mocks/responses/CheckoutUtility/origin_keys.json
 - spec/mocks/responses/DataProtectionService/request_subject_erasure.json
+- spec/mocks/responses/DisputeService/defend_dispute.json
+- spec/mocks/responses/DisputeService/delete_dispute_defense_document.json
+- spec/mocks/responses/DisputeService/retrieve_applicable_defense_reasons.json
+- spec/mocks/responses/DisputeService/supply_defense_document.json
 - spec/mocks/responses/Fund/account_holder_balance.json
 - spec/mocks/responses/Fund/account_holder_transaction_list.json
 - spec/mocks/responses/Fund/payout_account_holder.json