cachable_url 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cachable_url.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/cachable_url.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cachable_url/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cachable_url"
+  s.version     = CachableUrl::VERSION
+  s.authors     = ["Tom Lea"]
+  s.email       = ["commit@tomlea.co.uk"]
+  s.homepage    = "http://tomlea.co.uk"
+  s.summary     = %q{Hide query strings so caches can't see them.'}
+  s.description = %q{Replace all '?'s in URLs with '%1F' (the ASCII unit separator char), and a middleware to undo it before your rack app sees.}
+
+  s.rubyforge_project = "cachable_url"
+
+  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_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rack-test"
+end

data/lib/cachable_url/middleware.rb

@@ -0,0 +1,20 @@
+require "cachable_url"
+
+class CachableUrl::Midleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if env["QUERY_STRING"] == ''
+      env = env.clone
+      path, query = env["PATH_INFO"].split("%1F", 2)
+      query = CachableUrl.decode(query || "")
+      env["PATH_INFO"] = path
+      env["QUERY_STRING"] = query
+      @app.call(env)
+    else
+      @app.call(env)
+    end
+  end
+end

data/lib/cachable_url/version.rb

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

data/lib/cachable_url.rb

@@ -0,0 +1,11 @@
+require "cachable_url/version"
+
+module CachableUrl
+  def self.encode(url)
+    url.gsub('?', '%1F')
+  end
+
+  def self.decode(url)
+    url.gsub('%1F', '?')
+  end
+end

data/spec/encoder_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe CachableUrl do
+
+  EXAMPLES=[
+    "http://foo:bar@baz.com/wizz?bang=foo",
+    "http://foo:bar@baz.com/wi???bang=baz"
+  ]
+
+  EXAMPLES.each do |example|
+
+    it "symmetrically encodes/decodes #{example}" do
+      original_value = example
+      encoded_value = CachableUrl.encode(example)
+      decoded_value = CachableUrl.decode(encoded_value)
+      decoded_value.should == original_value
+    end
+
+    it "should encode without any '?'s in it" do
+      CachableUrl.encode(example).should_not include("?")
+    end
+
+  end
+
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe CachableUrl::Midleware do
+  include Rack::Test::Methods
+
+  let(:requests_received){ [] }
+
+  def app
+    logger_app = lambda{|env| requests_received << env; [200, {"Content-Type" => 'text/plain'}, ["Hello world"]] }
+    CachableUrl::Midleware.new(logger_app)
+  end
+
+  it "should pass through requests with query strings" do
+    get "/fooooooo%1F?foo=bar"
+  
+    requests_received.size.should == 1
+    requests_received.last["QUERY_STRING"].should == "foo=bar"
+    requests_received.last["PATH_INFO"].should == "/fooooooo%1F"
+  end
+
+  it "should decode requests with no query strings" do
+    get "/fooooooo%1Ffoo=bar"
+    
+    requests_received.size.should == 1
+    requests_received.last["QUERY_STRING"].should == "foo=bar"
+    requests_received.last["PATH_INFO"].should == "/fooooooo"
+  end
+
+  it "should decode requests with no query strings to the same thing as the query string based request" do
+    get "/fooooooo%1Ffoo=bar"
+    get "/fooooooo?foo=bar"
+    
+    requests_received.size.should == 2
+    a,b = clense_responses(*requests_received.last(2))
+    a.should == b
+  end
+
+  protected
+  def clense_responses(*args)
+    args.map{|r|
+      r.delete_if{|key, value|
+        ["rack.input", "rack.errors"].include? key
+      }
+    }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rack/test"
+
+require "cachable_url"
+require "cachable_url/middleware"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: cachable_url
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tom Lea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-20 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
+  name: rspec
+  type: :development
+  prerelease: false
+- !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
+  name: rake
+  type: :development
+  prerelease: false
+- !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
+  name: rack-test
+  type: :development
+  prerelease: false
+description: Replace all '?'s in URLs with '%1F' (the ASCII unit separator char), and a middleware to undo it before your rack app sees.
+email: 
+- commit@tomlea.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- cachable_url.gemspec
+- lib/cachable_url.rb
+- lib/cachable_url/middleware.rb
+- lib/cachable_url/version.rb
+- spec/encoder_spec.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: http://tomlea.co.uk
+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: cachable_url
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Hide query strings so caches can't see them.'
+test_files: 
+- spec/encoder_spec.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb