card-management-sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32008a1f6836380d63cf65c64b2605fba5595f32ebddd8d37890832aba819fe
-  data.tar.gz: 5dbed5478ee18be88200e22310f862769246d67be84970305b0eb42d43cebe79
+  metadata.gz: f5c05f096a109c51ab89c60ca4c2bed2d4afc9e0d00ced3b489c258706440b53
+  data.tar.gz: e2ae507c33be41d818ecebc705d8871b85f387b93759c0273b241ad3b83425f1
 SHA512:
-  metadata.gz: e53ecdad02ce9a0e77167c27f80d4225a6a697fb8d05986030af55681b391b2068d1e2224b073e15f2d7a4a70259206dce19f56ac0b41ceb5484d67f5970e985
-  data.tar.gz: 55a21a6eb4f7d3e4bbb1318df5179b70176aca596b3e028f2c1d6123cdf1075a6adc8e66e8db7a3d097ac5d757c012e6afbc861f1a1d7fc6d4a37e6dbc207173
+  metadata.gz: '084c7f36b7dfbfd41cb9bdf4c7db135766e2f897afe70ab3822ab0d0a0627f83a227c009cb90cccecc147bcfd28d4adfcefd8f4f5f1d71bdb93a8766d2710b58'
+  data.tar.gz: 412a5044dee928b4737c2006417a8e0e42805aba31f7c841fbf3fd94e71af94a9ff0e19324bf6ee7c67a16ea3f3a4ae3228d0127c4ada6a15bcc8191be4089b4

data/README.md

@@ -16,27 +16,26 @@ Go to the Shell Developer Portal: [https://developer.shell.com](https://develope
 Install the gem from the command line:
 
 ```ruby
-gem install card-management-sdk -v 1.0.0
+gem install card-management-sdk -v 1.2.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'card-management-sdk', '1.0.0'
+gem 'card-management-sdk', '1.2.0'
 ```
 
-For additional gem details, see the [RubyGems page for the card-management-sdk gem](https://rubygems.org/gems/card-management-sdk/versions/1.0.0).
+For additional gem details, see the [RubyGems page for the card-management-sdk gem](https://rubygems.org/gems/card-management-sdk/versions/1.2.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `url` | `UrlEnum` | This variable specifies the type of environment. Environments:<br><br>* `api.shell.com` - Production<br>* `api-test.shell.com` - SIT<br>*Default*: `UrlEnum::ENUM_APITESTSHELLCOMTEST` |
-| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SIT`** |
 | `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** |
@@ -46,8 +45,8 @@ 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. |
-| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/basic-authentication.md) | The credential object for Basic Authentication |
-| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.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:
 
@@ -61,28 +60,37 @@ client = ShellCardManagementApIs::Client.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
   ),
-  environment: Environment::PRODUCTION,
-  url: UrlEnum::ENUM_APITESTSHELLCOMTEST
+  environment: Environment::SIT
 )
 ```
 
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| SIT | **Default** |
+| Production | - |
+
 ## Authorization
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/basic-authentication.md)
-* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/auth/basic-authentication.md)
+* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [O Auth Authorization](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
-* [Customer](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/controllers/customer.md)
-* [Restriction](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/controllers/restriction.md)
-* [Card](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/controllers/card.md)
+* [Customer](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/controllers/customer.md)
+* [Restriction](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/controllers/restriction.md)
+* [Card](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/controllers/card.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.2.0/doc/http-request.md)
 

data/lib/shell_card_management_ap_is/client.rb

@@ -43,8 +43,7 @@ module ShellCardManagementApIs
       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,
-      environment: Environment::PRODUCTION,
-      url: UrlEnum::ENUM_APITESTSHELLCOMTEST, basic_auth_credentials: nil,
+      environment: Environment::SIT, basic_auth_credentials: nil,
       bearer_token_credentials: nil, config: nil
     )
       @config = if config.nil?
@@ -54,7 +53,7 @@ module ShellCardManagementApIs
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
-                    environment: environment, url: url,
+                    environment: environment,
                     basic_auth_credentials: basic_auth_credentials,
                     bearer_token_credentials: bearer_token_credentials
                   )

data/lib/shell_card_management_ap_is/configuration.rb

@@ -7,15 +7,16 @@ module ShellCardManagementApIs
   # An enum for SDK environments.
   class Environment
     ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
+      SIT = 'SIT'.freeze,
+      PRODUCTION = 'Production'.freeze
     ].freeze
   end
 
   # An enum for API servers.
   class Server
     SERVER = [
-      DEFAULT = 'default'.freeze,
-      ACCESS_TOKEN_SERVER = 'access token server'.freeze
+      OAUTH_SERVER = 'OAuth Server'.freeze,
+      SHELL = 'Shell'.freeze
     ].freeze
   end
 
@@ -23,8 +24,7 @@ module ShellCardManagementApIs
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
     # The attribute readers for properties.
-    attr_reader :environment, :url, :basic_auth_credentials,
-                :bearer_token_credentials
+    attr_reader :environment, :basic_auth_credentials, :bearer_token_credentials
 
     class << self
       attr_reader :environments
@@ -35,8 +35,7 @@ module ShellCardManagementApIs
       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,
-      environment: Environment::PRODUCTION,
-      url: UrlEnum::ENUM_APITESTSHELLCOMTEST, basic_auth_credentials: nil,
+      environment: Environment::SIT, basic_auth_credentials: nil,
       bearer_token_credentials: nil
     )
 
@@ -48,9 +47,6 @@ module ShellCardManagementApIs
       # Current API environment
       @environment = String(environment)
 
-      # This variable specifies the type of environment. Environments:   * `api.shell.com` - Production   * `api-test.shell.com` - SIT
-      @url = url
-
       # The object holding Basic Authentication credentials
       @basic_auth_credentials = basic_auth_credentials
 
@@ -64,7 +60,7 @@ module ShellCardManagementApIs
     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,
-                   environment: nil, url: nil, basic_auth_credentials: nil,
+                   environment: nil, basic_auth_credentials: nil,
                    bearer_token_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
@@ -76,7 +72,6 @@ module ShellCardManagementApIs
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
       environment ||= self.environment
-      url ||= self.url
       basic_auth_credentials ||= self.basic_auth_credentials
       bearer_token_credentials ||= self.bearer_token_credentials
 
@@ -87,7 +82,6 @@ module ShellCardManagementApIs
                         retry_statuses: retry_statuses,
                         retry_methods: retry_methods,
                         http_callback: http_callback, environment: environment,
-                        url: url,
                         basic_auth_credentials: basic_auth_credentials,
                         bearer_token_credentials: bearer_token_credentials)
     end
@@ -95,9 +89,13 @@ module ShellCardManagementApIs
 
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
+      Environment::SIT => {
+        Server::OAUTH_SERVER => 'https://api-test.shell.com',
+        Server::SHELL => 'https://api-test.shell.com/test'
+      },
       Environment::PRODUCTION => {
-        Server::DEFAULT => 'https://{url}',
-        Server::ACCESS_TOKEN_SERVER => 'https://api-test.shell.com/v1/oauth'
+        Server::OAUTH_SERVER => 'https://api.shell.com',
+        Server::SHELL => 'https://api.shell.com'
       }
     }.freeze
 
@@ -105,13 +103,8 @@ module ShellCardManagementApIs
     # @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)
-      parameters = {
-        'url' => { 'value' => url, 'encode' => false }
-      }
-      APIHelper.append_url_with_template_parameters(
-        ENVIRONMENTS[environment][server], parameters
-      )
+    def get_base_uri(server = Server::SHELL)
+      ENVIRONMENTS[environment][server].clone
     end
   end
 end

data/lib/shell_card_management_ap_is/controllers/base_controller.rb

@@ -30,15 +30,15 @@ module ShellCardManagementApIs
     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
-    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 [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    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