pebblebed 0.0.41 → 0.0.42

data/README.md

@@ -58,6 +58,51 @@ Other helper methods provided by this extension:
     require_god                             # Halts with 403 if the current user is not a god
     require_parameters(parameters, *keys)   # Halts with 409 if the at least one of the provided keys is not in the params-hash
 
+### Testing Sinatra APIs
+
+To use the handy (but very, very dirty) helpers for the Pebbles Checkpoint authorization,
+you must require `pebblebed/rspec_helper` (this is not included by default in the pebblebed gem)
+and include `Pebblebed::RSpecHelper` in your test context:
+
+
+```ruby
+require 'pebblebed/rspec_helper'
+
+describe Something do
+  include Pebblebed::RSpecHelper
+end
+```
+
+You can set the current identity to be either god, a regular logged in user, or a guest user.
+
+If you call either `god!` or `user!`, the sinatra app's
+current session defaults to the string 'validsession'.
+The current realm defaults to the string 'testrealm'.
+
+You can override default values for :id or :session or :realm,
+or add additional identity values on god or user by passing them in:
+
+```ruby
+user!(:id => 7, :session => 'abc', :realm => 'area51', :profile => {:a => 'b'})
+```
+
+There are two convenience methods that are added to the context:
+```ruby
+current_identity # => the god or user, or nil if you've called guest!
+another_identity # => a non-god user with an id of (current_user.id + 1)
+```
+
+```ruby
+  context "when god" do
+    before(:each) { god! }
+    it "has stuff in the test context" do
+      current_identity.god # => true
+      current_identity.id # => 1
+
+      other_identity.id # => 2
+    end
+  end
+```
 
 Not Sinatra
 ===========

data/integration/river_spec.rb

@@ -14,6 +14,8 @@ describe Pebblebed::River do
   after(:each) do
     subject.send(:bunny).queues.each do |name, queue|
       queue.purge
+      # If you don't delete the queue, the subscription will not
+      # change, even if you give it a new one.
       queue.delete
     end
     subject.disconnect
@@ -90,14 +92,19 @@ describe Pebblebed::River do
   end
 
   it "subscribes" do
-    queue = subject.queue(:name => 'alltestivore', :path => 'rspec|testunit', :klass => 'thing')
+    queue = subject.queue(:name => 'alltestivore', :path => 'area51.rspec|area51.testunit|area52.*|area53.**', :klass => 'thing', :event => 'smile')
 
     queue.message_count.should eq(0)
-    subject.publish(:event => 'smile', :uid => 'thing:rspec$1', :attributes => {:a => 'b'})
-    subject.publish(:event => 'frown', :uid => 'thing:rspec$2', :attributes => {:a => 'b'})
-    subject.publish(:event => 'laugh', :uid => 'thing:testunit$3', :attributes => {:a => 'b'})
+    subject.publish(:event => 'smile', :uid => 'thing:area51.rspec$1', :attributes => {:a => 'b'})
+    subject.publish(:event => 'smile', :uid => 'thing:area51.testunit$2', :attributes => {:a => 'b'})
+    subject.publish(:event => 'smile', :uid => 'thing:area51.whatever$3', :attributes => {:a => 'b'}) # doesn't match path
+    subject.publish(:event => 'frown', :uid => 'thing:area51.rspec$4', :attributes => {:a => 'b'}) # doesn't match event
+    subject.publish(:event => 'smile', :uid => 'thing:area52.one.two.three$5', :attributes => {:a => 'b'}) # doesn't match wildcard path
+    subject.publish(:event => 'smile', :uid => 'thing:area52.one$6', :attributes => {:a => 'b'}) # matches wildcard path
+    subject.publish(:event => 'smile', :uid => 'thing:area53.one.two.three$7', :attributes => {:a => 'b'}) # matches wildcard path
+
     sleep(0.1)
-    queue.message_count.should eq(3)
+    queue.message_count.should eq(4)
   end
 
   it "is a durable queue" do

data/lib/pebblebed/rspec_helper.rb

@@ -0,0 +1,58 @@
+require 'deepstruct'
+
+module Pebblebed
+  module RSpecHelper
+    def god!(options = {})
+      options.delete(:god)
+      stub_current_identity(options.merge(:id => 1, :god => true))
+    end
+
+    def user!(options = {})
+      options.delete(:god)
+      stub_current_identity(options.merge(:id => 1, :god => false))
+    end
+
+    def guest!
+      stub_current_identity
+    end
+
+    def current_identity
+      @current_identity
+    end
+
+    def another_identity
+      id = current_identity ? (current_identity.id + 1) : 1
+      DeepStruct.wrap(default_identity_options.merge(:id => id, :god => false))
+    end
+
+    private
+      def stub_current_identity(options = {})
+        guest = options.empty?
+
+        identity = nil
+        unless guest
+          identity = default_identity_options.merge(options)
+        end
+
+        @current_identity = DeepStruct.wrap(identity)
+
+        checkpoint = stub(:get => DeepStruct.wrap(:identity => identity), :service_url => 'http://example.com')
+        Pebblebed::Connector.any_instance.stub(:checkpoint => checkpoint)
+
+        unless guest
+          session = options.fetch(:session) { 'validsession' }
+          stub_current_session session
+        end
+      end
+
+      def default_identity_options
+        {:realm => 'testrealm'}
+      end
+
+      def stub_current_session(session)
+        app.any_instance.stub(:current_session).and_return session
+      end
+
+  end
+end
+

data/lib/pebblebed/version.rb

@@ -1,3 +1,3 @@
 module Pebblebed
-  VERSION = "0.0.41"
+  VERSION = "0.0.42"
 end

data/spec/sinatra_spec.rb

@@ -4,6 +4,7 @@ require 'pebblebed/sinatra'
 require 'sinatra/base'
 require 'rack/test'
 require 'spec_helper'
+require 'pebblebed/rspec_helper'
 
 class TestApp < Sinatra::Base
   register Sinatra::Pebblebed
@@ -36,31 +37,16 @@ end
 
 describe Sinatra::Pebblebed do
   include Rack::Test::Methods
+  include Pebblebed::RSpecHelper
 
   def app
     TestApp
   end
 
-  let(:guest) { DeepStruct.wrap({}) }
-  let(:alice) { DeepStruct.wrap(:identity => {:id => 1, :god => false}) }
-  let(:odin) { DeepStruct.wrap(:identity => {:id => 2, :god => true}) }
-
-  let(:checkpoint) { stub(:get => identity, :service_url => 'http://example.com') }
-
-  before :each do
-    TestApp.any_instance.stub(:current_session).and_return "validsessionyesyesyes"
-    Pebblebed::Connector.any_instance.stub(:checkpoint).and_return checkpoint
-  end
-
   let(:random_session) { rand(36**128).to_s(36) }
 
-  before :each do
-    # Make sure the app get an uniqie session key for every received request
-    TestApp.any_instance.stub(:current_session) { random_session }
-  end
-
   context "a guest" do
-    let(:identity) { guest }
+    before(:each) { guest! }
 
     specify "can see public endpoint" do
       get '/public'
@@ -84,7 +70,7 @@ describe Sinatra::Pebblebed do
   end
 
   context "as a user" do
-    let(:identity) { alice }
+    before(:each) { user! }
 
     specify "can see public endpoint" do
       get '/public'
@@ -103,7 +89,7 @@ describe Sinatra::Pebblebed do
   end
 
   context "as a god" do
-    let(:identity) { odin }
+    before(:each) { god!(:session => random_session) }
 
     specify "can see public endpoint" do
       get '/public'
@@ -122,11 +108,13 @@ describe Sinatra::Pebblebed do
   end
 
   describe "error handling" do
-    let(:identity) { guest }
+    before(:each) { guest! }
+
     it "Adds graceful handling of HttpNotFoundError exceptions" do
       get '/nonexistant'
       last_response.status.should == 404
     end
+
     it "Gives the error message of HttpNotFoundError as response body" do
       get '/nonexistant'
       last_response.status.should == 404
@@ -134,33 +122,36 @@ describe Sinatra::Pebblebed do
     end
   end
 
-  describe "current identity caching" do
-    let(:identity) { alice }
-
-    it "will not cache current_identity by default" do
-      checkpoint.should_receive(:get).twice
-      get '/private'
-      get '/private'
-    end
-
-    it "can be configured to cache current identity" do
-      session = random_session
-      app.set :cache_current_identity, true
-      checkpoint.should_receive(:get).once
-      get '/private'
-      get '/private'
+  describe "identity caching" do
+
+    context "with logged in user" do
+      before(:each) { user!(:session => random_session) }
+      let(:checkpoint) { Pebblebed::Connector.new.checkpoint }
+
+      it "is not turned on by default" do
+        checkpoint.should_receive(:get).twice
+        get '/private'
+        get '/private'
+      end
+
+      it "can be turned on" do
+        app.set :cache_current_identity, true
+        checkpoint.should_receive(:get).once
+        get '/private'
+        get '/private'
+      end
+
+      context "with guest user" do
+        before(:each) { guest! }
+
+        it "is disabled" do
+          app.set :cache_current_identity, true
+          checkpoint.should_receive(:get).twice
+          get '/private'
+          get '/private'
+        end
+      end
     end
-  end
-
-  describe "identity caching disabled when no current user" do
-    let(:identity) { {} }
 
-    it "will not cache identity when there is no current identity" do
-      identity = nil
-      app.set :cache_current_identity, true
-      checkpoint.should_receive(:get).twice
-      get '/private'
-      get '/private'
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pebblebed
 version: !ruby/object:Gem::Version
-  version: 0.0.41
+  version: 0.0.42
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360765760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360765760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360765140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360765140
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360764520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,15 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360764520
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360763860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,15 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360763860
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360763420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -86,15 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360763420
 - !ruby/object:Gem::Dependency
   name: memcache_mock
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360762920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -102,15 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360762920
 - !ruby/object:Gem::Dependency
   name: deepstruct
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360778520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -118,15 +88,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.4
+  version_requirements: *70269360778520
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360777860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,15 +99,10 @@ dependencies:
         version: 0.7.14
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.7.14
+  version_requirements: *70269360777860
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360777480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -150,15 +110,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360777480
 - !ruby/object:Gem::Dependency
   name: queryparams
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360777020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,15 +121,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360777020
 - !ruby/object:Gem::Dependency
   name: futurevalue
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360776580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -182,15 +132,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360776580
 - !ruby/object:Gem::Dependency
   name: pathbuilder
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360776120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -198,15 +143,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360776120
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360775660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -214,15 +154,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360775660
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360775220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -230,15 +165,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360775220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360774760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -246,15 +176,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360774760
 - !ruby/object:Gem::Dependency
   name: bunny
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70269360774320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -262,12 +187,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70269360774320
 description: Development tools for working with Pebblebed
 email:
 - katrina@bengler.no
@@ -293,6 +213,7 @@ files:
 - lib/pebblebed/parts.rb
 - lib/pebblebed/river.rb
 - lib/pebblebed/river/subscription.rb
+- lib/pebblebed/rspec_helper.rb
 - lib/pebblebed/security/access_data.rb
 - lib/pebblebed/security/client.rb
 - lib/pebblebed/security/listener.rb
@@ -326,21 +247,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3749590712618864123
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3749590712618864123
 requirements: []
 rubyforge_project: pebblebed
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Development tools for working with Pebblebed
@@ -359,3 +274,4 @@ test_files:
 - spec/sinatra_spec.rb
 - spec/spec_helper.rb
 - spec/uid_spec.rb
+has_rdoc: