hydra_cache 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in filet.gemspec
+gemspec
+
+unless ENV["TRAVIS"]
+  gem 'ruby-debug19', :platforms => :ruby_19
+  gem 'ruby-debug', :platforms => :mri_18
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Jorge Dias, Albert Llop
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/Readme.md

@@ -0,0 +1,34 @@
+This is a gem to provide caching for typhoeus that works with Test Unit
+
+## Installation
+
+Simply install with:
+
+    gem install hydra_cache
+
+## Basic usage
+
+You need to configure your hydra instance:
+
+    hydra.cache_setter &HydraCache.method(:setter)
+    hydra.cache_getter &HydraCache.method(:getter)
+
+There is a parameter called revision. This parameter is useful to generate unique identifier for your requests, so when you change the revision the fixtures would get regenerated.
+
+You may as well configure the path for your fixture files. Put something like this in your test helper.
+
+    HydraCache.fixtures_path = 'test/fixtures'
+
+## Prefixes
+
+Prefixes allow you to configure a sub-directory where to put your fixtures, Eg.
+
+    class Test
+      def setup
+        HydraCache.prefix = 'Something'
+      end
+
+      def teardown
+        HydraCache.prefix = nil # Reset the original value
+      end
+    end

data/hydra_cache.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hydra_cache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hydra_cache"
+  s.version     = HydraCache::VERSION
+  s.authors     = ["Jorge Dias", "Albert Llop"]
+  s.email       = ["jorge.dias@xing.com", "albert.llop@xing.com"]
+  s.homepage    = ""
+  s.summary     = %q{Cache support for Hydra}
+  s.description = %q{This gem provides a cache mechanism for Hydra to avoid hitting the same request multiple times}
+
+  s.rubyforge_project = "hydra_cache"
+
+  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_dependency "rake"
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "typhoeus"
+  s.add_development_dependency "test-construct"
+end

data/lib/hydra_cache.rb

@@ -0,0 +1,66 @@
+require "hydra_cache/version"
+
+module HydraCache
+  extend self
+
+  attr_accessor :prefix
+  attr_accessor :revision
+  attr_writer   :fixtures_path
+
+  def setter(request)
+    set_cache request
+  end
+
+  def getter(request)
+    if response = get_cache(request)
+      response.request = request
+    else
+      request.cache_timeout = 1
+    end
+
+    response
+  end
+
+  def get_cache(request)
+    filename = cache_filename(request)
+
+    if File.exist?(filename)
+      YAML.load_file(filename)
+    else
+      false
+    end
+  end
+
+  def set_cache(request)
+    filename = cache_filename(request)
+    response = request.response
+    response.request = request.inspect
+
+    FileUtils.mkdir_p(File.dirname(filename))
+    File.open(filename, 'w') do |f|
+      f << response.to_yaml
+    end
+  end
+
+  def cache_filename(request)
+    uri = URI.parse(request.url)
+    uri.query = uri.query.split('&').sort.join('&') if uri.query
+
+    body = request.body.to_s.split(/\n/).map do |line|
+      Digest::SHA1.hexdigest(line)
+    end.sort.join
+
+    params = Array(request.params).map do |k,v|
+      Digest::SHA1.hexdigest("#{k},#{v}")
+    end.sort.join
+
+    digest = Digest::MD5.hexdigest("#{uri}|#{body}|#{params}|#{request.method}")
+
+    File.join(fixtures_path, prefix.to_s.gsub(/\W+/,'_'), "#{digest}.yml")
+  end
+
+  def fixtures_path
+    @fixtures_path || File.expand_path('fixtures')
+  end
+
+end

data/lib/hydra_cache/version.rb

@@ -0,0 +1,3 @@
+module HydraCache
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'construct'
+require 'hydra_cache'
+require 'typhoeus'
+
+begin require 'ruby-debug'; rescue LoadError; end

data/test/unit/hydra_cache_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+describe HydraCache do
+  include Construct::Helpers
+
+  after { HydraCache.fixtures_path = nil }
+
+  let(:hydra) do
+    hydra = Typhoeus::Hydra.new
+    hydra.cache_setter &HydraCache.method(:setter)
+    hydra.cache_getter &HydraCache.method(:getter)
+    hydra
+  end
+
+  it 'should create a fixture file after the hit' do
+    r = Typhoeus::Request.new("http://example.com")
+    hydra.queue r
+
+    within_construct do |c|
+      HydraCache.fixtures_path = Dir.pwd
+      Dir["*.yml"].must_be_empty
+      hydra.run
+      Dir["*.yml"].wont_be_empty
+    end
+  end
+
+  it 'should handle different order of uri query' do
+    r1 = Typhoeus::Request.new("http://example.com?p1=1&p2=2")
+    hydra.queue r1
+    r2 = Typhoeus::Request.new("http://example.com?p2=2&p1=1")
+    hydra.queue r2
+
+    within_construct do |c|
+      HydraCache.fixtures_path = Dir.pwd
+      hydra.run
+      Dir["*.yml"].size.must_equal 1
+    end
+  end
+
+  it 'should handle different order of params' do
+    r1 = Typhoeus::Request.new("http://example.com", :params => {"p1" => 1, "p2" => 2})
+    hydra.queue r1
+    r2 = Typhoeus::Request.new("http://example.com", :params => {"p2" => 2, "p1" => 1})
+    hydra.queue r2
+
+    within_construct do |c|
+      HydraCache.fixtures_path = Dir.pwd
+      hydra.run
+      Dir["*.yml"].size.must_equal 1
+    end
+  end
+
+  it 'should handle different order of body' do
+    r1 = Typhoeus::Request.new("http://example.com", :body => "foo=bar\nbaz=wadus", :method => :post)
+    hydra.queue r1
+    r2 = Typhoeus::Request.new("http://example.com", :body => "baz=wadus\nfoo=bar", :method => :post)
+    hydra.queue r2
+
+    within_construct do |c|
+      HydraCache.fixtures_path = Dir.pwd
+      hydra.run
+      Dir["*.yml"].size.must_equal 1
+    end
+  end
+
+  it 'should handle different methods for same url' do
+    r1 = Typhoeus::Request.new("http://example.com")
+    hydra.queue r1
+    r2 = Typhoeus::Request.new("http://example.com", :method => :post)
+    hydra.queue r2
+
+    within_construct do |c|
+      HydraCache.fixtures_path = Dir.pwd
+      Dir["*.yml"].must_be_empty
+      hydra.run
+      Dir["*.yml"].size.must_equal 2
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: hydra_cache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jorge Dias
+- Albert Llop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  prerelease: false
+  type: :runtime
+  name: rake
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  prerelease: false
+  type: :development
+  name: minitest
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  prerelease: false
+  type: :development
+  name: typhoeus
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  prerelease: false
+  type: :development
+  name: test-construct
+description: This gem provides a cache mechanism for Hydra to avoid hitting the same request multiple times
+email: 
+- jorge.dias@xing.com
+- albert.llop@xing.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.md
+- hydra_cache.gemspec
+- lib/hydra_cache.rb
+- lib/hydra_cache/version.rb
+- test/test_helper.rb
+- test/unit/hydra_cache_test.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hydra_cache
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cache support for Hydra
+test_files: 
+- test/test_helper.rb
+- test/unit/hydra_cache_test.rb