module Procore

Constants

APIConnectionError

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

AuthorizationError

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

ForbiddenError

Raised when the request 403's

InvalidRequestError

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

MissingTokenError

Raised when a token is missing with refresh failure.

NotFoundError

Raised when the request 404's

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.

ServerError

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

VERSION

Public Class Methods

configuration() click to toggle source

The current configuration for the gem.

@return [Configuration]

# File lib/procore/configuration.rb, line 19
def self.configuration
  @configuration ||= Configuration.new
end
configure() { |configuration| ... } click to toggle source

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

@example Within config/initializers/procore.rb

Procore.configure do |config|
  config.timeout = 5.0
  config.user_agent = MyApp
end
# File lib/procore/configuration.rb, line 12
def self.configure
  yield(configuration)
end