adyen-ruby-api-library 4.0.0 → 4.3.0

data/lib/adyen/services/checkout.rb

@@ -8,7 +8,8 @@ module Adyen
       service = 'Checkout'
       method_names = [
         :payment_methods,
-        :payment_session
+        :payment_session,
+        :payment_links
       ]
 
       super(client, version, service, method_names)

data/lib/adyen/services/data_protection.rb

@@ -0,0 +1,17 @@
+require_relative 'service'
+
+module Adyen
+  class DataProtection < Service
+    attr_accessor :version
+    DEFAULT_VERSION = 1
+
+    def initialize(client, version = DEFAULT_VERSION)
+      service = 'DataProtectionService'
+      method_names = [
+        :request_subject_erasure
+      ]
+
+      super(client, version, service, method_names)
+    end
+  end
+end

data/lib/adyen/services/marketpay.rb

@@ -21,6 +21,10 @@ module Adyen
       def notification
         @notification ||= Adyen::Marketpay::Notification.new(@client)
       end
+
+      def hop
+        @hop ||= Adyen::Marketpay::Hop.new(@client)
+      end
     end
 
     class Account < Service
@@ -88,5 +92,19 @@ module Adyen
         super(client, version, service, method_names)
       end
     end
+
+    class Hop < Service
+      attr_accessor :version
+      DEFAULT_VERSION = 1
+
+      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

@@ -15,7 +15,8 @@ module Adyen
         :cancel,
         :refund,
         :cancel_or_refund,
-        :adjust_authorisation
+        :adjust_authorisation,
+        :donate
       ]
 
       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/service.rb

@@ -2,6 +2,15 @@ module Adyen
   class Service
     attr_accessor :service, :version
 
+    # 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
+    def self.action_for_method_name(method_name)
+      method_name.to_s.gsub(/_./) { |x| x[1].upcase }
+    end
+
     def initialize(client, version, service, method_names)
       @client = client
       @version = version
@@ -10,7 +19,7 @@ module Adyen
       # dynamically create API methods
       method_names.each do |method_name|
         define_singleton_method method_name do |request, headers = {}|
-          action = method_name.to_s.to_camel_case
+          action = self.class.action_for_method_name(method_name)
           @client.call_adyen_api(@service, action, request, headers, @version)
         end
       end

data/lib/adyen/utils/hmac_validator.rb

@@ -0,0 +1,48 @@
+module Adyen
+  module Utils
+    class HmacValidator
+      HMAC_ALGORITHM = 'sha256'.freeze
+      DATA_SEPARATOR = ':'.freeze
+      NOTIFICATION_VALIDATION_KEYS = %w[
+        pspReference originalReference merchantAccountCode merchantReference
+        amount.value amount.currency eventCode success
+      ].freeze
+
+      def valid_notification_hmac?(notification_request_item, hmac_key)
+        expected_sign = calculate_notification_hmac(notification_request_item, hmac_key)
+        merchant_sign = fetch(notification_request_item, 'additionalData.hmacSignature')
+
+        expected_sign == merchant_sign
+      end
+
+      def calculate_notification_hmac(notification_request_item, hmac_key)
+        data = data_to_sign(notification_request_item)
+
+        Base64.strict_encode64(OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data))
+      end
+
+      def data_to_sign(notification_request_item)
+        NOTIFICATION_VALIDATION_KEYS.map { |key| fetch(notification_request_item, key).to_s }
+                                    .map { |value| value.gsub('\\', '\\\\').gsub(':', '\\:') }
+                                    .join(DATA_SEPARATOR)
+      end
+
+      private
+
+      def fetch(hash, keys)
+        value = hash
+
+        keys.to_s.split('.').each do |key|
+          value = if key.to_i.to_s == key
+                    value[key.to_i]
+                  else
+                    value[key].nil? ? value[key.to_sym] : value[key]
+                  end
+          break if value.nil?
+        end
+
+        value
+      end
+    end
+  end
+end

data/lib/adyen/version.rb

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

data/renovate.json

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

data/spec/checkout_spec.rb

@@ -57,10 +57,14 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
       to eq(200)
     expect(response_hash).
       to eq(JSON.parse(response_body))
-    expect(response_hash.class).
-      to be Hash
+    expect(response_hash).
+      to be_a Adyen::HashWithAccessors
+    expect(response_hash).
+      to be_a_kind_of Hash
     expect(response_hash["resultCode"]).
       to eq("RedirectShopper")
+    expect(response_hash.resultCode).
+      to eq("RedirectShopper")
   end
 
   # must be created manually due to payments/result format
@@ -89,10 +93,14 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
       to eq(200)
     expect(response_hash).
       to eq(JSON.parse(response_body))
-    expect(response_hash.class).
-      to be Hash
+    expect(response_hash).
+      to be_a Adyen::HashWithAccessors
+    expect(response_hash).
+      to be_a_kind_of Hash
     expect(response_hash["resultCode"]).
       to eq("Authorised")
+    expect(response_hash.resultCode).
+      to eq("Authorised")
   end
 
   # create client for automated tests
@@ -102,6 +110,7 @@ RSpec.describe Adyen::Checkout, service: "checkout" do
   # format is defined in spec_helper
   test_sets = [
     ["payment_session", "publicKeyToken", "8115054323780109"],
+    ["payment_links", "url", "https://checkoutshopper-test.adyen.com"],
     ["payments", "resultCode", "Authorised"]
   ]
 

data/spec/checkout_utility_spec.rb

@@ -19,8 +19,10 @@ RSpec.describe Adyen::CheckoutUtility, service: "checkout utility" do
   # must be created manually because every field in the response is an array
   it "makes an origin_keys call" do
     parsed_body = create_test(@shared_values[:client], @shared_values[:service], "origin_keys", @shared_values[:client].checkout_utility)
-    expect(parsed_body["originKeys"].class).
-      to be Hash
+    expect(parsed_body["originKeys"]).
+      to be_a Adyen::HashWithAccessors
+    expect(parsed_body["originKeys"]).
+      to be_a_kind_of Hash
   end
 end
 

data/spec/data_protection_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Adyen::DataProtection, service: "Data Protection 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 = [
+    ["request_subject_erasure", "result", "SUCCESS"],
+  ]
+
+  generate_tests(client, "DataProtectionService", test_sets, client.data_protection)
+end

data/spec/errors_spec.rb

@@ -3,15 +3,45 @@
 require 'spec_helper'
 
 RSpec.describe Adyen::AdyenError do
+  before(:all) do
+    @shared_values = {
+      request: {
+        amount: {
+          currency: "USD",
+          value: 1000
+        },
+        reference: "Your order number",
+        paymentMethod: {
+          type: "scheme",
+          number: "4111111111111111",
+          expiryMonth: "10",
+          expiryYear: "2020",
+          holderName: "John Smith",
+          cvc: "737"
+        },
+        returnUrl: "https://your-company.com/",
+        merchantAccount: "YOUR_MERCHANT_ACCOUNT"
+      }
+    }
+  end
+
   describe '#to_s' do
     it 'describes using the error properties' do
-      expect(Adyen::AdyenError.new('request', 'response', 'message', 'code').to_s).to eq('Adyen::AdyenError code:code, request:request, response:response, msg:message')
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').to_s).to eq("Adyen::AdyenError code:code, msg:message, request:#{@shared_values[:request]}, response:response")
     end
     it 'skips the null properties' do
-      expect(Adyen::AdyenError.new('request', nil, nil, 'code').to_s).to eq('Adyen::AdyenError code:code, request:request')
+      expect(Adyen::AdyenError.new(@shared_values[:request], nil, nil, 'code').to_s).to eq("Adyen::AdyenError code:code, request:#{@shared_values[:request]}")
     end
     it 'uses the proper error class name' do
-      expect(Adyen::PermissionError.new('a message', 'a request').to_s).to eq('Adyen::PermissionError code:403, request:a request, msg:a message')
+      expect(Adyen::PermissionError.new('message', @shared_values[:request]).to_s).to eq("Adyen::PermissionError code:403, msg:message, request:#{@shared_values[:request]}")
+    end
+  end
+  describe '#masking' do
+    it 'masks card number when logging request in errors' do
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').request[:paymentMethod][:number]).to eq('411111******1111')
+    end
+    it 'masks CVC when logging request in errors' do
+      expect(Adyen::AdyenError.new(@shared_values[:request], 'response', 'message', 'code').request[:paymentMethod][:cvc]).to eq('***')
     end
   end
 end

data/spec/hash_with_accessors_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+RSpec.describe Adyen::HashWithAccessors do
+  shared_examples :hash_with_accessors do
+    subject do
+      h = described_class.new
+      h[key] = 1
+      h
+    end
+
+    it 'returns values of a hashes' do
+      expect(subject.arbitrary_accessor).to be 1
+    end
+
+    it 'can assign existing values' do
+      subject.arbitrary_accessor = 2
+      expect(subject.arbitrary_accessor).to be 2
+      expect(subject[key]).to be 2
+    end
+
+    it 'complains if there are arguments for the accessor' do
+      expect { subject.arbitrary_accessor(1) }.to raise_error(ArgumentError, 'wrong number of arguments (given 1, expected 0)')
+      expect { subject.arbitrary_accessor(1, 2) }.to raise_error(ArgumentError, 'wrong number of arguments (given 2, expected 0)')
+    end
+
+    it 'complains if there are arguments for the accessor =' do
+      # using send because i'm not sure how to do this wrong with normal ruby setter calling.
+      # just here for completeness
+      expect { subject.send(:arbitrary_accessor=) }.to raise_error(ArgumentError, 'wrong number of arguments (given 0, expected 1)')
+      expect { subject.send(:arbitrary_accessor=, 1, 2) }.to raise_error(ArgumentError, 'wrong number of arguments (given 2, expected 1)')
+    end
+
+    it 'responds to the accessor' do
+      expect(subject).to respond_to(:arbitrary_accessor)
+      expect(subject).to respond_to(:arbitrary_accessor=)
+      expect(subject).to_not respond_to(:another_accessor)
+      expect(subject).to_not respond_to(:another_accessor=)
+    end
+
+    it "raises when the key doesn't exist" do
+      expect { subject.another_accessor }.to raise_error(NoMethodError)
+      expect { subject.another_accessor = 1 }.to raise_error(NoMethodError)
+    end
+  end
+
+  context 'with a string key' do
+    let(:key) { 'arbitrary_accessor' }
+
+    it_behaves_like :hash_with_accessors
+  end
+
+  context 'with a symbol key' do
+    let(:key) { :arbitrary_accessor }
+
+    it_behaves_like :hash_with_accessors
+  end
+
+  context 'with a conflicting key' do
+    subject do
+      h = described_class.new
+      h['keys'] = 'not the keys'
+      h
+    end
+
+    it "does original thing if there'd be a conflict" do
+      expect(subject.keys).to eq ['keys'] # the default behaviour
+      expect(subject['keys']).to eq 'not the keys'
+    end
+
+    it 'still does the writer thing even if the reader is defined' do
+      subject.keys = 'written keys'
+      expect(subject['keys']).to eq 'written keys'
+      expect(subject.keys).to eq ['keys']
+    end
+  end
+
+  context 'with some other method missing defined' do
+    # this test setup is kind of janky,
+    # but we want to confirm super is set up correctly
+    # We could do a lot more house-keeping if we weren't sure Hash doesn't
+    # define its own method_missing and respond_to_missing? by default,
+    # and there was any particular reason to clean up properly and remove our
+    # called_super method from Hash.
+
+    before(:all) do
+      class Hash
+        def called_super(*args)
+        end
+
+        def method_missing(*args)
+          called_super(:method_missing, *args)
+          super
+        end
+
+        def respond_to_missing?(*args)
+          called_super(:respond_to_missing?, *args)
+          super
+        end
+      end
+    end
+
+    subject do
+      h = described_class.new
+      h[:my_accessor] = 1
+      h
+    end
+
+    it 'can fall back to another respond_to_missing?' do
+      expect(subject).to_not receive(:called_super).with(:respond_to_missing?, :my_accessor, false)
+      expect(subject).to respond_to(:my_accessor)
+      expect(subject).to receive(:called_super).with(:respond_to_missing?, :literally_anything, false)
+      expect(subject.respond_to?(:literally_anything)).to be false
+    end
+
+    it 'can fall back to another method_missing' do
+      expect(subject).to_not receive(:called_super).with(:method_missing, :my_accessor)
+      expect(subject.my_accessor).to be 1
+      expect(subject).to receive(:called_super).with(:method_missing, :something_else)
+      expect { subject.something_else }.to raise_error(NoMethodError)
+    end
+
+  end
+
+  it "doesn't modify all hashes" do
+    expect { {a: 1}.a }.to raise_error(NoMethodError)
+  end
+end

data/spec/hop_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Adyen::Payments, service: "marketpay hop 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_onboarding_url", "pspReference", "8815850625171183"]
+  ]
+
+  generate_tests(client, "Hop", test_sets, client.marketpay.hop)
+end

data/spec/mocks/requests/Checkout/payment_links.json

@@ -0,0 +1,9 @@
+{
+  "amount": {
+    "currency": "USD",
+    "value": 1000
+  },
+  "countryCode": "US",
+  "merchantAccount": "TestMerchant",
+  "reference": "Merchant Reference"
+}