# ConfigServerAgent

This is a client for the Config Server project. It allows you to retrieve configuration for your Ruby project.

The first time `get_config` is called, `ConfigServerAgent` will request your config pack from the configured Config Server. This will be cached and returned on subsequent calls to `get_config`, without further requests being made to the Config Server.

Call `clear` to clear the cache. The next call to `get_config` will cause the Config Server to be contacted again.

It is thread safe.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'config_server_agent'
```

And then execute:

```bash
    $ bundle
```

Or install it yourself as:

```bash
    $ gem install config_server_agent
```

## Usage

`ConfigServerAgent` requires six parameters to operate correctly. These parameters can either be explicitly provided to the constructor, or they will be pulled from environment variables. An `ArgumentError` will be raised if the parameters are not available from either source. Parameters supplied to the constructor will take precedence over environment variables.

```ruby
# Providing explicitly:
client = ConfigServerAgent.new(
	auth0_client_id: '4F4l7leKKigMN8CziKpgjvXGKrihih1F',
	auth0_client_secret: '3SrKmNAdKNzFBA3Lb6fgnTDyyFOQLt7hREWSlcU9QGc1SMKNKRL9DqmxyXQerS0E',
	auth0_host: 'yourdomain.au.auth0.com',
	config_server_audience: 'https://yourdomain.com',
	config_server_api_key: 'Rd5N9hQlbkK7pYxMZGGsQAv...snip...C2OpRq9hEIGtp4Aw6OpEOsec5==',
	config_server_host: 'https://your.config.server.com'
)

# Using environment variables:
client = ConfigServerAgent.new
# ConfigServerAgent will raise an exception if any of the following environment variables are not set:
# AUTH0_CLIENT_ID
# AUTH0_CLIENT_SECRET
# AUTH0_HOST
# CONFIG_SERVER_AUDIENCE
# CONFIG_SERVER_API_KEY
# CONFIG_SERVER_HOST

client.get_config
# => [{"id"=>"2481ea78-7699-4f59-8639-7992a6440c0f",
#   "value"=>"Braintree",
#   "name"=>"default_gateway",
#   "area"=>"Payments",
#   "created_at"=>"2018-12-06T00:39:12.236Z",
#   "updated_at"=>"2018-12-06T00:39:12.236Z"},
#  {"id"=>"02c74435-5309-4b7f-9a83-353cbf43e8cf",
#   "value"=>false,
#   "name"=>"payments_enabled",
#   "area"=>"Payments",
#   "created_at"=>"2018-12-06T00:39:12.240Z",
#   "updated_at"=>"2018-12-06T00:39:12.240Z"},
#  {"id"=>"17a0abc2-a0ac-4a2a-bfad-45a4e2afc00f",
#   "value"=>"L68Wh+[foZCVW/y3h",
#   "name"=>"account_password",
#   "area"=>"Payments",
#   "created_at"=>"2018-11-27T06:49:37.841Z",
#   "updated_at"=>"2018-11-27T06:49:37.841Z"}]
```

## Development

After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `rake console` for an interactive prompt that will allow you to experiment.

## Contributing

To experiment with the code, run `rake console` for an interactive prompt.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).