cloud-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22afde03ef83a2749759d80cbdd646a070348effbd70fb7311c92a52dae05869
+  data.tar.gz: 16737f0d99ddc1a3bffdf0cad9be1525558efab1565cd21a9552124c1217d838
+SHA512:
+  metadata.gz: 1bae934a5af84caeb67f8ba48b9eef08e3f7990ebe26bd577089da7f5d22a253044c499c7c4da0ac4ef92421c934830db4a2b5f21ba52da3892aeb4132eb2a45
+  data.tar.gz: 4d528c9e6b3c3e46919bc035424de7e572e87f0eedaaa8a29d38f9aa7fe325f72246ca1b45dc7803ba252c1523d6284f37015e1f3d80e2fe5918ea8838fa7e5d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - bin/**/*
+    - examples/**/*
+    - .bundle/**/*
+    - .yardoc**/*
+    - _yardoc/**/*
+    - coverage/**/*
+    - doc/**/*
+    - pkg/**/*
+    - spec/reports/**/*
+    - spec/mocks/**/*
+    - tmp/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hypernova2002@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:3.1.0
+
+RUN sed -i 's/http:/https:/' /etc/ssl/openssl.cnf
+RUN apt update
+RUN apt-get install -y libidn11
+RUN mkdir /cloud-config
+WORKDIR /cloud-config
+
+COPY . /cloud-config
+
+RUN bundle install
+
+EXPOSE 4550

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloud-config.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    cloud-config (0.1.0)
+      parallel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.765.0)
+    aws-sdk-core (3.172.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-ssm (1.150.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    coderay (1.1.3)
+    connection_pool (2.4.0)
+    diff-lcs (1.5.0)
+    jmespath (1.6.2)
+    json (2.6.3)
+    method_source (1.0.0)
+    mock_redis (0.36.0)
+      ruby2_keywords
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (5.0.6)
+      redis-client (>= 0.9.0)
+    redis-client (0.14.1)
+      connection_pool
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.6)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
+    yard (0.9.34)
+
+PLATFORMS
+  aarch64-linux
+
+DEPENDENCIES
+  aws-sdk-ssm
+  cloud-config!
+  mock_redis
+  pry
+  rack
+  rake
+  redis
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  timecop
+  webrick
+  yard
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 hypernova2002
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# CloudConfig
+
+A library to modernise the way applications fetch configuration. Typically an application will use environment variables and settings files to store and retrieve configurations, but there are many issues with this approach. Often environment variables create a security risk and settings files hard code infrastructure dependencies into the code. Changing configuration settings will usually require redeploying large parts of the infrastructure and perhaps even need to go through the application deployment lifecycle.
+
+A modern approach stores configuration remotely, often using key/value databases. Storing configurations in a single database, separately from the codebase reduces infrastructure dependency. Configuration updates can automatically sync with any application, without requiring redeployments. Security risk is greatly reduced, since the configurations can be securely stored. Another goal with this approach is creating an environmentless codebase. The application no longer needs to know which environment it's running in, since all the configuration is handled by the infrastucture.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cloud-config
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cloud-config
+
+## Usage
+
+CloudConfig can be configured to fetch keys from multiple providers. Since CloudConfig will need to know which provider has the correct key, all the keys will need to be preconfigured. An example configuration may look like
+
+```ruby
+CloudConfig.configure do
+  provider :aws_parameter_store, preload: { async: true } do
+    setting :db_url, cache: 60
+    setting :api_url
+  end
+end
+```
+
+### Configuration Options
+
+```ruby
+CloudConfig.configure do
+  # Set the cache client
+  cache_client CloudConfig::Cache::InMemory.new
+
+  # Configure a provider. You can use the built-in providers (:in_memory, :aws_parameter_store, :yaml_file).
+  provider :in_memory do
+  end
+
+  # If you want to configure a custom provider, then please you will need to set the provider_class option.
+  provider :custom_provider, provider_class: CustomProvider do
+  end
+
+  # Set the preload option, to enable cache preloading for the provider
+  provider :in_memory, preload: true do
+  end
+
+  # Add parallelism for faster preloading
+  provider :in_memory, preload: { async: true } do
+  end
+
+  # Configure some keys for a provider
+  provider :in_memory do
+    setting :key1
+    setting :key2
+    setting :key3
+  end
+
+  # Configure the setting to be cacheable
+  provider :in_memory do
+    setting :key1, cache: 60 # 60 seconds
+  end
+end
+```
+
+### Preloading
+
+CloudConfig can preload all the keys configured for preload enabled providers. A cache client must be configured, otherwise
+preloading won't do anything.
+
+```ruby
+CloudConfig.configure do
+  cache_client CloudConfig::Cache::InMemory.new
+
+  provider :in_memory, preload: true do
+  end
+end
+```
+
+Call preload to cache all the keys.
+
+```ruby
+CloudConfig.preload
+```
+
+## Development
+
+It's recommended to use Docker when working with the library. Assuming Docker is installed, run
+
+    $ docker-compose run config /bin/bash
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Documentation
+
+Documentation is built using Yardoc. To build the docs, run
+
+    $ yardoc
+
+To view the documentation, run
+
+    $ yard server -r
+
+or using the docker service
+
+    $ docker-compose up yardoc
+
+The documentation is viewable in the browser at [http://localhost:8808](http://localhost:8808)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hypernova2002/cloud-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/hypernova2002/cloud-config/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CloudConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hypernova2002/cloud-config/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/cloud-config.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'lib/cloud-config/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cloud-config'
+  spec.version = CloudConfig::VERSION
+  spec.authors = ['hypernova2002']
+  spec.email = ['hypernova2002@gmail.com']
+
+  spec.summary = 'A library for dynamically reloading settings from cloud services'
+  # spec.description = "TODO: Write a longer description or delete this line."
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'parallel'
+
+  spec.add_development_dependency 'aws-sdk-ssm'
+  spec.add_development_dependency 'mock_redis'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'webrick'
+  spec.add_development_dependency 'yard'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3.8'
+services:
+  config:
+    build: .
+    stdin_open: true
+    tty: true
+    environment:
+      SSH_AUTH_SOCK: /ssh-agent
+    volumes:
+      - .:/cloud-config
+      - ~/.gitconfig:/root/.gitconfig
+      - /run/host-services/ssh-auth.sock:/ssh-agent
+    networks:
+      - cloud-config
+
+  yardoc:
+    build: .
+    command: yard server -r
+    volumes:
+      - .:/cloud-config
+    ports:
+      - 8808:8808
+    networks:
+      - cloud-config
+
+networks:
+  cloud-config:
+    name: cloud_config

data/examples/001_parameter_store.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'nokogiri'
+  gem 'aws-sdk-ssm'
+
+  gem 'cloud-config', path: '..'
+end
+
+require 'benchmark'
+require 'cloud-config/providers/aws_parameter_store'
+
+CloudConfig.configure do
+  provider :aws_parameter_store do
+    setting :parameter_store_example
+  end
+end
+
+puts 'Fetching key parameter_store_example'
+value = CloudConfig.get(:parameter_store_example)
+puts "Fetched value #{value}"

data/examples/002_parameter_store_with_cache.rb

@@ -0,0 +1,40 @@
+#! /usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'nokogiri'
+  gem 'aws-sdk-ssm'
+
+  gem 'cloud-config', path: '..'
+end
+
+require 'benchmark'
+require 'cloud-config/cache/in_memory'
+require 'cloud-config/providers/aws_parameter_store'
+
+CloudConfig.configure do
+  cache_client CloudConfig::Cache::InMemory.new
+
+  provider :aws_parameter_store do
+    setting :parameter_store_example, cache: 5
+  end
+end
+
+value = nil
+
+puts 'Fetching key parameter_store_example'
+time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
+puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+
+puts 'Fetching key parameter_store_example (cached)'
+time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
+puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+
+sleep 5
+
+puts 'Fetching key parameter_store_example'
+time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
+puts "Fetched value #{value} in #{time.real.round(5)} seconds"

data/examples/003_parameter_store_with_preload.rb

@@ -0,0 +1,38 @@
+#! /usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'nokogiri'
+  gem 'aws-sdk-ssm'
+
+  gem 'cloud-config', path: '..'
+end
+
+require 'benchmark'
+require 'cloud-config/cache/in_memory'
+require 'cloud-config/providers/aws_parameter_store'
+
+CloudConfig.configure do
+  cache_client CloudConfig::Cache::InMemory.new
+
+  provider :aws_parameter_store, preload: true do
+    setting :parameter_store_example, cache: 5
+  end
+end
+
+CloudConfig.preload
+
+value = nil
+
+puts 'Fetching key parameter_store_example (cached)'
+time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
+puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+
+sleep 5
+
+puts 'Fetching key parameter_store_example'
+time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
+puts "Fetched value #{value} in #{time.real.round(5)} seconds"