gorynich 1.1.1.148381 → 1.2.0.180668

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b2a2381ebeca46d78d55e1c60ae743574cba05e521dab121f58b633ab7020e
-  data.tar.gz: 83548d76917b9c7db035133e0131ec0dfe0934db80893d9e22cd7a7eaa8582c8
+  metadata.gz: bfa5eb9e2309dbcb2cf03355c6f5e138789f8fe9e2b3c7ab670de90d6d3ac55a
+  data.tar.gz: 4cff866be86f922c0ac2e008cec177e674ee3a28b4d884e501809740e9eb169d
 SHA512:
-  metadata.gz: 438461a1fced07b637c5a582b7a058ec6bd79a541e69433a4a5907bfd71da7207803323b11dcffd409130669e438ddd81b4faff20a0c8538594d8fd6ec801dda
-  data.tar.gz: 9c62f0ad4172188406b59151fc52fa9164fd5bc05cd4ea44134b5c3fa6e5ac2ef352f5c07c842328ba76fe750b9ab1c59d792c9cb4197291ab049c5999073aec
+  metadata.gz: 1ad533e8db97798dd44be95f527eff513f1b641a0f7bc90f6b4b7caed6ce2f104c1be1739233bc11ede063671f72634b988c56775c819dcf9276d0fbeb9341d0
+  data.tar.gz: 12464ea4be054bb26aa9c3f6934bbe1eadcb5cbc1573aabee6a13cae93b35b8aea1998113d0e485ef4c344f72e904ec5eaf3f5a44f8934ae44163ab14dd12f62

data/README.md

@@ -16,7 +16,7 @@
 
 `Gorynich` - это гем для реализации [мультитенантности](https://ru.wikipedia.org/wiki/Мультиарендность) (мультиарендности) в Ruby on Rails приложении. Позволяет обеспечить строгую изоляцию данных в нескольких СУБД, поддерживаемых в ActiveRecord.
 
-Поскольку мультитенантное приложение тесно связано с разделением данных, которые в свою очередь могут находиться в разных источниках (СУБД, S3, Redis и пр.), а также с их обработкой в разных подсистемах (ActiveJob, ActionCable), мы выбрали название ["Горыныч"](https://ru.wikipedia.org/wiki/Змей_Горыныч), чтобы подчеркнуть ~многоголовость~ многогранность интеграций. 
+Поскольку мультитенантное приложение тесно связано с разделением данных, которые в свою очередь могут находиться в разных источниках (СУБД, S3, Redis и пр.), а также с их обработкой в разных подсистемах (ActiveJob, ActionCable), мы выбрали название ["Горыныч"](https://ru.wikipedia.org/wiki/Змей_Горыныч), чтобы подчеркнуть ~многоголовость~ многогранность интеграций.
 
 ---
 
@@ -66,14 +66,14 @@ gem 'gorynich'
 ```sh
 bundle install # для установки гема / gem installation
 
-rails generate gorynich:install # для добавления шаблонов конфигурации / install configuration templates 
+rails generate gorynich:install # для добавления шаблонов конфигурации / install configuration templates
 ```
 
 ## Что такое тенант? / What tenant is?
 
 Тенант (в данном случае) - это активное подключение к СУБД, а также доступный в любом месте объект `Gorynich::Current`, в котором находятся параметры текущего тенанта. К нему можно обратиться в любом месте.
 
---- 
+---
 
 In this case tenant is an active connection to the DBMS, as well as a `Gorynich::Current` object available anywhere, which contains the parameters of the current tenant. You can refer to it anywhere, for example when sending emails:
 
@@ -94,7 +94,7 @@ end
 
 Например, при отправке писем изнутри ActiveJob использование выглядит так:
 
---- 
+---
 
 Before request processing [Gorynich::Rack::RackMiddleware](./lib/gorynich/head/rack_middleware.rb) ActiveRecord connection switching to apropriate database. Additional tenant properties available in any part of application through [ActiveSupport::CurrentAttributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) as  `Gorynich::Current` instance. ActionCable, ActiveJob and other "heads" also uses `Gorynich::Current` to store context and evaluate it later.
 
@@ -130,19 +130,21 @@ end
 
 ## Использование / Usage
 
-### Настройка источника данных / Configuration source 
+### Настройка источника данных / Configuration source
 
-Для использования необходимо в файле `config/application.rb` добавить источник данных. Сейчас доступны 2 источника:
+Для использования необходимо в файле `config/application.rb` добавить источник данных. Сейчас доступны 3 источника:
 
 ---
 
-Now you need to select configuration source in `config/application.rb`. Yuo can choose from 2 source types now:
+Now you need to select configuration source in `config/application.rb`. Yuo can choose from 3 source types now:
 
 
 ```ruby
 Gorynich::Fetchers::File.new(file_path: [FILE_PATH]) # из файла / from file
 
 Gorynich::Fetchers::Consul.new(storage: [CONSUL_KEY], **options) # из консула / from consul (options - from Dimplomat gem https://github.com/WeAreFarmGeek/diplomat)
+
+Gorynich::Fetchers::ConsulSecure.new(storage: [CONSUL_KEY], file_path: [FILE_PATH], **options) # из консула с сохранением в файл (при недоступности консула будет читать из файла) / from consul with saving to a file (if unavailable, consul will read from the file) (options - from Dimplomat gem https://github.com/WeAreFarmGeek/diplomat)
 ```
 
 Пример / Example:
@@ -214,7 +216,7 @@ TENANT=tenant rails gc # default tenant name id  'default'
 
 Для создания статичного файла `database.yml` из источника данных (Fetcher) используйте:
 
---- 
+---
 
 For static `database.yml` generation from configured source (Fetcher) use:
 
@@ -228,7 +230,7 @@ rails gc:db:prepare
 
 Первый, самый простой способ работы, подходящий для локальной разработки, это статическая генерация `database.yml`.
 
---- 
+---
 
 First and most simple using of Gorynich handy for local development is static `database.yml` generation.
 
@@ -240,7 +242,7 @@ rails gc:db:prepare
 
 2. Полуавтоматический режим / Semi-automated mode
 
-Второй вариант - это создание конфигурации `database.yml` при старте Rails приложения - данные будут прочитаны из настроенного источника. В этом случае конфигурация СУБД может изменяться только при перезапуске приложения, но остальные настройки, такие как привязка тенантов к доменам и secrets, будут подхватываться "на лету" непосредственно во время работы приложения. Rake-задачи `db:create`, `db:migrate` работают для всех тенантов на момент запуска. 
+Второй вариант - это создание конфигурации `database.yml` при старте Rails приложения - данные будут прочитаны из настроенного источника. В этом случае конфигурация СУБД может изменяться только при перезапуске приложения, но остальные настройки, такие как привязка тенантов к доменам и secrets, будут подхватываться "на лету" непосредственно во время работы приложения. Rake-задачи `db:create`, `db:migrate` работают для всех тенантов на момент запуска.
 
 ---
 
@@ -353,7 +355,7 @@ config.telegram_updates_controller.session_store = :redis_cache_store, {
 }
 ```
 
-### Shrine 
+### Shrine
 
 ```ruby
 #lib/shrine/plugins/tenant_location.rb

data/lib/gorynich/fetcher.rb

@@ -1,5 +1,6 @@
 require_relative 'fetchers/file'
 require_relative 'fetchers/consul'
+require_relative 'fetchers/consul_secure'
 
 module Gorynich
   class Fetcher
@@ -32,7 +33,7 @@ module Gorynich
         elsif @fetcher.is_a?(Array)
           result = {}
           @fetcher.each do |f|
-            result = 
+            result =
               begin
                 f.fetch
               rescue ::StandardError

data/lib/gorynich/fetchers/consul_secure.rb

@@ -0,0 +1,38 @@
+module Gorynich
+  module Fetchers
+    class ConsulSecure
+      attr_reader :storage, :file_path, :consul_opts
+
+      def initialize(storage:, file_path:, **opts)
+        @storage = storage
+        @file_path = file_path
+        @consul_opts = opts
+      end
+
+      def fetch
+        cfg = Consul.new(storage: storage, **consul_opts).fetch
+        return from_file if cfg.empty?
+
+        save_to_file(cfg)
+
+        cfg
+      rescue ::StandardError
+        from_file
+      end
+
+      private
+
+      def save_to_file(cfg)
+        envs = ::Dir.glob(::Rails.root.join('config/environments/*.rb').to_s).map { |f| ::File.basename(f, '.rb') }
+
+        ::File.open(file_path, 'w') do |f|
+          f << cfg.deep_transform_keys(&:downcase).select { |k, _v| envs.include?(k) }.to_yaml.gsub('---', '')
+        end
+      end
+
+      def from_file
+        File.new(file_path: file_path).fetch
+      end
+    end
+  end
+end

data/lib/gorynich/version.rb

@@ -1,3 +1,3 @@
 module Gorynich
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/lib/gorynich/fetchers/consul_secure_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe Gorynich::Fetchers::ConsulSecure do
+  let(:storage) { Faker::Lorem.word }
+  let(:file_path) { "#{RSPEC_ROOT}/fixtures/fetchers/file_config.yml" }
+  let(:file_like_object) { double("file like object") }
+
+  context '#fetch' do
+    let(:consul_host) { Faker::Internet.url }
+    let(:consul_opts) { { http_addr: consul_host } }
+
+    def consul_request(response, code = 200)
+      stub_request(:get, "#{consul_host}/v1/kv/#{storage}?recurse=true")
+        .to_return(
+          status: code,
+          body: response
+        )
+    end
+
+    subject { described_class.new(storage: storage, file_path: file_path, **consul_opts) }
+
+    describe 'when consul return data' do
+      let(:response) { [{ 'Key' => "#{storage}/test_key", 'Value' => Base64.encode64('test') }].to_json }
+
+      before(:each) do
+        consul_request(response)
+      end
+
+      it do
+        allow(File).to receive(:open).with(file_path, 'w').and_return(file_like_object)
+        expect(subject.fetch).to eq({ 'test_key' => 'test' })
+      end
+    end
+
+    describe 'when http error' do
+      before(:each) do
+        consul_request([], 500)
+      end
+
+      it do
+        result = subject.fetch
+        expect(result.class).to eq(Hash)
+        expect(result).to include('development', 'test')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gorynich
 version: !ruby/object:Gem::Version
-  version: 1.1.1.148381
+  version: 1.2.0.180668
 platform: ruby
 authors:
 - Poliev Alexey
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -286,6 +286,7 @@ files:
 - lib/gorynich/engine.rb
 - lib/gorynich/fetcher.rb
 - lib/gorynich/fetchers/consul.rb
+- lib/gorynich/fetchers/consul_secure.rb
 - lib/gorynich/fetchers/file.rb
 - lib/gorynich/head.rb
 - lib/gorynich/head/action_cable.rb
@@ -358,6 +359,7 @@ files:
 - spec/fixtures/test_database.yml
 - spec/lib/gorynich/config_spec.rb
 - spec/lib/gorynich/fetcher_spec.rb
+- spec/lib/gorynich/fetchers/consul_secure_spec.rb
 - spec/lib/gorynich/fetchers/consul_spec.rb
 - spec/lib/gorynich/fetchers/file_spec.rb
 - spec/lib/gorynich/version_spec.rb
@@ -450,6 +452,7 @@ test_files:
 - spec/fixtures/test_database.yml
 - spec/lib/gorynich/config_spec.rb
 - spec/lib/gorynich/fetcher_spec.rb
+- spec/lib/gorynich/fetchers/consul_secure_spec.rb
 - spec/lib/gorynich/fetchers/consul_spec.rb
 - spec/lib/gorynich/fetchers/file_spec.rb
 - spec/lib/gorynich/version_spec.rb