CacheBar 1.0.1 → 1.0.2

data/CacheBar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{CacheBar}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Landau", "David Eisinger"]
-  s.date = %q{2011-06-01}
+  s.date = %q{2011-11-17}
   s.description = %q{A simple API caching layer built on top of HTTParty and Redis}
   s.email = %q{brian.landau@viget.com}
   s.extra_rdoc_files = [
@@ -26,11 +26,11 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/cachebar.rb",
-    "lib/core_ext/hash/require_keys.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",
@@ -50,7 +50,6 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<redis-namespace>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, ["~> 0.7.7"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<SystemTimer>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6"])
@@ -59,12 +58,12 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<vcr>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<SystemTimer>, [">= 0"])
     else
       s.add_dependency(%q<redis>, [">= 0"])
       s.add_dependency(%q<redis-namespace>, [">= 0"])
       s.add_dependency(%q<httparty>, ["~> 0.7.7"])
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<SystemTimer>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6"])
@@ -73,13 +72,13 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<vcr>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<SystemTimer>, [">= 0"])
     end
   else
     s.add_dependency(%q<redis>, [">= 0"])
     s.add_dependency(%q<redis-namespace>, [">= 0"])
     s.add_dependency(%q<httparty>, ["~> 0.7.7"])
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<SystemTimer>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6"])
@@ -88,6 +87,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<vcr>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<SystemTimer>, [">= 0"])
   end
 end
 

data/Gemfile

@@ -4,7 +4,6 @@ gem "redis"
 gem "redis-namespace"
 gem 'httparty', '~> 0.7.7'
 gem 'activesupport'
-gem 'SystemTimer', :platforms => :ruby_18
 
 group :development do
   gem "shoulda"
@@ -15,4 +14,5 @@ group :development do
   gem 'vcr'
   gem 'mocha'
   gem 'rake', '~> 0.8.7'
+  gem 'SystemTimer', :platforms => :ruby_18
 end

data/README.md

@@ -64,7 +64,7 @@ If you already have HTTParty included then you just need to use the `caches_api_
 
 * `host`* *optional*:
   * This is used internally to decide which requests to try to cache responses for.
-    If it's not provided it will use the `base_uri` specified on the class/module that HTTParty is included into.
+    If you've defined `base_uri` on the class/module that HTTParty is included into then this option is not needed.
 * `key_name`:
   * This is the name used in Redis to create a part of the cache key to easily differentiate it from other API caches.
 * `expire_in`:

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/cachebar.rb

@@ -5,7 +5,6 @@ require 'active_support'
 require 'active_support/core_ext/module/aliasing'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/object/blank'
-require 'core_ext/hash/require_keys'
 if RUBY_VERSION.split('.')[1].to_i < 9
   begin
     require 'system_timer'
@@ -18,7 +17,12 @@ require 'httparty/httpcache'
 module CacheBar
   def self.register_api_to_cache(host, options)
     raise ArgumentError, "You must provide a host that you are caching API responses for." if host.blank?
-    options.require_keys(:expire_in, :key_name)
+
+    missing_options = ([:expire_in, :key_name] - options.keys)
+    if missing_options.present?
+      raise(ArgumentError, "Missing some required options: #{missing_options.join(", ")}")
+    end
+
     HTTParty::HTTPCache.apis[host] = options
   end
 
@@ -32,6 +36,7 @@ module CacheBar
       CacheBar.register_api_to_cache(host, options)
     end
   end
+
 end
 
 HTTParty::ClassMethods.send(:include, CacheBar::ClassMethods)

data/lib/httparty/httpcache.rb

@@ -21,11 +21,12 @@ module HTTParty
     end
 
     def perform_with_caching
-      if HTTPCache.perform_caching && HTTPCache.apis.keys.include?(uri.host)
+      if cacheable?
         if response_in_cache?
           log_message("Retrieving response from cache")
           response_from(response_body_from_cache)
         else
+          validate
           begin
             httparty_response = timeout(timeout_length) do
               perform_without_caching
@@ -49,6 +50,11 @@ module HTTParty
     end
 
     protected
+    
+    def cacheable?
+      HTTPCache.perform_caching && HTTPCache.apis.keys.include?(uri.host) &&
+        http_method == Net::HTTP::Get
+    end
 
     def response_from(response_body)
       HTTParty::Response.new(self, OpenStruct.new(:body => response_body), parse_response(response_body))

data/test/fixtures/vcr_cassettes/status_update_post.yml

@@ -0,0 +1,49 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://api.twitter.com:443/1/statuses/update.json?screen_name=viget&status=My%20new%20status.
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Wed, 01 Jun 2011 20:37:34 GMT
+      server:
+      - hi
+      status:
+      - 200 OK
+      x-transaction:
+      - 1306960654-78174-14919
+      x-frame-options:
+      - SAMEORIGIN
+      last-modified:
+      - Wed, 01 Jun 2011 20:37:34 GMT
+      content-type:
+      - application/json; charset=utf-8
+      content-length:
+      - '1'
+      pragma:
+      - no-cache
+      x-revision:
+      - DEV
+      expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      cache-control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      x-mid:
+      - 174ecf14d1392c67f19109aa27b707fad326ca40
+      set-cookie:
+      - _twitter_sess=BAh7CToMY3NyZl9pZCIlYTdjZTM5MGNiYjM3MjY4ZWRhM2FhNGYwODAxMDk0%250AMjU6D2NyZWF0ZWRfYXRsKwiR8OxMMAE6B2lkIiVhMWRhMmE2M2QzMjNhMDU5%250ANjg1OTNjODkyNTFmMmYwMSIKZmxhc2hJQzonQWN0aW9uQ29udHJvbGxlcjo6%250ARmxhc2g6OkZsYXNoSGFzaHsABjoKQHVzZWR7AA%253D%253D--200a7dfe09fd1b68cc9e4924ce8af6fc7278d954;
+        domain=.twitter.com; path=/; HttpOnly
+      - auth_token=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT
+      - guest_id=130696065447966883; path=/; expires=Fri, 01 Jul 2011 20:37:34 GMT
+      - k=70.182.186.100.1306960654472912; path=/; expires=Wed, 08-Jun-11 20:37:34
+        GMT; domain=.twitter.com
+      vary:
+      - Accept-Encoding
+    body: ! ""
+    http_version: '1.1'

data/test/test_cachebar.rb

@@ -154,6 +154,25 @@ class TestCacheBar < Test::Unit::TestCase
             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

data/test/twitter_api.rb

@@ -17,6 +17,14 @@ module TwitterAPI
     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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CacheBar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-01 00:00:00.000000000 -04:00
+date: 2011-11-17 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2152494480 !ruby/object:Gem::Requirement
+  requirement: &2152173840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152494480
+  version_requirements: *2152173840
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &2152494000 !ruby/object:Gem::Requirement
+  requirement: &2152173280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152494000
+  version_requirements: *2152173280
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2152493520 !ruby/object:Gem::Requirement
+  requirement: &2152172740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 0.7.7
   type: :runtime
   prerelease: false
-  version_requirements: *2152493520
+  version_requirements: *2152172740
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152493040 !ruby/object:Gem::Requirement
+  requirement: &2152172200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,21 +56,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152493040
-- !ruby/object:Gem::Dependency
-  name: SystemTimer
-  requirement: &2152492560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2152492560
+  version_requirements: *2152172200
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2152492080 !ruby/object:Gem::Requirement
+  requirement: &2152171680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152492080
+  version_requirements: *2152171680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152491600 !ruby/object:Gem::Requirement
+  requirement: &2152171160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -89,10 +78,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2152491600
+  version_requirements: *2152171160
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152491120 !ruby/object:Gem::Requirement
+  requirement: &2152170620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -100,10 +89,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *2152491120
+  version_requirements: *2152170620
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152490640 !ruby/object:Gem::Requirement
+  requirement: &2152170120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152490640
+  version_requirements: *2152170120
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2152490160 !ruby/object:Gem::Requirement
+  requirement: &2152169620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +111,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152490160
+  version_requirements: *2152169620
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2152489680 !ruby/object:Gem::Requirement
+  requirement: &2152169080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152489680
+  version_requirements: *2152169080
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152489200 !ruby/object:Gem::Requirement
+  requirement: &2152168540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +133,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152489200
+  version_requirements: *2152168540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152488720 !ruby/object:Gem::Requirement
+  requirement: &2152168020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,7 +144,18 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *2152488720
+  version_requirements: *2152168020
+- !ruby/object:Gem::Dependency
+  name: SystemTimer
+  requirement: &2152167520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152167520
 description: A simple API caching layer built on top of HTTParty and Redis
 email: brian.landau@viget.com
 executables: []
@@ -173,11 +173,11 @@ files:
 - Rakefile
 - VERSION
 - lib/cachebar.rb
-- lib/core_ext/hash/require_keys.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
@@ -198,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1378991500197492114
+      hash: 2868285217308708845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/core_ext/hash/require_keys.rb

@@ -1,6 +0,0 @@
-class Hash
-  def require_keys(*valid_keys)
-    missing_keys = [valid_keys].flatten - keys
-    raise(ArgumentError, "Missing some required keys: #{missing_keys.join(", ")}") unless missing_keys.empty?
-  end
-end