Class: Jsapi::Controller::Authentication::Credentials::APIKey

Inherits:

Object

• Object
• Jsapi::Controller::Authentication::Credentials::APIKey

Defined in:

lib/jsapi/controller/authentication/credentials/api_key.rb

Overview

Holds an API key.

Instance Attribute Summary

• #api_key ⇒ Object readonly

  The API key as it was passed.

Instance Method Summary

• #initialize(api_key) ⇒ APIKey constructor

  A new instance of APIKey.

• #well_formed? ⇒ Boolean

  Returns true if the API Key is not nil.

Constructor Details

#initialize(api_key) ⇒ APIKey

Returns a new instance of APIKey.

# File 'lib/jsapi/controller/authentication/credentials/api_key.rb', line 12

def initialize(api_key)
  @api_key = api_key
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

The API key as it was passed.

# File 'lib/jsapi/controller/authentication/credentials/api_key.rb', line 10

def api_key
  @api_key
end

Instance Method Details

#well_formed? ⇒ Boolean

Returns true if the API Key is not nil.

Returns:

• (Boolean)

# File 'lib/jsapi/controller/authentication/credentials/api_key.rb', line 17

def well_formed?
  !api_key.nil?
end