rrx_config 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec601c3c455ddac07928729e842a56bdf68169c7c79933a2f9fbf1f4f73ef731
-  data.tar.gz: 5c6b2d173c96c364e8a950d8b73629d621bf2efe9ee6c0116e31b62b5249a264
+  metadata.gz: a1cef46013f979c18dacbea0608b8a5634ff55dba92d4a3e8a60d544a666265f
+  data.tar.gz: 9a188dbcfb69d4551364df86c5d79ec31c23b698b9b593432577c3433071b6f2
 SHA512:
-  metadata.gz: 93bfbb4cd84cf2dd39781d68073c85e76a9dc77e66c64d034395870fb79c4c14d1016890720aa5bc312fdb8d21e91c832b6adbb4879dd8cb4cc9aafced95f5b2
-  data.tar.gz: 9241012dda9185d410020eb2ed98fce23ec8061fc5c0821164578d83ef1a6997e893ee5457019ef0d7fee35f4debdcde54e7746691ae8f2c965996f90d47311d
+  metadata.gz: 9a10a0b572ad6a09237fc9321e97c19e9ced87777e04ff21280ebbd50742d484a354263662ddf6098ce42d62835f325112ec53cee90d5969e0753182de9b1fc4
+  data.tar.gz: fcca273e1e4b019a7a24a6adc06f085524fcef58a5bbe141d0539963651fc647ba9ba94dc9a1880b8bb5e7a4fb19b100d010f0c778c763e54964200cbb225754

data/Gemfile

@@ -2,8 +2,3 @@
 
 source "https://rubygems.org"
 gemspec
-
-gem 'rrx_dev', path: '../rrx_dev'
-
-gem 'sqlite3'
-gem 'aws-sdk-secretsmanager'

data/Gemfile.lock

@@ -1,28 +1,8 @@
-PATH
-  remote: ../rrx_dev
-  specs:
-    rrx_dev (0.1.1)
-      active_record_query_trace
-      activesupport (~> 7.1.0)
-      bootsnap
-      debug
-      factory_bot_rails
-      listen
-      railties (~> 7.1.0)
-      rake (>= 13.0)
-      rspec (>= 3.0)
-      rspec-parameterized
-      rspec-rails
-      rswag-specs
-      rubocop (>= 1.21)
-      rubocop-rails
-      spring
-      thor
-
 PATH
   remote: .
   specs:
-    rrx_config (0.1.0)
+    rrx_config (0.1.2)
+      activesupport
       railties
 
 GEM
@@ -72,6 +52,9 @@ GEM
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.8)
       jmespath (~> 1, >= 1.6.1)
+    aws-sdk-rds (1.213.0)
+      aws-sdk-core (~> 3, >= 3.188.0)
+      aws-sigv4 (~> 1.1)
     aws-sdk-secretsmanager (1.88.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
@@ -122,6 +105,7 @@ GEM
     minitest (5.20.0)
     msgpack (1.7.2)
     mutex_m (0.2.0)
+    mysql2 (0.5.5)
     nokogiri (1.16.0-x86_64-linux)
       racc (~> 1.4)
     parallel (1.24.0)
@@ -170,6 +154,23 @@ GEM
     reline (0.4.1)
       io-console (~> 0.5)
     rexml (3.2.6)
+    rrx_dev (0.1.2)
+      active_record_query_trace
+      activesupport (~> 7.1.0)
+      bootsnap
+      debug
+      factory_bot_rails
+      listen
+      railties (~> 7.1.0)
+      rake (>= 13.0)
+      rspec (>= 3.0)
+      rspec-parameterized
+      rspec-rails
+      rswag-specs
+      rubocop (>= 1.21)
+      rubocop-rails
+      spring
+      thor
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -245,9 +246,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  aws-sdk-rds
   aws-sdk-secretsmanager
+  mysql2
   rrx_config!
-  rrx_dev!
+  rrx_dev
   sqlite3
 
 BUNDLED WITH

data/README.md

@@ -1,9 +1,6 @@
 # RrxConfig
 
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rrx_config`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby on Rails application configuration support.
 
 ## Installation
 
@@ -17,7 +14,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-This gem loads runtime application configuration from an external source
+This gem loads runtime application configuration from JSON provided by an external source.
+Configurations are stored as immutable Ruby `Data` objects.
 
 For example, with the JSON config
 
@@ -40,16 +38,20 @@ def my_code
 end
 ```
 
-Configurations are stored as immutable Ruby `Data` objects. You can test for optional values:
+You can test for optional values using standard mechanisms:
 
 ```ruby
-optional_stuff if RrxConfig.members.include?(:optional_thing)
-deep_optional_stuff if RrxConfig.optional_thing.members.include?(:deep_thoughts)
+optional_stuff if RrxConfig.respond_to?(:optional_thing)
+deep_optional_stuff if RrxConfig.optional_thing.include?(:deep_thoughts)
+
+optional_flag = RrxConfig.try(:optional).try(:flag) || DEFAULT_FLAG
 
 # Root-level configs can also be tested with the xxxx? syntax
 optional_stuff if RrxConfig.optional_thing?
 ```
 
+## Configuration Sources
+
 ### Environment
 
 Set the `RRX_CONFIG` environment variable to the required JSON configuration
@@ -59,11 +61,53 @@ Set the `RRX_CONFIG` environment variable to the required JSON configuration
 Loads configuration from an AWS secret that contains the required JSON configuration. Recommended when deploying on AWS.
 By default will use the implicit AWS context that is assigned by the instance role.
 
-Set the `RRX_CONFIG_AWS_SECRET` to the name of the secret to read.
+Set the `RRX_CONFIG_AWS_SECRET` environment variable to the name of the secret to read.
 
-For local integration testing, set `RRX_AWS_PROFILE` to use local AWS credentials. The profile must have been
+For local integration testing, set `RRX_AWS_PROFILE` to use local AWS credentials. The profile must be
 configured in the local AWS client (typically `~/.aws/credentials`).
 
+### Local File Configuration
+
+For development purposes, the gem will also check for the following files:
+
+* `{rails_root}/spec/spec_config.json` if `RAILS_ENV=test`
+* `{rails_root}/local_config.json`
+
+## Database Support
+
+If the loaded config contains a root-level `database` item then it will be used to configure the
+application database instead of `database.yml`.
+
+### AWS RDS IAM Authentication
+
+The gem also adds support for AWS RDS authentication using IAM to MySQL/MariaDB databases. If the RDS instance
+and user account has been configured correctly, replace the `password` argument with `iam: true`. This is supported
+using the `database` configuration or `database.yml`.
+
+The gem will automatically download the required CA certificates and set the necessary client options.
+
+Using JSON configuration:
+```json
+{
+  "database": {
+    "adapter": "mysql2",
+    "host": "rds-db-address...rds.amazonaws.com",
+    "port": 3306,
+    "username": "my_app_user",
+    "iam": true
+  }
+}
+```
+Using `database.yml`:
+```yaml
+production:
+  adapter: mysql2
+  host: rds-db-address...rds.amazonaws.com
+  port: 3306
+  username: my_app_user
+  iam: true
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -72,7 +116,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rrx/rrx_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rrx_config/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rails-rrx/rrx_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rrx_config/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -80,4 +124,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RrxConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rrx_config/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the RrxConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rails-rrc/rrx_config/blob/main/CODE_OF_CONDUCT.md).