redis_backend 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.vimrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cristian R. Arroyo
+
+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,49 @@
+# RedisBackend
+
+On the vein of the simplest-possible yet-functional Gem you could possibly release, this is a convenient way to "wrap" your Redis calls on a block that will be gracefully ignored if there is no database connection established yet:
+
+    module Collectable
+      extend RedisBackend
+
+      def self.ready_to_collect?
+        available?  # $redis global variable holds the Redis DB connection
+      end
+
+      def self.all(which)
+        backend do |redis|
+          redis.smembers(which)
+        end
+      end
+    end
+
+All you need to do is set the environment variables `REDIS_SERVER` and `REDIS_AUTH` (optional) to the host and the password required to execute any command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_backend'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_backend
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+## Copyright
+
+(c)2015 [Cristian R. Arroyo](mailto:cristian.arroyo@vivaserver.com)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+# ref: http://rpheath.com/posts/394-get-the-most-out-of-test-unit
+# ref: http://stackoverflow.com/a/8395163
+Rake::TestTask.new(:test) do |t|
+  t.verbose = false
+  t.pattern = 'spec/*_spec.rb'
+end
+Rake::Task['test'].comment = 'no hands!'
+task :default => [:test]

data/lib/redis_backend.rb

@@ -0,0 +1,32 @@
+require "redis_backend/version"
+require 'rubygems'
+require 'bundler/setup'
+require 'redis'
+
+if ENV['REDIS_SERVER']
+  begin
+    $redis = Redis.new(:host => ENV['REDIS_SERVER'])
+    $redis.auth(ENV['REDIS_AUTH']) if ENV['REDIS_AUTH']
+  rescue Redis::CannotConnectError, Redis::TimeoutError
+    # unsetted $redis will disable backend support
+  end
+end
+
+module RedisBackend
+  def available?
+    true if $redis
+  end
+
+  def backend
+    yield $redis if available?
+  rescue => e
+    case e
+    when Redis::CommandError
+      # TODO: reconnect?
+    when Redis::TimeoutError, Redis::CannotConnectError
+      # fallback to live request?
+    else 
+      raise e
+    end
+  end
+end

data/lib/redis_backend/version.rb

@@ -0,0 +1,3 @@
+module RedisBackend
+  VERSION = "0.0.1"
+end

data/redis_backend.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_backend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_backend"
+  spec.version       = RedisBackend::VERSION
+  spec.authors       = ["Cristian R. Arroyo"]
+  spec.email         = ["cristian.arroyo@vivaserver.com"]
+  spec.description   = %q{Protect operations from Redis backend unavailability gracefully}
+  spec.summary       = %q{Protect operations from Redis backend unavailability gracefully}
+  spec.homepage      = "https://github.com/vivaserver/redis_backend"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'redis'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'redis_backend'
+
+require 'minitest/autorun'

data/spec/redis_backend_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'minitest_helper'
+
+describe RedisBackend do
+  it 'exists' do
+    assert RedisBackend
+  end
+
+  if ENV['REDIS_SERVER']
+    it 'is available' do
+      assert $redis
+    end
+  else
+    it 'is not available' do
+      refute $redis
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: redis_backend
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Cristian R. Arroyo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: redis
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Protect operations from Redis backend unavailability gracefully
+email:
+- cristian.arroyo@vivaserver.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_backend.rb
+- lib/redis_backend/version.rb
+- redis_backend.gemspec
+- spec/minitest_helper.rb
+- spec/redis_backend_spec.rb
+homepage: https://github.com/vivaserver/redis_backend
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -4356408551907309796
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -4356408551907309796
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Protect operations from Redis backend unavailability gracefully
+test_files:
+- spec/minitest_helper.rb
+- spec/redis_backend_spec.rb