Class: ConfigurationService::Base
- Inherits:
-
Object
- Object
- ConfigurationService::Base
- Defined in:
- lib/configuration_service/base.rb
Overview
Instance Method Summary collapse
-
#initialize(identifier, token, provider) ⇒ Base
constructor
deprecated
Deprecated.
use ConfigurationService::Client instead
-
#publish_configuraion(data, metadata = {}) ⇒ ConfigurationService::Configuration
Publishes configuration data and metadata.
-
#request_configuration ⇒ ConfigurationService::Configuration
Requests the configuration data and metadata.
Constructor Details
#initialize(identifier, token, provider) ⇒ Base
Deprecated.
use ConfigurationService::Client instead
Creates a new configuration service API instance
33 34 35 36 37 |
# File 'lib/configuration_service/base.rb', line 33 def initialize(identifier, token, provider) warn "[DEPRECATION] 'ConfigurationService::Base' is deprecated. Please use 'ConfigurationService::Client'." @identifier = identifier @client = ConfigurationService::Client.new(token, provider) end |
Instance Method Details
#publish_configuraion(data, metadata = {}) ⇒ ConfigurationService::Configuration
Publishes configuration data and metadata
The metadata
is decorated with the following keys:
-
“timestamp” - the current UTC time in ISO8601 format
-
“revision” - a UUID for this publication
Delegates the request to the configured provider
. The provider may further decorate the metadata
.
It is recommended that both the data
and metadata
dictionaries use strings as keys, and that values be limited to those that can be serialized to JSON.
73 74 75 |
# File 'lib/configuration_service/base.rb', line 73 def publish_configuraion(data, = {}) @client.publish_configuration(@identifier, data, = {}) end |
#request_configuration ⇒ ConfigurationService::Configuration
Requests the configuration data and metadata
Delegates the request to the configured provider
.
48 49 50 |
# File 'lib/configuration_service/base.rb', line 48 def request_configuration @client.request_configuration(@identifier) end |