class Procore::Configuration
Holds the configuration for the Procore
gem.
Attributes
@!attribute [rw] default_batch_size
@note defaults to Defaults::BATCH_SIZE
When using sync action, sets the default batch size to use for chunking up a request body. Example, if the size is set to 500 and 2,000 updates are desired, 4 requests will be made.
Note: The maximum size is 1,000
@return [Integer]
@!attribute [rw] default_version
@note defaults to Defaults::DEFAULT_VERSION
The default API version to use if none is specified in the request. Should be either “v1.0” (recommended) or “vapid” (legacy).
@return [String]
@!attribute [rw] host @note defaults to Defaults::API_ENDPOINT
Base API host name. Alter this depending on your environment - in a staging or test environment you may want to point this at a sandbox instead of production.
@return [String]
@!attribute [rw] logger @note defaults to nil
Instance of a Logger. This gem will log information about requests, responses and other things it might be doing. In a Rails application it should be set to Rails.logger
@return [Logger, nil]
@!attribute [rw] max_retries
@note Defaults
to 1
Number of times to retry a failed API call. Reasons an API call could potentially fail:
-
Service is briefly down or unreachable
-
Timeout hit - service is experiencing immense load or mid restart
-
Because computers
Would recommend 3-5 for production use. Has exponential backoff - first request waits a 1.5s after a failure, next one 2.25s, next one 3.375s, 5.0, etc.
@return [Integer]
@!attribute [rw] timeout @note defaults to 1.0
Threshold for canceling an API request. If a request takes longer than this value it will automatically cancel.
@return [Float]
@!attribute [rw] user_agent
@note defaults to Defaults::USER_AGENT
User Agent sent with each API request. API requests must have a user agent set. It is recomended to set the user agent to the name of your application.
@return [String]
Public Class Methods
# File lib/procore/configuration.rb, line 101 def initialize @default_batch_size = Procore::Defaults::BATCH_SIZE @host = Procore::Defaults::API_ENDPOINT @logger = nil @max_retries = 1 @timeout = 1.0 @user_agent = Procore::Defaults::USER_AGENT @default_version = Procore::Defaults::DEFAULT_VERSION end