rack-cachely 0.3.4 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f4080bb9c2d7996d66615deb889c894bbb4899d
+  data.tar.gz: 97b741a1f1b6c746c417066cb8191465f647af0f
+SHA512:
+  metadata.gz: 1e95627d21f37a878f4017c57647fb90fc6c51f185631f482d5b3f048562b635bc16e5b77273248d4376991217e5213c079ecae71fb88829e8ee2d4b02cbe4bc
+  data.tar.gz: 9185062d94498de7efa4003205ebd66d0cac8974661f3e94eaabe3e569cc0f59af027c85a36003a8e769585c8ee0bbd6624884fb92b58ecef95cfe50b7aac745

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-cachely (0.3.4)
+    rack-cachely (0.4.0)
       rack
 
 GEM
@@ -14,7 +14,7 @@ GEM
     fakeweb (1.3.0)
     i18n (0.6.1)
     multi_json (1.3.6)
-    rack (1.5.1)
+    rack (1.5.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)

data/README.md

@@ -46,14 +46,14 @@ end
 ### Detailed Configuration
 
 ```ruby
-config.middleware.use Rack::Cachely, 
+config.middleware.use Rack::Cachely,
   # Print debug information out to the log (default is false):
-  verbose: false, 
+  verbose: false,
   # Each Cachely account has a custom URL endpoint.
   # The URL can be found in your Heroku config or through
   # your Cachely dashboard. By default it looks for an
   # ENV variable named CACHELY_URL:
-  cachely_url: ENV["CACHELY_URL"], 
+  cachely_url: ENV["CACHELY_URL"],
   # How long are you willing to wait for requests to the Cachely
   # service to respond? Default is 1 second.
   timeout: 1.0
@@ -83,3 +83,8 @@ Rack::Cachely::Store.delete("users/\d+")
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Contributors
+
+* Mark Bates
+* Tim Raymond

data/lib/rack-cachely/config.rb

@@ -5,7 +5,7 @@ module Rack
       attr_accessor :options
 
       def initialize(options = {})
-        self.options = {ignore_query_params: [], timeout: 1.0}
+        self.options = {ignore_query_params: [], allow_query_params: [], timeout: 1.0}
         options.each do |key, value|
           self.send("#{key}=", value)
         end
@@ -16,6 +16,10 @@ module Rack
         self.options[:ignore_query_params] = [args].flatten.map {|x| x.downcase}
       end
 
+      def allow_query_params=(*args)
+        self.options[:allow_query_params] = [args].flatten.map {|x| x.downcase}
+      end
+
       def method_missing(sym, *args, &block)
         if /(.+)=$/.match(sym.to_s)
           self.options[$1.to_sym] = args[0]
@@ -39,4 +43,4 @@ module Rack
 
     end
   end
-end
+end

data/lib/rack-cachely/key.rb

@@ -43,11 +43,48 @@ module Rack
       # and applying consistent escaping.
       def query_string
         return nil if @request.query_string.nil?
-        ignore_query_params = ["no-cachely", "refresh-cachely", Rack::Cachely.config.ignore_query_params].flatten
-        query = @request.query_string.split(/[&;] */n).map { |p| unescape(p).split('=', 2) }.sort
-        query = query.reject{|k,v| ignore_query_params.include?(k)}.map{ |k,v| "#{escape(k)}=#{escape(v)}" }
+        if whitelist_mode?
+          whitelist(@request.query_string)
+        else
+          blacklist(@request.query_string)
+        end
+      end
+
+      def whitelist(query_string)
+        query_params = deparameterize(query_string)
+        whitelisted_params = query_params.select{|k,v| whitelisted?(k) }
+        parameterize(whitelisted_params)
+      end
+
+      def blacklist(query_string)
+        query_params = deparameterize(query_string)
+        blacklisted_params = query_params.reject{|k,v| blacklisted?(k) }
+        parameterize(blacklisted_params)
+      end
+
+      def parameterize(params)
+        params.map{ |k,v| "#{escape(k)}=#{escape(v)}" }.join('&')
+      end
+
+      def deparameterize(query_string)
+        query_string.split(/[&;] */n).map { |p| unescape(p).split('=', 2) }.sort
+      end
+
+      def whitelisted?(param)
+        Rack::Cachely.config.allow_query_params.include?(param)
+      end
+
+      def blacklisted?(param)
+        ["no-cachely", "refresh-cachely", Rack::Cachely.config.ignore_query_params].flatten.include?(param)
+      end
+
+      def whitelist_mode?
+        # Whitelist mode is enabled when the whitelist is the ONLY list set
+        Rack::Cachely.config.ignore_query_params.empty? && Rack::Cachely.config.allow_query_params.any?
+      end
 
-        query.join('&')
+      def blacklist_mode?
+        !whitelist_mode?
       end
     end
 

data/lib/rack-cachely/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Cachely
-    VERSION = "0.3.4"
+    VERSION = "0.4.0"
   end
 end

data/spec/rack-cachely/key_spec.rb

@@ -14,9 +14,28 @@ describe Rack::Cachely::Key do
 
     it "will ignore certain query params" do
       Rack::Cachely.config.ignore_query_params = ["A", "c"]
+      Rack::Cachely.config.allow_query_params = []
       key.to_s.should eql("http://example.com/foo/bar?b=B&d=D")
     end
 
+    it "allows whitelisted query params" do
+      Rack::Cachely.config.ignore_query_params = []
+      Rack::Cachely.config.allow_query_params = ["A", "b"]
+      key.to_s.should eql("http://example.com/foo/bar?a=A&b=B")
+    end
+
+    it "will blacklist query params if both whitelist and blacklist are present" do
+      Rack::Cachely.config.allow_query_params = ["A", "b"]
+      Rack::Cachely.config.ignore_query_params = ["A", "c"]
+      key.to_s.should eql("http://example.com/foo/bar?b=B&d=D")
+    end
+
+    it "will allow all query params when neither blacklist nor whitelist is set" do
+      Rack::Cachely.config.allow_query_params = []
+      Rack::Cachely.config.ignore_query_params = []
+      key.to_s.should eql("http://example.com/foo/bar?a=A&b=B&c=C&d=D")
+    end
+
     context "no query string" do
       
       let(:request) { double(scheme: "http", host: "example.com", port: 80, script_name: "/foo", path_info: "/bar", query_string: "") }
@@ -29,4 +48,4 @@ describe Rack::Cachely::Key do
   
   end
 
-end
+end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rack-cachely
 version: !ruby/object:Gem::Version
-  version: 0.3.4
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Mark Bates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Rack middleware for interfacing with the Cachely page caching service.
@@ -54,27 +51,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://www.cachelyapp.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware for interfacing with the Cachely page caching service.
 test_files:
 - spec/rack-cachely/config_spec.rb