hamza-payments-query-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bda6b6dc693e4fb61d71ca0b12a55d2c4f071d19dfc14737e6fdabcf0318c786
+  data.tar.gz: 2196e591ba4d5de2fdfdb8b9c6d0c463e0b5bf246436d2184414445b2859b0fa
+SHA512:
+  metadata.gz: a63c53b4dc065efa168bb9a444991c5ba5d3c9b6f116314d028ee2dac4bc012835d2a81e2abb3404b3705966fec3b84ac2d1b725cab059c112a537db3098b44a
+  data.tar.gz: d661c37e7c1a754673b25ec35454318ec5cf74cecf74a4abc8a669525e2f95ad7f5373b1f7dbcfac2a7932fa8e6c1a2199aa0dcc349a5a00a72d510dca382d5f

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2025 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,136 @@
+
+# Getting Started with Payments
+
+## Introduction
+
+Use a single API that orchestrates the payment flow to include FraudSight, 3DS and Token creation.
+
+__Authentication__
+
+Set your headers
+
+```
+Authorization: {your_credentials}    
+Content-Type: application/json    
+WP-Api-Version: 2024-06-01
+```
+
+Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.
+
+__DNS whitelisting__
+
+Whitelist the following URLs:
+
+* `https://try.access.worldpay.com/`
+* `https://access.worldpay.com/`
+
+Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.
+
+__API collection__
+
+A full set of API examples based on different scenarios.
+
+* __[Download Postman collection](./collections/index.md)__
+
+This API also includes Payment Queries functionality to retrieve and query payment information.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install hamza-payments-query-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'hamza-payments-query-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the hamza-payments-query-sdk gem](https://rubygems.org/gems/hamza-payments-query-sdk/versions/1.0.0).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+
+The API client can be initialized as follows:
+
+```ruby
+require 'payments'
+include Payments
+
+client = Client.new(
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'BasicAuthUserName',
+    password: 'BasicAuthPassword'
+  ),
+  environment: Environment::PRODUCTION
+)
+```
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| production | **Default** Try |
+| environment2 | Live |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [3 DS Actions](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/controllers/3-ds-actions.md)
+* [Manage Payments](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/controllers/manage-payments.md)
+* [Payment Queries](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/controllers/payment-queries.md)
+* [Payment](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/controllers/payment.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/MuHamza30/payments-query-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/lib/payments/api_helper.rb

@@ -0,0 +1,10 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/payments/client.rb

@@ -0,0 +1,78 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  #  payments client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to payment controller.
+    # @return [PaymentController] Returns the controller instance.
+    def payment
+      @payment ||= PaymentController.new @global_configuration
+    end
+
+    # Access to m3_ds_actions controller.
+    # @return [M3DSActionsController] Returns the controller instance.
+    def m3_ds_actions
+      @m3_ds_actions ||= M3DSActionsController.new @global_configuration
+    end
+
+    # Access to manage_payments controller.
+    # @return [ManagePaymentsController] Returns the controller instance.
+    def manage_payments
+      @manage_payments ||= ManagePaymentsController.new @global_configuration
+    end
+
+    # Access to payment_queries controller.
+    # @return [PaymentQueriesController] Returns the controller instance.
+    def payment_queries
+      @payment_queries ||= PaymentQueriesController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION, basic_auth_user_name: nil,
+      basic_auth_password: nil, basic_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings, environment: environment,
+                    basic_auth_user_name: basic_auth_user_name,
+                    basic_auth_password: basic_auth_password,
+                    basic_auth_credentials: basic_auth_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[BasicAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['BasicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
+    end
+  end
+end

data/lib/payments/configuration.rb

@@ -0,0 +1,145 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Try
+    # ENVIRONMENT2: Live
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def basic_auth_user_name
+      @basic_auth_credentials.username
+    end
+
+    def basic_auth_password
+      @basic_auth_credentials.password
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :basic_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION, basic_auth_user_name: nil,
+      basic_auth_password: nil, basic_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The username to use with basic authentication
+      @basic_auth_user_name = basic_auth_user_name
+
+      # The password to use with basic authentication
+      @basic_auth_password = basic_auth_password
+
+      # Initializing Basic Authentication credentials with the provided auth parameters
+      @basic_auth_credentials = create_auth_credentials_object(
+        basic_auth_user_name, basic_auth_password, basic_auth_credentials
+      )
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, environment: nil,
+                   basic_auth_user_name: nil, basic_auth_password: nil,
+                   basic_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      environment ||= self.environment
+      basic_auth_credentials = create_auth_credentials_object(
+        basic_auth_user_name, basic_auth_password,
+        basic_auth_credentials || self.basic_auth_credentials
+      )
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        environment: environment,
+                        basic_auth_credentials: basic_auth_credentials)
+    end
+
+    def create_auth_credentials_object(basic_auth_user_name,
+                                       basic_auth_password,
+                                       basic_auth_credentials)
+      return basic_auth_credentials if basic_auth_user_name.nil? && basic_auth_password.nil?
+
+      warn('The \'basic_auth_user_name\', \'basic_auth_password\' params are d'\
+           'eprecated. Use \'basic_auth_credentials\' param instead.')
+
+      unless basic_auth_credentials.nil?
+        return basic_auth_credentials.clone_with(
+          username: basic_auth_user_name,
+          password: basic_auth_password
+        )
+      end
+
+      BasicAuthCredentials.new(username: basic_auth_user_name,
+                               password: basic_auth_password)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://try.access.worldpay.com'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://access.worldpay.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/payments/controllers/base_controller.rb

@@ -0,0 +1,60 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/payments/controllers/m3_ds_actions_controller.rb

@@ -0,0 +1,97 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # M3DSActionsController
+  class M3DSActionsController < BaseController
+    # Gather additional device data. `linkData` refers to the pre-encoded
+    # segment of the URL that uniquely identifies a payment resource. It appears
+    # immediately after `/payments/` and continues until the next `/` or URL
+    # delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [DeviceDataRequest] body Optional parameter: TODO: type description
+    # here
+    # @return [DeviceDataResponse201] Response from the API call.
+    def supply3ds_device_data(link_data,
+                              wp_api_version,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/3dsDeviceData',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceDataResponse201.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Verify authentication challenge. `linkData` refers to the pre-encoded
+    # segment of the URL that uniquely identifies a payment resource. It appears
+    # immediately after /payments/ and continues until the next / or URL
+    # delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @return [ChallengeResponse201] Response from the API call.
+    def complete3ds_challenge(link_data,
+                              wp_api_version)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/3dsChallenges',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ChallengeResponse201.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end