atomic_redis_cache 0.2.1 → 0.2.2

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - jruby-head
+  - 2.1.0
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - ree
+
+script: 'bundle exec rake'

data/README.md

@@ -1,5 +1,9 @@
 # AtomicRedisCache
 
+[![Build Status](https://travis-ci.org/anujdas/atomic_redis_cache.png?branch=master)](https://travis-ci.org/anujdas/atomic_redis_cache) 
+
+[![Gem Version](https://badge.fury.io/rb/atomic_redis_cache.png)](http://badge.fury.io/rb/atomic_redis_cache)
+
 AtomicRedisCache is an overlay on top of Redis that allows you to use it much
 like the Rails cache (ActiveSupport::Cache). Usage centers around the `.fetch()`
 method, which reads from a key if present and valid, or else evaluates the
@@ -32,20 +36,43 @@ Or install it yourself as:
 Ensure that you set the value of `AtomicRedisCache.redis`. This can be either an
 instance of redis-rb (or compatible), or a lambda/Proc evaluating to one. Ex.
 
-``` AtomicRedisCache.redis = Redis.new(:host => '127.0.0.1', :port => 6379) ```
+```
+AtomicRedisCache.redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+```
 
 Then use it as you would Rails.cache:
 
 ```
->> v = AtomicRedisCache.fetch('key') { Faraday.get('example.com').status }
+>> AtomicRedisCache.fetch('key') { Faraday.get('http://example.com').status }
 => 200  # network call made
->> v = AtomicRedisCache.fetch('key') { raise 'Network call attempted' }
-=> 200  # value read from cache ```
+>> AtomicRedisCache.fetch('key') { raise }
+=> 200  # value read from cache; block not called
+>> AtomicRedisCache.write('key', {:new => 'value'})
+=> true
+>> AtomicRedisCache.read('key')
+=> {:new => "value"}
+>> AtomicRedisCache.delete('key')
+=> true
+>> AtomicRedisCache.read('key')
+=> nil
+```
 
-There are a couple of configurable options can be set per fetch:
+There are a couple of configurable options that can be set per fetch/write:
 - `:expires_in` - expiry in seconds; defaults to a day
-- `:race_condition_ttl` - time to lock down key for recalculation
-- `:max_retries` - # of times to retry cache refresh before expiring
+- `:race_condition_ttl` - time to lock down key for recalculation; default 30s
+- `:max_retries` - # of times to retry cache refresh before expiring; default 3
+
+AtomicRedisCache is most useful when wrapped around expensive but rarely
+changing calls, such as network APIs, that are hit frequently by many
+processes. For instance,
+
+```
+AtomicRedisCache.fetch('search.results') do
+  JSON.parse(Faraday.get('https://internal-api/search?q=value').body)
+end
+```
+
+will prevent your `internal-api` from getting pounded when the cached expires.
 
 ## Contributing
 

data/atomic_redis_cache.gemspec

@@ -23,5 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'fakeredis'
-  spec.add_development_dependency 'timecop'
+  if RUBY_VERSION == '1.8.7'
+    spec.add_development_dependency 'timecop', '0.5.2'
+  else
+    spec.add_development_dependency 'timecop'
+  end
 end

data/lib/atomic_redis_cache/version.rb

@@ -1,3 +1,3 @@
 module AtomicRedisCache
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_redis_cache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md