Class: ConfigurationService::AdminClient

Inherits:
Object
  • Object
show all
Defined in:
lib/configuration_service/admin_client.rb

Overview

The multi-identifier administrative configuration service API

See README for a summary of the service, including links to user stories.

It is recommended that consumers use a Factory to create and configure the service.

Instance Method Summary collapse

Constructor Details

#initialize(token, provider) ⇒ ConfigurationService::AdminClient

Deprecated.

use ConfigurationService::Client instead

Returns object.

Parameters:

  • token (String)
  • provider (String) 


20
21
22
23
 
# File 'lib/configuration_service/admin_client.rb', line 20

def initialize(token, provider)
  warn "[DEPRECATION] 'ConfigurationService::AdminClient' is deprecated.  Please use 'ConfigurationService::Client'."
  @client = ConfigurationService::Client.new(token, provider)
end

Instance Method Details

#publish_configuration(identifier, data, metadata = {}) ⇒ ConfigurationService::Configuration

Returns the published configuration.

Parameters:

  • identifier (String)
  • data (Hash)
  • metadata (Hash) (defaults to: {})

Returns:

Raises:

  • (ConfigurationaService::Error) —

    if data or metadata is not a hash



41
42
43
 
# File 'lib/configuration_service/admin_client.rb', line 41

def publish_configuration(identifier, data, metadata = {})
  @client.publish_configuration(identifier, data, metadata)
end

#request_configuration(identifier) ⇒ ConfigurationService::Configuration

Returns the requested configuration.

Parameters:

  • identifier (String)

Returns:

Raises:



30
31
32
 
# File 'lib/configuration_service/admin_client.rb', line 30

def request_configuration(identifier)
  @client.request_configuration(identifier)
end