rack-param_to_cookie 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff789a7ad9f19014e1e5d85d7c8301ec212328d
-  data.tar.gz: 0b43e39084247e90143fe4b417d1fba6fd31c717
+  metadata.gz: 3ad04222bd754f08090d5e8308b648a4aa80afab
+  data.tar.gz: 440b3a794b871eaa7175881fa8ced68f8d4b0746
 SHA512:
-  metadata.gz: 671d18c5bd162762248287605f391d333899c3332b86ae6966d1e8971faa8ae4fdb0d646aab2453866af4f7986d31f4346a6386a265b1d5f8077b9e9559911a3
-  data.tar.gz: a990dc602f606d02f6ed6abbc381dd713f90ff77f2a42afc560b86204bdb75007bfd1b7c809c3abf6d387a72726ab82deb12a612ad74043fbb803493a921c637
+  metadata.gz: c5ab893233126b3da78e0cbd176eaedf2bb087e463b7967e25cbfdf836c608cdf5e0f470f72d183fcaf659897970a1069a1f53cb295dab86e00bbf817ebd4829
+  data.tar.gz: 31e4213b2c2b65ab1198d7c7a1af6b2c5a2b6d6e309ff5209c7d5755e3eb6e9fdef52dea5b5c79fc12e0bbd621fd2e1bc067daa909f795c351b4feac253c4487

data/README.rdoc

@@ -20,17 +20,18 @@ Rack::ParamToCookie is a rack middleware that extracts request parameters from r
 In a Rails app, you can add it as middleware in +config/application.rb+. For a parameter called +ref+, the basic usage is:
 
   config.middleware.use 'Rack::ParamToCookie', 'ref' => {}
-  
+
 This tells Rack::ParamToCookie to capture a request parameter called +ref+, store it in a cookie called +ref+, and make it available in your rails app as <tt>request.env['ref']</tt>. You can specify multiple parameters and configure them. Here's a more in-depth example:
 
   config.middleware.use 'Rack::ParamToCookie',
     'ref' => {cookie_name: 'referral_code',
               env_name: 'referral.code',
-              ttl: 14*24*60*60},
+              ttl: 14*24*60*60,
+              max_length: 12},
     'aff' => {cookie_name: 'affiliate_code',
               env_name: 'affiliate.code'}
 
-The first cookie, +referral_code+ for parameter +ref+, has a 14 day time to live and is accessible in +request.env+ <tt>['referral.code']</tt>. The second, for parameter +aff+, has the default time to live, which is 30 days.
+The first cookie, +referral_code+ for parameter +ref+, has a 14 day time to live, can be a maximum of 12 characters and is accessible in +request.env+ <tt>['referral.code']</tt>. The second, for parameter +aff+, has the default time to live, which is 30 days and can be the default maximum length, which is 64 characters.
 
 == Installation
 

data/lib/rack/param_to_cookie/version.rb

@@ -1,6 +1,6 @@
 module Rack
   class ParamToCookie
-    VERSION_MAJOR = 2
+    VERSION_MAJOR = 3
     VERSION_MINOR = 0
     VERSION_PATCH = 0
     VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')

data/lib/rack/param_to_cookie.rb

@@ -19,6 +19,7 @@ module Rack
         options[:env_name] ||= param
         options[:ttl] ||= 60*60*24*30 # 30 days
         options[:set_cookie_options] ||= {}
+        options[:max_length] ||= 64 # characters
       end
     end
 
@@ -33,6 +34,10 @@ module Rack
         # check whether there's a new value for the cookie with this request
         params_value = req.params[param] rescue nil
 
+        # validate the length of the value
+        params_value = nil if
+          params_value && params_value.length > options[:max_length]
+
         value = params_value || cookie_value
         env[options[:env_name]] = value if value
 

data/test/rack/param_to_cookie/param_to_cookie_test.rb

@@ -26,7 +26,7 @@ describe "Rack::ParamToCookie" do
     it "should do nothing when there is no ref parameter" do
       get '/'
 
-      assert_equal nil, last_request.env['ref']
+      assert_nil last_request.env['ref']
       assert_equal({}, rack_mock_session.cookie_jar.to_hash)
     end
 
@@ -41,7 +41,7 @@ describe "Rack::ParamToCookie" do
       get '/'
       assert_equal 'abc', last_request.env['ref']
       assert_equal({'ref' => 'abc'}, rack_mock_session.cookie_jar.to_hash)
-      assert_equal nil, last_response.headers['Set-Cookie']
+      assert_nil last_response.headers['Set-Cookie']
 
       # if we set it again, it gets overwritten
       get '/', ref: '123'
@@ -53,14 +53,15 @@ describe "Rack::ParamToCookie" do
       get '/'
       assert_equal '123', last_request.env['ref']
       assert_equal({'ref' => '123'}, rack_mock_session.cookie_jar.to_hash)
-      assert_equal nil, last_response.headers['Set-Cookie']
+      assert_nil last_response.headers['Set-Cookie']
     end
   end
 
   describe "with multiple parameters and custom names" do
     before do
       make_app \
-        'ref' => {cookie_name: 'ref_cookie', env_name: 'ref.env', ttl: 10},
+        'ref' => {cookie_name: 'ref_cookie', env_name: 'ref.env', ttl: 10,
+                  max_length: 10},
         'aff' => {cookie_name: 'aff_cookie', env_name: 'aff.env', ttl: 20}
       clear_cookies
     end
@@ -68,8 +69,8 @@ describe "Rack::ParamToCookie" do
     it "should set ref and aff" do
       # initially no cookies
       get '/'
-      assert_equal nil, last_request.env['ref.env']
-      assert_equal nil, last_request.env['aff.env']
+      assert_nil last_request.env['ref.env']
+      assert_nil last_request.env['aff.env']
       assert_equal({}, rack_mock_session.cookie_jar.to_hash)
 
       # set both at the same time
@@ -95,7 +96,7 @@ describe "Rack::ParamToCookie" do
       assert_equal 'bar', last_request.env['aff.env']
       assert_equal({'ref_cookie' => 'foo', 'aff_cookie' => 'bar'},
                    rack_mock_session.cookie_jar.to_hash)
-      assert_equal nil, last_response.headers['Set-Cookie']
+      assert_nil last_response.headers['Set-Cookie']
 
       # update ref
       get '/', ref: 'baz'
@@ -112,7 +113,7 @@ describe "Rack::ParamToCookie" do
       assert_equal 'bar', last_request.env['aff.env']
       assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bar'},
                    rack_mock_session.cookie_jar.to_hash)
-      assert_equal nil, last_response.headers['Set-Cookie']
+      assert_nil last_response.headers['Set-Cookie']
 
       # update aff
       get '/', aff: 'bat'
@@ -129,7 +130,12 @@ describe "Rack::ParamToCookie" do
       assert_equal 'bat', last_request.env['aff.env']
       assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bat'},
                    rack_mock_session.cookie_jar.to_hash)
-      assert_equal nil, last_response.headers['Set-Cookie']
+      assert_nil last_response.headers['Set-Cookie']
+    end
+
+    it "should not set cookies longer than the max length" do
+      get '/', ref: 'abcdefghijklmnopqrstuvwxyz'
+      assert_equal({}, rack_mock_session.cookie_jar.to_hash)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-param_to_cookie
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - John Lees-Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -74,7 +74,7 @@ rdoc_options:
 - "--main"
 - README.rdoc
 - "--title"
-- rack-param_to_cookie-2.0.0 Documentation
+- rack-param_to_cookie-3.0.0 Documentation
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -89,10 +89,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Store selected request parameters to cookies.
 test_files:
 - test/rack/param_to_cookie/param_to_cookie_test.rb
-has_rdoc: