Module: Procore

Defined in:
lib/procore.rb,
lib/procore/util.rb,
lib/procore/client.rb,
lib/procore/errors.rb,
lib/procore/version.rb,
lib/procore/defaults.rb,
lib/procore/response.rb,
lib/procore/auth/token.rb,
lib/procore/requestable.rb,
lib/procore/configuration.rb,
lib/procore/auth/stores/file.rb,
lib/procore/auth/stores/dalli.rb,
lib/procore/auth/stores/redis.rb,
lib/procore/auth/stores/memory.rb,
lib/procore/auth/stores/session.rb,
lib/procore/auth/client_credentials.rb,
lib/procore/auth/stores/active_record.rb,
lib/procore/auth/access_token_credentials.rb

Defined Under Namespace

Modules: Auth, Requestable, Util Classes: Client, Configuration, Defaults, Error, OAuthError, Response

Constant Summary collapse

APIConnectionError =

Raised when the gem cannot connect to the Procore API. Possible causes: Procore is down or the network is doing something funny.

Class.new(Error)
AuthorizationError =

Raised when the request is attempting to access a resource the token’s owner does not have access to.

Class.new(Error)
InvalidRequestError =

Raised when the request is incorrectly formated. Possible causes: missing required parameters or sending a request to access a non-existent resource.

Class.new(Error)
ForbiddenError =

Raised when the request 403’s

Class.new(Error)
NotFoundError =

Raised when the request 404’s

Class.new(Error)
RateLimitError =

Raised when a token reaches it’s request limit for the current time period. If you are receiving this error then you are making too many requests against the Procore API.

Class.new(Error)
ServerError =

Raised when a Procore endpoint returns a 500x resonse code.

Class.new(Error)
MissingTokenError =

Raised when a token is missing with refresh failure.

Class.new(Error)
VERSION = 
"1.1.0".freeze

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

The current configuration for the gem.

Returns:



19
20
21
 
# File 'lib/procore/configuration.rb', line 19

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields the configuration so the end user can set multiple attributes at once.

Examples:

Within config/initializers/procore.rb

Procore.configure do |config|
  config.timeout = 5.0
  config.user_agent = MyApp
end

Yields:



12
13
14
 
# File 'lib/procore/configuration.rb', line 12

def self.configure
  yield(configuration)
end