djsun-rest-sinatra 0.2.1 → 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rest-sinatra"
+    gem.summary = %Q{Easily write RESTful actions with Sinatra and MongoMapper}
+    gem.description = %Q{Provides a DSL for making RESTful Sinatra actions with MongoMapper models.}
+    gem.email = "djames@sunlightfoundation.com"
+    gem.homepage = "http://github.com/djsun/rest-sinatra"
+    gem.authors = ["David James"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rest-sinatra #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/rest-sinatra.rb

@@ -0,0 +1,280 @@
+module RestSinatra
+
+  def self.included(includer)
+    includer.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    
+    attr_reader :config
+  
+    def resource(name, &block)
+      _resource(name, :regular, &block)
+    end
+    
+    def nestable_resource(name, &block)
+      _resource(name, :nestable, &block)
+    end
+    
+    protected
+    
+    def _resource(name, resource_type, &block)
+      config = evaluate_block(name, resource_type, &block)
+      validate(config)
+      build_resource(config)
+      config
+    end
+    
+    def evaluate_block(name, resource_type, &block)
+      scope = Object.new
+      scope.extend(ResourceMethods)
+      scope.instance_eval do
+        @c = {
+          :name             => name,
+          :resource_type    => resource_type,
+          :model            => nil,
+          :read_only        => [],
+          :permission       => nil,
+          :callbacks        => {},
+          :nested_resources => []
+        }
+      end
+      scope.instance_eval(&block)
+      scope.instance_variable_get("@c")
+    end
+    
+    def validate(c)
+      raise "name required" unless c[:name]
+      raise "model required" unless c[:model]
+      c[:nested_resources].each do |resource|
+        unless resource[:association]
+          raise "association required for #{resource[:class]}"
+        end
+      end
+    end
+    
+    def build_resource(config)
+      case config[:resource_type]
+      when :regular
+        build_parent_resource(config)
+        build_nested_resources(config)
+      when :nestable
+        save_nestable_config(config)
+      else
+        raise "Unexpected resource_type"
+      end
+    end
+
+    def build_parent_resource(config)
+      callbacks = config[:callbacks]
+      model     = config[:model]
+      name      = config[:name]
+      read_only = config[:read_only]
+
+      get '/?' do
+        require_at_least(:basic)
+        @documents = find(params, model)
+        @documents.to_json
+      end
+
+      get '/:id/?' do |id|
+        require_at_least(:basic)
+        id = params.delete("id")
+        @document = model.find_by_id(id)
+        error 404, [].to_json unless @document
+        @document.to_json
+      end
+
+      post '/?' do
+        require_at_least(:curator)
+        id = params.delete("id")
+        validate_before_create(params, model, read_only)
+        @document = model.find_by_id(id)
+        callback callbacks[:before_save]
+        callback callbacks[:before_create]
+        @document = model.new(params)
+        unless @document.valid?
+          error 400, { "errors" => @document.errors.errors }.to_json
+        end
+        @document.save
+        callback callbacks[:after_create]
+        callback callbacks[:after_save]
+        response.status = 201
+        response.headers['Location'] = full_uri "/#{name}/#{@document.id}"
+        @document.to_json
+      end
+
+      put '/:id/?' do
+        require_at_least(:curator)
+        id = params.delete("id")
+        @document = model.find_by_id(id)
+        error 404, [].to_json unless @document
+        validate_before_update(params, model, read_only)
+        callback(callbacks[:before_save])
+        callback(callbacks[:before_update])
+        validate_before_update(params, model, read_only)
+        @document = model.update(id, params)
+        unless @document.valid?
+          error 400, { "errors" => @document.errors.errors }.to_json
+        end
+        callback(callbacks[:after_update])
+        callback(callbacks[:after_save])
+        @document.to_json
+      end
+
+      delete '/:id/?' do
+        require_at_least(:curator)
+        id = params.delete("id")
+        @document = model.find_by_id(id)
+        error 404, [].to_json unless @document
+        callback(callbacks[:before_destroy])
+        @document.destroy
+        callback(callbacks[:after_destroy])
+        { "id" => id }.to_json
+      end
+    end
+
+    def build_nested_resources(parent_config)
+      parent_config[:nested_resources].each do |resource|
+        nested_res_class = resource[:class]
+        assoc            = resource[:association]
+        nested_config    = restore_nestable_config(nested_res_class)
+        build_nested_resource(nested_res_class, assoc, parent_config, nested_config)
+      end
+    end
+
+    # klass       : nested resource class
+    # association : a method on the parent model that will return child models
+    def build_nested_resource(klass, association, parent_config, child_config)
+      callbacks       = child_config[:callbacks]
+      child_model     = child_config[:model]
+      child_name      = child_config[:name]
+      permission      = child_config[:permission]
+      read_only       = child_config[:read_only]
+
+      parent_model    = parent_config[:model]
+      parent_name     = parent_config[:name]
+
+      get "/:parent_id/#{child_name}/?" do
+        parent_id = params.delete("parent_id")
+        permission_check(:basic, permission, parent_id)
+        @parent_document = find_parent(parent_model, parent_id)
+        all_child_documents = @parent_document.send(association)
+        @child_documents = nested_find(all_child_documents, params, parent_model)
+        @child_documents.to_json
+      end
+
+      get "/:parent_id/#{child_name}/:child_id/?" do
+        parent_id = params.delete("parent_id")
+        permission_check(:basic, permission, parent_id)
+        child_id = params.delete("child_id")
+        @parent_document, @child_document = find_documents(parent_model, parent_id, association, child_id)
+        @child_document.to_json
+      end
+
+      post "/:parent_id/#{child_name}/?" do
+        parent_id = params.delete("parent_id")
+        permission_check(:curator, permission, parent_id)
+        @parent_document = find_parent(parent_model, parent_id)
+        validate_before_create(params, child_model, read_only)
+        callback callbacks[:before_save]
+        callback callbacks[:before_create]
+        @child_document = child_model.new(params)
+        @parent_document.send(association) << @child_document
+        error 500, [].to_json unless @parent_document.save
+        callback callbacks[:after_create]
+        callback callbacks[:after_save]
+        response.status = 201
+        response.headers['Location'] = full_uri(
+          "/#{parent_name}/#{parent_id}/#{child_name}/#{@child_document.id}"
+        )
+        @child_document.to_json
+      end
+
+      put "/:parent_id/#{child_name}/:child_id/?" do
+        parent_id = params.delete("parent_id")
+        permission_check(:curator, permission, parent_id)
+        child_id = params.delete("child_id")
+        @parent_document, @child_document = find_documents(parent_model, parent_id, association, child_id)
+        validate_before_update(params, child_model, read_only)
+        callback callbacks[:before_save]
+        callback callbacks[:before_update]
+        @child_document.attributes = params
+        child_index = @parent_document.send(association).index(@child_document)
+        @parent_document.send(association)[child_index] = @child_document
+        error 500, [].to_json unless @parent_document.save
+        callback callbacks[:after_update]
+        callback callbacks[:after_save]
+        @child_document.to_json
+      end
+
+      delete "/:parent_id/#{child_name}/:child_id/?" do
+        parent_id = params.delete("parent_id")
+        permission_check(:curator, permission, parent_id)
+        child_id = params.delete("child_id")
+        @parent_document, @child_document = find_documents(parent_model, parent_id, association, child_id)
+        callback callbacks[:before_destroy]
+        @parent_document.send(association).delete(@child_document)
+        callback callbacks[:after_destroy]
+        error 500, [].to_json unless @parent_document.save
+        { "id" => child_id }.to_json
+      end
+
+      helpers do
+        def find_parent(parent_model, parent_id)
+          parent_document = parent_model.find_by_id(parent_id)
+          error 404, [].to_json unless parent_document
+          parent_document
+        end
+
+        def find_child(parent_document, association, child_id)
+          child_document = parent_document.send(association).find { |x| x.id == child_id }
+          error 404, [].to_json unless child_document
+          child_document
+        end
+
+        def find_documents(parent_model, parent_id, association, child_id)
+          parent_document = find_parent(parent_model, parent_id)
+          child_document = find_child(parent_document, association, child_id)
+          [parent_document, child_document]
+        end
+      end
+    end
+
+    def save_nestable_config(config)
+      @nestable_resource_config = config
+    end
+    
+    def restore_nestable_config(klass)
+      klass.instance_variable_get("@nestable_resource_config")
+    end
+
+  end
+  
+  module ResourceMethods
+    
+    def model(model)
+      raise "model already declared" if @c[:model]
+      @c[:model] = model
+    end
+
+    def read_only(attribute)
+      @c[:read_only] << attribute
+    end
+    
+    def permission(level)
+      raise "permission already declared" if @c[:permission]
+      @c[:permission] = level
+    end
+    
+    def callback(name, &block)
+      @c[:callbacks][name] = block
+    end
+    
+    def nested_resource(klass, options)
+      @c[:nested_resources] << options.merge({:class => klass})
+    end
+    
+  end
+  
+end

data/spec/helpers/comments.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/sinatra_stubs')
+
+class Comment ; end
+
+class Comments
+  include RestSinatra
+  include SinatraStubs
+  
+  @r = nestable_resource "comments" do
+    model Comment
+    
+    read_only :created_at
+    
+    callback :before_save do
+      "before saving comments"
+    end
+  end
+end

data/spec/helpers/posts.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/sinatra_stubs')
+require File.expand_path(File.dirname(__FILE__) + '/comments')
+
+class Post ; end
+
+class Posts
+  include RestSinatra
+  include SinatraStubs
+  
+  @r = resource "posts" do
+    model Post
+
+    read_only :created_at
+    read_only :updated_at
+    
+    nested_resource Comments, :association => :comments
+    
+    callback :before_save do
+      "before saving posts"
+    end
+  end
+end

data/spec/helpers/sinatra_stubs.rb

@@ -0,0 +1,39 @@
+module SinatraStubs
+  
+  def self.included(includer)
+    includer.class_eval do
+      @actions = {
+        :get     => [],
+        :post    => [],
+        :put     => [],
+        :delete  => []
+      }
+    end
+    includer.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    attr_reader :actions
+    
+    def get(route)
+      @actions[:get] << route
+    end
+
+    def post(route)
+      @actions[:post] << route
+    end
+
+    def put(route)
+      @actions[:put] << route
+    end
+
+    def delete(route)
+      @actions[:delete] << route
+    end
+    
+    def helpers()
+      # ...
+    end
+  end
+
+end

data/spec/helpers/sources.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/sinatra_stubs')
+
+class Source ; end
+
+class Sources
+  include RestSinatra
+  include SinatraStubs
+  
+  @r = resource "sources" do
+    model Source
+  end
+end

data/spec/helpers/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/rest-sinatra')

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rest-sinatra'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/unit/posts_and_comments_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/spec_helper.rb')
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/posts.rb')
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/comments.rb')
+
+describe "Posts" do
+  
+  before do
+    @config = Posts.instance_variable_get("@r")
+  end
+  
+  describe "DSL methods" do
+    it "resource should be 'posts'" do
+      @config[:name].should == "posts"
+    end
+
+    it "model should be Post" do
+      @config[:model].should == Post
+    end
+
+    it "read_only should be correct" do
+      @config[:read_only].should == [:created_at, :updated_at]
+    end
+
+    it "callback :before_create should be correct" do
+      @config[:callbacks][:before_save].call.should == "before saving posts"
+    end
+    
+    it "callback :before_update should return nil" do
+      @config[:callbacks][:before_update].should == nil
+    end
+  end
+
+  describe "actions" do
+    before do
+      @actions = Posts.actions
+    end
+    
+    describe "get" do
+      before do
+        @acts = @actions[:get]
+      end
+
+      it "get /?" do
+        @acts.should include("/?")
+      end
+
+      it "get /:id/?" do
+        @acts.should include("/:id/?")
+      end
+
+      it "get /:parent_id/comments/?" do
+        @acts.should include("/:parent_id/comments/?")
+      end
+
+      it "get /:parent_id/comments/:child_id/?" do
+        @acts.should include("/:parent_id/comments/:child_id/?")
+      end
+
+      it "exactly 4 actions" do
+        @acts.length.should == 4
+      end
+    end
+
+    describe "post" do
+      before do
+        @acts = @actions[:post]
+      end
+    
+      it "post /?" do
+        @acts.should include("/?")
+      end
+
+      it "post /:parent_id/comments/?" do
+        @acts.should include("/:parent_id/comments/?")
+      end
+    
+      it "exactly 2 actions" do
+        @acts.length.should == 2
+      end
+    end
+
+    describe "put" do
+      before do
+        @acts = @actions[:put]
+      end
+    
+      it "put /:id/?" do
+        @acts.should include("/:id/?")
+      end
+      
+      it "put /:parent_id/comments/:child_id/?" do
+        @acts.should include("/:parent_id/comments/:child_id/?")
+      end
+    
+      it "exactly 2 actions" do
+        @acts.length.should == 2
+      end
+    end
+
+    describe "delete" do
+      before do
+        @acts = @actions[:delete]
+      end
+    
+      it "delete /:id/?" do
+        @acts.should include("/:id/?")
+      end
+      
+      it "delete /:parent_id/comments/:child_id/?" do
+        @acts.should include("/:parent_id/comments/:child_id/?")
+      end
+    
+      it "exactly 2 actions" do
+        @acts.length.should == 2
+      end
+    end
+  end
+
+end
+
+describe "Comments" do
+  
+  before do
+    @config = Comments.instance_variable_get("@r")
+  end
+  
+  describe "DSL methods" do
+    it "resource should be 'comments'" do
+      @config[:name].should == "comments"
+    end
+
+    it "model should be Comment" do
+      @config[:model].should == Comment
+    end
+
+    it "read_only should be correct" do
+      @config[:read_only].should == [:created_at]
+    end
+
+    it "callback :before_create should be correct" do
+      @config[:callbacks][:before_save].call.should == "before saving comments"
+    end
+    
+    it "callback :before_update should return nil" do
+      @config[:callbacks][:before_update].should == nil
+    end
+  end
+end

data/spec/unit/sources_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/sources')
+
+describe "Sources" do
+  
+  describe "DSL methods" do
+    before do
+      @config = Sources.instance_variable_get("@r")
+    end
+
+    it "name should be 'sources'" do
+      @config[:name].should == "sources"
+    end
+
+    it "model should be Source" do
+      @config[:model].should == Source
+    end
+
+    it "read_only should be empty" do
+      @config[:read_only].should == []
+    end
+
+    it "callbacks should be empty" do
+      @config[:callbacks].should == {}
+    end
+  end
+
+  describe "actions" do
+    before do
+      @actions = Sources.actions
+    end
+    
+    describe "get" do
+      before do
+        @acts = @actions[:get]
+      end
+
+      it "get /?" do
+        @acts.should include("/?")
+      end
+
+      it "get /:id/?" do
+        @acts.should include("/:id/?")
+      end
+    
+      it "exactly 2 actions" do
+        @acts.length.should == 2
+      end
+    end
+    
+    describe "post" do
+      before do
+        @acts = @actions[:post]
+      end
+
+      it "post /?" do
+        @acts.should include("/?")
+      end
+
+      it "exactly 1 action" do
+        @acts.length.should == 1
+      end
+    end
+    
+    describe "put" do
+      before do
+        @acts = @actions[:put]
+      end
+
+      it "put /:id/?" do
+        @acts.should include("/:id/?")
+      end
+
+      it "exactly 1 action" do
+        @acts.length.should == 1
+      end
+    end
+    
+    describe "delete" do
+      before do
+        @acts = @actions[:delete]
+      end
+
+      it "delete /:id/?" do
+        @acts.should include("/:id/?")
+      end
+
+      it "exactly 1 action" do
+        @acts.length.should == 1
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: djsun-rest-sinatra
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - David James
@@ -11,11 +11,19 @@ cert_chain: []
 
 date: 2009-09-24 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
-description: Easily create RESTful actions with your Sinatra app and MongoMapper back-end.
-email: 
-- djames at sunlightfoundation.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides a DSL for making RESTful Sinatra actions with MongoMapper models.
+email: djames@sunlightfoundation.com
 executables: []
 
 extensions: []
@@ -24,10 +32,22 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
+- .document
+- .gitignore
 - LICENSE
-- rakefile.rb
 - README.md
-has_rdoc: true
+- Rakefile
+- VERSION
+- lib/rest-sinatra.rb
+- spec/helpers/comments.rb
+- spec/helpers/posts.rb
+- spec/helpers/sinatra_stubs.rb
+- spec/helpers/sources.rb
+- spec/helpers/spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/posts_and_comments_spec.rb
+- spec/unit/sources_spec.rb
+has_rdoc: false
 homepage: http://github.com/djsun/rest-sinatra
 licenses: 
 post_install_message: 
@@ -49,10 +69,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: "-"
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Helps build RESTful APIs with Sinatra and MongoMapper.
-test_files: []
-
+specification_version: 3
+summary: Easily write RESTful actions with Sinatra and MongoMapper
+test_files: 
+- spec/helpers/comments.rb
+- spec/helpers/posts.rb
+- spec/helpers/sinatra_stubs.rb
+- spec/helpers/sources.rb
+- spec/helpers/spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/posts_and_comments_spec.rb
+- spec/unit/sources_spec.rb

data/rakefile.rb

@@ -1,24 +0,0 @@
-desc "build and install gem"
-task :gem => ["gem:build", "gem:install"]
-
-namespace :gem do
-  
-  def gem_spec
-    Dir["*.gemspec"].sort.last
-  end
-  
-  def gem_file
-    Dir["*.gem"].sort.last
-  end
-
-  desc "build gem"
-  task :build do
-    puts `gem build #{gem_spec}`
-  end
-  
-  desc "install gem"
-  task :install do
-    puts `gem install --local --user-install #{gem_file}`
-  end
-
-end