sinatra-redis-cache 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fddb41084d855236180b8f318398cacf0ca4339
+  data.tar.gz: 011f08ff6d8b377e71f13d2c26b867fb8840bebe
+SHA512:
+  metadata.gz: 9f187012a94865f91273d809d57badadb5bd47f0476d79e91e66989212f2eab63e74cf2d61f25bdde0c74180b8f576d7b8dcf0cce0f074ab719a7f90da35bded
+  data.tar.gz: 6f4ee2343b063daa6077301382ee00bbc2e2adaeca390939f6be444e06c65b64befa8bcd36b0bb6eac0da66ed02502013d8a9988c0b5c856d80be204b67c3248

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (C) 2014 Warren Guy <warren@guy.net.au>
+
+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,44 @@
+# sinatra/redis-cache
+
+A simple redis backed cache for Sinatra applications.
+
+## Installing
+
+ * Add the gem to your Gemfile
+
+   ```ruby
+   gem 'sinatra-redis-cache', git: 'https://github.com/warrenguy/sinatra-redis-cache.git'
+   ```
+
+ * Require it in your app after including Sinatra
+
+   ```ruby
+   require 'sinatra/redis-cache'
+   ```
+
+## Using in your app
+
+Use `cache_do` anywhere you want to cache the output of a block of code.
+
+The following will be cached for 60 seconds with the key `test-key`.
+
+  ```ruby
+  cache_do('test-key', 60) do
+    'do something here'
+  end
+  ```
+
+If there is an unexpired object in the cache with the same key, it will be returned. If not, the code will be executed, returned, and stored in the cache.
+
+## Configuration
+
+Include the following block in your app after including `sinatra/redis-cache` to configure. Defaults are shown.
+
+```ruby
+Sinatra::RedisCache::Config.config do
+  redis_conn      Redis.new
+  namespace       'sinatra_cache'
+  default_expires 3600
+  environments    [:production]
+end
+```

data/Rakefile

@@ -0,0 +1,13 @@
+namespace :sinatra_cache do
+  desc 'Flush the cache'
+  task :flush do
+    include Sinatra::RedisCache
+    cache_flush
+  end
+
+  desc 'Print configured namespace'
+  task :namespace do
+    include Sinatra::RedisCache
+    Sinatra::RedisCache.config.namespace
+  end
+end

data/lib/sinatra/redis-cache.rb

@@ -0,0 +1,143 @@
+require 'sinatra/base'
+require 'redis'
+
+module Sinatra
+
+  module RedisCache
+
+    module Config
+      extend self
+
+      def parameter(*names)
+        names.each do |name|
+          attr_accessor name
+
+          define_method name do |*values|
+            value = values.first
+            if value
+              self.send("#{name}=", value)
+            else
+              instance_variable_get("@#{name}")
+            end
+          end
+        end
+      end
+
+      def config(&block)
+        instance_eval &block
+      end
+    end
+
+    class RedisCache
+      def do(key, expires, params={}, block)
+        key = key_with_namespace(key)
+        if Sinatra::RedisCache::Config.environments.include? Sinatra::Base.settings.environment
+          object = get(key)
+          if object
+            object
+          else
+            object = block.call
+            store(key, object, expires)
+            object
+          end
+        else
+          # Just run the block without cache if we're not in an allowed environment
+          block.call
+        end
+      end
+
+      def get(key, params={})
+        key = key_with_namespace(key)
+        redis.get(key)
+      end
+
+      def store(key, value, expires, params={})
+        key = key_with_namespace(key)
+        expires = expires || config.default_expires
+        redis.set(key, value)
+        redis.expire(key, expires)
+      end
+
+      def flush
+        redis.del(all_keys)
+      end
+
+      private
+
+      def config
+        Sinatra::RedisCache::Config
+      end
+
+      def redis
+        config.redis_conn
+      end
+
+      def namespace
+        config.namespace
+      end
+
+      def key_with_namespace(key)
+        if key.start_with? namespace
+          key
+        else
+          "#{namespace}:#{key}"
+        end
+      end
+
+      def key_without_namespace(key)
+        if key.start_with? namespace
+          key.gsub(/^#{namespace}:/,'')
+        else
+          key
+        end
+      end
+
+      def all_keys
+        redis.keys(namespace + '*')
+      end
+    end
+
+    def cache_do(key, expires=nil, params={}, &block)
+      cache = RedisCache.new
+      cache.do(key, expires, params, block)
+    end
+
+    def cache_get(key, params={})
+      cache = RedisCache.new
+      cache.get(key, params)
+    end
+
+    def cache_store(key, value, expires, params={})
+      cache = RedisCache.new
+      cache.store(key, value, expires, params)
+    end
+
+    def cache_flush
+      cache = RedisCache.new
+      cache.flush
+    end
+
+  end
+
+  helpers RedisCache
+end
+
+Sinatra::RedisCache::Config.config do
+  # Set up configurable values
+  parameter :redis_conn
+  parameter :namespace
+  parameter :default_expires
+  parameter :environments
+end
+
+Sinatra::RedisCache::Config.config do
+  # Default values
+  redis_conn      Redis.new
+  namespace       'sinatra_cache'
+  default_expires 3600
+  environments    [:production]
+end
+
+unless defined?(Rake).nil?
+    Rake.load_rakefile("#{File.dirname(__FILE__)}/../../Rakefile")
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-redis-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Warren Guy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: A simple redis backed cache for Sinatra
+email: warren@guy.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/redis-cache.rb
+homepage: https://github.com/warrenguy/sinatra-redis-cache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple redis backed cache for Sinatra
+test_files: []