typhoeus_spec_cache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+typhoeus_spec_cache.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 David Balatero <david@mediapiston.com>
+
+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

@@ -0,0 +1,17 @@
+= typhoeus_spec_cache
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 David Balatero. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "typhoeus_spec_cache"
+    gem.summary = %Q{A plugin to help you dynamically manage HTTP caching for your specs.}
+    gem.description = %Q{A plugin to help you dynamically manage HTTP caching for your specs.}
+    gem.email = "dbalatero@gmail.com"
+    gem.homepage = "http://github.com/dbalatero/typhoeus_spec_cache"
+    gem.authors = ["David Balatero"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "typhoeus_spec_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/typhoeus/response_marshalling.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module Typhoeus
+  class Response
+    def _dump(depth)
+      fields = {
+        :code => @code,
+        :headers => @headers,
+        :body => @body,
+        :time => @time,
+        :requested_url => @requested_url,
+        :requested_http_method => @requested_http_method,
+        :start_time => @start_time
+      }
+
+      YAML.dump(fields)
+    end
+
+    def self._load(string)
+      options = YAML.load(string)
+      Typhoeus::Response.new(options)
+    end
+  end
+end

data/lib/typhoeus/spec_cache.rb

@@ -0,0 +1,87 @@
+module Typhoeus
+  class SpecCache
+    attr_accessor :responses
+    attr_accessor :cache_path
+    attr_reader :hydra
+
+    def initialize(hydra, cache_path)
+      @responses = {}
+      @cache_path = cache_path
+
+      @hydra = hydra
+      @hydra.cache_setter do |request|
+        cache_setter_callback(request)
+      end
+      @hydra.cache_getter do |request|
+        cache_getter_callback(request)
+      end
+
+      read_cache_fixtures!
+    end
+
+    def cache_setter_callback(request)
+      responses[request.cache_key] = request.response
+    end
+
+    def cache_getter_callback(request)
+      responses[request.cache_key]
+    end
+
+    def filepath_for(cache_key)
+      "#{cache_path}/#{cache_key}.cache"
+    end
+
+    # Removes any cache files that aren't needed anymore
+    def remove_unnecessary_cache_files!
+      current_keys = cache_files.map do |file|
+        get_cache_key_from_filename(file)
+      end
+      inmemory_keys = responses.keys
+
+      unneeded_keys = current_keys - inmemory_keys
+      unneeded_keys.each do |key|
+        File.unlink(filepath_for(key))
+      end
+    end
+
+    # Reads in the cache fixture files to in-memory cache.
+    def read_cache_fixtures!
+      cache_files.each do |file|
+        cache_key = get_cache_key_from_filename(file)
+        responses[cache_key] = Marshal.load(File.read(file))
+      end
+    end
+
+    # Dumps out any cached items to disk.
+    def dump_cache_fixtures!
+      responses.each do |cache_key, response|
+        File.open(filepath_for(cache_key), "wb") do |fp|
+          fp.write(Marshal.dump(response))
+        end
+      end
+    end
+
+    def clear_hydra_callbacks!
+      if hydra.respond_to?(:clear_cache_callbacks)
+        hydra.clear_cache_callbacks
+      else
+        # you like that? do you?!?!
+        hydra.instance_variable_set("@cache_setter", nil)
+        hydra.instance_variable_set("@cache_getter", nil)
+      end
+    end
+
+    def clear_cache!
+      @responses = {}
+    end
+
+    def cache_files
+      Dir.glob("#{cache_path}/*.cache")
+    end
+
+    private
+    def get_cache_key_from_filename(file)
+      File.basename(file).gsub(/\.cache/, '')
+    end
+  end
+end

data/lib/typhoeus/spec_cache_macros.rb

@@ -0,0 +1,25 @@
+module Typhoeus
+  module SpecCacheMacros
+    module InstanceMethods
+      def stub_hydra(hydra)
+        Typhoeus::Hydra.stub(:new).
+          and_return(hydra)
+      end
+    end
+
+    module ClassMethods
+      def typhoeus_spec_cache(cache_path, &block)
+        hydra = Typhoeus::Hydra.new
+        cache = SpecCache.new(hydra, cache_path)
+
+        yield hydra
+
+        after(:all) do
+          cache.remove_unnecessary_cache_files!
+          cache.dump_cache_fixtures!
+          cache.clear_hydra_callbacks!
+        end
+      end
+    end
+  end
+end

data/lib/typhoeus_spec_cache.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'typhoeus'
+require 'typhoeus'
+
+Dir.glob(File.dirname(__FILE__) + "/**/*.rb").each do |f|
+  require f
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'typhoeus_spec_cache'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/typhoeus/spec_cache_macros_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Typhoeus::SpecCacheMacros do
+  describe "#typhoeus_spec_cache" do
+    include Typhoeus::SpecCacheMacros::ClassMethods
+    before(:each) do
+      @path = "path/to/cache"
+      @cache = mock('spec cache')
+      Typhoeus::SpecCache.should_receive(:new).
+        with(an_instance_of(Typhoeus::Hydra), @path).and_return(@cache)
+      @cache.should_receive(:remove_unnecessary_cache_files!).ordered
+      @cache.should_receive(:dump_cache_fixtures!).ordered
+      @cache.should_receive(:clear_hydra_callbacks!)
+
+      self.should_receive(:after).
+        with(:all).
+        and_yield
+
+      @value_to_modify = nil
+      block_to_run = lambda { |hydra|
+        @value_to_modify = 50
+      }
+
+      typhoeus_spec_cache(@path, &block_to_run)
+    end
+
+    it "should run the block successfully" do
+      @value_to_modify.should == 50
+    end
+  end
+end

data/spec/typhoeus/spec_cache_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+def cache_path(name)
+  File.expand_path(File.dirname(__FILE__) + "/../fixtures/#{name}")
+end
+
+describe Typhoeus::SpecCache do
+  before(:each) do
+    @hydra = mock('hydra')
+    @hydra.should_receive(:cache_setter)
+    @hydra.should_receive(:cache_getter)
+    @cache = Typhoeus::SpecCache.new(@hydra,
+                                     cache_path('cache'))
+    @request = mock('typhoeus request',
+                    :cache_key => 'mykey',
+                    :response => mock('typhoeus response'))
+  end
+
+  describe "#cache_setter_callback" do
+    it "should cache a request" do
+      @cache.cache_setter_callback(@request)
+      @cache.responses['mykey'].should == @request.response
+    end
+  end
+
+  describe "#cache_getter_callback" do
+    it "should return nil if there is no cache hit" do
+      result = @cache.cache_getter_callback(@request)
+      result.should be_nil
+    end
+
+    it "should return the response if there is a cache hit" do
+      @cache.cache_setter_callback(@request)
+      result = @cache.cache_getter_callback(@request)
+      result.should == @request.response
+    end
+  end
+
+  describe "#clear_hydra_callbacks!" do
+    it "should not completely die" do
+      @cache.clear_hydra_callbacks!
+    end
+  end
+
+  describe "#read_cache_fixtures!" do
+    it "should read in cache fixtures that are dumped out" do
+      @cache.cache_setter_callback(@request)
+      @cache.dump_cache_fixtures!
+      @cache.clear_cache!
+      @cache.responses.should have(0).things
+
+      @cache.read_cache_fixtures!
+      @cache.responses.should have(1).things
+      @cache.responses[@request.cache_key].should be_an_instance_of(Spec::Mocks::Mock)
+    end
+  end
+
+  describe "#remove_unnecessary_cache_files!" do
+    it "should remove any .cache files that are in the cache directory, but not needed" do
+      @cache.cache_setter_callback(@request)
+      @cache.dump_cache_fixtures!
+
+      old_keys = ['oldkey', 'oldkey2']
+      old_keys.each do |key|
+        File.open(@cache.filepath_for(key), "wb") do |f|
+          f.write "blah blah blah"
+        end
+      end
+
+      @cache.cache_files.should have(3).things
+      @cache.remove_unnecessary_cache_files!
+      @cache.cache_files.should have(1).things
+    end
+  end
+
+  describe "#clear_cache!" do
+    it "should clear the in-memory cache" do
+      @cache.cache_setter_callback(@request)
+      @cache.responses.should have(1).thing
+      @cache.clear_cache!
+      @cache.responses.should be_empty
+    end
+  end
+
+  describe "#dump_cache_fixtures!" do
+    it "should dump out the responses to disk" do
+      @cache.cache_setter_callback(@request)
+      @cache.responses.should have(1).thing
+      @cache.dump_cache_fixtures!
+      @cache.responses.each do |key, response|
+        path = @cache.filepath_for(key)
+        File.exist?(path).should be_true
+
+        # cleanup
+        File.unlink(path)
+        File.exist?(path).should be_false
+      end
+    end
+  end
+
+  after(:each) do
+    @cache.cache_files.each { |f| File.unlink(f) }
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: typhoeus_spec_cache
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Balatero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A plugin to help you dynamically manage HTTP caching for your specs.
+email: dbalatero@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/typhoeus/response_marshalling.rb
+- lib/typhoeus/spec_cache.rb
+- lib/typhoeus/spec_cache_macros.rb
+- lib/typhoeus_spec_cache.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/typhoeus/spec_cache_macros_spec.rb
+- spec/typhoeus/spec_cache_spec.rb
+has_rdoc: true
+homepage: http://github.com/dbalatero/typhoeus_spec_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A plugin to help you dynamically manage HTTP caching for your specs.
+test_files: 
+- spec/spec_helper.rb
+- spec/typhoeus/spec_cache_macros_spec.rb
+- spec/typhoeus/spec_cache_spec.rb