pears 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c55e7f744c1a5403452f6c6d3a88246e185ce2e1abad292b66146347fac14a
-  data.tar.gz: 2bf8070b221f5bb58b843c83ff3d9a19e355f4134fbca2920622b1898a93a433
+  metadata.gz: 314b1898a9c7b3f45eeaf3f2eb34097dba27a23c36c76af9efc18a61f247a56b
+  data.tar.gz: 1a021c4464cd3daafb0a2b222824abbcd6552e3990daf40fde4f17c9cc26aafe
 SHA512:
-  metadata.gz: b0b5d6f09fe5f6c1aca571afed5f5c3576441f370ef27d67083ae7e9f98ddd270c0e55404dad2afa9c6ae0ca8f92af275504261dc3e87c6ddaa26c644d544e01
-  data.tar.gz: 940068ae86b7ba75f7290fea87d0f36b5c38d02bf39946c2bb253d469c017175307abd58e3c3ee7f10a31764e644bcd69cb0d25afdaeb51976d9c57b32ebb529
+  metadata.gz: 6893c3c466be5d1da5f9d8e3eb05900a2d6292c4be0135dc531a9ec2902ada9958760fc26b345793cb45308f064ef14efaed760667e192791da66ea9def7d00c
+  data.tar.gz: cd69dcc4d02e48a6b0a89aed4e06b3558264d6f142c553ae7efd5641905ee5a4b49bc304661fc617f8294d1e4cc88d8733f0cac89a31420e3100a58d4517cd2a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pears (0.0.7)
+    pears (0.0.8)
       activesupport
       dry-configurable (>= 0.13.0)
       redis
@@ -47,6 +47,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  ruby
 
 DEPENDENCIES
   byebug

data/README.md

@@ -22,7 +22,31 @@ Or install it yourself as:
 
 ## Usage
 
-Configuration is loaded via the provider setting.
+Examples:
+
+```ruby
+# You can load a dynamic config file like this
+dynamic_config = Pears.subject(:settings) do |provider|
+  provider.subscription do
+    provider.remote_file "https://raw.githubusercontent.com/codefresh-io/yaml-examples/master/codefresh-build-1.yml"
+  end
+end
+
+# You can "Cascade" data like this
+cascading_config = Pears.subject(:settings) do |provider|
+  provider.local_file Rails.root.join('config', 'settings.concrete.yml') # defines foo: 'foo'
+  provider.local_file Rails.root.join('config', 'settings.default.yml') # defines foo: 'bar', baz: 'baz'
+end
+
+cascading_config[:foo] # => foo
+cascading_config[:baz] # => baz
+
+# And you can combine these
+combined_config = Pears.subject(:settings) do |provider|
+  provider.subscription { provider.remote_file "https://admin/configuration.yml" }
+  provider.local_file Rails.root.join('config', 'default.yml')
+end
+```
 
 
 ## Terminology
@@ -37,20 +61,40 @@ Configuration is loaded via the provider setting.
 - 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
+You can create a custom povider like this:
+
+```ruby
+class GcloudProvider < Pears::Provider::LocalFile
+  def initialize
+    @data = parse_yaml Faraday.get(url, {}, authorization: token )
+  end
+
+  private
+
+  def url
+    'https://velogica-portal-admin.ey.r.appspot.com/settings/' \
+    "#{Rails.application.secrets.settings_file}"
+  end
+
+  def token
+    path = 'http://metadata.google.internal/computeMetadata/v1/instance/'
+
+    'Bearer ' + Faraday.get(path, {}, { metadata_flavor: 'Google' }).body
+  end
+end
+```
+
+And register it like this:
+
+```ruby
+# config/initializers/pears.rb
+Pears::Provider::Builder.enable_provider Pears::GcloudProvider
+```
 
 
 ## 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
 
@@ -58,9 +102,25 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+
+## Future
+
+- Factor subject as a distinct, non-provider entitity.
+- Add Loco as a provider.
+- Add ENV 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.
+
+We want to add the following providers:
+- ENV - read the ENV and overwrite keys found on lower layers of the segment. **
+- LOCO - read a loco file into a segment.
+- Redis - consume data drom a redis key.
+
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pears.
+Hit me up on slack, jira or Bitbucket!
 
 ## License
 

data/lib/pears/errors.rb

@@ -1 +1,5 @@
-class Error < StandardError; end
+module Pears
+  class Error < StandardError; end
+  class RedisHasLeftTheBuilding < Error; end
+  class Pears::InvalidProviderData < Error; end
+end

data/lib/pears/provider/base.rb

@@ -2,6 +2,11 @@ module Pears
   module Provider
     class Base
       attr_accessor :data
+
+      def initialize(data, on_failure: :raise)
+        @data = data
+      end
+
       def has_key?(key)
         @data.has_key? key
       end
@@ -13,6 +18,14 @@ module Pears
       def [](key)
         @data[key]
       end
+
+      private
+
+      def parse_yaml(yaml_data)
+        yaml_data = YAML.load(yaml_data)
+        raise Pears::InvalidProviderData if yaml_data.is_a? String
+        yaml_data.with_indifferent_access
+      end
     end
   end
 end

data/lib/pears/provider/local_file.rb

@@ -5,15 +5,15 @@ module Pears
   module Provider
     # Used for loading simple YAML file locally.
     class LocalFile < Base
-      def initialize(file_path)
+      def initialize(file_path,  on_failure: :raise)
         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
+      rescue Errno::ENOENT => error
+        if on_failure == :null
+          @data = {}
+        else
+          raise error
+        end
       end
     end
   end

data/lib/pears/provider/remote_file.rb

@@ -3,10 +3,17 @@ require 'net/http'
 module Pears
   module Provider
     # Fetch a yaml file via HTTP
-    class RemoteFile < LocalFile
-      def initialize(remote_url)
+    class RemoteFile < Base
+      def initialize(remote_url, on_failure: :raise)
         yaml_data = Net::HTTP.get(URI(remote_url))
         @data = parse_yaml(yaml_data)
+
+      rescue SocketError, InvalidProviderData => e
+        if on_failure == :null
+          @data = {}
+        else
+          raise e
+        end
       end
     end
   end

data/lib/pears/provider/subscription.rb

@@ -24,7 +24,7 @@ module Pears
 
         # Setup redis subscription
         establish_connection(redis_host)
-        reload
+        load_config
         subscribe
       end
 
@@ -32,7 +32,7 @@ module Pears
         @channel ||= @builder.subject_name
       end
 
-      def reload
+      def load_config
         @builder.freeze_layers do
           @data = @fetcher.call.data
         end
@@ -50,7 +50,7 @@ module Pears
         @subscription = Thread.new do
           connection.subscribe(channel) do |on|
             on.message do |channel, message|
-              reload
+              load_config
             end
           end
           puts "Redis connection died!"

data/lib/pears/version.rb

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

data/pears.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Steven Kemp"]
   spec.email         = ["steven@remarkgroup.com"]
 
-  spec.summary       = "Ingest hot-swappable configuration data"
-  spec.homepage      = "https://www.rubygems.com"
+  spec.summary       = "An overly complicated library for juggling configuration data."
+  spec.homepage      = "https://bitbucket.org/ivaldi/rubygems-pears/src/master/"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.0.1"
+  spec.required_ruby_version = ">= 2.7.4"
 
   spec.metadata["homepage_uri"] = spec.homepage
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pears
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Steven Kemp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -97,11 +97,11 @@ files:
 - lib/pears/subject.rb
 - lib/pears/version.rb
 - pears.gemspec
-homepage: https://www.rubygems.com
+homepage: https://bitbucket.org/ivaldi/rubygems-pears/src/master/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.rubygems.com
+  homepage_uri: https://bitbucket.org/ivaldi/rubygems-pears/src/master/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,15 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.1
+      version: 2.7.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Ingest hot-swappable configuration data
+summary: An overly complicated library for juggling configuration data.
 test_files: []