rack-state 0.0.2 → 0.0.3

data/README.rdoc

@@ -90,30 +90,32 @@ code sets up Rack::State to function similarly to Rack::Session.
 
 === Multiple state management with different storage adapters
 
-Below, the _store_ state will use the default Memory store and _blog_ will store
-state in files under "tmp/sessions" in the project's root.  Additionally, if
-"/store" requires encryption it is wise to secure the token.
+Below, the _flash_ state will use the default Memory store and _store_ will
+save state in files under "tmp/state-store" in the project's root.
+Additionally, if "/store" requires encryption it is wise to secure the token.
 
-  use Rack::State, key: 'store', path: '/store', secure: true
-  use Rack::State, key: 'blog',  path: '/blog', max_age: 60*60*24*30,
-    store: Rack::State::Store::File.new('tmp/sessions')
+  use Rack::State, key: 'flash', path: '/', max_age: 60*60
+  use Rack::State, key: 'store', path: '/store', secure: true,
+    store: Rack::State::Store::File.new('tmp/state-store')
 
 Then on the application side you may have some helper methods like this:
 
+  def flash
+    env['rack.state.flash'].get or env['rack.state.flash'].set Flash.new
+  end
+
   def store
     env['rack.state.store']
   end
 
   store.set SecureStore.new # start shopping session
-  store.get.cart.add :item7 # buy some stuff
-  store.delete              # remove from client and server after checkout
 
-  def blog
-    env['rack.state.blog'].get or env['rack.state.blog'].set BlogTracker.new
-  end
+  store.get.cart.add :item7
+  flash.notice 'Added Item 7'
 
-  blog.viewed << :article9
-  blog.shared << :article5
+  store.get.transaction.process
+  flash.notice 'Transaction successful'
+  store.delete # remove from client/server after checkout
 
 
 === Choose a specific storage adapter depending on the environment
@@ -129,15 +131,37 @@ store for development and testing.
   end
 
 
+=== Keep state of an arbitrary object using helper methods
+
+First setup the middleware key and helpers.
+
+  use Rack::State, key: 'myobj'
+
+  def my_object
+    env['rack.state.myobj'].get
+  end
+
+  def set_my_object(obj)
+    obj ? env['rack.state.myobj'].set(obj) : env['rack.state.myobj'].delete
+  end
+
+Then get state tracking in your app.
+
+  set_my_object ObjectA.new  # instance of ObjectA persistently stored
+  my_object.do_something     # interact with original instance
+  set_my_object nil          # remove instance from state store
+  set_my_object ObjectB.new  # do it all again with another object
+
+
 == Install, Test & Contribute
 
 Install the gem:
 
   $ sudo gem install rack-state
 
-Or clone the project:
+Or clone the Mercurial repository:
 
-  TODO
+  $ hg clone http://code.pachl.us/rack-state
 
 State is tested with Christian Neukirchen's awesome test framework,
 {Bacon}[https://github.com/chneukirchen/bacon].
@@ -157,6 +181,13 @@ After you fix a bug or develop a storage adapter, submit your code and tests.
 
   TODO
 
+== Links
+
+Homepage      :: http://ecentryx.com/gems/rack-state
+Ruby Gem      :: https://rubygems.org/gems/rack-state
+Source Code   :: https://bitbucket.org/pachl/rack-state/src
+Bug Tracker   :: https://bitbucket.org/pachl/rack-state/issues
+
 == Compatibility
 
 Rack::State was developed and tested on
@@ -166,13 +197,16 @@ and Rack[https://github.com/rack/rack] 1.5.
 
 == History
 
-* September 5, 2013: Initial design, development and testing.
+1. 2013-09-05, v0.0.0: Initial design, development and testing
+2. 2013-09-22, v0.0.1: First public release
+3. 2013-09-22, v0.0.2: Update Gem info and documentation
+4. 2014-04-20, v0.0.3: Add homepage and bug tracker URLs
 
-* September 22, 2013: First public release 0.0.1.
+== License
 
-== Copyright
+({ISC License}[http://opensource.org/licenses/ISC])
 
-Copyright (c) 2013, Clint Pachl <http://clint.pachl.us>
+Copyright (c) 2013, Clint Pachl <pachl@ecentryx.com>
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

data/lib/rack/state.rb

@@ -16,7 +16,7 @@ module Rack
   #
   class State
 
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
 
     #
     # == Middleware Options
@@ -44,12 +44,18 @@ module Rack
     end
 
     def call(env)
-      token = Request.new(env).cookies.fetch(@key, nil)
-      state = env[@skey] = Manager.new(@store, token, @key, @options)
-      status, headers, body = @app.call(env)
-      resp = Response.new(body, status, headers)
-      state.finish(resp)
-      resp.finish
+      request = Request.new(env)
+
+      if request.path =~ /^#{@options[:path]}/
+        token = request.cookies.fetch(@key, nil)
+        state = env[@skey] = Manager.new(@store, token, @key, @options)
+        status, headers, body = @app.call(env)
+        resp = Response.new(body, status, headers)
+        state.finish(resp)
+        resp.finish
+      else
+        @app.call(env)
+      end
     end
 
     #

data/spec/spec_state.rb

@@ -16,6 +16,10 @@ module StateMiddlewareHelpers #:nodoc:
     }
   end
 
+  def key
+    'token' # default key name
+  end
+
   def get_state(key, token)
     @req.get("/get_state?key=#{key}", {'HTTP_COOKIE' => token})['Set-Cookie']
   end
@@ -32,7 +36,7 @@ module StateMiddlewareHelpers #:nodoc:
   def mock_app
     Proc.new do |env|
       req = Rack::Request.new(env)
-      key = req.params['key'] || 'token'
+      key = req.params['key'] || self.key
       skey = 'rack.state.' + key
       data = nil
 
@@ -50,13 +54,32 @@ module StateMiddlewareHelpers #:nodoc:
   end
 end
 
+module StateMiddlewarePathHelpers #:nodoc:
+  def allow(path)
+    should.not.raise(SecurityError) { @req.get(path) }
+  end
+
+  def disallow(path)
+    should.raise(SecurityError) { @req.get(path) }
+  end
+
+  def mock_app
+    Proc.new do |env|
+      if env['rack.state.token'].nil?
+        raise SecurityError, 'state unavailable at path'
+      else
+        Rack::Response.new.finish
+      end
+    end
+  end
+end
+
 describe Rack::State do
 
   describe 'Default Options' do
     extend StateMiddlewareHelpers
 
     before do
-      @key = 'token' # default key name
       @req = Rack::MockRequest.new(Rack::State.new(mock_app))
     end
 
@@ -65,37 +88,37 @@ describe Rack::State do
     end
 
     should 'return token when setting state' do
-      set_state(@key).should.be.a valid_token
+      set_state(key).should.be.a valid_token
     end
 
     should 'return previous token' do
-      token1 = set_state(@key)
-      token2 = get_state(@key, token1)
+      token1 = set_state(key)
+      token2 = get_state(key, token1)
       token1.should.equal token2
     end
 
     should 'not return token after deleting state' do
-      token1 = set_state(@key)
-      token2 = del_state(@key, token1)
-      token3 = get_state(@key, token1)
+      token1 = set_state(key)
+      token2 = del_state(key, token1)
+      token3 = get_state(key, token1)
       token1.should.be.a valid_token
       token2.should.be.an expired_token
       token3.should.be.nil
     end
 
     should 'return no token when getting state with nonexistent token' do
-      get_state(@key, "#{@key}=nonexistent").should.be.nil
+      get_state(key, "#{key}=nonexistent").should.be.nil
     end
 
     should 'return new token when setting state with nonexistent token' do
-      token = set_state(@key, "#{@key}=nonexistent")
-      token.should.not.equal "#{@key}=nonexistent"
+      token = set_state(key, "#{key}=nonexistent")
+      token.should.not.equal "#{key}=nonexistent"
       token.should.be.a valid_token
     end
 
     should 'expire token when deleting state with nonexistent token' do
-      token = del_state(@key, "#{@key}=nonexistent")
-      token.should.not.equal "#{@key}=nonexistent"
+      token = del_state(key, "#{key}=nonexistent")
+      token.should.not.equal "#{key}=nonexistent"
       token.should.be.an expired_token
     end
   end
@@ -171,4 +194,32 @@ describe Rack::State do
       mt.should.not.equal ft
     end
   end
+
+  describe 'Path Restrictions' do
+    extend StateMiddlewarePathHelpers
+
+    should 'allow state access for any path by default' do
+      @req = Rack::MockRequest.new(Rack::State.new(mock_app))
+      allow '/'
+      allow '/a'
+      allow '/a/b'
+    end
+
+    should 'allow state access for specified path only' do
+      @req = Rack::MockRequest.new(Rack::State.new(mock_app, path:'/a'))
+      allow '/a'
+      allow '/a/b'
+      disallow '/'
+      disallow '/b'
+    end
+
+    should 'allow state access for specified multi-level path only' do
+      @req = Rack::MockRequest.new(Rack::State.new(mock_app, path:'/a/b'))
+      allow '/a/b'
+      allow '/a/b/c'
+      disallow '/'
+      disallow '/a'
+      disallow '/b'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-state
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -71,7 +71,7 @@ files:
 - spec/spec_state_store_file.rb
 - spec/spec_state_store_memory.rb
 - spec/spec_state_store_postgres.rb
-homepage: http://pachl.us/code/rack-state
+homepage: http://ecentryx.com/gems/rack-state
 licenses:
 - ISC
 post_install_message: