mongoid-dynamic_clients 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 872245b9e005a4e7d6c4563530ec18810992c1bc
+  data.tar.gz: 6eb522024736e94b109123f8de288bcbf4e6ca23
+SHA512:
+  metadata.gz: 4c071a345d114e7a07a6b4296190e7132bd99cc58e67ac5cf56d4116063634f90ebb1efe09785ed96352e987d7b937579ba6f45530451960802eb5062e4e24de
+  data.tar.gz: d50c70de57fc3f4664760d023bad394f8660c5d8b8155830ede03b0d7dd2cf6a7b47152f6863c6653e8a2f2770714fce2c75ec5e9d8b45eadf660b8ff4631c5e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/bundle
+.idea

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-dynamic_clients.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 pavlo
+
+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,172 @@
+# Mongoid::DynamicClients
+
+[![Build Status](https://semaphoreci.com/api/v1/pavlikus/mongoid-dynamic-clients/branches/develop/badge.svg)](https://semaphoreci.com/pavlikus/mongoid-dynamic-clients)
+
+## Overview
+
+`Mongoid::DynamicClients` helps [MongoId](https://docs.mongodb.com/mongoid/master/#ruby-mongoid-tutorial) enabled 
+apps to talk to multiple MongoDB databases. It is **dynamic** in the sense that you do not necessary have to know the 
+databases you're connecting to beforehand. Instead you provide connection properties (i.e. auth. credentials, hosts etc) 
+at runtime so you can get them gotten from a DB or receive from an other source. 
+
+In the example below the connection properties come from the `config` hash:
+ 
+```ruby
+require "mongoid/dynamic_clients"
+
+# the database to connect to:
+config = { 
+  database: 'my_custom_db',
+  hosts: ['https://foobar.mongo.com:27017'],
+  options: {
+    user: 'default_user',
+    password: 'default_password',
+    auth_source: 'admin'
+   }
+}
+
+# connect and execute the block against that database:
+with_mongoid_client(:my_custom_db, config) do
+  Record.create!(foo: "bar")
+end
+```
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-dynamic_clients'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-dynamic_clients
+
+### Documentation
+
+`Mongoid::DynamicClients` extends [MongoId](https://docs.mongodb.com/mongoid/master/#ruby-mongoid-tutorial) a little bit
+to make it easier to switch databases at runtime without the need to configure them all in `mongoid.yml` file. This 
+is helpful when you do not know the databases you're connecting to at the build time, say you're developing a multi-tenancy
+or a white-labeable application where every tenant has its own database and you do not have the ability to enumerate them
+all in `mongoid.yml`.
+
+#### Terms: Clients or Databases?
+
+Let's put it straight - both `clients` and `databases` terms are used interchangeably in this document. It is because 
+MongoId (and the underlying mongodb driver) use the mention of `client` - a thing that is responsible for maintaining 
+connections to the database and perform basic operations against it. Regular people though would call it `database` - 
+i.e. _let it connect to database A and then connect to database B_... So the document uses the two terms in the same meaning
+so both, experienced and regular developers would understand what's going on here.
+
+#### The `default` client / database
+ 
+When MongoId gem is installed and set up, it generates a `mongoid.yml` config file. The file features a single client 
+(database) that is used by default and has the name of **_default_**: 
+
+```yaml
+production:
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
+    default:
+      database: default
+      hosts:
+        - 'localhost:27017'
+      options:
+        user: 'default_user'
+        password: 'default_password'
+        auth_source: admin
+```
+
+This is default client/database the application will use when it starts up.
+
+
+#### Switch the clients / databases
+
+The idea behind the `Mongoid::DynamicClients` is to switch the databases at runtime, for this it provides a single 
+`with_mongoid_client` method that takes care of the job:
+
+```ruby
+
+# this goes to the `default` database
+Record.create!()
+
+# queries within the block go to the `my_custom_db` database
+with_mongoid_client(:my_custom_db, config) do
+  Record.create!() 
+end
+
+# this goes back to the `default` database
+Record.create!() 
+```
+
+_(the code above assumes that `Record` is a [MongoId document](https://docs.mongodb.com/mongoid/master/tutorials/mongoid-documents/))_
+
+#### Configuring the client
+
+The second argument of the `with_mongoid_client` method is a configuration hash. It is supposed to convey connection 
+information for given database. The structure of the config hash is the reflection of the `client` structure seen 
+in `mongoid.yml` file above:
+
+```yaml
+
+default:
+  database: default
+  hosts:
+    - 'localhost:27017'
+  options:
+    user: 'default_user'
+    password: 'default_password'
+    auth_source: adminkm
+
+```
+
+so, `config` hash should be a structure like this:
+
+```ruby
+
+config = {
+  database: 'default',
+  hosts: [ 'localhost:27017' ],
+  options: {
+    user: 'default_user',
+    password: 'default_password',
+    auth_source: 'admin'
+  }
+}
+
+with_mongoid_client(:my_custom_db, config) do
+  Record.create!() 
+end
+
+```
+
+_Note: any other client options available in `mongoid.yml` can be specified in the configuration hash, so that's how you
+may configure connection pooling and other options for the client._
+
+
+### How it works
+todo: Explain how Core Mongoid Threaded works, where the clients are stored and how that affects code
+
+#### Integrating with Rails 5
+todo: Describe puma setup, how threads are managed and how that affects multi database connections
+
+#### Integrating with Sidekiq
+todo: Describe the theading model behind sidekiq, provide a code sample of the use of dynamic clients in a sidekiq job
+
+#### Possible traps
+
+todo: It is easy to get out of connection pool limits by passing connection pool configuration to `with_mongoid_client` - explain the danger of that.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mongoid-dynamic_clients. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid/dynamic_clients"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path vendor/bundle
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: "3"
+services:
+  mongo-default:
+    image: mongo:latest
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: "default_user"
+      MONGO_INITDB_ROOT_PASSWORD: "default_password"
+      MONGO_INITDB_DATABASE: "default"
+    ports:
+      - "37017:27017"
+  mongo-client-1:
+    image: mongo:latest
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: "client1_user"
+      MONGO_INITDB_ROOT_PASSWORD: "client1_password"
+      MONGO_INITDB_DATABASE: "client1"
+    ports:
+      - "27018:27017"
+  mongo-client-2:
+    image: mongo:latest
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: "client2_user"
+      MONGO_INITDB_ROOT_PASSWORD: "client2_password"
+      MONGO_INITDB_DATABASE: "client-2"
+    ports:
+      - "27019:27017"

data/lib/mongoid/dynamic_clients.rb

@@ -0,0 +1,2 @@
+require "mongoid/dynamic_clients/version"
+require 'mongoid/dynamic_clients/client_switch'

data/lib/mongoid/dynamic_clients/client_switch.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module DynamicClients
+
+    def with_mongoid_client(client_identifier, client_config = {})
+
+      previous_client = Mongoid::Threaded.client_override
+      cid = client_identifier.to_sym
+
+      begin
+
+        unless Mongoid::Config.clients[cid]
+          Mongoid::Config.clients[cid] = client_config
+          #Mongoid::Clients.with_name(cid).reconnect
+        end
+
+        Mongoid.override_client(cid)
+        yield
+
+      ensure
+        Mongoid.override_client(previous_client)
+      end
+    end
+
+  end
+end

data/lib/mongoid/dynamic_clients/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module DynamicClients
+    VERSION = "1.0.0"
+  end
+end

data/mongoid-dynamic_clients.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongoid/dynamic_clients/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-dynamic_clients"
+  spec.version       = Mongoid::DynamicClients::VERSION
+  spec.authors       = ["pavlo"]
+  spec.email         = ["pavlikus@gmail.com"]
+
+  spec.summary       = %q{Helps MongoId enabled apps to talk to multiple MongoDB databases}
+  spec.description   = %q{The gem makes it easier to switch databases at runtime without the need to configure them all in `mongoid.yml` file. This is helpful when you do not know the databases you're connecting to at the build time, say you're developing a multi-tenancy or a white-labeable application where every tenant has its own database and you do not have the ability to enumerate them all in `mongoid.yml`}
+  spec.homepage      = "https://github.com/pavlo/mongoid-dynamic-clients"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("mongoid", ["~> 6"])
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-dynamic_clients
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pavlo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: The gem makes it easier to switch databases at runtime without the need
+  to configure them all in `mongoid.yml` file. This is helpful when you do not know
+  the databases you're connecting to at the build time, say you're developing a multi-tenancy
+  or a white-labeable application where every tenant has its own database and you
+  do not have the ability to enumerate them all in `mongoid.yml`
+email:
+- pavlikus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/mongoid/dynamic_clients.rb
+- lib/mongoid/dynamic_clients/client_switch.rb
+- lib/mongoid/dynamic_clients/version.rb
+- mongoid-dynamic_clients.gemspec
+homepage: https://github.com/pavlo/mongoid-dynamic-clients
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Helps MongoId enabled apps to talk to multiple MongoDB databases
+test_files: []