api_cache 0.2.0 → 0.2.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+.DS_Store
+rdoc
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2011 Martyn Loughran
+
+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.rdoc → README.md}

@@ -1,8 +1,8 @@
-= APICache (aka api_cache)
+# APICache (aka api_cache)
 
 APICache allows any API client library to be easily wrapped with a robust caching layer. It supports caching (obviously), serving stale data and limits on the number of API calls. It's also got a handy syntax if all you want to do is cache a bothersome url.
 
-== For the impatient
+## For the impatient
 
     # Install
     sudo gem install api_cache -s http://gemcutter.org
@@ -15,6 +15,7 @@ APICache allows any API client library to be easily wrapped with a robust cachin
     APICache.get("http://twitter.com/statuses/public_timeline.rss")
     
     # Use a proper store
+    require 'moneta'
     require 'moneta/memcache'
     APICache.store = Moneta::Memcache.new(:server => "localhost")
     
@@ -24,7 +25,16 @@ APICache allows any API client library to be easily wrapped with a robust cachin
       FlickrRb.get_all_sets
     end
 
-== The longer version
+## Heroku + memcache
+
+Heroku memcache add-on users can use APICache with the [Dalli](https://github.com/mperham/dalli) gem, no manual configuration is required as Dalli automatically picks up the appropriate environment variables.
+
+    require 'api_cache'
+    require 'dalli'
+
+    APICache.store = APICache::DalliStore.new(Dalli::Client.new)
+
+## The longer version
 
 You want to use the Twitter API but you don't want to die?
 
@@ -36,7 +46,7 @@ This works better than a standard HTTP get because you get the following functio
 * Stale response returned for a day if twitter is down
 * Limited to attempt a connection at most once a minute
 
-To understand what <tt>APICache</tt> does here's an example: Given cached data less than 10 minutes old, it returns that. Otherwise, assuming it didn't try to request the URL within the last minute (to avoid the rate limit), it makes a get request to the supplied url. If the Twitter API timeouts or doesn't return a 2xx code (very likely) we're still fine: it just returns the last data fetched (as long as it's less than a day old). In the exceptional case that all is lost and no data can be returned, a subclass of <tt>APICache::APICacheError</tt> is raised which you're responsible for rescuing.
+To understand what `APICache` does here's an example: Given cached data less than 10 minutes old, it returns that. Otherwise, assuming it didn't try to request the URL within the last minute (to avoid the rate limit), it makes a get request to the supplied url. If the Twitter API timeouts or doesn't return a 2xx code (very likely) we're still fine: it just returns the last data fetched (as long as it's less than a day old). In the exceptional case that all is lost and no data can be returned, a subclass of `APICache::APICacheError` is raised which you're responsible for rescuing.
 
 Assuming that you don't care whether it was a timeout error or an invalid response (for example) you could do this:
 
@@ -69,9 +79,9 @@ The real value however is not caching HTTP calls, but allowing caching functiona
       end
     end
 
-The first argument to <tt>APICache.get</tt> is now assumed to be a unique key rather than a URL. As you'd expect, the block will only be called if the request cannot be fulfilled by the cache. Throwing any exception signals to <tt>APICache</tt> that the request was not successful, should not be cached, and a cached value should be returned if available. If a cached value is not available then the exception will be re-raised for you to handle.
+The first argument to `APICache.get` is now assumed to be a unique key rather than a URL. As you'd expect, the block will only be called if the request cannot be fulfilled by the cache. Throwing any exception signals to `APICache` that the request was not successful, should not be cached, and a cached value should be returned if available. If a cached value is not available then the exception will be re-raised for you to handle.
 
-You can send any of the following options to <tt>APICache.get(url, options = {}, &block)</tt>. These are the default values (times are all in seconds):
+You can send any of the following options to `APICache.get(url, options = {}, &block)`. These are the default values (times are all in seconds):
 
     {
       :cache => 600,    # 10 minutes  After this time fetch new data
@@ -89,6 +99,15 @@ Before using the APICache you should set the cache to use. By default an in memo
 
 Please be liberal with the github issue tracker, more so with pull requests, or drop me a mail to me [at] mloughran [dot] com. I'd love to hear from you.
 
-== Copyright
+## Contributing
+
+There is a Gemfile to make running the specs easy:
+
+    bundle install
+    bundle exec rake
+
+Code, write specs, send pull request, easy as pie. Thanks!
+
+## Copyright
 
-Copyright (c) 2008 Martyn Loughran. See LICENSE for details.
+Copyright (c) 2008-2011 Martyn Loughran. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/api_cache.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "api_cache"
+  s.version     = "0.2.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Martyn Loughran"]
+  s.email       = ["me@mloughran.com"]
+  s.homepage    = "http://mloughran.github.com/api_cache/"
+  s.summary     = %q{API Cache allows advanced caching of APIs}
+  s.description = %q{APICache allows any API client library to be easily wrapped with a robust caching layer. It supports caching (obviously), serving stale data and limits on the number of API calls. It's also got a handy syntax if all you want to do is cache a bothersome url.}
+
+  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"]
+
+  s.add_development_dependency('rspec', "~> 1.0")
+  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('moneta', "~> 0.6.0")
+  s.add_development_dependency('dalli')
+  s.add_development_dependency('memcache-client')
+end

data/init.rb

@@ -0,0 +1,2 @@
+# To use api_cache as a rails plugin
+require "api_cache"

data/lib/api_cache.rb

@@ -133,5 +133,7 @@ require 'api_cache/cache'
 require 'api_cache/api'
 
 APICache.autoload 'AbstractStore', 'api_cache/abstract_store'
+APICache.autoload 'DalliStore', 'api_cache/dalli_store'
 APICache.autoload 'MemoryStore', 'api_cache/memory_store'
 APICache.autoload 'MonetaStore', 'api_cache/moneta_store'
+APICache.autoload 'NullStore', 'api_cache/null_store'

data/lib/api_cache/dalli_store.rb

@@ -0,0 +1,29 @@
+class APICache
+  class DalliStore < APICache::AbstractStore
+    def initialize(store)
+      @dalli = store
+    end
+
+    # Set value. Returns true if success.
+    def set(key, value)
+      @dalli.set(key, value)
+      @dalli.set("#{key}_created_at", Time.now)
+      true
+    end
+
+    # Get value.
+    def get(key)
+      @dalli.get(key)
+    end
+
+    # Does a given key exist in the cache?
+    def exists?(key)
+      !get(key).nil?
+    end
+
+    # Has a given time passed since the key was set?
+    def expired?(key, timeout)
+      Time.now - @dalli.get("#{key}_created_at") > timeout
+    end
+  end
+end

data/lib/api_cache/null_store.rb

@@ -0,0 +1,20 @@
+class APICache
+  # A null store for environments where caching may be undesirable, such as
+  # testing.
+  class NullStore < APICache::AbstractStore
+    def initialize
+    end
+    
+    def exists?(key)
+      false
+    end
+
+    def set(key, value)
+      true
+    end
+
+    def expired?(key, timeout)
+      true
+    end
+  end
+end

data/spec/api_cache_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe APICache do
   before :each do

data/spec/api_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe APICache::API do
   before :each do

data/spec/cache_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe APICache::Cache do
   before :each do

data/spec/dalli_store_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'dalli'
+
+describe APICache::DalliStore do
+  before :each do
+    @dalli = Dalli::Client.new('localhost:11211')
+    @dalli.delete('foo')
+    @store = APICache::DalliStore.new(@dalli)
+  end
+
+  it 'should set and get' do
+    @store.set('key', 'value')
+    @store.get('key').should == 'value'
+  end
+
+  it 'should allow checking whether a key exists' do
+    @store.exists?('foo').should be_false
+    @store.set('foo', 'bar')
+    @store.exists?('foo').should be_true
+  end
+
+  it 'should allow checking whether a given amount of time has passed since the key was set' do
+    @store.expired?('foo', 1).should be_false
+    @store.set('foo', 'bar')
+    @store.expired?('foo', 1).should be_false
+    sleep 1
+    @store.expired?('foo', 1).should be_true
+  end
+end

data/spec/integration_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe "api_cache" do
   before :each do

data/spec/monteta_store_spec.rb

@@ -1,5 +1,6 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
+require 'moneta'
 require 'moneta/memcache'
 
 describe APICache::MonetaStore do

data/spec/null_store_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe APICache::NullStore do
+  before :each do
+    @store = APICache::NullStore.new
+  end
+
+  it "should NOT set" do
+    @store.exists?('foo').should be_false
+    @store.set('foo', 'bar')
+    @store.exists?('foo').should be_false
+  end
+
+  it "should allows say keys are expired" do
+    @store.expired?('foo', 1).should be_true
+    @store.set('foo', 'bar')
+    @store.expired?('foo', 1).should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
-require "rubygems"
-require "api_cache"
 require "spec"
 require "fakeweb"
 
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require "api_cache"
+
 APICache.logger.level = Logger::FATAL

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: api_cache
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors: 
 - Martyn Loughran
@@ -9,31 +10,78 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 +02:00
+date: 2011-03-25 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: moneta
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: dalli
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id006
 description: APICache allows any API client library to be easily wrapped with a robust caching layer. It supports caching (obviously), serving stale data and limits on the number of API calls. It's also got a handy syntax if all you want to do is cache a bothersome url.
-email: me@mloughran.com
+email: 
+- me@mloughran.com
 executables: []
 
 extensions: []
@@ -41,48 +89,64 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README.rdoc
-- VERSION.yml
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- api_cache.gemspec
+- init.rb
+- lib/api_cache.rb
 - lib/api_cache/abstract_store.rb
 - lib/api_cache/api.rb
 - lib/api_cache/cache.rb
+- lib/api_cache/dalli_store.rb
 - lib/api_cache/memory_store.rb
 - lib/api_cache/moneta_store.rb
-- lib/api_cache.rb
+- lib/api_cache/null_store.rb
 - spec/api_cache_spec.rb
 - spec/api_spec.rb
 - spec/cache_spec.rb
+- spec/dalli_store_spec.rb
 - spec/integration_spec.rb
 - spec/monteta_store_spec.rb
+- spec/null_store_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://mloughran.github.com/api_cache/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --inline-source
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: API Cache allows advanced caching of APIs
-test_files: []
-
+test_files: 
+- spec/api_cache_spec.rb
+- spec/api_spec.rb
+- spec/cache_spec.rb
+- spec/dalli_store_spec.rb
+- spec/integration_spec.rb
+- spec/monteta_store_spec.rb
+- spec/null_store_spec.rb
+- spec/spec_helper.rb

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:patch: 0
-:major: 0
-:minor: 2