Class: Restforce::Middleware

Inherits:

Faraday::Middleware

• Object
• Faraday::Middleware
• Restforce::Middleware

Defined in:

lib/restforce/middleware.rb

Overview

Base class that all middleware can extend. Provides some convenient helper functions.

Direct Known Subclasses

Authentication, Authorization, CustomHeaders, Gzip, InstanceURL, Mashify

Defined Under Namespace

Classes: Authentication, Authorization, Caching, CustomHeaders, Gzip, InstanceURL, Logger, Mashify, Multipart, RaiseError

Instance Method Summary

• #client ⇒ Object

  Internal: Proxy to the client.

• #connection ⇒ Object

  Internal: Proxy to the client’s faraday connection.

• #initialize(app, client, options) ⇒ Middleware constructor

  A new instance of Middleware.

Constructor Details

#initialize(app, client, options) ⇒ Middleware

Returns a new instance of Middleware.

# File 'lib/restforce/middleware.rb', line 16

def initialize(app, client, options)
  @app = app
  @client = client
  @options = options
end

Instance Method Details

#client ⇒ Object

Internal: Proxy to the client.

# File 'lib/restforce/middleware.rb', line 23

def client
  @client
end

#connection ⇒ Object

Internal: Proxy to the client’s faraday connection.

# File 'lib/restforce/middleware.rb', line 28

def connection
  client.send(:connection)
end