blockhole 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian Schlensker
+
+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,118 @@
+# Blockhole (alpha)
+
+Have an expensive block that you need to cache? Maybe an http response from an
+expensive third party service?
+
+Inspired heavily from the interface of [VCR](https://github.com/vcr/vcr)
+Blockhole will suck up the response from the block so it only runs once.
+
+    Blockhole.use_hole('pie-hole') do
+      # some expensive operation that returns some value
+    end
+
+It currently only supports redis for storage, but more options are forthcoming.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blockhole'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blockhole
+
+## Usage
+
+
+### Configuration
+
+The first step is to configure Blockhole to use your redis connection.
+Instructions on setting up a redis connection can be found in the [redis-rb
+docs](https://github.com/redis/redis-rb).
+
+    Blockhole.configure do |b|
+      b.storage = Redis.new(:host => 'localhost', :port => 6379)
+    end
+
+
+### Basic usage
+
+Next record a block by passing the name of the redis key you would like to use.
+
+    my_pie = Blockhole.use_hole('pie-hole') do
+      # some expensive operation to get pie
+      'cherry pie'
+    end
+
+    puts my_pie
+    > 'cherry pie'
+
+Blockhole will check redis cache for that key and return that value if it
+exists (this is called a *cache hit*). If it doesn't find anything it will run
+the block, store it's return value in the cache and return it to you.
+
+You can also explicitly get the value back out without passing a block using
+a get call.
+
+    my_pie = Blockhole.get('pie-hole') # still cherry
+
+### What can be stored
+
+Anything that can be fed into `MultiJson.dump` will work.
+Strings will just be stored and returned as is. Arrays and Hashes will be
+serialized before storage and then reparsed after retreival.
+
+    Blockhole.use_hole('pie-hole') do
+      [
+        { name: 'cherry' },
+        { name: 'peach' }
+      ]
+    end
+
+    pies =  Blockhole.get('pie-hole')
+    puts pies[1][:name]
+
+    > 'peach'
+
+
+### Expiration
+
+You can pass an optional expiration value (in seconds). The key will
+automatically be deleted after that amount of time has passed.
+
+    lifespan = 3600 # 1 hour
+
+    my_pie = Blockhole.use_hole('pie-hole', lifespan) do
+      # some expensive operation to get pie
+    end
+
+    # an hour passes
+
+    my_pie = Blockhole.use_hole('pie-hole', lifespan) do
+      # Now it's blueberry!
+    end
+
+Note that this command will refresh the expiration each time it is called.
+
+### Busting the cache
+
+If you'd had enough with the existing data you can collapse the hole and clear
+the cache. This will result in the key being deleted from redis.
+
+    Blockhole.collapse('pie-hole')
+
+
+## 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

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+
+  # we require spec_helper so we don't get an RSpec warning about
+  # examples being defined before configuration.
+  # t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
+  t.rspec_opts = %w[--format progress]
+end

data/blockhole.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blockhole/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "blockhole"
+  gem.version       = Blockhole::VERSION
+  gem.authors       = ["Christian Schlensker"]
+  gem.email         = ["christian@cswebartisan.com"]
+  gem.description   = %q{This is a simple caching library inspired by the api of VCR. Currently Redis is the only storage mechanism supported but there are more forthcoming.}
+  gem.summary       = %q{Caches the result of heavy blocks.}
+  gem.homepage      = "https://github.com/wordofchristian/blockhole"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "redis", '~> 2.1'
+  gem.add_dependency "multi_json", '~> 1.5'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'bundler', '>= 1.0.7'
+  gem.add_development_dependency 'rspec', '~> 2.11'
+end

data/lib/blockhole.rb

@@ -0,0 +1,49 @@
+require "blockhole/version"
+require 'redis'
+require 'multi_json'
+
+module Blockhole
+  class << self
+    attr_accessor :storage
+
+    def configure
+      yield self
+      self
+    end
+
+    def use_hole(hole_name, lifespan = nil, &block)
+      if lifespan and lifespan < 1
+        raise ArgumentError,
+          "lifespan (if provided) must be >= 0, got #{lifespan}"
+      end
+
+      unless value = storage.get(hole_name)
+        value = block.call(hole_name)
+        storage.set(hole_name, encode(value))
+        storage.expire(hole_name, lifespan) if lifespan
+      end
+
+      value
+    end
+
+    def get(name)
+      value = storage.get(name)
+      begin
+        return MultiJson.load value
+      rescue MultiJson::DecodeError
+        return value
+      end
+    end
+
+    def collapse(name)
+      storage.del name
+    end
+
+  private
+
+    def encode(value)
+      return value if value.kind_of? String
+      MultiJson.dump value
+    end
+  end
+end

data/lib/blockhole/version.rb

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

data/spec/blockhole_spec.rb

@@ -0,0 +1,66 @@
+require 'blockhole'
+require_relative 'spec_helper'
+
+describe Blockhole do
+  it 'should have a version number' do
+    Blockhole::VERSION.should_not be_nil
+  end
+
+  it 'should cache things' do
+    Blockhole.use_hole('pie-hole') { 'blueberry pie' }
+    pie = Blockhole.use_hole('pie-hole') { 'cherry pie' }
+    pie.should == 'blueberry pie'
+  end
+
+  it 'should support blocks that return hash objects' do
+    Blockhole.use_hole('pie-hole') do
+      { 'name' => 'blueberry pie'}
+    end
+
+    pie = Blockhole.get('pie-hole')
+    pie.should be_kind_of Hash
+
+    pie['name'].should == 'blueberry pie'
+  end
+
+  it 'should support blocks that return array objects' do
+    Blockhole.use_hole('pie-hole') do
+      ['blueberry', 'cherry']
+    end
+
+    pies = Blockhole.get('pie-hole')
+    pies.should be_kind_of Array
+    pies[0].should == 'blueberry'
+  end
+
+  context 'with an optional lifespan' do
+    it 'expires values' do
+      Blockhole.use_hole('pie-hole', 1) { 'blueberry pie' }
+      sleep(2) #50 milliseconds
+      pie = Blockhole.use_hole('pie-hole') { 'cherry pie' }
+      pie.should == 'cherry pie'
+    end
+
+    it 'requires that lifespan be more than 0' do
+      lambda do
+        Blockhole.use_hole('pie-hole', -1) { 'blueberry pie' }
+      end.should raise_error ArgumentError
+    end
+  end
+
+  describe 'get' do
+    it 'gets the values back out again' do
+      Blockhole.use_hole('pie-hole') { 'blueberry pie' }
+      Blockhole.get('pie-hole').should == 'blueberry pie'
+    end
+  end
+
+  describe 'collapse' do
+    it 'should bust the cache' do
+      Blockhole.use_hole('pie-hole') { 'blueberry' }
+      Blockhole.collapse('pie-hole')
+      Blockhole.use_hole('pie-hole') { 'cherry' }
+      Blockhole.get('pie-hole').should == 'cherry'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'blockhole'
+require 'redis'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    $redis = Redis.new(:host => 'localhost', :port => 6379)
+    Blockhole.configure do |b|
+      b.storage = $redis
+    end
+  end
+  config.before(:each) do
+    $redis.flushdb
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: blockhole
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Schlensker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    none: false
+description: This is a simple caching library inspired by the api of VCR. Currently
+  Redis is the only storage mechanism supported but there are more forthcoming.
+email:
+- christian@cswebartisan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blockhole.gemspec
+- lib/blockhole.rb
+- lib/blockhole/version.rb
+- spec/blockhole_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wordofchristian/blockhole
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Caches the result of heavy blocks.
+test_files:
+- spec/blockhole_spec.rb
+- spec/spec_helper.rb