ev-recharge-sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91582bc1739f9e24f85bc8815b4904c3c3aa4887dc4e4d986cb79508f3afeea
-  data.tar.gz: 291214a251e8dc918b7f727336bb253e33129bf0c45252db46c47fa95770c1e1
+  metadata.gz: 3581a5328737a93ee89d58d621cd5b0cd8ab33f77a8940b52e7a5992e96c17ae
+  data.tar.gz: d6397da21ac9a71c372605d673fcf9f4afddf119405becae51a32228fdf4cb50
 SHA512:
-  metadata.gz: a4f42064d469f193a69b9fabc12b4e8b75dd00ce17130371fd240c15504b73f076b78d1f744c73049c0f32d82b21432eb0c29e8192cad8f57509ab1558b41e5a
-  data.tar.gz: e82d3a275a00e2e7239eefe970d53a4693bbe51af74619592dfdfd275aec9a508492fee569f7314eaf3a8c7e9729d1be8a94f94744fc6ff6fe46323f210c2113
+  metadata.gz: 3b459aa49f87f0aef6aa7d6aad385b8488718c06c3b69f1d6950e4732a71d454d3649fa80f7fd89ebe72ddff63c84adc5b4b410dba9dc4585e6753f662eabe6c
+  data.tar.gz: a484563a4340d88c652cfbaf24ba62ad4c875e501ccabccc7cce407e68574f1d335681bb62397adf75c5a1bda963443fc065e8c810d30218b5ea3a9779a8ed5a

data/README.md

@@ -3,14 +3,23 @@
 
 ## Introduction
 
-This API Product provides the option to manage charging at all public Shell Recharge locations. The end points provides control to start, stop and get status of the charging session.
+This API Product provides the list of all Shell Recharge locations. The list includes all Shell Recharge network and all locations available through our roaming partners.
 
-Supported Function
+Supported Functions
 
-* Start a charging session
-* Stop a charging session
-* Retrieve the status of a charging session
-* Retrieve the list of all active sessions for a card   termsOfService: 'https://developer.shell.com/terms-of-use'
+* Get the list of all the locations and its details.
+* Get the details of a particular location.
+* Get the list of locations nearby using the latitude and longitude.
+* Get the list of locations for a given set of bounds with different zoom levels.
+
+The Charging endpoints provides control to start, stop and get status of the charging session.
+
+Supported Functions
+
+* Start a charging session\n
+* Stop a charging session \n
+* Retrieve the status of a charging session \n
+* Retrieve the list of all active sessions for a card
 
 Go to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)
 
@@ -19,16 +28,16 @@ Go to the Shell Developer Portal: [https://developer.shell.com](https://develope
 Install the gem from the command line:
 
 ```ruby
-gem install ev-recharge-sdk -v 1.0.0
+gem install ev-recharge-sdk -v 1.2.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'ev-recharge-sdk', '1.0.0'
+gem 'ev-recharge-sdk', '1.2.0'
 ```
 
-For additional gem details, see the [RubyGems page for the ev-recharge-sdk gem](https://rubygems.org/gems/ev-recharge-sdk/versions/1.0.0).
+For additional gem details, see the [RubyGems page for the ev-recharge-sdk gem](https://rubygems.org/gems/ev-recharge-sdk/versions/1.2.0).
 
 ## Test the SDK
 
@@ -40,13 +49,12 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `env` | `EnvEnum` | This variable specifies the type of environment. Environments:<br><br>* `api` - Production<br>* `api-test` - UAT<br>*Default*: `EnvEnum::ENUM_APITESTSHELLCOM` |
 | `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 |
@@ -57,7 +65,7 @@ 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. |
-| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
 
 The API client can be initialized as follows:
 
@@ -67,26 +75,35 @@ client = ShellEv::Client.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
   ),
-  environment: Environment::PRODUCTION,
-  env: EnvEnum::ENUM_APITESTSHELLCOM
+  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** Production |
+| environment2 | Test |
+
 ## Authorization
 
 This API uses the following authentication schemes.
 
-* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
+* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [O Auth Authorization](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
-* [Charging](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/charging.md)
-* [Locations](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/locations.md)
+* [Locations](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/controllers/locations.md)
+* [Charging](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/controllers/charging.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.2.0/doc/http-request.md)
 

data/lib/shell_ev/client.rb

@@ -14,18 +14,18 @@ module ShellEv
       @auth_managers['BearerAuth']
     end
 
-    # Access to charging controller.
-    # @return [ChargingController] Returns the controller instance.
-    def charging
-      @charging ||= ChargingController.new @global_configuration
-    end
-
     # Access to locations controller.
     # @return [LocationsController] Returns the controller instance.
     def locations
       @locations ||= LocationsController.new @global_configuration
     end
 
+    # Access to charging controller.
+    # @return [ChargingController] Returns the controller instance.
+    def charging
+      @charging ||= ChargingController.new @global_configuration
+    end
+
     # Access to o_auth_authorization controller.
     # @return [OAuthAuthorizationController] Returns the controller instance.
     def o_auth_authorization
@@ -37,7 +37,8 @@ module ShellEv
       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, env: EnvEnum::ENUM_APITESTSHELLCOM,
+      environment: Environment::PRODUCTION, o_auth_client_id: nil,
+      o_auth_client_secret: nil, o_auth_token: nil,
       client_credentials_auth_credentials: nil, config: nil
     )
       @config = if config.nil?
@@ -47,7 +48,10 @@ module ShellEv
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
-                    environment: environment, env: env,
+                    environment: environment,
+                    o_auth_client_id: o_auth_client_id,
+                    o_auth_client_secret: o_auth_client_secret,
+                    o_auth_token: o_auth_token,
                     client_credentials_auth_credentials: client_credentials_auth_credentials
                   )
                 else

data/lib/shell_ev/configuration.rb

@@ -6,8 +6,11 @@
 module ShellEv
   # An enum for SDK environments.
   class Environment
+    # PRODUCTION: Production
+    # ENVIRONMENT2: Test
     ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
     ].freeze
   end
 
@@ -21,8 +24,20 @@ module ShellEv
   # All configuration including auth info and base URI for the API access
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
+    def o_auth_client_id
+      @client_credentials_auth_credentials.o_auth_client_id
+    end
+
+    def o_auth_client_secret
+      @client_credentials_auth_credentials.o_auth_client_secret
+    end
+
+    def o_auth_token
+      @client_credentials_auth_credentials.o_auth_token
+    end
+
     # The attribute readers for properties.
-    attr_reader :environment, :env, :client_credentials_auth_credentials
+    attr_reader :environment, :client_credentials_auth_credentials
 
     class << self
       attr_reader :environments
@@ -33,7 +48,8 @@ module ShellEv
       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, env: EnvEnum::ENUM_APITESTSHELLCOM,
+      environment: Environment::PRODUCTION, o_auth_client_id: nil,
+      o_auth_client_secret: nil, o_auth_token: nil,
       client_credentials_auth_credentials: nil
     )
 
@@ -45,14 +61,24 @@ module ShellEv
       # Current API environment
       @environment = String(environment)
 
-      # This variable specifies the type of environment. Environments:   * `api` - Production   * `api-test` - UAT
-      @env = env
+      # OAuth 2 Client ID
+      @o_auth_client_id = o_auth_client_id
+
+      # OAuth 2 Client Secret
+      @o_auth_client_secret = o_auth_client_secret
 
-      # The object holding OAuth 2 Client Credentials Grant credentials
-      @client_credentials_auth_credentials = client_credentials_auth_credentials
+      # Object for storing information about the OAuth token
+      @o_auth_token = if o_auth_token.is_a? OAuthToken
+                        OAuthToken.from_hash o_auth_token.to_hash
+                      else
+                        o_auth_token
+                      end
 
       # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
-     @client_credentials_auth_credentials = client_credentials_auth_credentials
+      @client_credentials_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_token,
+        client_credentials_auth_credentials
+      )
 
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
@@ -61,7 +87,8 @@ module ShellEv
     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, env: nil,
+                   environment: nil, o_auth_client_id: nil,
+                   o_auth_client_secret: nil, o_auth_token: nil,
                    client_credentials_auth_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
@@ -73,24 +100,53 @@ module ShellEv
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
       environment ||= self.environment
-      env ||= self.env
-      client_credentials_auth_credentials ||= client_credentials_auth_credentials
+      client_credentials_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_token,
+        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,
-        environment: environment, env: env,
+        environment: environment,
         client_credentials_auth_credentials: client_credentials_auth_credentials
       )
     end
 
+    def create_auth_credentials_object(o_auth_client_id, o_auth_client_secret,
+                                       o_auth_token,
+                                       client_credentials_auth_credentials)
+      return client_credentials_auth_credentials if o_auth_client_id.nil? &&
+                                                    o_auth_client_secret.nil? &&
+                                                    o_auth_token.nil?
+
+      warn('The \'o_auth_client_id\', \'o_auth_client_secret\', \'o_auth_token'\
+           '\' params are deprecated. Use \'client_credentials_auth_credential'\
+           's\' param instead.')
+
+      unless client_credentials_auth_credentials.nil?
+        return client_credentials_auth_credentials.clone_with(
+          o_auth_client_id: o_auth_client_id,
+          o_auth_client_secret: o_auth_client_secret,
+          o_auth_token: o_auth_token
+        )
+      end
+
+      ClientCredentialsAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token
+      )
+    end
 
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       Environment::PRODUCTION => {
-        Server::DEFAULT => 'https://{env}'
+        Server::DEFAULT => 'https://api.shell.com'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://api-test.shell.com'
       }
     }.freeze
 
@@ -99,12 +155,7 @@ module ShellEv
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = Server::DEFAULT)
-      parameters = {
-        'env' => { 'value' => env, 'encode' => false }
-      }
-      APIHelper.append_url_with_template_parameters(
-        ENVIRONMENTS[environment][server], parameters
-      )
+      ENVIRONMENTS[environment][server].clone
     end
   end
 end

data/lib/shell_ev/controllers/base_controller.rb

@@ -30,15 +30,15 @@ module ShellEv
     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