cachebar 1.1.0

data/test/helper.rb

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+require 'vcr'
+require 'active_support/testing/assertions'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cachebar'
+require 'twitter_api'
+require 'redis-namespace'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  c.stub_with :webmock
+  c.default_cassette_options = { :record => :none }
+  c.allow_http_connections_when_no_cassette = false
+end
+
+HTTParty::HTTPCache.perform_caching = true
+
+class Test::Unit::TestCase
+  include ActiveSupport::Testing::Assertions
+
+  def turn_off_caching
+    HTTParty::HTTPCache.perform_caching = false
+  end
+
+  def turn_on_caching
+    HTTParty::HTTPCache.perform_caching = true
+  end
+
+  def fixture_file(name)
+    File.read(File.join(File.dirname(__FILE__), 'fixtures', name))
+  end
+
+  def mock_response_in_backup(hash)
+    @redis.stubs(:exists).with("api-cache:twitter:#{hash}").returns(false)
+    @redis.stubs(:exists).with("api-cache:twitter").returns(true)
+    @redis.stubs(:hexists).with("api-cache:twitter", hash).returns(true)
+    @redis.expects(:hget).with('api-cache:twitter', hash).returns(@response)
+    @redis.expects(:set).with("api-cache:twitter:#{hash}", @response).returns(true)
+    @redis.expects(:expire).with("api-cache:twitter:#{hash}", 300).returns(true)
+  end
+
+  def mock_no_response_in_backup(hash)
+    @redis.stubs(:exists).with("api-cache:twitter:#{hash}").returns(false)
+    @redis.stubs(:exists).with("api-cache:twitter").returns(true)
+    @redis.stubs(:hexists).with("api-cache:twitter", hash).returns(false)
+  end
+
+  def mock_bad_response_from_server
+    http_response = mock
+    http_response.expects(:is_a?).with(Net::HTTPSuccess).returns(false)
+    HTTParty::Response.any_instance.expects(:response).at_least_once.returns(http_response)
+  end
+
+  def mock_http_exception
+    HTTParty::Request.any_instance.expects(:perform_without_caching).raises(Net::HTTPError.new("ERROR MESSAGE", stub('response')))
+  end
+end

data/test/test_cachebar.rb

@@ -0,0 +1,235 @@
+require 'helper'
+
+class TestCacheBar < Test::Unit::TestCase
+  context 'CacheBar' do
+
+    context 'mocking redis' do
+      setup do
+        @redis = mock
+        HTTParty::HTTPCache.redis = @redis
+      end
+
+      context 'with caching on' do
+        context 'with a good response' do
+          setup do
+            @uri_hash = '007a3a7aa28b11ef362040283e114f55'
+            @response = fixture_file('user_timeline.json')
+            VCR.insert_cassette('good_response')
+          end
+
+          teardown do
+            VCR.eject_cassette
+          end
+
+          should "set key with expiration" do
+            @redis.stubs(:exists).returns(false)
+            @redis.expects(:set).with("api-cache:twitter:#{@uri_hash}", @response).returns(true)
+            @redis.expects(:expire).with("api-cache:twitter:#{@uri_hash}", is_a(Integer)).returns(true)
+            @redis.stubs(:hset).returns(true)
+            TwitterAPI.user_timeline('viget')
+          end
+
+          should "store a backup" do
+            @redis.stubs(:exists).returns(false)
+            @redis.stubs(:set).returns(true)
+            @redis.stubs(:expire).returns(true)
+            @redis.expects(:hset).with('api-cache:twitter', @uri_hash, @response).returns(true)
+            TwitterAPI.user_timeline('viget')
+          end
+
+          should 'return expected result to PIM class' do
+            @redis.stubs(:exists).returns(false)
+            @redis.stubs(:set).returns(true)
+            @redis.stubs(:expire).returns(true)
+            @redis.stubs(:hset).returns(true)
+            tweets = TwitterAPI.user_timeline('viget')
+            assert_kind_of Array, tweets.parsed_response
+            assert tweets.parsed_response.present?
+          end
+
+          context 'and stored in cache' do
+            should 'retrieve response from cache correctly' do
+              @redis.stubs(:exists).returns(true)
+              @redis.expects(:get).with("api-cache:twitter:#{@uri_hash}").returns(@response)
+              tweets = TwitterAPI.user_timeline('viget')
+              assert_kind_of Array, tweets.parsed_response
+              assert tweets.parsed_response.present?
+            end
+          end
+        end
+
+        context 'with timeout' do
+          setup do
+            @uri_hash = '007a3a7aa28b11ef362040283e114f55'
+            @response = fixture_file('user_timeline.json')
+            HTTParty::Request.any_instance.expects(:timeout).raises(Timeout::Error)
+          end
+
+          should 'retrieve from backup if exists' do
+            mock_response_in_backup(@uri_hash)
+            response = TwitterAPI.user_timeline('viget')
+            assert_kind_of Array, response.parsed_response
+            assert response.parsed_response.present?
+          end
+
+          should 'raise NoResponseError error if no response in backup' do
+            mock_no_response_in_backup(@uri_hash)
+            assert_raise HTTParty::HTTPCache::NoResponseError do
+              TwitterAPI.user_timeline('viget')
+            end
+          end
+        end
+
+        context 'with unparsable response' do
+          setup do
+            VCR.insert_cassette('unparsable')
+            @uri_hash = '9780998e3ec445e5c0e56ca0bf10248c'
+            @response = fixture_file('user_timeline.json')
+          end
+
+          should 'retrieve from backup if exists' do
+            mock_response_in_backup(@uri_hash)
+            response = TwitterAPI.bogus_resource
+            assert_kind_of Array, response.parsed_response
+            assert response.parsed_response.present?
+          end
+
+          should 'raise NoResponseError error if no response in backup' do
+            mock_no_response_in_backup(@uri_hash)
+            assert_raise HTTParty::HTTPCache::NoResponseError do
+              TwitterAPI.bogus_resource
+            end
+          end
+
+          teardown do
+            VCR.eject_cassette
+          end
+        end
+
+        context 'with bad response' do
+          setup do
+            VCR.insert_cassette('bad_response')
+            @uri_hash = '01cedaf99cbf9f7e585ac4fa034a4fd5'
+            @response = fixture_file('user_timeline.json')
+          end
+
+          should 'retrieve from backup if exists' do
+            mock_response_in_backup(@uri_hash)
+            response = TwitterAPI.bogus_timeline('viget')
+            assert_kind_of Array, response.parsed_response
+            assert response.parsed_response.present?
+          end
+
+          should 'return bad response' do
+            mock_no_response_in_backup(@uri_hash)
+            response = TwitterAPI.bogus_timeline('viget')
+            assert_equal 401, response.code
+            assert !response.response.is_a?(Net::HTTPSuccess)
+          end
+
+          teardown do
+            VCR.eject_cassette
+          end
+        end
+
+        context 'with bad response exception' do
+          setup do
+            @uri_hash = '9780998e3ec445e5c0e56ca0bf10248c'
+            @response = fixture_file('user_timeline.json')
+          end
+
+          should 'retrieve from backup if exists' do
+            mock_response_in_backup(@uri_hash)
+            mock_http_exception
+            response = TwitterAPI.bogus_resource
+            assert_kind_of Array, response.parsed_response
+            assert response.parsed_response.present?
+          end
+
+          should 'raise NoResponseError error if no response in backup' do
+            mock_no_response_in_backup(@uri_hash)
+            mock_http_exception
+            assert_raise HTTParty::HTTPCache::NoResponseError do
+              TwitterAPI.bogus_resource
+            end
+          end
+        end
+      
+        context 'with a post' do
+          setup do
+            VCR.insert_cassette('status_update_post')
+          end
+          
+          should 'never try to cache' do
+            @redis.expects(:exists).never
+            @redis.expects(:set).never
+            @redis.expects(:expires).never
+            @redis.expects(:hset).never
+            @redis.expects(:get).never
+            TwitterAPI.update_status('viget', 'My new status.')
+          end
+          
+          teardown do
+            VCR.eject_cassette
+          end
+        end
+      end
+
+      context 'with caching off' do
+        setup do
+          turn_off_caching
+          @redis.expects(:exists).never
+          @uri_hash = '007a3a7aa28b11ef362040283e114f55'
+          @response = fixture_file('user_timeline.json')
+          VCR.insert_cassette('good_response')
+        end
+
+        should 'just return the response' do
+          tweets = TwitterAPI.user_timeline('viget')
+          assert_kind_of Array, tweets.parsed_response
+          assert tweets.parsed_response.present?
+        end
+
+        teardown do
+          VCR.eject_cassette
+          turn_on_caching
+        end
+      end
+    end
+
+    context 'connecting to redis' do
+      setup do
+        VCR.insert_cassette('good_response')
+
+        redis = Redis.new(:host => 'localhost', :port => 6379,
+          :thread_safe => true, :db => '3')
+        @redis = Redis::Namespace.new('httpcache', :redis => redis)
+        HTTParty::HTTPCache.redis = @redis
+
+        @redis.keys("api-cache*").each do |key|
+          @redis.del(key)
+        end
+      end
+
+      should "store its response in the cache" do
+        assert_difference "@redis.keys('api-cache:twitter:*').count", 1 do
+          TwitterAPI.user_timeline('viget')
+        end
+      end
+
+      should "store a backup of its response" do
+        assert_difference "@redis.hkeys('api-cache:twitter').count", 1 do
+          TwitterAPI.user_timeline('viget')
+        end
+      end
+
+      teardown do
+        VCR.eject_cassette
+        @redis.keys("api-cache*").each do |key|
+          @redis.del(key)
+        end
+      end
+    end
+
+  end
+end

data/test/twitter_api.rb

@@ -0,0 +1,30 @@
+module TwitterAPI
+  include HTTParty
+  base_uri 'https://api.twitter.com/1'
+  format :json
+
+  caches_api_responses :key_name => "twitter", :expire_in => 3600
+
+  class << self
+    def user_timeline(username)
+      get '/statuses/user_timeline.json', :query => {:screen_name => username}
+    end
+
+    def bogus_timeline(username)
+      get '/statuses/bogus_timeline.json', :query => {:screen_name => username}
+    end
+
+    def bogus_resource
+      get '/user_timeline.json'
+    end
+    
+    def update_status(username, new_status)
+      # this is just for testing as this isn't really complient with API
+      post '/statuses/update.json', :query => {
+        :screen_name => username,
+        :status => new_status
+      }
+    end
+  end
+
+end

metadata

@@ -0,0 +1,277 @@
+--- !ruby/object:Gem::Specification
+name: cachebar
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Landau
+- David Eisinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: SystemTimer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple API caching layer built on top of HTTParty and Redis
+email: brian.landau@viget.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- CacheBar.gemspec
+- Gemfile
+- HISTORY
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/cachebar.rb
+- lib/httparty/httpcache.rb
+- test/fixtures/user_timeline.json
+- test/fixtures/vcr_cassettes/bad_response.yml
+- test/fixtures/vcr_cassettes/good_response.yml
+- test/fixtures/vcr_cassettes/status_update_post.yml
+- test/fixtures/vcr_cassettes/unparsable.yml
+- test/helper.rb
+- test/test_cachebar.rb
+- test/twitter_api.rb
+homepage: http://github.com/vigetlabs/cachebar
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4078844821069531998
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A simple API caching layer built on top of HTTParty and Redis
+test_files: []