block_cache 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/block_cache.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "block_cache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "block_cache"
+  s.version     = BlockCache::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Blake Chambers"]
+  s.email       = ["chambb1@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/block_cache"
+  s.summary     = %q{uses mongo_mapper to cache block response strings.}
+  s.description = %q{uses mongo_mapper to cache block response strings. Use case: wrap your twitter api call with a block, if twitter bugs out, raise an error and the last value will be returned}
+    
+  s.add_dependency('mongo_mapper')
+  s.add_development_dependency "rspec"
+  # s.rubyforge_project = "block_cache"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/block_cache/version.rb

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

data/lib/block_cache.rb

@@ -0,0 +1,68 @@
+=begin
+
+block_cache methods for caching single block responses in mongo
+planned to support mongoid in the future. :D -blake
+
+attributes:
+* block_key:      basic key passed to the cache_overwrite_by method that 
+                  will store and overwrite by that valid. could easily use 
+                  the request.uri for content cached as json or something as 
+                  such.
+* block_response: basic block of content that is returned by the block call.
+
+WARNING: BLOCKS THAT RETURN NIL WILL OVERWRITE THE DATA. TO BE SURE RAISE ERRORS
+         WHEN EXITING BLOCKS WITH NIL DATA. THIS LIBRARY CURRENTLY DOSESNT PREVENT
+         THIS EXCEPTION.
+
+=end
+
+module BlockCache
+  CACHE_NIL_RESPONSES = true
+  HOPTOAD_SUPPORTED=begin
+    require 'hoptoad_notifier' ;; true
+  rescue
+    false
+  end
+  
+  def self.included(receiver)
+    receiver.send :include, ControllerMethods
+  end
+  
+  module ControllerMethods
+    class NilResponseError < Exception ;; end
+    def cache_overwrite_by(key, &block)
+      raise ArgumentError, "needs a key and block" unless key && block
+      
+      return begin
+        response_body = block.call()
+        
+        raise NilResponseError, "you returned a nil response" if response_body.nil? and not CACHE_NIL_RESPONSES
+        
+        BlockCache::Record.cache_by_key(key, response_body) 
+      rescue => exception
+        logger.info "block cache error(#{exception.to_s}) returned, rendering from mongo."
+        logger.debug "Backtrace:\n\n#{exception.backtrace}\n\n"
+        HoptoadNotifier.notify_hoptoad(exception) if RAILS_ENV["production"] and HOPTOAD_SUPPORTED
+        
+        return BlockCache::Record.find_by_block_key(key).try(:block_response)
+      end
+    end
+  end
+  
+  class Record
+    include MongoMapper::Document
+    
+    key  :block_key,          String
+    key  :block_response,     String
+    
+    class << self
+      def cache_by_key(block_key, response_body)
+        record = find_or_initialize_by_block_key(block_key)
+        record.block_response = response_body
+        record.save!
+        
+        return response_body
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: block_cache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Blake Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "uses mongo_mapper to cache block response strings. Use case: wrap your twitter api call with a block, if twitter bugs out, raise an error and the last value will be returned"
+email: 
+- chambb1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- block_cache.gemspec
+- lib/block_cache.rb
+- lib/block_cache/version.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/block_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: uses mongo_mapper to cache block response strings.
+test_files: []
+