data-and-reporting-sdk 1.0.0 → 1.2.0

data/lib/shell_data_reporting_ap_is/exceptions/default_error_exception.rb

@@ -11,21 +11,21 @@ module ShellDataReportingApIs
 
     # Error object
     # @return [DefaultErrorFault]
-    attr_accessor :fault
-
-    # 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 :fault
+
+    # 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)
       @fault = DefaultErrorFault.from_hash(hash['fault']) if hash['fault']
     end
   end

data/lib/shell_data_reporting_ap_is/exceptions/error_object_exception.rb

@@ -22,21 +22,21 @@ module ShellDataReportingApIs
     # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
     # PARTIAL_SUCCESS
     # @return [Array[ErrorDetails]]
-    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)
+    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

data/lib/shell_data_reporting_ap_is/exceptions/error_user_access_error1_exception.rb

@@ -11,21 +11,21 @@ module ShellDataReportingApIs
 
     # TODO: Write general description for this method
     # @return [ErrorUserAccessError]
-    attr_accessor :error
-
-    # 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
+
+    # 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 = ErrorUserAccessError.from_hash(hash['Error']) if hash['Error']
     end
   end

data/lib/shell_data_reporting_ap_is/exceptions/o_auth_provider_exception.rb

@@ -24,21 +24,21 @@ module ShellDataReportingApIs
     # 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_data_reporting_ap_is/http/auth/bearer_token.rb

@@ -15,23 +15,27 @@ module ShellDataReportingApIs
 
     # Initialization constructor.
     def initialize(bearer_token_credentials, config)
-      auth_params = {}
       @_o_auth_client_id = bearer_token_credentials.o_auth_client_id unless
         bearer_token_credentials.nil? || bearer_token_credentials.o_auth_client_id.nil?
       @_o_auth_client_secret = bearer_token_credentials.o_auth_client_secret unless
         bearer_token_credentials.nil? || bearer_token_credentials.o_auth_client_secret.nil?
       @_o_auth_token = bearer_token_credentials.o_auth_token unless
         bearer_token_credentials.nil? || bearer_token_credentials.o_auth_token.nil?
+      @_o_auth_clock_skew = bearer_token_credentials.o_auth_clock_skew unless
+        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_clock_skew.nil?
+      @_o_auth_token_provider = bearer_token_credentials.o_auth_token_provider unless
+        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_token_provider.nil?
+      @_o_auth_on_token_update = bearer_token_credentials.o_auth_on_token_update unless
+        bearer_token_credentials.nil? || bearer_token_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 ShellDataReportingApIs
     # @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 BearerTokenCredentials.
   class BearerTokenCredentials
-    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
 
       BearerTokenCredentials.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_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
 end

data/lib/shell_data_reporting_ap_is/models/account_access.rb

@@ -82,14 +82,9 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(colco_id = SKIP,
-                   colco_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   payer_name = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   account_name = SKIP)
+    def initialize(colco_id = SKIP, colco_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, payer_name = SKIP, account_id = SKIP,
+                   account_number = SKIP, account_name = SKIP)
       @colco_id = colco_id unless colco_id == SKIP
       @colco_code = colco_code unless colco_code == SKIP
       @payer_id = payer_id unless payer_id == SKIP

data/lib/shell_data_reporting_ap_is/models/account_request.rb

@@ -13,12 +13,12 @@ module ShellDataReportingApIs
     # Optional if StatusList is passed, else mandatory.
     # Ignored if StatusList is passed.
     # Allowed values:
-    # •	ALL
-    # •	ACTIVE
-    # •	BLOCKED
-    # •	CANCELLED
-    # •	CREDITLOCK
-    # •	DELINQUENCYLOCK
+    # •    ALL
+    # •    ACTIVE
+    # •    BLOCKED
+    # •    CANCELLED
+    # •    CREDITLOCK
+    # •    DELINQUENCYLOCK
     # @return [String]
     attr_accessor :status
 
@@ -100,11 +100,11 @@ module ShellDataReportingApIs
     # Optional 
     # Multiple statuses are allowed to be included in the search criteria.
     # Allowed values:
-    # •	ACTIVE
-    # •	BLOCKED
-    # •	CANCELLED
-    # •	CREDITLOCK
-    # •	DELINQUENCYLOCK
+    # •    ACTIVE
+    # •    BLOCKED
+    # •    CANCELLED
+    # •    CREDITLOCK
+    # •    DELINQUENCYLOCK
     # @return [Array[String]]
     attr_accessor :status_list
 
@@ -167,21 +167,12 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(status = SKIP,
-                   include_card_summary = true,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   page_size = SKIP,
-                   request_id = SKIP,
-                   col_co_code = SKIP,
-                   col_co_country_code = SKIP,
-                   current_page = SKIP,
-                   invoice_points_only = false,
-                   col_co_id = SKIP,
-                   return_tolls_customer_id = SKIP,
-                   accounts = SKIP,
-                   account_name = SKIP,
-                   status_list = SKIP)
+    def initialize(status = SKIP, include_card_summary = true, payer_id = SKIP,
+                   payer_number = SKIP, page_size = SKIP, request_id = SKIP,
+                   col_co_code = SKIP, col_co_country_code = SKIP,
+                   current_page = SKIP, invoice_points_only = false,
+                   col_co_id = SKIP, return_tolls_customer_id = SKIP,
+                   accounts = SKIP, account_name = SKIP, status_list = SKIP)
       @status = status unless status == SKIP
       @include_card_summary = include_card_summary unless include_card_summary == SKIP
       @payer_id = payer_id unless payer_id == SKIP

data/lib/shell_data_reporting_ap_is/models/account_response.rb

@@ -64,12 +64,8 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(accounts = SKIP,
-                   current_page = SKIP,
-                   row_count = SKIP,
-                   total_pages = SKIP,
-                   error = SKIP,
-                   request_id = SKIP)
+    def initialize(accounts = SKIP, current_page = SKIP, row_count = SKIP,
+                   total_pages = SKIP, error = SKIP, request_id = SKIP)
       @accounts = accounts unless accounts == SKIP
       @current_page = current_page unless current_page == SKIP
       @row_count = row_count unless row_count == SKIP

data/lib/shell_data_reporting_ap_is/models/account_response_accounts_items.rb

@@ -32,10 +32,10 @@ module ShellDataReportingApIs
     # Billing/Invoice frequency. The frequency in which the transactions will be
     # considered for invoicing in a bulling run
     # E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_frequency_type
@@ -46,10 +46,10 @@ module ShellDataReportingApIs
     attr_accessor :billing_frequency_type_id
 
     # Frequency at which the billing process is triggered. E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_run_frequency
@@ -435,60 +435,36 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(account_full_name = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   account_short_name = SKIP,
-                   best_of_indicator = SKIP,
-                   billing_frequency_type = SKIP,
+    def initialize(account_full_name = SKIP, account_id = SKIP,
+                   account_number = SKIP, account_short_name = SKIP,
+                   best_of_indicator = SKIP, billing_frequency_type = SKIP,
                    billing_frequency_type_id = SKIP,
                    billing_run_frequency = SKIP,
                    billing_run_frequency_type_id = SKIP,
-                   col_co_country_code = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   day1_run = SKIP,
-                   day2_run = SKIP,
-                   day3_run = SKIP,
-                   day4_run = SKIP,
-                   frequency_type = SKIP,
-                   gross_amount = SKIP,
-                   international_pos_language_code = SKIP,
+                   col_co_country_code = SKIP, currency_code = SKIP,
+                   currency_symbol = SKIP, day1_run = SKIP, day2_run = SKIP,
+                   day3_run = SKIP, day4_run = SKIP, frequency_type = SKIP,
+                   gross_amount = SKIP, international_pos_language_code = SKIP,
                    international_pos_language_id = SKIP,
-                   invoice_account_id = SKIP,
-                   invoice_account_number = SKIP,
+                   invoice_account_id = SKIP, invoice_account_number = SKIP,
                    invoice_account_short_name = SKIP,
-                   invoice_distribution_methods = SKIP,
-                   is_international = SKIP,
-                   is_invoice_point = SKIP,
-                   last_modified_date = SKIP,
-                   local_currency_code = SKIP,
-                   local_currency_symbol = SKIP,
-                   local_pos_language_code = SKIP,
-                   local_pos_language_id = SKIP,
-                   net_amount = SKIP,
-                   outstanding_balance = SKIP,
-                   paid_amount = SKIP,
-                   status = SKIP,
-                   status_reason = SKIP,
-                   total_active_card_groups = SKIP,
-                   total_active_cards = SKIP,
-                   total_blocked_cards = SKIP,
-                   total_cancelled_cards = SKIP,
-                   total_cards = SKIP,
-                   total_expired_cards = SKIP,
-                   total_fraud_cards = SKIP,
-                   total_new_cards = SKIP,
+                   invoice_distribution_methods = SKIP, is_international = SKIP,
+                   is_invoice_point = SKIP, last_modified_date = SKIP,
+                   local_currency_code = SKIP, local_currency_symbol = SKIP,
+                   local_pos_language_code = SKIP, local_pos_language_id = SKIP,
+                   net_amount = SKIP, outstanding_balance = SKIP,
+                   paid_amount = SKIP, status = SKIP, status_reason = SKIP,
+                   total_active_card_groups = SKIP, total_active_cards = SKIP,
+                   total_blocked_cards = SKIP, total_cancelled_cards = SKIP,
+                   total_cards = SKIP, total_expired_cards = SKIP,
+                   total_fraud_cards = SKIP, total_new_cards = SKIP,
                    total_renewal_pending_cards = SKIP,
                    total_replaced_cards = SKIP,
                    total_temporary_block_cards_by_customer = SKIP,
                    total_temporary_block_cards_by_shell = SKIP,
-                   vat_amount = SKIP,
-                   is_partner_card = SKIP,
-                   tolls_customer_id = SKIP,
-                   tolls_colco_country_type_id = SKIP,
-                   contracts = SKIP,
-                   is_consortium_member = SKIP)
+                   vat_amount = SKIP, is_partner_card = SKIP,
+                   tolls_customer_id = SKIP, tolls_colco_country_type_id = SKIP,
+                   contracts = SKIP, is_consortium_member = SKIP)
       @account_full_name = account_full_name unless account_full_name == SKIP
       @account_id = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP

data/lib/shell_data_reporting_ap_is/models/accounts.rb

@@ -43,8 +43,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_number = SKIP)
+    def initialize(account_id = SKIP, account_number = SKIP)
       @account_id = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP
     end

data/lib/shell_data_reporting_ap_is/models/address.rb

@@ -111,17 +111,10 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(address_id = SKIP,
-                   address_line1 = SKIP,
-                   address_line2 = SKIP,
-                   address_line3 = SKIP,
-                   zip_code = SKIP,
-                   city = SKIP,
-                   region_id = SKIP,
-                   country_iso_code = SKIP,
-                   country = SKIP,
-                   telephone = SKIP,
-                   email_address = SKIP,
+    def initialize(address_id = SKIP, address_line1 = SKIP,
+                   address_line2 = SKIP, address_line3 = SKIP, zip_code = SKIP,
+                   city = SKIP, region_id = SKIP, country_iso_code = SKIP,
+                   country = SKIP, telephone = SKIP, email_address = SKIP,
                    fax = SKIP)
       @address_id = address_id unless address_id == SKIP
       @address_line1 = address_line1 unless address_line1 == SKIP

data/lib/shell_data_reporting_ap_is/models/audit_request.rb

@@ -10,14 +10,14 @@ module ShellDataReportingApIs
     private_constant :SKIP
 
     # Status of requests to be fetched.
-    # •	Success
-    # •	Failed
-    # •	InProgress
-    # •	Submitted
-    # •	Rejected
-    # •	PendingApproval
-    # •	All
-    # •	MailedToCSC
+    # •    Success
+    # •    Failed
+    # •    InProgress
+    # •    Submitted
+    # •    Rejected
+    # •    PendingApproval
+    # •    All
+    # •    MailedToCSC
     # Optional
     # If not passed “All” will be considered as the default value.
     # @return [String]
@@ -83,10 +83,10 @@ module ShellDataReportingApIs
     attr_accessor :requested_operation
 
     # Allowed Sorting Options:
-    # 1.	SubmittedDateDescending
-    # 2.	SubmittedDateAscending 
-    # 3.	AccountNumberAscending
-    # 4.	AccountNumberDescending
+    # 1.    SubmittedDateDescending
+    # 2.    SubmittedDateAscending 
+    # 3.    AccountNumberAscending
+    # 4.    AccountNumberDescending
     # Optional: Default value is 1
     # Example value to be passed: 1,3
     # @return [String]
@@ -185,19 +185,11 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(status = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   account_number = SKIP,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   accounts = SKIP,
-                   page_size = SKIP,
-                   requested_operation = SKIP,
-                   sort_order = SKIP,
-                   search_text = SKIP,
-                   current_page = SKIP,
-                   from_date = SKIP,
+    def initialize(status = SKIP, payer_number = SKIP, payer_id = SKIP,
+                   account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP,
+                   accounts = SKIP, page_size = SKIP,
+                   requested_operation = SKIP, sort_order = SKIP,
+                   search_text = SKIP, current_page = SKIP, from_date = SKIP,
                    to_date = SKIP)
       @status = status unless status == SKIP
       @payer_number = payer_number unless payer_number == SKIP

data/lib/shell_data_reporting_ap_is/models/audit_response.rb

@@ -64,12 +64,8 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(audits = SKIP,
-                   current_page = SKIP,
-                   row_count = SKIP,
-                   total_pages = SKIP,
-                   error = SKIP,
-                   request_id = SKIP)
+    def initialize(audits = SKIP, current_page = SKIP, row_count = SKIP,
+                   total_pages = SKIP, error = SKIP, request_id = SKIP)
       @audits = audits unless audits == SKIP
       @current_page = current_page unless current_page == SKIP
       @row_count = row_count unless row_count == SKIP