Module: Kairos::Configuration

Included in:

Kairos

Defined in:

lib/kairos/configuration.rb

Constant Summary

VALID_CONNECTION_KEYS =

[:app_id, :app_key].freeze

VALID_OPTIONS_KEYS =

[:url, :subject_id, :gallery_name, :threshold, :max_num_results, :selector].freeze

VALID_CONFIG_KEYS =

VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS

DEFAULT_USER_AGENT =

"Kairos API Ruby Gem #{Kairos::VERSION}".freeze

DEFAULT_APP_ID =

nil

DEFAULT_APP_KEY =

nil

ENROLL =

'http://api.kairos.io/enroll'

RECOGNIZE =

'http://api.kairos.io/recognize'

DETECT =

'http://api.kairos.io/detect'

GALLERY_LIST_ALL =

'http://api.kairos.io/gallery/list_all'

GALLERY_VIEW =

'http://api.kairos.io/gallery/view'

GALLERY_REMOVE_SUBJECT =

'http://api.kairos.io/gallery/remove_subject'

Class Method Summary

• .extended(base) ⇒ Object

  Make sure we have the default values set when we get ‘extended’.

Instance Method Summary

• #configure {|_self| ... } ⇒ Object
• #options ⇒ Object

  Return the configuration values set in this module.

• #reset ⇒ Object

Class Method Details

.extended(base) ⇒ Object

Make sure we have the default values set when we get ‘extended’

# File 'lib/kairos/configuration.rb', line 24

def self.extended(base)
  base.reset
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (Kairos::Configuration) —

  the object that the method was called on

# File 'lib/kairos/configuration.rb', line 33

def configure
  yield self
end

#options ⇒ Object

Return the configuration values set in this module

# File 'lib/kairos/configuration.rb', line 38

def options
  Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
end

#reset ⇒ Object

# File 'lib/kairos/configuration.rb', line 28

def reset
  self.app_id  = DEFAULT_APP_ID
  self.app_key = DEFAULT_APP_KEY
end