shared-settings-ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 514468c693f649ca7fc63e9f40b45e1da6da1a34768160e7abc1fd2eccfc79e7
+  data.tar.gz: e784afc4cf23680497861a254314a0adc5c04aea196102a641cc837d71ce40ed
+SHA512:
+  metadata.gz: '068aa5940b764bb5b147a1a30ce7b3f917ecfa507bbd7519547cd13c2936a6950e16659958813051a8a68580a191feac7b9cef0fdd005d877d25d076b46b40a5'
+  data.tar.gz: 623a899f857eb39602e4d7999410f818e10fcde718c95c4e848c9829eba859ca51ff8e593af43820456b7dc9d08c445df07dd321171b4ac42f04747661813ed9

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+name: Ruby CI
+
+on: push
+
+jobs:
+  test:
+    name: Build and test
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Check linting
+      run: bundle exec rubocop
+
+    - name: Run tests
+      run: bundle exec rake test
+      env:
+        # Not actually secret but keeps this file neat
+        SHARED_SETTINGS_KEY: ${{ secrets.SHARED_SETTINGS_KEY }}

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Naming/FileName:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec name: 'shared-settings'
+gemspec name: 'shared-settings-ui'
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'
+gem 'redis', '~> 4.0'
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    shared-settings (0.1.0)
+    shared-settings-ui (0.1.0)
+      rack (>= 2.0, < 3)
+      shared-settings (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.2.2)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.4.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  redis (~> 4.0)
+  rubocop
+  shared-settings!
+  shared-settings-ui!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kieran Eglin
+
+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,154 @@
+# Shared Settings (Ruby)
+
+Shared Settings is a simple library for managing runtime settings in Ruby with optional support for encryption and Elixir.
+
+Heavily inspired by [Fun with Flags][fwf] and [Flipper][flipper].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shared-settings'
+# Optional
+gem 'shared-settings-ui'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install shared-settings
+    $ gem install shared-settings-ui
+    
+This Gem depends on Redis for the default adapter so ensure that the Redis gem is also installed and configured.
+
+Once installed, the Gem must be configured.  This would normally exist as a file within `config/initializers` if you're using Rails.
+
+```ruby
+@client = Redis.new
+@adapter = SharedSettings::Persistence::Redis.new(@client)
+
+SharedSettings.configure do |config|
+  config.default { SharedSettings.new(@adapter) }
+  # Optional. Can be generaed with `SharedSettings::Utilities::Encryption.generate_aes_key`
+  # Store this somewhere secure out of VCS
+  config.encryption_key = '...'
+end
+```
+
+The optional UI works with any Rack-based webserver. Assuming you're using Rails, set up your `routes.rb` like so:
+
+```ruby
+mount SharedSettings::UI.app, at: '/shared-settings'
+```
+
+This doesn't provide any form of protection - anyone could visit this URL.  To add something like basic auth, you can pass a block like so:
+
+```ruby
+shared_settings_app = SharedSettings::UI.app do |builder|
+  builder.use Rack::Auth::Basic do |username, password|
+    # Perform validation
+  end
+end
+
+mount shared_settings_app, at: '/shared-settings'
+```
+
+Elixir support is provided by the [shared-settings-ex][ss-ex] library.
+
+## Why "shared" settings?
+
+The intention for this library is to also create an [accompanying Elixir Library][ss-ex] which uses the same storage adapter, format, and UI found here.
+
+This means that a Rails app could change a runtime setting in an Elixir app and vice-versa.  They would also share a single UI dashboard if configured, allowing a one-stop location to manage parallel apps or to help migration efforts. Of course, this library could be used with Elixir or Ruby individually.
+
+The API/storage conventions are designed to be simple enough that additional libraries in other languages (eg: Go) could be created to allow further interop between applications as long as there was a shared data source.
+
+## Encryption
+
+Encryption is implemented as AES256.  If you choose to provide an encryption key, specified setting values within your storage adapter will be encrypted.  Nothing else about the setting, including its name, will be encrypted.  Once an encrypted setting is requested via `get` it's automatically decrypted so the plaintext value is returned.
+
+```ruby
+SharedSettings.put(:client_id, 'supersecret', encrypt: true)
+SharedSettings.get(:client_id) # => 'supersecret'
+```
+
+## Usage
+
+The API is quite simple.  For most cases, you have `put`, `get`, `delete`, and `exists?`.  
+
+There is also `all` which returns all raw settings, but this is primarily to support UI.
+
+### Supported Types
+
+At a high level, the currently supported types are `string`, `boolean`, `number`, and `range`. `number` includes negative numbers as well as floats. `range`s are inclusive.
+
+All types are serialized as strings to be held within the storage adapter.
+
+### Put
+
+`put` takes a name as well as a value with a supported type. It returns the name of the setting.
+
+```ruby
+SharedSettings.put(:signups_enabled, true)
+SharedSettings.put(:referral_bonus, 52, encrypt: true)
+```
+
+`put` will overwrite old settings if the provided name already exists.  This means there's no method for updating - replacement is the way to go:
+
+```ruby
+SharedSettings.put(:confusing_setting, true)
+SharedSettings.put(:confusing_setting, 2..7)
+```
+
+### Get
+
+`get` takes the name of a setting and returns the value.  A `SettingNotFoundError` is returned if the setting doesn't exist.
+
+```ruby
+ranks = SharedSettings.get(:permitted_ranks)
+```
+
+### Delete
+
+`delete` takes the name of a setting and removes it from storage.  It's safe to call delete on settings that may not exist.
+
+```ruby
+SharedSettings.delete(:contrived_example)
+SharedSettings.delete(:not_real)
+```
+
+### Exists?
+
+`exists?` takes the name of a setting and returns a boolean reflecting its existence.
+
+```ruby
+SharedSettings.exists?(:signups_enabled)
+```
+
+### All
+
+`all` returns all stored settings in their raw form.  This is mainly used by the accompanying UI library but it could also be used to ensure all needed flags exist at boot time.
+
+```ruby
+SharedSettings.all
+```
+
+## License
+
+MIT License
+
+Copyright 2021
+
+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.
+
+[fwf]: https://github.com/tompave/fun_with_flags
+[flipper]: https://github.com/jnunemaker/flipper
+[ss-ex]: https://github.com/kieraneglin/shared-settings-ex

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_helper'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks name: 'shared-settings'
+Bundler::GemHelper.install_tasks name: 'shared-settings-ui'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shared-settings'
+require 'shared-settings-ui'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shared-settings-ui.rb

@@ -0,0 +1,3 @@
+# This file uses kebab-case to match the name of the Gem for autoloading purposes
+
+require 'shared_settings/ui'

data/lib/shared-settings.rb

@@ -0,0 +1,57 @@
+# This file uses kebab-case to match the name of the Gem for autoloading purposes
+
+require 'forwardable'
+
+require 'shared_settings/version'
+require 'shared_settings/setting'
+require 'shared_settings/instance'
+require 'shared_settings/configuration'
+require 'shared_settings/serialized_setting'
+
+require 'shared_settings/persistence/redis'
+
+require 'shared_settings/utilities/base16'
+require 'shared_settings/utilities/encryption'
+
+module SharedSettings
+  class SettingNotFoundError < StandardError; end
+
+  extend self
+  extend Forwardable
+
+  def new(storage_adapter)
+    SharedSettings::Instance.new(storage_adapter)
+  end
+
+  def configure
+    yield configuration if block_given?
+  end
+
+  def configuration
+    @configuration ||= SharedSettings::Configuration.new
+  end
+
+  def instance
+    configuration.default
+  end
+
+  def exists?(name)
+    get(name)
+
+    true
+  rescue SettingNotFoundError
+    false
+  end
+
+  def_delegators :instance,
+    :put,
+    :get,
+    :all,
+    :delete
+
+  private
+
+  def configuration=(configuration)
+    @configuration = configuration
+  end
+end

data/lib/shared_settings/configuration.rb

@@ -0,0 +1,17 @@
+module SharedSettings
+  class Configuration
+    attr_accessor :encryption_key
+
+    def initialize
+      @default = -> { raise ArgumentError, 'Default configuration must be set' }
+    end
+
+    def default(&block)
+      if block_given?
+        @default = block
+      else
+        @default.call
+      end
+    end
+  end
+end