Module: Restforce
- Defined in:
- lib/restforce.rb,
lib/restforce/mash.rb,
lib/restforce/client.rb,
lib/restforce/config.rb,
lib/restforce/sobject.rb,
lib/restforce/version.rb,
lib/restforce/upload_io.rb,
lib/restforce/attachment.rb,
lib/restforce/collection.rb,
lib/restforce/middleware.rb,
lib/restforce/data/client.rb,
lib/restforce/concerns/api.rb,
lib/restforce/concerns/base.rb,
lib/restforce/concerns/verbs.rb,
lib/restforce/signed_request.rb,
lib/restforce/tooling/client.rb,
lib/restforce/abstract_client.rb,
lib/restforce/concerns/canvas.rb,
lib/restforce/middleware/gzip.rb,
lib/restforce/concerns/caching.rb,
lib/restforce/middleware/logger.rb,
lib/restforce/concerns/picklists.rb,
lib/restforce/concerns/streaming.rb,
lib/restforce/middleware/caching.rb,
lib/restforce/middleware/mashify.rb,
lib/restforce/concerns/connection.rb,
lib/restforce/middleware/multipart.rb,
lib/restforce/middleware/raise_error.rb,
lib/restforce/concerns/authentication.rb,
lib/restforce/middleware/instance_url.rb,
lib/restforce/middleware/authorization.rb,
lib/restforce/middleware/authentication.rb,
lib/restforce/middleware/authentication/token.rb,
lib/restforce/middleware/authentication/password.rb
Defined Under Namespace
Modules: Concerns, CoreExtensions, Data, Tooling Classes: AbstractClient, Attachment, Collection, Configuration, Mash, Middleware, SObject, SignedRequest
Constant Summary collapse
- Error =
Class.new(StandardError)
- AuthenticationError =
Class.new(Error)
Class.new(Error)
- Client =
Data::Client
- VERSION =
'1.5.1'
- UploadIO =
Faraday::UploadIO
Class Attribute Summary collapse
Class Method Summary collapse
-
.configuration ⇒ Object
Returns the current Configuration.
-
.configure {|configuration| ... } ⇒ Object
Yields the Configuration.
- .data(*args) ⇒ Object
-
.decode_signed_request(*args) ⇒ Object
Helper for decoding signed requests.
- .log? ⇒ Boolean
-
.new(*args) ⇒ Object
Alias for Restforce::Data::Client.new.
- .tooling(*args) ⇒ Object
Class Attribute Details
.log(message) ⇒ Object
33 34 35 36 |
# File 'lib/restforce/config.rb', line 33 def log() return unless Restforce.log? Restforce.configuration.logger.send :debug, end |
Class Method Details
.configuration ⇒ Object
13 14 15 |
# File 'lib/restforce/config.rb', line 13 def configuration @configuration ||= Configuration.new end |
.configure {|configuration| ... } ⇒ Object
Yields the Configuration
Example
Restforce.configure do |config|
config.username = "username"
config.password = "password"
end
25 26 27 |
# File 'lib/restforce/config.rb', line 25 def configure yield configuration end |
.data(*args) ⇒ Object
51 52 53 |
# File 'lib/restforce.rb', line 51 def data(*args) Restforce::Data::Client.new(*args) end |
.decode_signed_request(*args) ⇒ Object
Helper for decoding signed requests.
60 61 62 |
# File 'lib/restforce.rb', line 60 def decode_signed_request(*args) SignedRequest.decode(*args) end |
.log? ⇒ Boolean
29 30 31 |
# File 'lib/restforce/config.rb', line 29 def log? @log ||= false end |
.new(*args) ⇒ Object
Alias for Restforce::Data::Client.new
Shamelessly pulled from github.com/pengwynn/octokit/blob/master/lib/octokit.rb
47 48 49 |
# File 'lib/restforce.rb', line 47 def new(*args) data(*args) end |