puffing-billy 0.1.2 → 0.1.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.1.1)
+    puffing-billy (0.1.3)
       capybara
       em-http-request
       eventmachine

data/lib/billy.rb

@@ -1,5 +1,6 @@
 require "billy/version"
 require "billy/config"
 require "billy/proxy_request_stub"
+require "billy/cache"
 require "billy/proxy"
 require "billy/proxy_connection"

data/lib/billy/cache.rb

@@ -0,0 +1,39 @@
+require 'resolv'
+require 'uri'
+
+module Billy
+  class Cache
+    def initialize
+      reset
+    end
+
+    def cacheable?(url, headers)
+      if Billy.config.cache
+        host = URI(url).host
+        Billy.log(:info, Billy.config.whitelist)
+        !Billy.config.whitelist.include?(host)
+        # TODO test headers for cacheability
+      end
+    end
+
+    def cached?(url)
+      !@cache[url].nil?
+    end
+
+    def fetch(url)
+      @cache[url]
+    end
+
+    def store(url, status, headers, content)
+      @cache[url] = {
+        :status => status,
+        :headers => headers,
+        :content => content
+      }
+    end
+
+    def reset
+      @cache = {}
+    end
+  end
+end

data/lib/billy/config.rb

@@ -2,10 +2,14 @@ require 'logger'
 
 module Billy
   class Config
-    attr_accessor :logger
+    DEFAULT_WHITELIST = ['127.0.0.1', 'localhost']
+
+    attr_accessor :logger, :cache, :whitelist
 
     def initialize
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @logger    = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @cache     = true
+      @whitelist = DEFAULT_WHITELIST
     end
   end
 

data/lib/billy/proxy.rb

@@ -6,6 +6,7 @@ module Billy
   class Proxy
     def initialize
       reset
+      @cache = Billy::Cache.new
     end
 
     def start(threaded = true)
@@ -48,6 +49,10 @@ module Billy
       @stubs = []
     end
 
+    def reset_cache
+      @cache.reset
+    end
+
     protected
 
     def find_stub(method, url)
@@ -66,6 +71,7 @@ module Billy
 
         @signature = EM.start_server('127.0.0.1', 0, ProxyConnection) do |p|
           p.handler = self
+          p.cache = @cache
         end
 
         Billy.log(:info, "Proxy listening on #{url}")

data/lib/billy/proxy_connection.rb

@@ -1,3 +1,4 @@
+require 'uri'
 require 'eventmachine'
 require 'http/parser'
 require 'em-http'
@@ -6,6 +7,7 @@ require 'evma_httpserver'
 module Billy
   class ProxyConnection < EventMachine::Connection
     attr_accessor :handler
+    attr_accessor :cache
 
     def post_init
       @parser = Http::Parser.new(self)
@@ -77,6 +79,9 @@ module Billy
         response.headers = result[1].merge('Connection' => 'close')
         response.content = result[2]
         response.send_response
+      elsif @parser.http_method == 'GET' && cache.cached?(@url)
+        Billy.log(:info, "CACHE #{@parser.http_method} #{@url}")
+        respond_from_cache
       else
         Billy.log(:info, "PROXY #{@parser.http_method} #{@url}")
         proxy_request
@@ -99,18 +104,34 @@ module Billy
       req = req.send(@parser.http_method.downcase, req_opts)
 
       req.errback do
-        puts "Request failed: #{@url}"
+        Billy.log(:error, "Request failed: #{@url}")
         close_connection
       end
 
       req.callback do
+        res_status = req.response_header.status
+        res_headers = req.response_header.raw
+        res_headers = res_headers.merge('Connection' => 'close')
+        res_headers.delete('Transfer-Encoding')
+        res_content = req.response.force_encoding('BINARY')
+        if @parser.http_method == 'GET' && cache.cacheable?(@url, res_headers)
+          cache.store(@url, res_status, res_headers, res_content)
+        end
         res = EM::DelegatedHttpResponse.new(self)
-        res.status = req.response_header.status
-        res.headers = req.response_header.merge('Connection' => 'close')
-        res.content = req.response.force_encoding('BINARY')
+        res.status = res_status
+        res.headers = res_headers
+        res.content = res_content
         res.send_response
       end
     end
 
+    def respond_from_cache
+      cached_res = cache.fetch(@url)
+      res = EM::DelegatedHttpResponse.new(self)
+      res.status = cached_res[:status]
+      res.headers = cached_res[:headers]
+      res.content = cached_res[:content]
+      res.send_response
+    end
   end
 end

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/requests/proxy_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'billy'
+require 'resolv'
 
 shared_examples_for 'a proxy server' do
   it 'should proxy GET requests' do
@@ -15,7 +16,7 @@ shared_examples_for 'a proxy server' do
   end
 
   it 'should proxy HEAD requests' do
-    http.head('/echo').headers['http_x_echoserver'].should == 'HEAD /echo'
+    http.head('/echo').headers['HTTP-X-EchoServer'].should == 'HEAD /echo'
   end
 
   it 'should proxy DELETE requests' do
@@ -55,6 +56,39 @@ shared_examples_for 'a request stub' do
   end
 end
 
+shared_examples_for 'a cache' do
+
+  context 'whitelisted GET requests' do
+    it 'should not be cached' do
+      r = http.get('/foo')
+      r.body.should == 'GET /foo'
+      expect {
+        expect {
+          r = http.get('/foo')
+        }.to change { r.headers['HTTP-X-EchoCount'].to_i }.by(1)
+      }.to_not change { r.body }
+    end
+  end
+
+  context 'other GET requests' do
+    around do |example|
+      Billy.configure { |c| c.whitelist = [] }
+      example.run
+      Billy.configure { |c| c.whitelist = Billy::Config::DEFAULT_WHITELIST }
+    end
+
+    it 'should be cached' do
+      r = http.get('/foo')
+      r.body.should == 'GET /foo'
+      expect {
+        expect {
+          r = http.get('/foo')
+        }.to_not change { r.headers['HTTP-X-EchoCount'] }
+      }.to_not change { r.body }
+    end
+  end
+end
+
 describe Billy::Proxy do
 
   before do
@@ -99,4 +133,18 @@ describe Billy::Proxy do
 
   end
 
+  context 'caching' do
+
+    context 'HTTP' do
+      let!(:http) { @http }
+      it_should_behave_like 'a cache'
+    end
+
+    context 'HTTPS' do
+      let!(:http) { @https }
+      it_should_behave_like 'a cache'
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -21,4 +21,8 @@ RSpec.configure do |config|
   config.before :all do
     start_test_servers
   end
+
+  config.before :each do
+    proxy.reset_cache
+  end
 end

data/spec/support/test_server.rb

@@ -17,12 +17,19 @@ module Billy
       q = Queue.new
       Thread.new do
         EM.run do
+          counter = 0
           echo = Proc.new do |env|
             req_body = env['rack.input'].read
             request_info = "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
             res_body = request_info
             res_body += "\n#{req_body}" unless req_body.empty?
-            [200, {'HTTP-X-EchoServer'=>request_info}, [res_body]]
+            counter += 1
+            [
+              200,
+              { 'HTTP-X-EchoServer' => request_info,
+                'HTTP-X-EchoCount' => "#{counter}" },
+              [res_body]
+            ]
           end
 
           Thin::Logging.silent = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -256,6 +256,7 @@ files:
 - examples/facebook_api.html
 - examples/tumblr_api.html
 - lib/billy.rb
+- lib/billy/cache.rb
 - lib/billy/config.rb
 - lib/billy/mitm.crt
 - lib/billy/mitm.key
@@ -307,4 +308,3 @@ test_files:
 - spec/requests/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
-has_rdoc: