Module: SimpleAuthSdk

Defined in:
lib/simple_auth_sdk.rb,
lib/simple_auth_sdk/mixins.rb,
lib/simple_auth_sdk/version.rb,
lib/simple_auth_sdk/exception.rb,
lib/simple_auth_sdk/configuration.rb,
lib/simple_auth_sdk/mixins/httpproxy.rb,
lib/simple_auth_sdk/api/authentication_endpoints.rb

Overview

The SimpleAuthSdk module provides a simple authentication SDK for Ruby applications.

Defined Under Namespace

Modules: API, Mixins Classes: AccessDenied, BadRequest, Configuration, Error, Exception, HTTPError, InvalidApiNamespace, InvalidCredentials, InvalidIdToken, InvalidParameter, MissingActionId, MissingActionName, MissingClientId, MissingExecutionId, MissingOrganizationId, MissingParameter, MissingTriggerId, MissingUserId, MissingVersionId, NotFound, RateLimitEncountered, RequestTimeout, ServerError, Unauthorized, Unsupported

Constant Summary collapse

VERSION = 
'0.1.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



13
14
15
 
# File 'lib/simple_auth_sdk.rb', line 13

def configuration
  @configuration
end

Class Method Details

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

Configures the SimpleAuthSdk module.

Examples:

Configuring the SDK:

SimpleAuthSdk.configure do |config|
  config.api_key = 'YOUR_API_KEY'
  config.secret_key = 'YOUR_SECRET_KEY'
end

Yields:

Yield Parameters:



26
27
28
29
30
 
# File 'lib/simple_auth_sdk.rb', line 26

def configure
  self.configuration ||= Configuration.new
  yield(configuration) if block_given?
  configuration.validate!
end