paypal-server-sdk 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6efdfdb5c0d12d4903e4c09dc6a0b033b574e4ace39f00c1d867314ac006783
-  data.tar.gz: d0d73b90afe15c9bb77a687a8a9a0233da6e5365f05fbd39f1b1039bd4af9dc0
+  metadata.gz: 716ca4b1a12121acd6e221becbf2d29c55063b4f8b46eb68b499a84d6c22a175
+  data.tar.gz: c875e40983c4bb398f4d40849540c2e3e8a612f94383ca70326bd7a5a24f7223
 SHA512:
-  metadata.gz: b8564b3b7cc18e06c95424b33fe51319e469f70b61ccc96812e7952bddab1e1013aedefc282ce98b16d790e0996d4029263b54ee366a899872373f959097c317
-  data.tar.gz: 3c2d90a8a331ced3469cdd1d49a8d5fe77e657875ee92d56b7b691299bc57fb02528e9f0041b2305e7d49ae6e7fa2bef858885394a95dc2720371b86c91abb59
+  metadata.gz: 96c1fd80ecdf37001dc6e351e81677e02740414aba53b4913a71c56a82a1bafcc5d5f55caf6af264a5e065fdbcfcb7ddd07875358c09b893087277016371a6a3
+  data.tar.gz: 0d5bb3db5f27cddfff1c1712fd14d0519108a9d5239605615f6ade8aa5c452cdf5b2cb59986e9e99066e44ea04042867c5c79491b4e21f10be0db6eddb228ebc

data/README.md

@@ -5,35 +5,72 @@
 
 ### Important Notes
 
-- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
+- **Available Features:** This SDK currently contains only 5 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
 
 ### Information
 
 The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
 
 - Orders Controller: [Orders API v2](https://developer.paypal.com/docs/api/orders/v2/)
-- Payments Controller: [Payments API v2](https://developer.paypal.com/docs/api/payments/v2
-- Vault Controller: [Payment Method Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) *Available in the US only.*
+- Payments Controller: [Payments API v2](https://developer.paypal.com/docs/api/payments/v2)
+- Vault Controller: [Payment Method Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) *Available in the US only.*
+- Transaction Search Controller: [Transaction Search API v1](https://developer.paypal.com/docs/api/transaction-search/v1/)
+- Subscriptions Controller: [Subscriptions API v1](https://developer.paypal.com/docs/api/subscriptions/v1/)
 
 ## Install the Package
 
 Install the gem from the command line:
 
 ```bash
-gem install paypal-server-sdk -v 1.1.0
+gem install paypal-server-sdk -v 2.1.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'paypal-server-sdk', '1.1.0'
+gem 'paypal-server-sdk', '2.1.0'
 ```
 
-For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/1.1.0).
+For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/2.1.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'paypal_server_sdk'
+include PaypalServerSdk
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/paypal_server_sdk
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -49,13 +86,19 @@ The following parameters are configurable for the API Client:
 | 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. |
-| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
-| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
 
 The API client can be initialized as follows:
 
+### Code-Based Client Initialization
+
 ```ruby
-client = PaypalServerSdk::Client.new(
+require 'paypal_server_sdk'
+include PaypalServerSdk
+
+client = Client.new(
   client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
@@ -73,6 +116,18 @@ client = PaypalServerSdk::Client.new(
 )
 ```
 
+### Environment-Based Client Initialization
+
+```ruby
+require 'paypal_server_sdk'
+include PaypalServerSdk
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md) section for details.
+
 ## Environments
 
 The SDK can be configured to use a different environment for making API calls. Available environments are:
@@ -88,31 +143,35 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/controllers/orders.md)
-* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/controllers/payments.md)
-* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/controllers/vault.md)
+* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/orders.md)
+* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/payments.md)
+* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/vault.md)
+* [Transaction Search](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/transaction-search.md)
+* [Subscriptions](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/subscriptions.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [AbstractLogger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/abstract-logger.md)
-* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/response-logging-configuration.md)
+* [ProxySettings](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/api-response.md)
-* [ApiHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.1.0/doc/date-time-helper.md)
+* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/date-time-helper.md)
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'paypal_server_sdk'
+
+puts 'PaypalServerSdk SDK loaded!'
+puts 'You can now create a client with: client = PaypalServerSdk::Client.new'
+puts 'Or use from_env: client = PaypalServerSdk::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/paypal_server_sdk/api_helper.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # API utility class

data/lib/paypal_server_sdk/client.rb

@@ -1,13 +1,17 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   #  paypal_server_sdk client class.
   class Client
     include CoreLibrary
     attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
 
     # Returns the configured authentication Oauth2 instance.
     def oauth2
@@ -32,6 +36,18 @@ module PaypalServerSdk
       @vault ||= VaultController.new @global_configuration
     end
 
+    # Access to transaction_search controller.
+    # @return [TransactionSearchController] Returns the controller instance.
+    def transaction_search
+      @transaction_search ||= TransactionSearchController.new @global_configuration
+    end
+
+    # Access to subscriptions controller.
+    # @return [SubscriptionsController] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsController.new @global_configuration
+    end
+
     # Access to o_auth_authorization controller.
     # @return [OAuthAuthorizationController] Returns the controller instance.
     def o_auth_authorization
@@ -42,7 +58,7 @@ module PaypalServerSdk
       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,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       logging_configuration: nil, environment: Environment::SANDBOX,
       client_credentials_auth_credentials: nil, config: nil
     )
@@ -53,6 +69,7 @@ module PaypalServerSdk
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
                     logging_configuration: logging_configuration,
                     environment: environment,
                     client_credentials_auth_credentials: client_credentials_auth_credentials
@@ -81,5 +98,12 @@ module PaypalServerSdk
       @auth_managers['Oauth2'] = OAuth2.new(http_client_config.client_credentials_auth_credentials,
                                             global_config)
     end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
   end
 end

data/lib/paypal_server_sdk/configuration.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # An enum for SDK environments.
@@ -12,6 +12,21 @@ module PaypalServerSdk
       PRODUCTION = 'Production'.freeze,
       SANDBOX = 'Sandbox'.freeze
     ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'sandbox' then SANDBOX
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
   end
 
   # An enum for API servers.
@@ -19,6 +34,13 @@ module PaypalServerSdk
     SERVER = [
       DEFAULT = 'default'.freeze
     ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 
   # All configuration including auth info and base URI for the API access
@@ -35,15 +57,15 @@ module PaypalServerSdk
       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,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       logging_configuration: nil, environment: Environment::SANDBOX,
       client_credentials_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,
             logging_configuration: logging_configuration
 
       # Current API environment
@@ -53,7 +75,7 @@ module PaypalServerSdk
       @client_credentials_auth_credentials = client_credentials_auth_credentials
 
       # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
-     @client_credentials_auth_credentials = client_credentials_auth_credentials
+      @client_credentials_auth_credentials = client_credentials_auth_credentials
 
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
@@ -62,8 +84,8 @@ module PaypalServerSdk
     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,
-                   logging_configuration: nil, environment: nil,
-                   client_credentials_auth_credentials: nil)
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, client_credentials_auth_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -73,15 +95,17 @@ module PaypalServerSdk
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
       logging_configuration ||= self.logging_configuration
       environment ||= self.environment
-      client_credentials_auth_credentials ||= client_credentials_auth_credentials
+      client_credentials_auth_credentials ||= self.client_credentials_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,
         logging_configuration: logging_configuration, environment: environment,
         client_credentials_auth_credentials: client_credentials_auth_credentials
       )
@@ -105,5 +129,49 @@ module PaypalServerSdk
     def get_base_uri(server = Server::DEFAULT)
       ENVIRONMENTS[environment][server].clone
     end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sandbox'))
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      client_credentials_auth_credentials = ClientCredentialsAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        client_credentials_auth_credentials: client_credentials_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
   end
 end

data/lib/paypal_server_sdk/controllers/base_controller.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # BaseController.
@@ -10,7 +10,7 @@ module PaypalServerSdk
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'PayPal REST API Ruby SDK, Version: 1.1.0, on OS {os-info}'
+      'PayPal REST API Ruby SDK, Version: 2.1.0, on OS {os-info}'
     end
 
     def self.user_agent_parameters
@@ -31,13 +31,7 @@ module PaypalServerSdk
       @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 builder for the Api Call instance.
-    # @return [ApiCall] The instance of ApiCall.
-    def new_api_call_builder
-      @api_call.new_builder
+      @api_call = ApiCall.new(@global_configuration)
     end
 
     # Creates a new instance of the request builder.

data/lib/paypal_server_sdk/controllers/o_auth_authorization_controller.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # OAuthAuthorizationController
@@ -13,10 +13,10 @@ module PaypalServerSdk
     # space-delimited list.
     # @param [Hash] _field_parameters Additional optional form parameters are
     # supported by this endpoint.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def request_token(options = {},
                       _field_parameters: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v1/oauth2/token',
                                      Server::DEFAULT)