pooled_redis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 703256e707168da682b836de7be20d4e36d82cc8
+  data.tar.gz: 8a17b74e367e46006c91ab716095c669bbbed1e4
+SHA512:
+  metadata.gz: 330b09edf2b189a4a54f02113f509450d244e79bd67ee2ad2de79633729a41fb40fc66d552740e632d55c2513484d2eae5deb7bf62958e1bd64490bcb85c8165
+  data.tar.gz: 156ed895a90febf94e3b75423b6d0a7c3cc8dfbd9b9fadfd7316c8679e53643473cdc74f8d1b1ffb80ef8460d8ac1c2589528c6dd45ad25c26d0ed24dc77bab5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max Melentiev
+
+MIT License
+
+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,68 @@
+# PooledRedis
+
+Simple way to access redis connections without global variables.
+
+Provides `Rails.redis_pool` & `Rails.redis` methods and configuration via `database.yml`.
+You can add this methods to custom modules.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pooled_redis'
+```
+
+## Usage
+
+- Add `redis` section to your `database.yml` with options supported by `Redis.new`
+
+```yml
+development:
+  redis:
+    db: 2
+production:
+  redis:
+    url: 'redis://mymaster'
+    sentinels:
+      - host: host
+      - host: other
+```
+
+- You can also provide `pool` & `timeout` values for ConnectionPool.
+- Use `Rails.redis_pool` & `Rails.redis` method.
+
+PooledRedis uses ConnectionPool for pooling connections.
+`.redis` returns proxy object that checkouts connection for every method call.
+So you may want to avoid it for bulk operations.
+
+### Custom modules or without rails
+
+- Extend or include `PooledRedis` module.
+- Override `redis_config` method to return valid configuration.
+- Use `redis_pool` & `redis` methods.
+
+```ruby
+class Storage
+  extend PooledRedis
+
+  class << self
+    def redis_config
+      read_your_yaml.symbolize_keys
+    end
+  end
+
+  # ...
+
+  def save
+    self.class.redis.set id, to_json
+  end
+end
+
+Storage.redis_pool.with { |r| r.get :some_key }
+Storage.redis.get :some_key
+```
+
+# Licence
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/pooled_redis/version.rb

@@ -0,0 +1,7 @@
+module PooledRedis
+  VERSION = '0.0.1'
+
+  def self.gem_version
+    Gem::Version.new VERSION
+  end
+end

data/lib/pooled_redis.rb

@@ -0,0 +1,56 @@
+require 'pooled_redis/version'
+require 'connection_pool'
+
+ConnectionPool.class_eval do
+  # Wraps pool and proxies every method to checked out connection.
+  # Similar to Wrapper, but works on existing pool.
+  class SimpleConnection < BasicObject
+    def initialize(pool)
+      @pool = pool
+    end
+
+    private
+
+    def method_missing(name, *args, &block)
+      @pool.with { |x| x.send name, *args, &block }
+    end
+
+    def respond_to_missing?(name, include_all = false)
+      @pool.with { |x| x.respond_to?(name, include_all) }
+    end
+  end
+
+  def simple_connection
+    SimpleConnection.new(self)
+  end
+end
+
+module PooledRedis
+  # Override this method unless using Rails.
+  def redis_config
+    @redis_config = begin
+      config = ActiveRecord::Base.connection_config[:redis].with_indifferent_access
+      config[:driver] ||= :hiredis if defined?(Hiredis)
+      config[:logger] = Rails.logger if Rails.env.development?
+      config
+    end
+  end
+
+  def redis_pool_config
+    @redis_pool_config ||= {
+      pool:     redis_config.delete(:pool)    || 5,
+      timeout:  redis_config.delete(:timeout) || 5,
+    }
+  end
+
+  def redis_pool
+    @redis_pool ||= ConnectionPool.new(redis_pool_config) { Redis.new(redis_config) }
+  end
+
+  def redis
+    @redis ||= redis_pool.simple_connection
+  end
+end
+
+# Use Rails module methods to access redis client.
+Rails.class_eval { extend PooledRedis } if defined?(Rails)

data/pooled_redis.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pooled_redis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pooled_redis'
+  spec.version       = PooledRedis::VERSION
+  spec.authors       = ['Max Melentiev']
+  spec.email         = ['melentievm@gmail.com']
+  spec.summary       = %q{Simple way to access redis connections without global variables.}
+  spec.description   = %q{Provides `Rails.redis_pool` & `Rails.redis` methods and configuration via `database.yml`.}
+  spec.homepage      = 'https://github.com/printercu/pooled_redis'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis', '~> 3.0'
+  spec.add_dependency 'connection_pool', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: pooled_redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Melentiev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Provides `Rails.redis_pool` & `Rails.redis` methods and configuration
+  via `database.yml`.
+email:
+- melentievm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pooled_redis.rb
+- lib/pooled_redis/version.rb
+- pooled_redis.gemspec
+homepage: https://github.com/printercu/pooled_redis
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple way to access redis connections without global variables.
+test_files: []