pears 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6027c30390f8c8c7eb777118ac67a2c92ab1492c9e56cbf8bfd7f0b3af7dd9b4
+  data.tar.gz: 55a01b652c8f57945d864b9b35b2a0ae974cbf434f26012541eb5a62e8fe4f36
+SHA512:
+  metadata.gz: 805d0cdae121ba3fc165de1e12177bc63eab1396af53d661652062253b85b40dec8487c7cb49e673784f3cfc4420adc7ef4cd7737f9a10b381655c4ca6e9cacd
+  data.tar.gz: c18a180c02015f9a8816f177fdfca43119552e2e5b584cace0877aceab9108a28a21ceeb1099501060599fdacbb22629ae016d5046c766e3e5b7d34886286176

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pears.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    pears (0.1.0)
+      activesupport
+      dry-configurable (>= 0.13.0)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    redis (4.5.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  byebug
+  pears!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Steven Kemp
+
+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,67 @@
+# Pears
+
+Welcome to the readme of Pears. This library is used to consume configuration
+in Ruby applications in a cascading way. It is named Pears because its a short,
+rememberable word and wasn't taken on rubygem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pears'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pears
+
+## Usage
+
+Configuration is loaded via the provider setting.
+
+
+## Terminology
+
+- A Subject is a grouping of configuration items with a single interface
+- A Subject contains at least a single "Layer" that wraps a "Provider"
+- A Provider is an adapter(YAML OR REDIS).
+- That wraps it up
+
+##### Providers:
+
+- LocalFile - read a yaml file identified by a path into a "Subject"
+- RemoteFile - read a yaml file identified by a URI into a "Subject"
+- Subscription - Read a yaml file identified by a URI as a segment and update it whenever the the provided redis channel gets an update.
+- ENV - read the ENV and overwrite keys found on lower layers of the segment. **
+- LOCO - read a loco file into a segment. **
+
+** Nice to have
+
+
+## Todo
+- Figure out if subscription should be a providerof maybe something else.
+- Add Loco as a provider.
+- Add ENV as a provider.
+- Add Redis as a provider.
+- Figure out if there is a sensible tie in with kubernetes.
+- Add support for different file-types.
+- Add different ways to trigger updates from redis subscriptions. (like hand fired events?)
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pears.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pears"
+
+# 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/pears/errors.rb

@@ -0,0 +1 @@
+class Error < StandardError; end

data/lib/pears/provider/base.rb

@@ -0,0 +1,18 @@
+module Pears
+  module Provider
+    class Base
+      attr_accessor :data
+      def has_key?(key)
+        @data.has_key? key
+      end
+
+      def each(&block)
+        @data.block(&:yield)
+      end
+
+      def [](key)
+        @data[key]
+      end
+    end
+  end
+end

data/lib/pears/provider/builder.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/module'
+
+module Pears
+  module Providers
+    class Builder
+      delegate :name, to: :subject
+
+      def initialize(subject)
+        @subject = subject
+      end
+
+      def hash
+        raise 'not yet implemented'
+      end
+
+      def loco
+        raise 'not yet implemented'
+      end
+
+      def env
+        raise 'not yet implemented'
+      end
+
+      def local_file(file_path)
+        register Provider::LocalFile.new(file_path)
+      end
+
+      def remote_file(file_url)
+        register Provider::RemoteFile.new(file_url)
+      end
+
+      def subscription &block
+        register Provider::Subscription.new(@subject.name, &block)
+      end
+
+      private
+
+      def register provider
+        return provider unless @subject.is_a? Subject
+
+        @subject.push_layer provider
+      end
+    end
+  end
+end

data/lib/pears/provider/env.rb

@@ -0,0 +1,6 @@
+module Pears
+  module Provider
+    class ENV < Base
+    end
+  end
+end

data/lib/pears/provider/hash.rb

@@ -0,0 +1,9 @@
+module Pears
+  module Provider
+    class Hash < Base
+      def initialize(hash)
+        @data = hash
+      end
+    end
+  end
+end

data/lib/pears/provider/local_file.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Pears
+  module Provider
+    # Used for loading simple YAML file locally.
+    class LocalFile < Base
+      def initialize(file_path)
+        yaml_data = File.read(file_path)
+        @data = parse_yaml(yaml_data)
+      end
+
+      private
+
+      def parse_yaml(yaml_data)
+        YAML.load(yaml_data).with_indifferent_access
+      end
+    end
+  end
+end

data/lib/pears/provider/loco.rb

@@ -0,0 +1,16 @@
+module Pears
+  module Provider
+    # Maps to a Locolize export
+    class Loco < Base
+      def initialize(api_key, url)
+        @data = fetch_from_loco(api_key, url)
+      end
+
+      private
+
+      def fetch_from_loco(api_key, url)
+        # Get config from loco
+      end
+    end
+  end
+end

data/lib/pears/provider/remote_file.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+
+module Pears
+  module Provider
+    # Fetch a yaml file via HTTP
+    class RemoteFile < LocalFile
+      def initialize(remote_url)
+        yaml_data = Net::HTTP.get(URI(remote_url))
+        @data = parse_yaml(yaml_data)
+      end
+    end
+  end
+end

data/lib/pears/provider/subscription.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'redis'
+
+module Pears
+  module Provider
+    # Config using redis subscription. This updates automatically upon Redis
+    # channel updates.
+    class Subscription < Base
+      attr_reader :subscription
+
+      def initialize(channel,
+          redis_host: Pears.config.redis_host,
+          &fetcher)
+        @channel = channel
+        @fetcher = fetcher
+
+        establish_connection(redis_host)
+        subscribe
+        reload
+      end
+
+      def reload
+        @data = @fetcher.call(Pears::Providers::Builder.new(self))
+            .data
+      end
+
+      # This seems a bit "rough" of an approach. we should check if
+      # unsubscribing can be done more gracefully.
+      def unsubscribe
+        @subscription.terminate
+      end
+
+      private
+
+      def subscribe
+        @subscription = Thread.new do
+          connection.subscribe(@channel) do |on|
+            on.message do |channel, message|
+              reload
+            end
+          end
+        end
+      end
+
+      def connection
+        @connection ||= establish_connection
+      end
+
+      def establish_connection(host='redis')
+        @connection = ::Redis.new(host: host,
+            reconnect_attempts: 10,
+            reconnect_delay: 5)
+      end
+    end
+  end
+end

data/lib/pears/provider.rb

@@ -0,0 +1,13 @@
+require_relative "provider/base"
+require_relative "provider/local_file"
+require_relative "provider/remote_file"
+require_relative "provider/subscription"
+require_relative "provider/env"
+require_relative "provider/loco"
+require_relative "provider/hash"
+require_relative "provider/builder"
+
+module Pears
+  module Provider
+  end
+end

data/lib/pears/subject.rb

@@ -0,0 +1,43 @@
+module Pears 
+  # A subject is a collection of settings.
+  # You could different Pears::Subjects in your application for different parts
+  # of its domain. for instance: application_settings, theming or translations.
+  class Subject
+    attr_reader :name
+
+    def initialize(name, *layers)
+      @name = name
+      @layers = layers
+      Pears.subjects << self
+    end
+
+    def [](key)
+      project[key]
+    end
+
+    def keys
+      project.keys
+    end
+
+    def has_key?(key)
+      project.has_key? key
+    end
+
+    def push_layer(layer)
+      @layers << layer
+    end
+
+    # Projects the layers to a hash that van be used as a single source of truth.
+    def project
+      layers.reverse.reduce(Hash.new) do |hash, layer|
+        hash.deep_merge(layer.data)
+      end
+    end
+
+    private
+
+    def layers
+      @layers
+    end
+  end
+end

data/lib/pears/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pears
+  VERSION = "0.0.1"
+end

data/lib/pears.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'dry-configurable'
+require_relative "pears/version"
+require_relative "pears/errors"
+require_relative "pears/provider"
+require_relative "pears/subject"
+
+module Pears
+  extend Dry::Configurable
+
+  setting :redis_host, default: :localhost
+
+  def self.subjects
+    @subjects ||= []
+  end
+
+
+  # This is the main way of locating a subject.
+  def self.subject(name)
+    Subject.new(name: name).tap do |subject|
+      builder = Providers::Builder.new(subject)
+      yield(builder)
+    end
+  end
+end

data/pears.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/pears/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pears"
+  spec.version       = Pears::VERSION
+  spec.authors       = ["Steven Kemp"]
+  spec.email         = ["steven@remarkgroup.Com"]
+
+  spec.summary       = "Ingest hot-swappable configuration data"
+  spec.homepage      = "https://www.rubygems.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  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 'dry-configurable', '~> 0.13.0'
+  spec.add_dependency 'activesupport', '~> 6.1.4.1'
+  spec.add_dependency 'redis', '~>4.5.1'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pears
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Kemp
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.1
+description:
+email:
+- steven@remarkgroup.Com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pears.rb
+- lib/pears/errors.rb
+- lib/pears/provider.rb
+- lib/pears/provider/base.rb
+- lib/pears/provider/builder.rb
+- lib/pears/provider/env.rb
+- lib/pears/provider/hash.rb
+- lib/pears/provider/local_file.rb
+- lib/pears/provider/loco.rb
+- lib/pears/provider/remote_file.rb
+- lib/pears/provider/subscription.rb
+- lib/pears/subject.rb
+- lib/pears/version.rb
+- pears.gemspec
+homepage: https://www.rubygems.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.rubygems.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Ingest hot-swappable configuration data
+test_files: []