Sha256: f28f7cccf9b4c059324abe1efd44fac06405d36af43221087008dd97ca0d5cdb

Contents?: true

Size: 1.35 KB

Versions: 16

Compression:

Stored size: 1.35 KB

Contents

# frozen_string_literal: true

class ApplicationApiClient < MyApiClient::Base
  # This is a super class for all API Client classes.
  # Almost settings are inherited to child classes.

  # Set the log output destination. The default is `Logger.new(STDOUT)`.
  self.logger = Rails.logger

  # Set the maximum number of seconds to wait on HTTP connection. If the
  # connection does not open even after this number of seconds, the exception
  # `MyApiClient::NetworkError` will raise. Setting nil will not time out.
  # The default is 60 seconds.
  #
  # http_open_timeout 2.seconds

  # Set the maximum number of seconds to block at one HTTP read. If it does not
  # read even after this number of seconds, it will raise the exception
  # MyApiClient::NetworkError. Setting nil will not time out. The default is 60
  # seconds.
  #
  # http_read_timeout 3.seconds

  # Catch the exception and re-execution after any seconds, like as ActiveJob.
  # Please note that it is executed as a synchronous process unlike ActiveJob.
  #
  # retry_on MyApiClient::NetworkError, wait: 5.seconds, attempts: 3

  # Set a HTTP response verifyment and behavior. If conflicting conditions are
  # set, the processing defined later takes precedence
  #
  # error_handling status_code: 400..499, raise: MyApiClient::ClientError
  # error_handling status_code: 500..599, raise: MyApiClient::ServerError
end

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
my_api_client-0.15.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.14.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.14.0.pre lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.13.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.12.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.11.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.10.3 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.10.2 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.10.1 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.10.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.9.2 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.9.1 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.9.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.8.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.7.0 lib/generators/rails/templates/application_api_client.rb.erb
my_api_client-0.6.2 lib/generators/rails/templates/application_api_client.rb.erb