consul_application_settings 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abc7a1661131160a981373791ccc8ac3a48323283803b32f04a866ae33d3cd2
-  data.tar.gz: f6c70feae5652f55c564a98df789518efe4e3980ded79c09f51c7429811444b6
+  metadata.gz: b20ecf9e1eb2ea05e41f729b69082093305d3ce5291d8fb45a64f185ba8ae44f
+  data.tar.gz: ce5d16eb80ae0a9c0be78dda05d06e350546328d737ae1dd65309120f17fa814
 SHA512:
-  metadata.gz: 20fd00d62bbb2c98fcb4566fe505d67b208190c6bf7b5240520c410d11822252caad6b5574d08a7603f0c5400d75dc80d4b566c1524bd8181ae912fb5d6d3d48
-  data.tar.gz: a0d0d0ed7fbdb672bb4252558875d01638d78fb4a92c5179f661192fc4125db47800aff3c6b27b1a185f85cde38c356f096fc6ee1ee09b1c05f24c8718dd6abe
+  metadata.gz: eac2795525ed07225d749c836781c5f9bebdfcaa55a8490d4cdca4ce2463db3130cd94e081cd87bd808743d7d1acf29729ccb5002000d5efc79a76b87a57bc0a
+  data.tar.gz: ed28b56badd89cbf5097ac4d061eadd43e7aa1da37aefec1693d5b17b4bb78996e9cc8c9f4b38564b6c0383ea77ac65f89c8b66bb4e7ba4af8c7e8c7820dc2d7

data/Gemfile.lock

@@ -24,7 +24,7 @@ GEM
       ast (~> 2.4.0)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -62,7 +62,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   consul_application_settings!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.66)
   rubocop-rspec (~> 1.32.0)

data/README.md

@@ -23,7 +23,7 @@ Example use cases:
 
 Gem reads any particular setting from consul and if it is missing tries to find value in YAML defaults file
 
-**NOTE** Consul is requested every time you query the settings. Defaults YAML file loaded in memory and not changing.
+**NOTE** Consul is requested every time you query the settings. Defaults YAML file is loaded in memory and is not changing.
 
 ## Installation
 
@@ -40,13 +40,17 @@ gem 'consul_application_settings'
 At the load of application: 
 ```ruby
 ConsulApplicationSettings.configure do |config|
-  # Specify path to defaults file
-  config.defaults = Rails.root.join('config/settings.yml')
-  # Specify namespace to consul settings
-  config.namespace = 'staging/my_cool_app'
+  # Specify path to the base settings YML. Default: 'config/application_settings.yml' 
+  config.base_file_path = Rails.root.join('config/my_settings.yml')
+  # Specify path to the local settings YML, which overrides the base file. Default: 'config/application_settings.local.yml'
+  config.local_file_path = Rails.root.join('config/my_settings.local.yml')
+  # Specify whether exceprion should be thrown on Consul connection errors. Default: false
+  config.disable_consul_connection_errors = true
 end
 
 APP_SETTINGS = ConsulApplicationSettings.load
+# Specify path to settings both in YML files and Consul
+AUTH_SETTIGNS = ConsulApplicationSettings.load('authentication')
 ```
 
 **NOTE** For rails you can add this code to custom initializer `console_application_settings.rb` in `app/config/initializers`
@@ -55,7 +59,7 @@ APP_SETTINGS = ConsulApplicationSettings.load
 
 ### Settings structure
 
-Assuming your defaults file in repository `config/settings.yml` looks like:
+Assuming your defaults file in repository `config/application_settings.yml` looks like:
 ```yaml
 staging:
   my_cool_app:
@@ -98,15 +102,13 @@ Anywhere in your code base, after initialization, you can use
 previously loaded settings to query any key by full path
 
 ```ruby
-APP_SETTINGS.app_name                           # "MyCoolApp"
+APP_SETTINGS['app_name']                           # "MyCoolApp"
 APP_SETTINGS.get(:hostname)                     # "https://mycoolapp.com"
 
 APP_SETTINGS.get('integrations/database/user')  # "app"
 APP_SETTINGS['integrations/slack/enabled']      # true
 ```
 
-**NOTE** Gem is pulling settings from consul with namespace but ignores namespace for defaults
-
 ### Nested settings
 
 Assuming some part of your code needs to work with smaller part of settings - 
@@ -114,36 +116,30 @@ gem provides interface to avoid duplicating absolute path
 
 ```ruby
 # You can load subsettings from root object
-db_settings = APP_SETTINGS.load_from('integrations/database')
-db_settings.domain                  # "194.78.92.19"
-db_settings['user']                 # "app"
-
-# You can load subsettings from subsettings
-integrations_settings = APP_SETTINGS.load_from('integrations')
-slack_settings = integrations_settings.load_from('slack')  
-slack_settings.enabled              # true
-slack_settings.get('webhook_url')   # "https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX"
+db_settings = APP_SETTINGS.load('integrations/database')
+db_settings.get(:domain)                  # "194.78.92.19"
+db_settings['user']                       # "app"
 ``` 
 
 ### Gem Configuration
 You can configure gem with block:
 ```ruby
 ConsulApplicationSettings.configure do |config|
-  config.namespace = 'staging/my_cool_app'
+  config.local_file_path = 'config/config.yml'
 end
 ```
 or one option at a time
 ```ruby
-ConsulApplicationSettings.config.namespace = 'staging/my_cool_app'
+ConsulApplicationSettings.config.local_file_path = 'config/config.yml'
 ```
 
 All Gem configurations
 
-| Configuration                    | Required | Default | Type    | Description                                                                  |
-|----------------------------------|----------|---------|---------|------------------------------------------------------------------------------|
-| defaults                         | yes      |         | String  | Path to the file with default settings                                       |
-| namespace                        | no       |         | String  | Base path to read settings from in consul and defaults                       |
-| disable_consul_connection_errors | no       | false   | Boolean | Do not raise exception when consul is not available (useful for development) |
+| Configuration                    | Required | Default | Type    | Description                                                                                                  |
+|----------------------------------|----------|-----------------------------------------|---------|------------------------------------------------------------------------------|
+| base_file_path                   | no       | 'config/application_settings.yml'       | String  | Path to the file with base settings                                          |
+| local_file_path                  | no       | 'config/application_settings.local.yml' | String  | Path to the file with local settings overriding the base settings            |
+| disable_consul_connection_errors | no       | true                                    | Boolean | Do not raise exception when consul is not available (useful for development) |
 
 ## Development
 

data/consul_application_settings.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'diplomat', '~> 2.1.3'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.66'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.32.0'

data/lib/consul_application_settings.rb

@@ -1,11 +1,11 @@
 require 'consul_application_settings/version'
 require 'consul_application_settings/configuration'
-require 'consul_application_settings/defaults'
-require 'consul_application_settings/options'
+require 'consul_application_settings/consul_provider'
+require 'consul_application_settings/file_provider'
+require 'consul_application_settings/settings_provider'
 require 'consul_application_settings/utils'
-require 'diplomat'
 
-# Main class used to configure defaults file path and load initial settings
+# The gem provides possibility to load settings from Consul and automatically fall back to data stored in file system
 module ConsulApplicationSettings
   class Error < StandardError; end
 
@@ -16,19 +16,11 @@ module ConsulApplicationSettings
 
   self.config ||= ConsulApplicationSettings::Configuration.new
 
-  class << self
-    def configure
-      yield(config)
-      self.defaults = ConsulApplicationSettings::Defaults.read(config.defaults_path)
-    end
-
-    def load_from(path)
-      settings_path = ConsulApplicationSettings::Utils.generate_path(config.namespace, path)
-      ConsulApplicationSettings::Options.new(settings_path, defaults)
-    end
+  def self.configure
+    yield(config)
+  end
 
-    def load
-      load_from('')
-    end
+  def self.load(path = '')
+    SettingsProvider.new(path, config)
   end
 end

data/lib/consul_application_settings/configuration.rb

@@ -1,14 +1,14 @@
 module ConsulApplicationSettings
   # All gem configuration settings
   class Configuration
-    # Required attributes
-    attr_accessor :defaults_path
-    # Optional attributes
-    attr_accessor :namespace
-    attr_accessor :disable_consul_connection_errors
+    DEFAULT_BASE_FILE_PATH = 'config/application_settings.yml'.freeze
+    DEFAULT_LOCAL_FILE_PATH = 'config/application_settings.local.yml'.freeze
+    attr_accessor :base_file_path, :local_file_path, :disable_consul_connection_errors
 
     def initialize
-      self.namespace = ''
+      @base_file_path = DEFAULT_BASE_FILE_PATH
+      @local_file_path = DEFAULT_LOCAL_FILE_PATH
+      @disable_consul_connection_errors = true
     end
   end
 end

data/lib/consul_application_settings/consul_provider.rb

@@ -0,0 +1,33 @@
+require 'diplomat'
+
+module ConsulApplicationSettings
+  # Provides access to settings stored in Consul
+  class ConsulProvider
+    def initialize(base_path, config)
+      @base_path = base_path
+      @config = config
+    end
+
+    def get(path)
+      value = fetch_value(path)
+      ConsulApplicationSettings::Utils.cast_consul_value(value)
+    end
+
+    private
+
+    def fetch_value(path)
+      full_path = generate_full_path(path)
+      Diplomat::Kv.get(full_path, {}, :return)
+    rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
+      raise e unless disable_consul_connection_errors?
+    end
+
+    def generate_full_path(path)
+      ConsulApplicationSettings::Utils.generate_path(@base_path, path)
+    end
+
+    def disable_consul_connection_errors?
+      @config.disable_consul_connection_errors
+    end
+  end
+end

data/lib/consul_application_settings/file_provider.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+module ConsulApplicationSettings
+  # Provides access to settings stored in file system with support of base and local files
+  class FileProvider
+    def initialize(base_path, config)
+      @base_path = base_path
+      @config = config
+      load
+    end
+
+    def get(path)
+      read_path(path).clone
+    end
+
+    private
+
+    def load
+      base_yml = read_yml(base_file_path)
+      local_yml = read_yml(local_file_path)
+      @data = DeepMerge.deep_merge!(local_yml, base_yml, preserve_unmergeables: false, overwrite_arrays: true,
+                                                         merge_nil_values: true)
+    end
+
+    def base_file_path
+      @config.base_file_path
+    end
+
+    def local_file_path
+      @config.local_file_path
+    end
+
+    def read_yml(path)
+      return {} unless File.exist?(path)
+
+      YAML.safe_load(IO.read(path))
+    rescue Psych::SyntaxError, Errno::ENOENT => e
+      raise ConsulApplicationSettings::Error, "Cannot read settings file at #{path}: #{e.message}"
+    end
+
+    def read_path(path)
+      full_path = ConsulApplicationSettings::Utils.generate_path(@base_path, path)
+      parts = ConsulApplicationSettings::Utils.decompose_path(full_path)
+      parts.reduce(@data, &method(:read_value))
+    end
+
+    def read_value(hash, key)
+      raise ConsulApplicationSettings::Error, 'reading arrays not implemented' if hash.is_a? Array
+      return {} if hash.nil?
+
+      hash.fetch(key.to_s)
+    end
+  end
+end

data/lib/consul_application_settings/settings_provider.rb

@@ -0,0 +1,16 @@
+module ConsulApplicationSettings
+  # Provides access to settings stored in Consul or in file system
+  class SettingsProvider
+    def initialize(base_path, config)
+      @consul_provider = ConsulProvider.new(base_path, config)
+      @file_provider = FileProvider.new(base_path, config)
+    end
+
+    def get(path)
+      consul_value = @consul_provider.get(path)
+      !consul_value.nil? && consul_value != '' ? consul_value : @file_provider.get(path)
+    end
+
+    alias [] get
+  end
+end

data/lib/consul_application_settings/version.rb

@@ -1,3 +1,3 @@
 module ConsulApplicationSettings
-  VERSION = '0.1.4'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul_application_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,8 +136,9 @@ files:
 - consul_application_settings.gemspec
 - lib/consul_application_settings.rb
 - lib/consul_application_settings/configuration.rb
-- lib/consul_application_settings/defaults.rb
-- lib/consul_application_settings/options.rb
+- lib/consul_application_settings/consul_provider.rb
+- lib/consul_application_settings/file_provider.rb
+- lib/consul_application_settings/settings_provider.rb
 - lib/consul_application_settings/utils.rb
 - lib/consul_application_settings/version.rb
 homepage: https://github.com/matic-insurance/consul_application_settings

data/lib/consul_application_settings/defaults.rb

@@ -1,43 +0,0 @@
-require 'yaml'
-
-module ConsulApplicationSettings
-  # Reading default file from YAML file and providing interface to query them
-  class Defaults
-    attr_reader :contents
-
-    def initialize(hash)
-      @contents = hash
-    end
-
-    def get(name)
-      read_path(name, contents).clone
-    end
-
-    def load_from(path)
-      keys = ConsulApplicationSettings::Utils.decompose_path(path)
-      new_defaults = keys.reduce(contents) { |hash, key| read_path(key, hash, {}) }
-      self.class.new(new_defaults)
-    end
-
-    def self.read(path)
-      new YAML.safe_load(IO.read(path))
-    rescue Psych::SyntaxError, Errno::ENOENT => e
-      raise ConsulApplicationSettings::Error, "Cannot read defaults file at #{path}: #{e.message}"
-    end
-
-    private
-
-    def read_path(path, hash, default = nil)
-      parts = ConsulApplicationSettings::Utils.decompose_path(path)
-      result = parts.reduce(hash, &method(:read_value))
-      result || default
-    end
-
-    def read_value(hash, key)
-      raise ConsulApplicationSettings::Error, 'reading arrays not implemented' if hash.is_a? Array
-      return {} if hash.nil?
-
-      hash.fetch(key.to_s)
-    end
-  end
-end

data/lib/consul_application_settings/options.rb

@@ -1,53 +0,0 @@
-require 'json'
-
-module ConsulApplicationSettings
-  # Reads settings from consul or ask defaults for value
-  class Options
-    attr_reader :path, :defaults
-
-    def initialize(path, defaults)
-      @path = path
-      @defaults = defaults.load_from(path)
-    end
-
-    def load_from(new_path)
-      full_path = ConsulApplicationSettings::Utils.generate_path(path, new_path)
-      self.class.new(full_path, defaults)
-    end
-
-    def get(name)
-      consul_value = key_value(name)
-      if consul_value.nil? || consul_value.empty?
-        defaults.get(name)
-      else
-        ConsulApplicationSettings::Utils.cast_consul_value(consul_value)
-      end
-    end
-
-    def [](name)
-      get(name)
-    end
-
-    # rubocop:disable Style/MethodMissingSuper
-    def method_missing(name, *_args)
-      get(name)
-    end
-    # rubocop:enable Style/MethodMissingSuper
-
-    def respond_to_missing?(_name)
-      true
-    end
-
-    private
-
-    def key_value(name)
-      Diplomat::Kv.get(key_path(name), {}, :return)
-    rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
-      raise e unless ConsulApplicationSettings.config.disable_consul_connection_errors
-    end
-
-    def key_path(name)
-      ConsulApplicationSettings::Utils.generate_path(path, name)
-    end
-  end
-end