ev-recharge-sdk 1.0.0 → 1.1.0

data/lib/shell_ev/exceptions/{m405_error_response_error1_exception.rb → internal_server_error_exception.rb}

@@ -4,49 +4,54 @@
 # ( https://apimatic.io ).
 
 module ShellEv
-  # Method Not Allowed
-  class M405ErrorResponseError1Exception < APIException
+  # InternalServerError class.
+  class InternalServerErrorException < APIException
     SKIP = Object.new
     private_constant :SKIP
 
-    # Mandatory UUID (according to RFC 4122 standards) for requests and
-    # responses. This will be played back in the response from the request.
+    # requestId is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
     # @return [String]
     attr_accessor :request_id
 
-    # Indicates overall status of the request
+    # Status of the request
     # @return [String]
     attr_accessor :status
 
-    # Indicates overall status of the request
-    # @return [Array[M405ErrorResponseError]]
+    # Exception details of the error
+    # @return [Array[InternalErrorObject]]
     attr_accessor :errors
 
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
-      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
-      @status = hash.key?('Status') ? hash['Status'] : nil
+    # Exception details of the error
+    # @return [Array[String]]
+    attr_accessor :details
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
       # Parameter is an array, so we need to iterate through it
       @errors = nil
-      unless hash['Errors'].nil?
+      unless hash['errors'].nil?
         @errors = []
-        hash['Errors'].each do |structure|
-          @errors << (M405ErrorResponseError.from_hash(structure) if structure)
+        hash['errors'].each do |structure|
+          @errors << (InternalErrorObject.from_hash(structure) if structure)
         end
       end
 
-      @errors = SKIP unless hash.key?('Errors')
+      @errors = SKIP unless hash.key?('errors')
+      @details = hash.key?('details') ? hash['details'] : SKIP
     end
   end
 end

data/lib/shell_ev/exceptions/not_found_exception.rb

@@ -4,34 +4,51 @@
 # ( https://apimatic.io ).
 
 module ShellEv
-  # NotFound class.
+  # Requested resource path not available it will provides the error in OpenAPI
+  # spec mentioned format, if there is any change in base URL then respective
+  # platform error message will be populated.
   class NotFoundException < APIException
     SKIP = Object.new
     private_constant :SKIP
 
-    # Error code
+    # requestId is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
     # @return [String]
-    attr_accessor :code
+    attr_accessor :request_id
 
-    # Error desctiption in English
+    # Status of the request
     # @return [String]
-    attr_accessor :message
+    attr_accessor :status
 
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
+    # Exception details of the error
+    # @return [Array[NotFoundErrMsg]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (NotFoundErrMsg.from_hash(structure) if structure)
+        end
+      end
 
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
-      @code = hash.key?('code') ? hash['code'] : SKIP
-      @message = hash.key?('message') ? hash['message'] : SKIP
+      @errors = SKIP unless hash.key?('errors')
     end
   end
 end

data/lib/shell_ev/exceptions/o_auth_provider_exception.rb

@@ -24,21 +24,21 @@ module ShellEv
     # about the error, used to provide the client developer with additional
     # information about the error.
     # @return [String]
-    attr_accessor :error_uri
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error = hash.key?('error') ? hash['error'] : nil
       @error_description =
         hash.key?('error_description') ? hash['error_description'] : SKIP

data/lib/shell_ev/exceptions/{m400_error_response_error1_exception.rb → serviceunavailable_exception.rb}

@@ -4,49 +4,49 @@
 # ( https://apimatic.io ).
 
 module ShellEv
-  # Bad Request
-  class M400ErrorResponseError1Exception < APIException
+  # Serviceunavailable class.
+  class ServiceunavailableException < APIException
     SKIP = Object.new
     private_constant :SKIP
 
-    # Mandatory UUID (according to RFC 4122 standards) for requests and
-    # responses. This will be played back in the response from the request.
+    # requestId is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
     # @return [String]
     attr_accessor :request_id
 
-    # Indicates overall status of the request
+    # Status of the request
     # @return [String]
     attr_accessor :status
 
-    # Indicates overall status of the request
-    # @return [Array[M400ErrorResponseError]]
-    attr_accessor :errors
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
-      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
-      @status = hash.key?('Status') ? hash['Status'] : nil
+    # Exception details of the error
+    # @return [Array[ServiceunavailableErrMsg]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
       # Parameter is an array, so we need to iterate through it
       @errors = nil
-      unless hash['Errors'].nil?
+      unless hash['errors'].nil?
         @errors = []
-        hash['Errors'].each do |structure|
-          @errors << (M400ErrorResponseError.from_hash(structure) if structure)
+        hash['errors'].each do |structure|
+          @errors << (ServiceunavailableErrMsg.from_hash(structure) if structure)
         end
       end
 
-      @errors = SKIP unless hash.key?('Errors')
+      @errors = SKIP unless hash.key?('errors')
     end
   end
 end

data/lib/shell_ev/exceptions/{m401_error_response_error1_exception.rb → too_many_requests_exception.rb}

@@ -4,49 +4,49 @@
 # ( https://apimatic.io ).
 
 module ShellEv
-  # Unauthorized
-  class M401ErrorResponseError1Exception < APIException
+  # TooManyRequests class.
+  class TooManyRequestsException < APIException
     SKIP = Object.new
     private_constant :SKIP
 
-    # Mandatory UUID (according to RFC 4122 standards) for requests and
-    # responses. This will be played back in the response from the request.
+    # RequestID is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
     # @return [String]
     attr_accessor :request_id
 
-    # Indicates overall status of the request
+    # Status of the request
     # @return [String]
     attr_accessor :status
 
-    # Indicates overall status of the request
-    # @return [Array[M401ErrorResponseError]]
-    attr_accessor :errors
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
-      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
-      @status = hash.key?('Status') ? hash['Status'] : nil
+    # Exception details of the error
+    # @return [Array[RatelimitErrMsg]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
       # Parameter is an array, so we need to iterate through it
       @errors = nil
-      unless hash['Errors'].nil?
+      unless hash['errors'].nil?
         @errors = []
-        hash['Errors'].each do |structure|
-          @errors << (M401ErrorResponseError.from_hash(structure) if structure)
+        hash['errors'].each do |structure|
+          @errors << (RatelimitErrMsg.from_hash(structure) if structure)
         end
       end
 
-      @errors = SKIP unless hash.key?('Errors')
+      @errors = SKIP unless hash.key?('errors')
     end
   end
 end

data/lib/shell_ev/exceptions/unauthorized_exception.rb

@@ -9,29 +9,43 @@ module ShellEv
     SKIP = Object.new
     private_constant :SKIP
 
-    # Error code
+    # requestId or correlation id of the message
     # @return [String]
-    attr_accessor :code
+    attr_accessor :request_id
 
-    # Error desctiption in English
+    # Status of the request
     # @return [String]
-    attr_accessor :message
+    attr_accessor :status
 
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
+    # Exception details of the error
+    # @return [Array[UnauthorizedErrMsg]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (UnauthorizedErrMsg.from_hash(structure) if structure)
+        end
+      end
 
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
-      @code = hash.key?('code') ? hash['code'] : SKIP
-      @message = hash.key?('message') ? hash['message'] : SKIP
+      @errors = SKIP unless hash.key?('errors')
     end
   end
 end

data/lib/shell_ev/http/auth/o_auth2.rb

@@ -15,23 +15,27 @@ module ShellEv
 
     # Initialization constructor.
     def initialize(client_credentials_auth_credentials, config)
-      auth_params = {}
       @_o_auth_client_id = client_credentials_auth_credentials.o_auth_client_id unless
         client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_id.nil?
       @_o_auth_client_secret = client_credentials_auth_credentials.o_auth_client_secret unless
         client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_secret.nil?
       @_o_auth_token = client_credentials_auth_credentials.o_auth_token unless
         client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token.nil?
+      @_o_auth_clock_skew = client_credentials_auth_credentials.o_auth_clock_skew unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_clock_skew.nil?
+      @_o_auth_token_provider = client_credentials_auth_credentials.o_auth_token_provider unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token_provider.nil?
+      @_o_auth_on_token_update = client_credentials_auth_credentials.o_auth_on_token_update unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_on_token_update.nil?
       @_o_auth_api = OAuthAuthorizationController.new(config)
-      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
-
-      super auth_params
+      super({})
     end
 
     # Validates the oAuth token.
     # @return [Boolean] true if the token is present and not expired.
     def valid
-      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+      @_o_auth_token = get_token_from_provider
+      @_o_auth_token.is_a?(OAuthToken) && !token_expired?(@_o_auth_token)
     end
 
     # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
@@ -58,32 +62,72 @@ module ShellEv
     # @param [OAuthToken] token The oAuth token instance.
     # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
     def token_expired?(token)
-      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry, @_o_auth_clock_skew)
+    end
+
+    def apply(http_request)
+      auth_params = { 'Authorization' => "Bearer #{@_o_auth_token.access_token}" }
+      AuthHelper.apply(auth_params, http_request.method(:add_header))
+    end
+
+    private
+
+    # This provides the OAuth Token from either the user configured callbacks or from default provider.
+    # @return [OAuthToken] The fetched oauth token.
+    def get_token_from_provider
+      return @_o_auth_token if @_o_auth_token && !token_expired?(@_o_auth_token)
+
+      if @_o_auth_token_provider
+        o_auth_token = @_o_auth_token_provider.call(@_o_auth_token, self)
+        @_o_auth_on_token_update&.call(o_auth_token)
+        return o_auth_token
+      end
+      begin
+        o_auth_token = fetch_token
+        @_o_auth_on_token_update&.call(o_auth_token)
+        o_auth_token
+      rescue ApiException
+        @_o_auth_token
+      end
     end
   end
 
   # Data class for ClientCredentialsAuthCredentials.
   class ClientCredentialsAuthCredentials
-    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token,
+                :o_auth_token_provider, :o_auth_on_token_update,
+                :o_auth_clock_skew
 
-    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil)
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil,
+                   o_auth_token_provider: nil, o_auth_on_token_update: nil,
+                   o_auth_clock_skew: nil)
       raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
       raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
 
       @o_auth_client_id = o_auth_client_id
       @o_auth_client_secret = o_auth_client_secret
       @o_auth_token = o_auth_token
+      @o_auth_token_provider = o_auth_token_provider
+      @o_auth_on_token_update = o_auth_on_token_update
+      @o_auth_clock_skew = o_auth_clock_skew
     end
 
     def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
-                   o_auth_token: nil)
+                   o_auth_token: nil, o_auth_token_provider: nil,
+                   o_auth_on_token_update: nil, o_auth_clock_skew: nil)
       o_auth_client_id ||= self.o_auth_client_id
       o_auth_client_secret ||= self.o_auth_client_secret
       o_auth_token ||= self.o_auth_token
+      o_auth_token_provider ||= self.o_auth_token_provider
+      o_auth_on_token_update ||= self.o_auth_on_token_update
+      o_auth_clock_skew ||= self.o_auth_clock_skew
 
       ClientCredentialsAuthCredentials.new(
         o_auth_client_id: o_auth_client_id,
-        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token,
+        o_auth_token_provider: o_auth_token_provider,
+        o_auth_on_token_update: o_auth_on_token_update,
+        o_auth_clock_skew: o_auth_clock_skew
       )
     end
   end

data/lib/shell_ev/models/accessibility.rb

@@ -38,8 +38,7 @@ module ShellEv
       []
     end
 
-    def initialize(status = SKIP,
-                   remark = SKIP)
+    def initialize(status = SKIP, remark = SKIP)
       @status = status unless status == SKIP
       @remark = remark unless remark == SKIP
     end

data/lib/shell_ev/models/active_response200_json.rb

@@ -9,8 +9,8 @@ module ShellEv
     SKIP = Object.new
     private_constant :SKIP
 
-    # A unique request id in GUID format. The value is written to the Shell API
-    # Platform audit log for end to end traceability of a request.
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
     # @return [UUID | String]
     attr_accessor :request_id
 
@@ -25,9 +25,9 @@ module ShellEv
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['request_id'] = 'RequestId'
-      @_hash['status'] = 'Status'
-      @_hash['data'] = 'Data'
+      @_hash['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash['data'] = 'data'
       @_hash
     end
 
@@ -43,9 +43,7 @@ module ShellEv
       []
     end
 
-    def initialize(request_id = nil,
-                   status = nil,
-                   data = SKIP)
+    def initialize(request_id = nil, status = nil, data = SKIP)
       @request_id = request_id
       @status = status
       @data = data unless data == SKIP
@@ -56,18 +54,18 @@ module ShellEv
       return nil unless hash
 
       # Extract variables from the hash.
-      request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
-      status = hash.key?('Status') ? hash['Status'] : nil
+      request_id = hash.key?('requestId') ? hash['requestId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
       # Parameter is an array, so we need to iterate through it
       data = nil
-      unless hash['Data'].nil?
+      unless hash['data'].nil?
         data = []
-        hash['Data'].each do |structure|
+        hash['data'].each do |structure|
           data << (DataActive.from_hash(structure) if structure)
         end
       end
 
-      data = SKIP unless hash.key?('Data')
+      data = SKIP unless hash.key?('data')
 
       # Create object from extracted values.
       ActiveResponse200Json.new(request_id,

data/lib/shell_ev/models/address.rb

@@ -50,9 +50,7 @@ module ShellEv
       []
     end
 
-    def initialize(street_and_number = SKIP,
-                   postal_code = SKIP,
-                   city = SKIP,
+    def initialize(street_and_number = SKIP, postal_code = SKIP, city = SKIP,
                    country = SKIP)
       @street_and_number = street_and_number unless street_and_number == SKIP
       @postal_code = postal_code unless postal_code == SKIP