kabuki-escort-mission 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kabuki
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,78 @@
+= escort-mission
+
+Escort missions. They're like Take Your Child to Work Day, only your job involves 
+getting shot at and your child is a mental deficient with a lousy sense of 
+direction and giant target painted on his back.
+
+Unfortunately, no matter how much story is piled on top of these scenarios, the 
+missions rarely feel like more than a chore, leaving you feeling less like the 
+savior of the universe and more like a hired thug with little else to do but 
+watch other people do more interesting, less violent work; the Blackwater 
+mercenary of the videogame land, escorting pencil pushers to the Green Zone.
+
+http://www.escapistmagazine.com/articles/view/issues/issue_124/2644-Escort-Missions-Suck
+
+Escort Mission provides a well-mannered escort for your models.  Typically, this 
+is how you might scope and filter models in a standard rails app:
+
+  def index
+    if admin?
+      @posts = Post.all
+      json   = @posts.to_json
+    else
+      @posts = Post.published
+      json   = @posts.to_json(:except => [:secret_token, :editor_id])
+    end
+    render :json => json, :callback => params[:callback]
+  end
+
+You can replace some of the logic in an Escort class:
+
+  def index
+    @escort = Post::Escort.new(self)
+
+    #scope automatically adds published scope if user is not an admin
+    @posts = @escort.scope.all
+
+    #filter adds the :except hash if the user is not an admin
+    render :json => @posts.to_json(@escort.filter), :callback => params[:callback]
+  end
+
+You can use the #api method to wrap up the rendering for you.
+
+  def index
+    @escort = Post::Escort.new(self)
+    @posts  = @escort.api.all
+  end
+
+Here's an example of what the Post escort might look like:
+
+  class Post::Escort < EscortMission
+    include EscortMission::ActiveRecord, EscortMission::ActionPack
+    attr_reader :user
+  
+    def initialize(*args)
+      super
+      @user = @controller.send(:current_user)
+    end
+  
+    def scope
+      @scope ||= begin
+        s = Post
+        s = s.published if @user.admin?
+        s
+      end
+    end
+  
+    def filter
+      if @user.admin?
+        {}
+      else
+        {:except => [:secret_token, :editor_id]}
+      end
+    end
+  end
+
+== Copyright
+
+Copyright (c) 2009 kabuki. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/escort_mission.rb

@@ -0,0 +1,47 @@
+class EscortMission
+  attr_reader :controller
+
+  def initialize(controller)
+    @controller = controller
+  end
+
+  # Responsible for scoping the model to the current user.  The result should be
+  # either a model or a named scope.  Possible methods it needs to respond to are
+  # find/all/first/paginate.
+  def scope
+    raise NotImplementedError
+  end
+
+  # Responsible for filtering the serialization format for the current user.
+  # Some model attributes should be stripped depending on the rule of the given user.
+  # The return value will be passed to the model's #to_json or #to_xml methods.
+  def filter
+    {}
+  end
+
+  # Uses the given escort's controller to respond to the current request.  This 
+  # could involve rendering a conventional template or returning a serialized
+  # output of the model.
+  class Responder
+    attr_reader :escort, :controller
+
+    def initialize(escort)
+      @escort     = escort
+      @controller = escort.controller
+    end
+
+    # Override this to provide controller-specific details for responding to the
+    # controller request in a certain way.
+    def display(records)
+      raise NotImplementedError
+    end
+
+    # Passes the given method to the escort to fetch the records, and then calls
+    # #display to respond to the controller request.
+    def method_missing(method_name, *args)
+      records = @escort.send(method_name, *args)
+      display(records)
+      records
+    end
+  end
+end

data/lib/escort_mission/rails.rb

@@ -0,0 +1,36 @@
+require 'escort_mission'
+class EscortMission
+  module ActiveRecord
+    def self.included(base)
+      base.delegate :find,     :to => :scope
+      base.delegate :first,    :to => :scope
+      base.delegate :all,      :to => :scope
+      base.delegate :paginate, :to => :scope
+    end
+  end
+
+  module ActionPack
+    class ApiResponder < Responder
+      delegate :params, :to => :controller
+      delegate :render, :to => :controller
+
+      def format
+        @controller.request.format
+      end
+
+      def display(records)
+        format_sym = format.to_sym
+        render format_sym => records.send("to_#{format_sym}", @escort.filter), :callback => params[:callback]
+      end
+    end
+
+    # Call this to fetch records and render the response as an API call.
+    def api
+      EscortMission::ActionPack::ApiResponder.new(self)
+    end
+  end
+end
+
+class EscortMission::Rails < EscortMission
+  include EscortMission::ActiveRecord, EscortMission::ActionPack
+end

data/test/action_pack_test.rb

@@ -0,0 +1,38 @@
+require 'rails_test_helper'
+
+class PostsController < ActionController::Base
+  def index
+    @escort = Post::Escort.new(self, User.new)
+    @posts  = @escort.api.all
+  end
+end
+
+class ActionPackTest < ActionController::TestCase
+  tests PostsController
+
+  before :all do
+    @published, @unpublished = Post.all
+  end
+
+  describe "ApiResponder" do
+    it "renders JSON" do
+      get :index, :format => 'json'
+      @response.body.should == %([{"title": "a"}])
+    end
+
+    it "renders JSON with callback" do
+      get :index, :format => 'json', :callback => 'escort'
+      @response.body.should == %(escort([{"title": "a"}]))
+    end
+
+    it "renders XML" do
+      get :index, :format => 'xml'
+      assert_select 'posts > post > title'
+    end
+
+    it "sets records ivar" do
+      get :index, :format => 'json'
+      assigns(:posts).should == [@published]
+    end
+  end
+end

data/test/active_record_test.rb

@@ -0,0 +1,26 @@
+require 'rails_test_helper'
+
+class ActiveRecordTest < Test::Unit::TestCase
+  before :all do
+    @user = User.new
+    @published, @unpublished = Post.all
+  end
+
+  before { @escort = Post::Escort.new(nil, @user) }
+
+  it "scopes data with #all according to given user" do
+    @escort.scope.all.should == [@published]
+  end
+
+  it "scopes data with #find according to given user" do
+    @escort.scope.find(:all).should == [@published]
+  end
+
+  it "scopes data with #first according to given user" do
+    @escort.scope.first.should == @published
+  end
+
+  it "filters json data according to the given user" do
+    @published.to_json(@escort.filter).should == %({"title": "a"})
+  end
+end

data/test/escort_mission_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class EscortMissionTest < Test::Unit::TestCase
+  before :all do
+    @user  = User.new
+    @array = [1,2,3,4,5]
+  end
+
+  before { @escort = Array::Escort.new(nil, @user, @array) }
+
+  it "scopes data according to given user" do
+    @escort.scope.should == [2,3,4,5]
+  end
+
+  it "filters data according to the given user" do
+    @array[@escort.filter].should == [2,3,4,5]
+  end
+
+  it "filters data and creates a response" do
+    @escort.test.first.should == 2
+    @escort.output.string.should == "[2]"
+  end
+end

data/test/rails_test_helper.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require 'active_record'
+require 'action_controller'
+require 'escort_mission/rails'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :dbfile => ':memory:'
+
+class User < ActiveRecord::Base
+end
+
+class Post < ActiveRecord::Base
+  named_scope :published, :conditions => 'published_at is not null'
+
+  class Escort < EscortMission
+    include EscortMission::ActiveRecord, EscortMission::ActionPack
+
+    def initialize(controller, user)
+      super(controller)
+      @user = user
+    end
+
+    def scope
+      @scope ||= begin
+        s = Post
+        s = s.published unless @user.admin?
+        s
+      end
+    end
+
+    def filter
+      @user.admin? ? {} : {:only => :title}
+    end
+  end
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :posts
+end
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users, :force => true do |t|
+    t.boolean :admin
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.datetime :published_at
+  end
+end
+
+Post.create! :title => 'a', :published_at => Time.now.utc
+Post.create! :title => 'b'

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'context'
+require 'matchy'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'escort_mission'
+require 'stringio'
+
+class Test::Unit::TestCase
+  class TestResponder < EscortMission::Responder
+    def display(records)
+      records = [records]
+      records.flatten!
+      @escort.output << "[#{records.join(",")}]"
+    end
+  end
+
+  class User
+    def admin?
+      false
+    end
+  end
+end
+
+class Array::Escort < EscortMission
+  attr_reader :user, :array
+
+  def initialize(controller, user, array)
+    super(controller)
+    @user, @array = user, array
+  end
+
+  def first
+    scope.first
+  end
+
+  def scope
+    @scope ||= @user.admin? ? @array : @array[1..-1]
+  end
+
+  def filter
+    (@user.admin? ? 0 : 1)..-1
+  end
+
+  # used to capture the output from the test responder
+  attr_writer :output
+  def output
+    @output ||= StringIO.new
+  end
+
+  def test
+    @test_responder ||= Test::Unit::TestCase::TestResponder.new(self)
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: kabuki-escort-mission
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- kabuki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kabukiruby@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/escort_mission
+- lib/escort_mission/rails.rb
+- lib/escort_mission.rb
+- test/action_pack_test.rb
+- test/active_record_test.rb
+- test/escort_mission_test.rb
+- test/rails_test_helper.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: false
+homepage: http://github.com/kabuki/escort-mission
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Escort Mission provides a well-mannered escort for your models.
+test_files: []
+