briefbag 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c807fdac63eab78442377c2b2765ae65bb6e0f3436a3cc8ff6b20b5de6ef6c
-  data.tar.gz: 9adb0fe34b1d23af84ee18d75fb1813a5ae4d8e52b7d2987ff1df5bbd0e0cd0c
+  metadata.gz: e6e6bf248cfd0d804741a17696bf4b3253f4f33e402f734bc44acf2cfe6898c8
+  data.tar.gz: 2a705576cdc9171f56756b0087bbde902ae410f8a70976cd08f07f6eb19b756e
 SHA512:
-  metadata.gz: b9436d0adc2e01f38710bfc6c0ecb1a6dd1bddc27c296e3ad3b54d23c06543a51cb83cbeb8a86251a141d6ee642a7550e5f7148e39e8a5b15afcba84aa4290b6
-  data.tar.gz: b24fa250adb528144c68e6f1fdc04bda1170e85ba6980032d67993a2a40c123f9e46baf54323ee83e013337da258de383c8fce420243ba5fc9a8efe8eb384fc6
+  metadata.gz: 1d9d22f500079df4041e66b27f3342f4e93531f69fd616a8357f0948ca9b1b12736051901f076e0dd16134c1dec1cd0f71447ac6bc068b62d9339ccfd15fcef5
+  data.tar.gz: f01c619192ddf5cb69bfb943d8b86b9de4d179afbd00a03125db64a356b8ba47d6c551cb1a504f448da730b642f0b9271aaa27317e2f11c516fa032509a9b0dd

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1.2
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle:  single_quotes
+
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.2@briefbag
+2.7.5@briefbag

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## 0.0.1 - 2023-01-22
 
 * Briefbag was born
+
+## 1.0.0 - 2023-02-24
+
+* Briefbag was born in ruby 2.7.5
+
+## 2.0.1 - 2023-01-22
+
+* update gem Briefbag to new ruby 3.1.2 

data/Gemfile

@@ -6,8 +6,3 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in briefbag.gemspec
 gemspec
-
-gem 'anyway_config'
-gem 'diplomat'
-gem 'hash_to_struct'
-gem 'rainbow'

data/README.md

@@ -0,0 +1,135 @@
+# Briefbag
+
+[![Gem Version](https://badge.fury.io/rb/briefbag.svg)](https://badge.fury.io/rb/dadatas)
+[![Gem](https://img.shields.io/gem/dt/briefbag.svg)](https://rubygems.org/gems/briefbag)
+
+
+## Application config management library.
+
+### What's Briefbag for?
+
+Briefbag allows any ruby application to assemble configs `.yml` files, into single `.yml` file for the `development` environment 
+or use interact with [Consul's](http://www.consul.io/) distributed key value store
+
+### Does it work in rails?
+Yup! In fact, we're using it in all of our rails production apps instead
+
+### How it is work
+#### Overview
+It works quite easily,
+you are a developer and work in the `development` environment, it is more convenient for you to use one `.yml` file with configuration. 
+No more `.yml` zoos, or ENV variables -  all in one place.
+You just create constant (for example usage) in your application `APPLICATION_CONFIG` and forward.
+refer to the desired config as an object. To do this, under the hood, I use [Struct](https://ruby-doc.org/core-2.7.5/Struct.html)
+therefore, the appeal becomes simpler: `APPLICATION_CONFIG.database.port`
+
+And what if you need to share the configuration file with colleagues, or use this design at other stands - `production` environment. 
+Consul comes to the rescue. Thanks to him, you can act config and undress in different stands.
+Generation `.yml` file there are 2 rake tasks: rake
+
+- **rake settings:consul2yml** -  Get key/value variables from consul to `.yml` file
+- **rake settings:template2yml** - Generate basic `.yml` for your app. Based on it, you can fill it with any values
+
+
+Need add to you Rakefile
+```ruby
+
+require 'briefbag'
+
+spec = Gem::Specification.find_by_name 'briefbag'
+load "#{spec.gem_dir}/lib/tasks/settings.rake"
+```
+
+#### Notifications:
+If you use `.yml` .You will see: 
+> NOTICE! Your app using configs from yml file
+
+If you use Consul. You will see: 
+
+> NOTICE! Your app using configs from consul now
+If you want to use local configs need to create config file. Just run `rake settings:consul2yml`
+
+
+If you don't have access to consul (for example VPN or bad connections)
+You will see:
+>ALARM! You try are get consul config, but not connection to consul.
+Please! connect to VPN or check consul configuration
+
+## Installation
+Adding to your project:
+
+```ruby
+gem 'briefbag'
+```
+Then run `bundle install`
+
+or 
+
+Or install it yourself as:
+`gem install briefbag`
+
+# Usage
+> params to input:
+- **consul_host(string)** -  *(required)* Consul service ip or host.
+- **consul_port(integer)** - *(optional)* Default value ${443}. Consul service port.
+- **consul_token(string)** - *(optional)* If you use ACL Token.
+- **consul_folder(string)** *(required)* Name config folder in consul.
+- **environment(string)** - *(optional)* Default value ${development}. Environment in consul.
+- **config_name(string)** - *(optional)* Default value ${application}. Config name in your application for example path to yml file:  'config/application.yml' you need use name 'application'.
+
+```ruby
+require 'briefbag'
+
+params_config = {
+  consul_host: 'consul.example.com',
+  consul_port: 8500,
+  consul_token: '233b604b-b92e-48c8-a253-5f11514e4b50',
+  consul_folder: 'briefbag',
+  environment: 'test', 
+  config_name: 'some_config' 
+}
+configs = Briefbag::Configuration.new(params_config).call
+=> #<struct database=#<struct adapter="postgresql", host="localhost", port=5432, database="tets_dev", username="postgres", password=""... 
+> configs.database
+=> #<struct adapter="postgresql", host="localhost", port=5432, database="tets_dev", username="postgres", password=""... 
+> configs.database.username
+=> "postgres"
+
+```
+example yml file: 
+
+```yml
+---
+development:
+  database:
+    adapter: postgresql
+    host: localhost
+    port: 5432
+    database: tets_dev
+    username: postgres
+    password: ''
+    schema_search_path: public
+    encoding: utf8
+    pool: 30
+  puma:
+    port: 3000
+    workers: 0
+    min_threads: 1
+    max_threads: 4
+    max_ram: 4048
+    restart_frequency: 21600
+  sidekiq:
+    login: admin
+    password: admin
+    queues:
+      default: 2
+    concurrency: 2
+```
+
+## Contributions
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MichaelHitchens/briefbag.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/briefbag.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'Briefbag manage your config'
   spec.homepage = 'https://github.com/MichaelHitchens/briefbag'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.4.2'
+  spec.required_ruby_version = '>= 2.7.5'
 
   spec.metadata = {
     'homepage_uri' => spec.homepage,
@@ -33,15 +33,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Requires Ruby faraday to http request
-  spec.add_dependency 'anyway_config', '~> 1.4.4'
-  spec.add_dependency 'diplomat', '~> 2.4.4'
-  spec.add_dependency 'hash_to_struct', '~> 1.0.0'
+  spec.add_dependency 'anyway_config', '~> 2.3.1'
+  spec.add_dependency 'diplomat', '>=2.6.4'
+  spec.add_dependency 'hash_to_struct', '>=1.0.0'
   spec.add_dependency 'rainbow', '~> 3.1.1'
+  spec.add_dependency 'rake', '~> 13.0.6'
 
-  spec.add_development_dependency 'bundler', '~> 1.17.3'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'faker', '~> 2.12.0'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  spec.add_development_dependency 'faker', '~> 3.1.1'
   spec.add_development_dependency 'rake', '~> 13.0.6'
   spec.add_development_dependency 'rspec', '~> 3.12.0'
-  spec.add_development_dependency 'rubocop', '~> 1.12.1'
+  spec.add_development_dependency 'rubocop', '~> 1.44.1'
 end

data/lib/briefbag/configuration.rb

@@ -3,7 +3,6 @@
 require 'briefbag/diplomat'
 require 'anyway_config'
 require 'rainbow'
-require 'byebug'
 require 'hash_to_struct'
 
 module Briefbag
@@ -11,12 +10,12 @@ module Briefbag
     attr_reader :config, :config_name
 
     MESSAGES = {
-      notice_yml: 'NOTICE! Your app using configs from yml file',
-      notice_consul: 'NOTICE! Your app using configs from consul now
-        If you want to use local configs need to create config file. Just run `rake settings:consul2yml`',
-      error_consul: 'ALARM! You try are get consul config, but not connection to consul.
+      notice_yml: 'NOTICE! Your app is using configs from yml file',
+      notice_consul: 'NOTICE! Your app is using configs from consul now
+        If you want to use local configs. you need to create config file. Just run `rake settings:consul2yml`',
+      error_consul: 'ALARM! You are trying to get consul config, but you have no consul connection.
         Please! connect to VPN or check consul configuration',
-      error_yml: "ALARM! You try are using local schema connection! But file configuration doesn't exist!
+      error_yml: "ALARM! You are trying to use local schema connection! But file configuration doesn't exist!
         Just run `rake settings:consul2yml`"
     }.freeze
 
@@ -26,12 +25,12 @@ module Briefbag
     end
 
     def call
-      diplomat = Briefbag::Diplomat.new(config).call
-
-      return file_config if file_exist? && config[:environment].eql?('development')
+      return file_config if file_exist?
 
-      return diplomat_config(diplomat[:consul_data]) if diplomat.success?
+      diplomat = Briefbag::Diplomat.new(config).call
       return Briefbag.aborting_message(MESSAGES[:error_consul]) unless diplomat.success?
+
+      diplomat_config(diplomat[:consul_data])
     rescue StandardError
       return Briefbag.aborting_message(MESSAGES[:error_yml]) unless file_exist?
 
@@ -45,14 +44,16 @@ module Briefbag
 
     def file_config
       Briefbag.warning_message(MESSAGES[:notice_yml])
-      data = Anyway::Config.for(:application)[config[:environment]]
-      HashToStruct.struct(data)
+      Anyway::Settings.default_config_path = 'config'
+      data = Anyway::Config.for(config_name.to_sym, env_prefix: config[:environment])
+
+      return HashToStruct.struct(data.deep_symbolize_keys) if defined?(Rails)
+
+      HashToStruct.struct(symbolize_all_keys(data))
     end
 
     def file_exist?
-      return true if File.exist?(yaml_file)
-
-      false
+      @file_exist ||= File.exist?(yaml_file)
     end
 
     def yaml_file
@@ -62,5 +63,16 @@ module Briefbag
     def local_keys
       @local_keys ||= YAML.safe_load(File.read(yaml_file))[environment].keys
     end
+
+    def symbolize_all_keys(h) # rubocop:disable  Naming/MethodParameterName
+      if h.is_a? Hash
+        h.transform_keys!(&:to_sym)
+        h.each_value do |val|
+          val.each { |v| symbolize_all_keys(v) } if val.is_a? Array
+          symbolize_all_keys(val)
+        end
+      end
+      h
+    end
   end
 end

data/lib/briefbag/diplomat.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 require 'diplomat'
-require 'byebug'
 require 'socket'
 
 module Briefbag
   class Diplomat
     Result = Struct.new(:success?, :errors, :consul_data)
-    attr_reader :config, :consul_folder
+    attr_reader :config, :consul_folder, :host, :port
 
     def initialize(config)
       @config = config
+      @host = config[:consul_host]
+      @port = config[:consul_port].nil? ? 443 : config[:consul_port]
       @consul_folder = "#{config[:environment]}/#{config[:consul_folder]}"
     end
 
@@ -22,7 +23,9 @@ module Briefbag
     def configuration
       ::Diplomat.configure do |conf|
         # Set up a custom Consul URL
-        conf.url = url_build(config[:consul_host], config[:consul_port])
+        conf.url = url_build
+        break if config[:consul_token].nil?
+
         conf.options = {
           ssl: { version: :TLSv1_2 }, # rubocop:disable Naming/VariableNumber
           headers: { 'X-Consul-Token' => config[:consul_token] }
@@ -63,12 +66,12 @@ module Briefbag
       Result.new(false, [e], nil)
     end
 
-    def url_build(host, port)
+    def url_build
       Object.const_get("URI::HTTP#{port.eql?(443) ? 'S' : ''}").build(host: host, port: port)
     end
 
     def check_consul
-      Timeout.timeout(1) { TCPSocket.new(config[:consul_host], config[:consul_port]) }
+      Timeout.timeout(1) { TCPSocket.new(host, port) }
       Result.new(true, nil, nil)
     rescue Timeout::Error => e
       Result.new(false, [e], nil)

data/lib/briefbag/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Briefbag
+  class Railtie < Rails::Railtie
+    railtie_name :briefbag
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/lib/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/briefbag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Briefbag
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/lib/briefbag.rb

@@ -2,9 +2,9 @@
 
 require 'briefbag/version'
 require 'briefbag/configuration'
-require 'multipart/post'
 
 module Briefbag
+  require 'briefbag/railtie' if defined?(Rails::Railtie)
   class << self
     def warning_message(message, color: nil)
       color ||= :yellow

data/lib/tasks/settings.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace :settings do
+  desc 'create application.yml from consul data'
+
+  # task :consul2yml [:consul_host, :consul_port, :consul_token, :consul_folder, :environment] do |_t, args|
+  #   ss = Briefbag::Diplomat.new(consul_host: args[:consul_host],
+  #                               consul_port: args[:consul_port],
+  #                               consul_token: args[:consul_token],
+  #                               consul_folder: args[:consul_folder],
+  #                               environment: args[:environment]).call
+  #   puts ss
+  # end
+
+  task consul2yml: :environment do
+    p 'ya rake task'
+  end
+
+  desc 'create application.yml from template'
+  task template2yml: :environment do
+    p 'ya rake task'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: briefbag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Hitchens
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: diplomat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.6.4
 - !ruby/object:Gem::Dependency
   name: hash_to_struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -66,48 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 3.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.44.1
 description:
 email:
 - mmseleznev@gmail.com
@@ -157,22 +171,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - briefbag.gemspec
-- config/application.yml
 - lib/briefbag.rb
 - lib/briefbag/configuration.rb
 - lib/briefbag/diplomat.rb
+- lib/briefbag/railtie.rb
 - lib/briefbag/version.rb
+- lib/tasks/settings.rake
 homepage: https://github.com/MichaelHitchens/briefbag
 licenses:
 - MIT
@@ -188,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.2
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Briefbag manage your config

data/Gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: .
-  specs:
-    briefbag (0.0.1)
-      anyway_config (~> 1.4.4)
-      diplomat (~> 2.4.4)
-      hash_to_struct (~> 1.0.0)
-      rainbow (~> 3.1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    anyway_config (1.4.4)
-    ast (2.4.2)
-    byebug (11.1.3)
-    concurrent-ruby (1.2.0)
-    deep_merge (1.2.2)
-    diff-lcs (1.5.0)
-    diplomat (2.4.4)
-      deep_merge (~> 1.0, >= 1.0.1)
-      faraday (>= 0.9, < 1.1.0)
-    faker (2.12.0)
-      i18n (>= 1.6, < 2)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    hash_to_struct (1.0.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    multipart-post (2.3.0)
-    parallel (1.20.1)
-    parser (3.2.0.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.2)
-    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.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.12.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  anyway_config
-  briefbag!
-  bundler (~> 1.17.3)
-  byebug
-  diplomat
-  faker (~> 2.12.0)
-  hash_to_struct
-  rainbow
-  rake (~> 13.0.6)
-  rspec (~> 3.12.0)
-  rubocop (~> 1.12.1)
-
-BUNDLED WITH
-   1.17.3

data/config/application.yml

@@ -1,2 +0,0 @@
-development:
-  test: 'i am file'