connection-manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68a246ccfb28bcc3f2a98ed195f85b27d7231465
+  data.tar.gz: 4cd7b0ff860ed9f20325d60dcfc4f3784ba4ce9b
+SHA512:
+  metadata.gz: 71893e0a094fd795fe374d2bf908b666dd2d140f69d80a10f9967d9b521bc4f4e378518754ed20be2aee0acca51234985be6d1314c4ba60d1f1845d61d299ce6
+  data.tar.gz: d6e5faf6dbe381df88ea0992cbc5114f5911fe901434c3ff5683a3e2a8f73064a8c78c398cea7117fe12289891793d3db09a3f30fa0525688d128335a9a9624a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.10
+  - 2.1.10
+  - 2.0.0-p648
+before_install: gem install bundler -v 1.16.1

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:latest
+RUN mkdir /usr/src/app
+ADD . /usr/src/app/
+WORKDIR /usr/src/app/
+RUN ["bundle", "install"]

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/spuyet/connection_manager" }
+
+# Specify your gem's dependencies in connection_manager.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    connection-manager (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  connection-manager!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sébastien Puyet
+
+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,51 @@
+# ConnectionManager
+
+[![Build Status](https://travis-ci.com/spuyet/connection_manager.svg?token=n5bcPpqTwxxsDsj9JB2x&branch=master)](https://travis-ci.com/spuyet/connection_manager)
+
+A gem to manage your persistent connections.
+
+## Usage
+
+Create a thread-safe connection manager:
+```ruby
+$manager = ConnectionManager.new(timeout: 5)  
+```
+
+Push your connections at any time:
+```ruby
+$manager.push("redis") { Redis.new }
+```
+
+And use them according to your needs:
+```ruby
+$manager.with("redis") do |redis|
+  redis.get("mykey")
+end
+```
+
+A metadata store per connection is also available allowing you to create custom behavior:
+```ruby
+Thread.new do 
+  $manager.with("redis") do |redis, metadata|
+    metadata[:last_used_at] = Time.now
+    redis.get("mykey")
+  end
+end
+
+Thread.new do
+  metadata = $manager.metadata("redis")
+  $manager.reset("redis") if metadata[:last_used_at] < 1.hour.ago
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spuyet/connection_manager.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+Sébastien Puyet ([@spuyet](https://twitter.com/spuyet)): [sebastien@puyet.fr](mailto:sebastien@puyet.fr)

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 "connection_manager"
+
+# 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
+
+# Do any other automated setup that you need to do here

data/connection-manager.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "connection-manager/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "connection-manager"
+  spec.version       = ConnectionManager::VERSION
+  spec.authors       = ["Sébastien Puyet"]
+  spec.email         = ["sebastien@puyet.fr"]
+
+  spec.summary       = %q{A useful connection manager}
+  spec.homepage      = "https://github.com/spuyet/connection_manager"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/connection-manager.rb

@@ -0,0 +1,173 @@
+require "timeout"
+require "connection-manager/version"
+require "connection-manager/wrapper"
+
+class ConnectionManager
+  class LockingError < StandardError; end
+
+  TIMEOUT_ARITY = Timeout.method(:timeout).arity
+
+  def initialize(**options)
+    @connection_timeout = options.fetch(:timeout, 0)
+    @manager_timeout = options.fetch(:manager_timeout, 0)
+    @connections = {}
+    @mutex = Mutex.new
+  end
+
+  def clear
+    execute do
+      connections.delete_if do |_, wrapper|
+        wrapper.synchronize do
+          wrapper.closed?
+        end
+      end
+    end
+    true
+  end
+
+  def close(key)
+    wrapper = execute do
+      connections[key.to_sym]
+    end
+    wrapper.synchronize do
+      wrapper.close
+    end if wrapper
+  end
+
+  def closed?(key)
+    wrapper = execute do
+      connections[key.to_sym]
+    end
+    wrapper.synchronize do
+      wrapper.closed?
+    end if wrapper
+  end
+
+  def delete(key)
+    execute do
+      wrapper = connections[key.to_sym]
+      wrapper.synchronize do
+        connections.delete(key.to_sym)
+        true
+      end if wrapper
+    end
+  end
+
+  def delete_if(&block)
+    execute do
+      connections.delete_if do |_, wrapper|
+        wrapper.synchronize do
+          block.call(wrapper.connection, wrapper.metadata)
+        end
+      end
+    end
+    true
+  end
+
+  def empty?
+    size == 0
+  end
+
+  def exists?(key)
+    execute do
+      connections.key? key.to_sym
+    end
+  end
+
+  def metadata(key)
+    wrapper = execute do
+      connections[key.to_sym]
+    end
+    wrapper.synchronize do
+      wrapper.metadata
+    end if wrapper
+  end
+
+  def open?(key)
+    wrapper = execute do
+      connections[key.to_sym]
+    end
+    wrapper.synchronize do
+      !wrapper.closed?
+    end if wrapper
+  end
+
+  def pop(key)
+    execute do
+      wrapper = connections[key.to_sym]
+      wrapper.synchronize do
+        connections.delete(key.to_sym).connection
+      end if wrapper
+    end
+  end
+
+  def push(key, **options, &block)
+    options[:timeout] ||= connection_timeout
+    execute do
+      previous_connection = connections[key.to_sym]
+      executor = if previous_connection
+        -> { previous_connection.synchronize { connections[key.to_sym] = Wrapper.new(options, &block) } }
+      else
+        -> { connections[key.to_sym] = Wrapper.new(options, &block) }
+      end
+      executor.call
+    end
+    true
+  end
+
+  def reset(key)
+    execute do
+      wrapper = connections[key.to_sym]
+      wrapper.synchronize do
+        wrapper.reset
+      end if wrapper
+    end
+  end
+
+  def shutdown
+    execute do
+      connections.values.map do |wrapper|
+        Thread.new do
+          # Keep compatibility with ruby < 2.4
+          Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception=)
+          wrapper.synchronize { wrapper.close }
+        end
+      end.each(&:join)
+    end
+    true
+  end
+
+  def size
+    execute do
+      connections.keys.size
+    end
+  end
+
+  def with(key, **options, &block)
+    wrapper = execute do
+      connections[key.to_sym]
+    end
+    raise Connection::ClosedError if wrapper && wrapper.closed?
+
+    wrapper.synchronize(options) do
+      block.call(wrapper.connection, wrapper.metadata)
+    end if wrapper
+  end
+
+  private
+
+  attr_reader :connections, :mutex, :connection_timeout, :manager_timeout
+
+  def execute(&block)
+    Timeout.timeout(*lock_timeout_args) { mutex.lock }
+    block.call.tap do
+      mutex.unlock
+    end
+  end
+
+  def lock_timeout_args
+    [manager_timeout, LockingError].tap do |args|
+      args << "unable to acquire lock on time" if TIMEOUT_ARITY > 2
+    end
+  end
+end

data/lib/connection-manager/version.rb

@@ -0,0 +1,3 @@
+class ConnectionManager
+  VERSION = "0.1.0"
+end

data/lib/connection-manager/wrapper.rb

@@ -0,0 +1,51 @@
+class ConnectionManager::Connection
+  class LockingError < StandardError; end
+  class ClosedError < StandardError; end
+end
+
+class ConnectionManager::Wrapper
+  attr_reader :connection, :metadata
+
+  def initialize(options = {}, &block)
+    @closed = false
+    @close_method = options.fetch(:close_method, :close)
+    @initializer = block
+    @metadata = options.fetch(:metadata, {})
+    @mutex = Mutex.new
+    @timeout = options.fetch(:timeout, 0)
+  end
+
+  def close
+    return true if closed?
+    return false unless connection.respond_to?(close_method)
+    connection.public_send(close_method)
+    @closed = true
+  end
+
+  def closed?
+    @closed
+  end
+
+  def reset
+    @closed = false
+    @connection = nil
+    true
+  end
+
+  def synchronize(**options, &block)
+    @connection ||= initializer.call
+    timeout = options.fetch(:timeout, @timeout)
+    Timeout.timeout(*lock_timeout_args(timeout)) { mutex.lock }
+    block.call.tap { mutex.unlock }
+  end
+
+  private
+
+  attr_reader :close_method, :mutex, :initializer
+
+  def lock_timeout_args(timeout)
+    [timeout, ConnectionManager::Connection::LockingError].tap do |args|
+      args << "unable to acquire lock on time" if ConnectionManager::TIMEOUT_ARITY > 2
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: connection-manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sébastien Puyet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- sebastien@puyet.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- connection-manager.gemspec
+- lib/connection-manager.rb
+- lib/connection-manager/version.rb
+- lib/connection-manager/wrapper.rb
+homepage: https://github.com/spuyet/connection_manager
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A useful connection manager
+test_files: []