cacho 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Damian Janowski & Michel Martens
+
+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,6 @@
+task :test do
+  require "cutest"
+  Cutest.run(Dir["test/*"])
+end
+
+task :default => :test

data/cacho.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name              = "cacho"
+  s.version           = "0.0.1"
+  s.summary           = "Cache aware, Redis based HTTP client."
+  s.description       = "HTTP client that understands cache responses and stores results in Redis."
+  s.authors           = ["Damian Janowski", "Michel Martens"]
+  s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
+  s.homepage          = "http://github.com/djanowski/cacho"
+  s.files = ["LICENSE", "Rakefile", "lib/cacho.rb", "cacho.gemspec", "test/cacho.rb"]
+  s.add_dependency "redis", "~> 2.1"
+  s.add_dependency "curb", "~> 0.7"
+  s.add_dependency "mock-server", "~> 0.1"
+end

data/lib/cacho.rb

@@ -0,0 +1,104 @@
+require "curb"
+require "redis"
+require "json"
+
+class Cacho
+  VERSION = "0.0.1"
+
+  def self.get(url, request_headers = {})
+    response = Local.get(url)
+
+    if response.nil?
+      response = Remote.get(url, Local.validation_for(url).merge(request_headers))
+      Local.set(url, response)
+    end
+
+    response
+  end
+
+  class Local
+    def self.get(url)
+      expire, json = redis.hmget(url, :expire, :response)
+
+      if json && (expire.nil? || Time.utc(expire) <= Time.now)
+        JSON.parse(json)
+      end
+    end
+
+    def self.set(url, response)
+      return unless cacheable?(response)
+
+      _, headers, _ = response
+
+      fields = {}
+
+      if headers["Cache-Control"]
+        ttl = headers["Cache-Control"][/max\-age=(\d+)/, 1].to_i
+
+        fields[:expire] = (Time.now + ttl).to_i
+      end
+
+      fields[:response] = response.to_json
+
+      fields[:etag] = headers["Etag"]
+      fields[:last_modified] = headers["Last-Modified"]
+
+      redis.hmset(url, *fields.to_a.flatten)
+    end
+
+    def self.validation_for(url)
+      etag, last_modified = redis.hmget(url, :etag, :last_modified)
+
+      {}.tap do |headers|
+        headers["If-None-Match"] = etag if etag
+        headers["If-Modified-Since"] = last_modified if last_modified
+      end
+    end
+
+    def self.cacheable?(response)
+      status, headers, _ = response
+
+      status == 200 && (headers["Cache-Control"] || headers["Etag"] || headers["Last-Modified"])
+    end
+
+    def self.redis
+      Redis.current
+    end
+  end
+
+  class Remote
+    def self.get(url, request_headers)
+      status = nil
+      headers = {}
+      body = ""
+
+      Curl::Easy.http_get(url) do |curl|
+        curl.headers = request_headers
+
+        curl.on_header do |header|
+          headers.store(*header.rstrip.split(": ", 2)) if header.include?(":")
+          header.bytesize
+        end
+
+        curl.on_body do |string|
+          body << string
+          string.bytesize
+        end
+
+        curl.on_complete do |response|
+          status = response.response_code
+        end
+      end
+
+      if status == 301
+        Local.get(url)
+      else
+        [status, headers, body]
+      end
+    end
+
+    def self.redis
+      Redis.current
+    end
+  end
+end

data/test/cacho.rb

@@ -0,0 +1,85 @@
+require "cutest"
+require "socket"
+require "mock_server"
+
+require File.expand_path("../lib/cacho", File.dirname(__FILE__))
+
+include MockServer::Methods
+
+mock_server do
+  get "/cacheable" do
+    response.headers["Cache-Control"] = "public, max-age=1"
+    response.headers["Content-Type"] = "text/plain"
+    Time.now.httpdate
+  end
+
+  get "/non-cacheable" do
+    response.headers["Content-Type"] = "text/plain"
+    Time.now.httpdate
+  end
+
+  get "/etag" do
+    if request.env["HTTP_IF_MODIFIED_SINCE"]
+      halt 301
+    else
+      time = Time.now
+
+      response.headers["Etag"] = time.hash.to_s
+      response.headers["Last-Modified"] = time.httpdate
+      response.headers["Content-Type"] = "text/plain"
+
+      time.httpdate
+    end
+  end
+
+  get "/echo" do
+    request.env.map do |name, value|
+      "#{name}: #{value}"
+    end.join("\n")
+  end
+end
+
+prepare do
+  Redis.current.flushdb
+end
+
+test "caches cacheable responses" do
+  status, headers, body = Cacho.get("http://localhost:4000/cacheable")
+
+  assert_equal status, 200
+  assert_equal headers["Content-Type"], "text/plain"
+
+  t1 = body
+
+  status, headers, body = Cacho.get("http://localhost:4000/cacheable")
+
+  assert_equal t1, body
+
+  sleep 2
+
+  status, headers, body = Cacho.get("http://localhost:4000/cacheable")
+
+  assert body > t1
+end
+
+test "does not cache non-cacheable responses" do
+  _, _, t1 = Cacho.get("http://localhost:4000/non-cacheable")
+  sleep 1
+  _, _, t2 = Cacho.get("http://localhost:4000/non-cacheable")
+
+  assert t2 > t1
+end
+
+test "performs conditional GETs" do
+  _, _, t1 = Cacho.get("http://localhost:4000/etag")
+  sleep 1
+  _, _, t2 = Cacho.get("http://localhost:4000/etag")
+
+  assert_equal t1, t2
+end
+
+test "allows to pass custom HTTP headers" do
+  _, _, body = Cacho.get("http://localhost:4000/echo", "Accept" => "text/plain")
+
+  assert body =~ %r{HTTP_ACCEPT: text/plain}
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: cacho
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damian Janowski
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-22 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mock-server
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id003
+description: HTTP client that understands cache responses and stores results in Redis.
+email: 
+- djanowski@dimaion.com
+- michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- lib/cacho.rb
+- cacho.gemspec
+- test/cacho.rb
+has_rdoc: true
+homepage: http://github.com/djanowski/cacho
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Cache aware, Redis based HTTP client.
+test_files: []
+