wallee-ruby-sdk 3.3.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05885b11b963cb7ac49534cff2e2995f4309be7e8789fc4c5e1c7fcfff327f29'
-  data.tar.gz: be4b2f45a61b0623549bc99b2e6519e8665c198b39d5e54e18c8f0e7eb158c27
+  metadata.gz: b7f19d2ce92b7114905dabbdbdb20cfb314c8001ac5a5df3daea364c3ebb25a6
+  data.tar.gz: 51ee92be3a3b74201ddb67df9ee7a415f75dc38b0437511b6086254079482cf6
 SHA512:
-  metadata.gz: 56a95b99a6b992be5b3da9ecb1c577e07c6cdb7f993f741db9dc93d106ceb17ecc1e774c6c02f9ef1d79199085f188c2c53f460e32d54c49452908f98fc24b49
-  data.tar.gz: e79e5a5201238aab39db55499703ee17524ea7ea61c56c622fbc01e1015059bdfb680ce608f3d6c1398e1dc83ae70865f023b9c93a41a240c984f0e86686275f
+  metadata.gz: 333bcdc3099fbcf89d4337c92308d3da77f1c01d93735d3481383616a70bdfb4ec189ca99780b67d401dd2b05094c748de4c092873acc869bf8ae0e74f33d71b
+  data.tar.gz: 222ca42b3b3de5c24a02c58111861dc84f031259b2ca830a63ad2134e6c8afcc66dbb64096eb4ecbcbb2bb06f56b40117a87484485f09ebc2120043132ea84f0

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.3.3'
-  gem 'test-unit', '~> 3.2.5'
+  gem 'rake', '~> 13.0.3'
+  gem 'test-unit', '~> 3.3.9'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wallee-ruby-sdk (3.3.0)
+    wallee-ruby-sdk (4.2.0)
       addressable (~> 2.3, >= 2.3.0)
       json (~> 2.3, >= 2.3.0)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -9,27 +9,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
-    json (2.6.3)
+    ffi (1.16.3)
+    json (2.7.1)
     power_assert (2.0.3)
-    public_suffix (5.0.1)
-    rake (12.3.3)
-    test-unit (3.2.9)
+    public_suffix (5.0.4)
+    rake (13.0.6)
+    test-unit (3.3.9)
       power_assert
-    typhoeus (1.4.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 12.3.3)
-  test-unit (~> 3.2.5)
+  rake (~> 13.0.3)
+  test-unit (~> 3.3.9)
   wallee-ruby-sdk!
 
 BUNDLED WITH
-   2.4.5
+   2.2.3

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2023 wallee AG
+   Copyright 2024 wallee AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -8,7 +8,7 @@ The wallee Ruby library wraps around the wallee API. This library facilitates yo
 
 ## Requirements
 
-- Ruby 2.2+
+- Ruby 3.0.0+
 
 ## Installation
 
@@ -136,6 +136,41 @@ payment_page_url = transaction_payment_page_service.payment_page_url(space_id, t
 # redirect to payment_page_url
 ```
 
+### Integrating Webhook Payload Signing Mechanism into webhook callback handler
+
+The HTTP request which is sent for a state change of an entity now includes an additional field `state`, which provides information about the update of the monitored entity's state. This enhancement is a result of the implementation of our webhook encryption mechanism.
+
+Payload field `state` provides direct information about the state update of the entity, making additional API calls to retrieve the entity state redundant.
+
+#### ⚠️ Warning: Generic Pseudocode
+
+> **The provided pseudocode is intentionally generic and serves to illustrate the process of enhancing your API to leverage webhook payload signing. It is not a complete implementation.**
+>
+> Please ensure that you adapt and extend this code to meet the specific needs of your application, including appropriate security measures and error handling.
+For a detailed webhook payload signing mechanism understanding we highly recommend referring to our comprehensive
+[Webhook Payload Signing Documentation](https://app-wallee.com/doc/webhooks#_webhook_payload_signing_mechanism).
+
+```ruby
+post '/webhook/callback' do
+    request_payload = request.body.read
+    signature = request.env['HTTP_X_SIGNATURE']
+
+    if signature.nil? || signature.empty?
+        # Make additional API call to retrieve the entity state
+        # ...
+    else
+        if webhook_encryption_service.is_content_valid(signature, request_payload)
+            # Parse request_payload to extract 'state' value
+            # Process entity's state change
+            # ...
+        end
+    end
+
+    # Process the received webhook data
+    # ...
+end
+```
+
 ## License
 
 Please see the [license file](https://github.com/wallee-payment/ruby-sdk/blob/master/LICENSE) for more information.

data/lib/wallee-ruby-sdk/api/token_service_api.rb

@@ -225,6 +225,74 @@ module Wallee
       return data, status_code, headers
     end
 
+    # Create Token
+    # This operation creates a token for the given transaction.
+    # @param space_id 
+    # @param transaction_id The id of the transaction for which we want to create the token.
+    # @param [Hash] opts the optional parameters
+    # @return [Token]
+    def create_token(space_id, transaction_id, opts = {})
+      data, _status_code, _headers = create_token_with_http_info(space_id, transaction_id, opts)
+      return data
+    end
+
+    # Create Token
+    # This operation creates a token for the given transaction.
+
+    # @param space_id 
+    # @param transaction_id The id of the transaction for which we want to create the token.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
+    def create_token_with_http_info(space_id, transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TokenService.create_token ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_token" if space_id.nil?
+      # verify the required parameter 'transaction_id' is set
+      fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.create_token" if transaction_id.nil?
+      # resource path
+      local_var_path = "/token/create-token".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'transactionId'] = transaction_id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = []
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+      
+      # connection timeout
+      timeout = @api_client.get_connection_timeout()
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :timeout => timeout,
+        :auth_names => auth_names,
+        :return_type => 'Token')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TokenService#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Token Based On Transaction
     # This operation creates a token for the given transaction and fills it with the stored payment information of the transaction.
     # @param space_id 

data/lib/wallee-ruby-sdk/api/webhook_encryption_service_api.rb

@@ -0,0 +1,117 @@
+=begin
+The wallee API allows an easy interaction with the wallee web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module Wallee
+  class WebhookEncryptionService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Read
+    # Reads the entity with the given 'id' and returns it.
+    # @param id The ID of the key version.
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookEncryptionPublicKey]
+    def read(id, opts = {})
+      data, _status_code, _headers = read_with_http_info(id, opts)
+      return data
+    end
+
+    # Read
+    # Reads the entity with the given 'id' and returns it.
+
+    # @param id The ID of the key version.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookEncryptionPublicKey, Fixnum, Hash)>] WebhookEncryptionPublicKey data, response status code and response headers
+    def read_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WebhookEncryptionService.read ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling WebhookEncryptionService.read" if id.nil?
+      # resource path
+      local_var_path = "/webhook-encryption/read".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+      
+      # connection timeout
+      timeout = @api_client.get_connection_timeout()
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :timeout => timeout,
+        :auth_names => auth_names,
+        :return_type => 'WebhookEncryptionPublicKey')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookEncryptionService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify webhook content
+    # Verify webhook content using signature header
+
+    # @param [String] signature_header Signature header 'X-Signature' value from the Http request
+    # @param [String] content_to_verify Raw webhook content in String format
+    # @return [bool] if webhook content body conforms with signature header
+    def is_content_valid(signature_header, content_to_verify)
+      # Regular expression to extract algorithm, keyId, and signature from the signature_header
+      regex = /^algorithm=([a-zA-Z0-9]+),\skeyId=([a-z0-9\-]+),\ssignature=([a-zA-Z0-9+\/=]+)$/
+      matcher = signature_header.match(regex)
+
+      if matcher
+        signature_algorithm = matcher[1]
+        public_key_id = matcher[2]
+        content_signature = matcher[3]
+
+        public_key = read(public_key_id)
+
+        raise "Could not find public key with id #{public_key_id}" if public_key.nil?
+
+        return EncryptionUtil.is_content_valid(content_to_verify, content_signature, public_key.public_key, signature_algorithm)
+      else
+        raise "Invalid webhook signature header. Expected format: 'algorithm=<algorithm>, keyId=<keyId>, signature=<signature>'"
+      end
+    end
+  end
+end

data/lib/wallee-ruby-sdk/api_client.rb

@@ -102,7 +102,7 @@ module Wallee
       http_method = http_method.to_sym.downcase
 
       default_headers = {
-        'x-meta-sdk-version': "3.3.0",
+        'x-meta-sdk-version': "4.2.0",
         'x-meta-sdk-language': "ruby",
         'x-meta-sdk-provider': "wallee",
         'x-meta-sdk-language-version': RUBY_VERSION

data/lib/wallee-ruby-sdk/encryption_util.rb

@@ -0,0 +1,41 @@
+require 'base64'
+require 'openssl'
+
+module Wallee
+  class EncryptionUtil
+    def self.is_content_valid(content, signature, public_key, encryption_algorithm)
+      algorithm_class = get_algorithm_class(encryption_algorithm)
+      raise "Unsupported algorithm: #{encryption_algorithm}" if algorithm_class.nil?
+
+      begin
+        signature = Base64.decode64(signature)
+      rescue ArgumentError
+        raise 'Invalid signature value format'
+      end
+
+      begin
+        public_key_bytes = Base64.decode64(public_key)
+      rescue ArgumentError
+        raise 'Invalid public key value format'
+      end
+
+      public_key = OpenSSL::PKey.read(public_key_bytes)
+
+      begin
+        public_key.verify(OpenSSL::Digest::SHA256.new, signature, content)
+        return true
+      rescue OpenSSL::PKey::PKeyError, OpenSSL::PKey::ECError, OpenSSL::PKey::EC::Point::Error
+        return false
+      end
+    end
+
+    def self.get_algorithm_class(algorithm)
+      case algorithm
+      when 'SHA256withECDSA'
+        OpenSSL::PKey::EC
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/wallee-ruby-sdk/models/abstract_account_update.rb

@@ -19,13 +19,13 @@ require 'date'
 
 module Wallee
   class AbstractAccountUpdate
-    # 
+    # The date and time when the object was last modified.
     attr_accessor :last_modified_date
 
-    # The name of the account identifies the account within the administrative interface.
+    # The name used to identify the account.
     attr_accessor :name
 
-    # This property restricts the number of subaccounts which can be created within this account.
+    # The number of sub-accounts that can be created within this account.
     attr_accessor :subaccount_limit
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_application_user_update.rb

@@ -19,13 +19,13 @@ require 'date'
 
 module Wallee
   class AbstractApplicationUserUpdate
-    # The user name is used to identify the application user in administrative interfaces.
+    # The name used to identify the application user.
     attr_accessor :name
 
-    # The request limit defines the maximum number of API request accepted within 2 minutes. This limit can only be changed with special privileges.
+    # The maximum number of API requests that are accepted every 2 minutes.
     attr_accessor :request_limit
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_customer_active.rb

@@ -19,25 +19,25 @@ require 'date'
 
 module Wallee
   class AbstractCustomerActive
-    # 
+    # The customer's ID in the merchant's system.
     attr_accessor :customer_id
 
-    # 
+    # The customer's email address.
     attr_accessor :email_address
 
-    # 
+    # The customer's family or last name.
     attr_accessor :family_name
 
-    # 
+    # The customer's given or first name.
     attr_accessor :given_name
 
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The customer's preferred currency.
     attr_accessor :preferred_currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_customer_address_active.rb

@@ -19,10 +19,10 @@ require 'date'
 
 module Wallee
   class AbstractCustomerAddressActive
-    # 
+    # The actual postal address.
     attr_accessor :address
 
-    # 
+    # Whether the address is for billing or shipping or both.
     attr_accessor :address_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_customer_comment_active.rb

@@ -19,7 +19,7 @@ require 'date'
 
 module Wallee
   class AbstractCustomerCommentActive
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_human_user_update.rb

@@ -19,28 +19,28 @@ require 'date'
 
 module Wallee
   class AbstractHumanUserUpdate
-    # The email address of the user.
+    # The user's email address.
     attr_accessor :email_address
 
-    # The first name of the user.
+    # The user's first name.
     attr_accessor :firstname
 
-    # The preferred language of the user.
+    # The user's preferred language.
     attr_accessor :language
 
-    # The last name of the user.
+    # The user's last name.
     attr_accessor :lastname
 
-    # 
+    # The user's mobile phone number.
     attr_accessor :mobile_phone_number
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
-    # The time zone which is applied for the user. If no timezone is specified the browser is used to determine an appropriate time zone.
+    # The user's time zone. If none is specified, the one provided by the browser will be used.
     attr_accessor :time_zone
 
-    # Defines whether two-factor authentication is enabled for this user.
+    # Whether two-factor authentication is enabled for this user.
     attr_accessor :two_factor_enabled
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_payment_link_update.rb

@@ -40,7 +40,7 @@ module Wallee
     # The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.
     attr_accessor :language
 
-    # The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.
+    # The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters. If no amount for the payment link is defined, the additional checkout page to enter the amount is shown to the consumer.
     attr_accessor :line_items
 
     # The maximal number of transactions limits the number of transactions which can be created with this payment link.

data/lib/wallee-ruby-sdk/models/abstract_refund_comment_active.rb

@@ -19,7 +19,7 @@ require 'date'
 
 module Wallee
   class AbstractRefundCommentActive
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_space_update.rb

@@ -19,28 +19,28 @@ require 'date'
 
 module Wallee
   class AbstractSpaceUpdate
-    # 
+    # The date and time when the object was last modified.
     attr_accessor :last_modified_date
 
-    # The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the space.
     attr_accessor :name
 
-    # The address to use in communication with clients for example in email, documents etc.
+    # The address that is used in communication with clients for example in emails, documents, etc.
     attr_accessor :postal_address
 
-    # This is the currency that is used to display aggregated amounts in the space.
+    # The currency that is used to display aggregated amounts in the space.
     attr_accessor :primary_currency
 
-    # The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.
+    # The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.
     attr_accessor :request_limit
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
-    # The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.
+    # The email address that will receive messages about technical issues and errors that occur in the space.
     attr_accessor :technical_contact_addresses
 
-    # The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.
+    # The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.
     attr_accessor :time_zone
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_subscriber_update.rb

@@ -37,7 +37,7 @@ module Wallee
     # The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
     attr_accessor :language
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
     # The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).

data/lib/wallee-ruby-sdk/models/abstract_subscription_affiliate_update.rb

@@ -19,16 +19,16 @@ require 'date'
 
 module Wallee
   class AbstractSubscriptionAffiliateUpdate
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
     # 
     attr_accessor :name
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_subscription_metric_update.rb

@@ -36,8 +36,8 @@ module Wallee
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'description' => :'DatabaseTranslatedStringCreate',
-        :'name' => :'DatabaseTranslatedStringCreate'
+        :'description' => :'Hash<String, String>',
+        :'name' => :'Hash<String, String>'
       }
     end
 
@@ -50,11 +50,15 @@ module Wallee
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'description')
-        self.description = attributes[:'description']
+        if (value = attributes[:'description']).is_a?(Hash)
+          self.description = value
+        end
       end
 
       if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+        if (value = attributes[:'name']).is_a?(Hash)
+          self.name = value
+        end
       end
     end
 

data/lib/wallee-ruby-sdk/models/abstract_subscription_product_active.rb

@@ -34,7 +34,7 @@ module Wallee
     # The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.
     attr_accessor :sort_order
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/abstract_token_update.rb

@@ -28,7 +28,7 @@ module Wallee
     # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
     attr_accessor :enabled_for_one_click_payment
 
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
     # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.

data/lib/wallee-ruby-sdk/models/abstract_transaction_comment_active.rb

@@ -19,7 +19,7 @@ require 'date'
 
 module Wallee
   class AbstractTransactionCommentActive
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
     # Attribute mapping from ruby-style variable name to JSON key.