gorynich 1.1.0.142046

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1d0c21b8e0cbfde7c435ee42f9a3a7a4c25cf73579c715ecb8b8854ccb2b73c
+  data.tar.gz: 24c73120bd544cea50228a905f002f54bcbf240a155391a4d6cca3df1adefd8d
+SHA512:
+  metadata.gz: 765d8a73f9c06784e280f54e4c8b760a0f6d66fd0c9536c202a7db5faaeecc04b262368e21aa8653b349c5b8b922fc1985bab49506eccdb81beb6b3041838b59
+  data.tar.gz: c2fab106eb7faf514fc441fccf56f38d940f4261cf445e5dfd870259ba8a372ec8aa718a2a81052090269483155ff6ee6c20087afeff94e2eee2e4754d26adc4

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014-2023 Рнд Софт
+
+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,414 @@
+# Gorynich
+
+<div align="center">
+
+[![Gem Version](https://badge.fury.io/rb/gorynich.svg)](https://rubygems.org/gems/gorynich)
+[![Gem](https://img.shields.io/gem/dt/gorynich.svg)](https://rubygems.org/gems/gorynich/versions)
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/gorynich)
+
+
+[![coverage](https://lysander.rnds.pro/api/v1/badges/gorynich_coverage.svg)](https://lysander.rnds.pro/api/v1/badges/gorynich_coverage.html)
+[![quality](https://lysander.rnds.pro/api/v1/badges/gorynich_quality.svg)](https://lysander.rnds.pro/api/v1/badges/gorynich_quality.html)
+[![outdated](https://lysander.rnds.pro/api/v1/badges/gorynich_outdated.svg)](https://lysander.rnds.pro/api/v1/badges/gorynich_outdated.html)
+[![vulnerable](https://lysander.rnds.pro/api/v1/badges/gorynich_vulnerable.svg)](https://lysander.rnds.pro/api/v1/badges/gorynich_vulnerable.html)
+
+</div>
+
+`Gorynich` это гем для реализации [мультитенантности](https://ru.wikipedia.org/wiki/Мультиарендность) (мультиарендности) в Ruby on Rails приложении. Позволяет обеспечить строгую изоляцию данных в нескольких СУБД, поддерживаемых в ActiveRecord.
+
+Поскольку мультитенантное приложение тесно связано с разделение данных, которые в совю очередь могут находиться в разных источниках (СУБД, S3, Redis и пр), а также с их обработкой в разных подсистемах (ActiveJob, ActionCable), мы выбрали название ["Горыныч"](https://ru.wikipedia.org/wiki/Змей_Горыныч), что бы подчеркнуть ~многоголовость~ многогранность интеграций. 
+
+---
+
+`Gorynich` provides tools for creating [Multitenancy](https://en.wikipedia.org/wiki/Multitenancy) Ruby on Rails application. If you need to have strong data segregation and isolated DBMS's with diffrent providers (supported by ActiveRecord) and credentials, `Gorynich` can help.
+
+Since a multi-tenant application is closely related to the separation of data, which in turn can be located in different sources (DBMS, S3, Redis, etc.), as well as their processing in different subsystems (ActiveJob, ActionCable), we chose the name ["Gorynych"](https://en.wikipedia.org/wiki/Zmei_(Russian)#Multiheadedness), which to emphasize the ~multiheadedness~ versatility of integrations.
+
+<div align="left">
+  <a href="https://rnds.pro/" >
+    <img src="https://library.rnds.pro/repository/public-blob/logo/RNDS.svg" alt="Supported by RNDSOFT"  height="35">
+  </a>
+</div>
+
+## Возможности / Features
+
+- Прозрачное переключение БД/СУБД на основании данных запросы / Transparent request based DB/DBMS switching
+- Интеграция с / Integrations:
+  - ActiveRecord
+  - ActionCable
+  - ActiveJob
+  - DelayedJob
+- Получение параметров из [Consul KV](https://developer.hashicorp.com/consul/docs/dynamic-app-config/kv) / Stoting configuration in [Consul KV](https://developer.hashicorp.com/consul/docs/dynamic-app-config/kv)
+- Получение параметров из файла / Storing configuration in file
+- Разделение секретов / Secret storing and isolation
+- Обновление конфигурации "на лету" / update configuration "on the fly"
+- Статическая генерация `database.yml` / Static `database.yml` generation
+
+
+## Начало работы / Getting started
+
+```sh
+gem install gorynich
+```
+
+При установке `Gorynich` через bundler добавьте следующую строку в `Gemfile`:
+
+---
+
+If you'd rather install `Gorynichr` using bundler, add a line for it in your `Gemfile`:
+
+```sh
+gem 'gorynich'
+```
+
+Затем выполнить / Then run:
+
+```sh
+bundle install # для установки гема / gem installation
+
+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:
+
+
+```ruby
+Gorynich::Current.tap do |t|
+  t.tenant   # tenant_name
+  t.uri      # https://app.domain.org
+  t.host     # app.domain.org
+  t.secrets  # { key1 => value1, key2 => value2}
+  t.database # { adapter => postgresql, host => localhost, port => 5432, username => xxx, password => xxx }
+end
+```
+
+## Как это работает / How it works
+
+Перед обработкой запроса с помощью [Gorynich::Rack::RackMiddleware](./lib/gorynich/head/rack_middleware.rb) соединение Active Record переключается на указанную БД, а с помощью [ActiveSupport::CurrentAttributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) в любом месте приложения становятся доступны дополнительные параметры через обращение к `Gorynich::Current`. ActionCable, ActiveJob и другие "головы" используют настройки из `Gorynich::Current` для сохранения контекста и дальнейшего исполнения.
+
+Например при отправке писем изнутри 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.
+
+For example, when sending emails from within ActiveJob, the usage looks like this:
+
+```ruby
+#app/mailers/application_mailer.rb
+
+class ApplicationMailer < ActionMailer::Base
+  helper :application
+
+  def self.email_settings
+    (
+      Gorynich::Current.secrets[:email_settings] || Rails.application.secrets.email_settings || {}
+    ).with_indifferent_access
+  end
+
+  default from: email_settings[:from], content_type: 'text/plain'
+
+  def mail(args)
+    @host = Gorynich.instance.hosts(Gorynich::Current.tenant).first || Rails.application.secrets.domain
+
+    @settings ||= smtp_settings.merge(application_host: @host)
+
+    super(args).tap |m|
+      m.from = @settings[:from]
+      m.delivery_method.settings = @settings unless Rails.env.development?
+    end
+  end
+
+end
+```
+
+## Использование / Usage
+
+### Настройка источника данных / Configuration source 
+
+Для использования необходимо в файле `config/application.rb` добавить источник данных. Сейчас доступны 2 источника:
+
+---
+
+Now you need to select configuration source in `config/application.rb`. Yuo can choose from 2 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)
+```
+
+Пример / Example:
+
+```ruby
+# из одного / from single source
+Gorynich.configuration.fetcher = Gorynich::Fetchers::File.new(file_path: Rails.root.join('config', 'gorynich_config.yml'))
+
+# из нескольких (данные берутся от первого успешного fetcher)
+# from multiple sources - first succesful source is used
+Gorynich.configuration.fetcher  = [
+  Gorynich::Fetchers::Consul.new(storage: 'gorynich_project/config'),
+  Gorynich::Fetchers::File.new(file_path: Rails.root.join('config', 'gorynich_config.yml'))
+]
+```
+
+### Настройка интеграций ("голов") / Integration "Heads"
+
+`Gorynich` настраивается в обычных инициалайзерах / `Gorynich` configured in initializer:
+
+```ruby
+# config/initializers/gorynich.rb
+
+Gorynich.configure do |config|
+  # config cache of gorynich
+  config.cache = Rails.cache
+
+  # config cache namespace
+  config.namespace = ENV.fetch('YOUR_NAMESPACE_ENV', 'your_namespace')
+
+  # config how long your source cache will be alive in seconds
+  config.cache_expiration = 'your_value'
+
+  # Custom handler for swithing tenants in gorynich rack middleware
+  config.rack_env_handler =
+    lambda do |env|
+      host = env['SERVER_NAME']
+      tenant = Gorynich.instance.tenant_by_host(host)
+      uri = Gorynich.instance.uri_by_host(host, tenant)
+
+      Sentry.set_tags(tenant: tenant) if Sentry.get_current_scope.present?
+
+      [tenant, { host: host, uri: uri }]
+    end
+end
+
+# Add cable head
+ActiveSupport.on_load(:action_cable_connection) do
+  include Gorynich::Head::ActionCable::Connection
+end
+
+ActiveSupport.on_load(:action_cable_channel) do
+  prepend Gorynich::Head::ActionCable::Channel
+end
+
+# Add active job head
+ActiveSupport.on_load(:active_job) do
+  include Gorynich::Head::ActiveJob
+end
+```
+
+### Rake Tasks
+
+Запуск `Rails console` внутри тенанта / Run `rails console` inside tenant:
+
+```bash
+TENANT=tenant rails gc # default tenant name id  'default'
+```
+
+Для создания статичного файла `database.yml` из источника данных (Fetcher), используйте:
+
+--- 
+
+For static `database.yml` generation from configured source (Fetcher) use:
+
+```bash
+rails gc:db:prepare
+```
+
+### Настройка конфигурации БД / Database configuration
+
+1. Статическая генерация / static generation
+
+Первый, самый простой способ работы, подходящий для локальной разработки, это статическая генерация `database.yml`.
+
+--- 
+
+First and most simple using of Gorynich handy for local development is static `database.yml` generation.
+
+запуск rake-задачи / runing rake task:
+
+```bash
+rails gc:db:prepare
+```
+
+2. Полуавтоматический режим / Semi-automated mode
+
+Второй вариант это создание конфигурации `database.yml` при старте Rails приложения - данные буду прочитаны из настроенного источника. В этом случае конфигурация СУБД может изменяться только при перезапуске приложения, но остальные настройки, такие как привязка тенантов к доменам и secrets будут подхватываться "на лету" непосредственно во время работы приложения. Rake-задачи `db:create`, `db:migrate` работают для всех тенантов на момент запуска. 
+
+---
+
+Second option is dynamic `database.yml` creation while starting Rails application. Configuration will be readed from selected source. In this case database configuration can change only when application restarts, but other configuration such a domain to tenant binding and application secrets wil be updated "on the fly" while application running. Rake tasks `db:create` and `db:migrate` works as expected for all tenant in order.
+
+> ВНИМАНИЕ! `db:rollback` не работает в мультитенантном режиме.
+
+> WARNING!  `db:rollback` is not working in multitenancy mode.
+
+В `database.yml` прописать следующее / In `database.yml` set:
+
+```yaml
+# config/database.yml
+<%= Gorynich.instance.database_config %>
+```
+
+3. Дополнительные БД / Additional datbases
+
+Если вам нужны дополнительные БД, не являющиеся тенантами, например, общая БД, то в `database.yml` можно дописать всё необходимое как в обычном Rails приложении:
+
+---
+
+If you need additional DB, not for tenants Ex. generic database you can configure it in `database.yml` like in regular Rails application:
+
+```yaml
+# config/database.yml
+<%= Gorynich.instance.database_config('development') %>
+
+your_database:
+  <<: *configs_for_your_database
+
+<%= Gorynich.instance.database_config('test') %>
+your_database:
+  <<: *configs_for_your_database
+
+<%= Gorynich.instance.database_config('production') %>
+your_database:
+  <<: *configs_for_your_database
+```
+
+### В коде / Inside code
+Проверить в каком вы тенанте можно с помощью / Check in which tenant you are:
+
+```ruby
+Gorynich::Current.tenant
+```
+
+Переключение тенантов работает автоматичеки и внутри Rails приложения не нужно предпринимать никаких дополнительных действий - вы всегда подключены к той базе данных к которой привязан домен текущего запроса (или иной параметр). Но если необходимо явно выполнить действия в контексте конкретного тената это можно сделать:
+
+---
+
+Switching tenants is automatic and no additional steps need to be taken inside a Rails application - you always connected to database associated with currently procesed request. But if you want take action inside specific tenant context you can use:
+
+```ruby
+  # для выполнения в конкретном тенанте / run block inside specific tenant
+  Gorynich.with('tenant_name') do
+    # your code
+  end
+
+  # для выполнения в каждом тенанте / run block inside each tenant
+  Gorynich.with_each_tenant do |tenant|
+    # your code
+  end
+```
+
+## Примеры дополнительных интеграций и использвоаний / Additional integration examples
+
+### Redis / Rails.cache
+
+```ruby
+#config/environments/production.rb
+
+config.cache_store = :redis_cache_store, {
+  url:                ENV.fetch('REDIS_URL', nil),
+  expires_in:         90.minutes,
+  connect_timeout:    3,
+  reconnect_attempts: 3,
+  namespace:          -> { "#{Gorynich.configuration.namespace}#{Gorynich::Current.tenant}" }
+}
+```
+
+### Sentry
+
+```ruby
+#config/initializers/gorynich.rb
+
+Gorynich.configure do |config|
+  config.rack_env_handler =
+    lambda do |env|
+      host = env['SERVER_NAME']
+      tenant = Gorynich.instance.tenant_by_host(host)
+      uri = Gorynich.instance.uri_by_host(host, tenant)
+
+      Sentry.set_tags(tenant: tenant) if Sentry.get_current_scope.present?
+
+      [tenant, { host: host, uri: uri }]
+    end
+end
+```
+
+### Telegram
+
+```ruby
+#config/environments/production.rb
+
+config.telegram_updates_controller.session_store = :redis_cache_store, {
+  url:        ENV.fetch('REDIS_URL', nil),
+  expires_in: 90.minutes,
+  namespace:  -> { "#{Gorynich.configuration.namespace}#{Gorynich::Current.tenant}" }
+}
+```
+
+### Shrine 
+
+```ruby
+#lib/shrine/plugins/tenant_location.rb
+
+class Shrine
+  module Plugins
+    module TenantLocation
+      module InstanceMethods
+        def generate_location(io, **options)
+          "#{Gorynich::Current.tenant}/#{super}"
+        end
+      end
+    end
+
+    register_plugin(:tenant_location, TenantLocation)
+  end
+end
+
+#config/initializers/shrine.rb
+
+Shrine.plugin :tenant_location
+```
+
+### ApplicationController
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :around_action_notification
+
+  def around_action_notification(&block)
+    ActiveSupport::Notifications.instrument(
+      'around_action.action_controller',
+      current_user: original_user,
+      request:      request,
+      tenant:       Gorynich::Current.tenant, &block
+    )
+  end
+end
+```
+
+### DelayedJob
+
+```ruby
+#config/initializers/delayed_job.rb
+
+require 'gorynich/head/delayed_job'
+
+Delayed::Worker.plugins << Gorynich::Head::DelayedJob
+```
+
+## Лицензия / License
+
+Библиотека доступна с открытым исходным кодом в соответствии с условиями [лицензии MIT](./LICENSE).
+
+---
+
+The gem is available as open source under the terms of the [MIT License](./LICENSE).
+

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  gorynich:
+    tenant_not_found: Tenant %{tenant} not found
+    host_not_found: Host %{host} not found
+    uri_not_found: URI %{uri} not found
+    internal_error: Gorynich internal error

data/lib/generators/gorynich/gorynich_generator.rb

@@ -0,0 +1,9 @@
+# :nocov:
+module Gorynich
+  module Generators
+    class GorynichGenerator < Rails::Generators::NamedBase
+      namespace 'gorynich'
+    end
+  end
+end
+# :nocov:

data/lib/generators/gorynich/install_generator.rb

@@ -0,0 +1,17 @@
+# :nocov:
+require 'rails/generators/base'
+
+module Gorynich
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+    
+      desc 'Creates a Gorynich initializer'
+    
+      def copy_initializer
+        template 'gorynich.rb', Rails.root.join('config', 'initializers', 'gorynich.rb')
+      end
+    end
+  end
+end
+# :nocov:

data/lib/generators/templates/gorynich.rb

@@ -0,0 +1,32 @@
+# :nocov:
+Gorynich.configure do |config|
+  # config cache of gorynich
+  config.cache = Rails.cache
+
+  # config cache namespace
+  # config.namespace = 'gorynich'
+
+  # config how long your cache will be alive in seconds
+  # config.cache_expiration = 30
+
+  # handler for gorynich rack middleware
+  # config.rack_env_handler =
+  #   lambda do |env|
+  #     # your code
+  #   end
+end
+
+# Add cable head
+# ActiveSupport.on_load(:action_cable_connection) do
+#   include Gorynich::Head::ActionCable::Connection
+# end
+#
+# ActiveSupport.on_load(:action_cable_channel) do
+#   prepend Gorynich::Head::ActionCable::Channel
+# end
+
+# Add active job head
+# ActiveSupport.on_load(:active_job) do
+#   include Gorynich::Head::ActiveJob
+# end
+# :nocov: