sinatra_resource 0.2.2 → 0.2.3

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/examples/datacatalog/test/helpers/shared/common_body_responses.rb

@@ -11,5 +11,17 @@ class ResourceTestCase
       assert_equal [], parsed_response_body
     end
   end
+  
+  shared "content type header indicates JSON" do
+    test "should have JSON content type" do
+      assert_equal "application/json", last_response.headers["Content-Type"]
+    end
+  end
+
+  shared "content type header not set" do
+    test "should not have Content-Type set" do
+      assert_equal nil, last_response.headers["Content-Type"]
+    end
+  end
 
 end

data/examples/datacatalog/test/helpers/shared/status_codes.rb

@@ -4,6 +4,8 @@ class ResourceTestCase
     test "status should be 200 Ok" do
       assert_equal 200, last_response.status
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 201 Created" do
@@ -16,6 +18,8 @@ class ResourceTestCase
       generic_uri = %r{^http://localhost}
       assert_match generic_uri, last_response.headers["Location"]
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 204 No Content" do
@@ -24,30 +28,39 @@ class ResourceTestCase
     end
     
     use "return an empty response body"
+    use "content type header not set"
   end
 
   shared "return 400 Bad Request" do
     test "status should be 400 Bad Request" do
       assert_equal 400, last_response.status
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 401 Unauthorized" do
     test "status should be 401 Unauthorized" do
       assert_equal 401, last_response.status
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 403 Forbidden" do
     test "status should be 403 Forbidden" do
       assert_equal 403, last_response.status
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 404 Not Found" do
     test "status should be 404 Not Found" do
       assert_equal 404, last_response.status
     end
+
+    use "content type header indicates JSON"
   end
 
   shared "return 404 Not Found with empty response body" do

data/examples/datacatalog/test/resources/categories/categories_get_many_test.rb

@@ -7,7 +7,9 @@ class CategoriesGetManyResourceTest < ResourceTestCase
   def app; Categories end
 
   before do
-    raise "Unexpected Category count" unless Category.count == 0
+    unless 0 == (c = Category.count)
+      raise "Expected 0 for Category.count, found #{c}"
+    end
     @categories = 3.times.map do |i|
       create_category(:name => "Category #{i}")
     end

data/examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb

@@ -7,7 +7,9 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
   def app; Categories end
 
   before do
-    raise "Unexpected Source count" unless Source.count == 0
+    unless 0 == (c = Source.count)
+      raise "Expected 0 for Source.count, found #{c}"
+    end
     @category = create_category
     @sources = 3.times.map do |i|
       create_source(:title => "Source #{i}")
@@ -29,6 +31,7 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
         :category_id => @other_category.id
       )
     end
+    @source_titles = ["Source 0", "Source 1", "Source 2"].sort
   end
   
   after do
@@ -40,8 +43,6 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
     @category.destroy
   end
 
-  SOURCES = ["Source 0", "Source 1", "Source 2"].sort
-
   context "get /:id/sources/" do
     context "anonymous" do
       before do
@@ -82,7 +83,7 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
 
       test "body should have correct source titles" do
         actual = parsed_response_body.map { |e| e["title"] }
-        assert_equal SOURCES, actual.sort
+        assert_equal @source_titles, actual.sort
       end
       
       docs_properties %w(title url raw id created_at updated_at)

data/examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesGetManyResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Sources end
+
+  before do
+    Source.destroy_all unless Source.count == 0
+    @sources = 3.times.map do |i|
+      create_source(:title => "Source #{i}")
+    end
+    @source_titles = ["Source 0", "Source 1", "Source 2"].sort
+  end
+
+  after do
+    @sources.each { |x| x.destroy } if @sources
+  end
+
+  context "title='Source 2'" do
+    before do
+      @search_params = { :filter => "title='Source 2'" }
+    end
+
+    context "get /" do
+      context "anonymous" do
+        before do
+          get "/", @search_params
+        end
+
+        use "return 401 because the API key is missing"
+      end
+
+      context "incorrect API key" do
+        before do
+          get "/", @search_params.merge(:api_key => BAD_API_KEY)
+        end
+
+        use "return 401 because the API key is invalid"
+      end
+    end
+
+    %w(basic curator admin).each do |role|
+      context "#{role} : get /" do
+        before do
+          get "/", @search_params.merge(:api_key => api_key_for(role))
+        end
+
+        use "return 200 Ok"
+
+        test "body should have 1 source" do
+          assert_equal 1, parsed_response_body.length
+        end
+
+        test "body should have correct source" do
+          assert_equal 'Source 2', parsed_response_body[0]['title']
+        end
+
+        docs_properties %w(title url raw categories id created_at updated_at)
+      end
+    end
+  end
+
+  context "title:Source" do
+    before do
+      @search_params = { :filter => "title:Source" }
+    end
+
+    %w(basic curator admin).each do |role|
+      context "#{role} : get /" do
+        before do
+          get "/", @search_params.merge(:api_key => api_key_for(role))
+        end
+
+        use "return 200 Ok"
+
+        test "body should have 3 sources" do
+          assert_equal 3, parsed_response_body.length
+        end
+
+        test "body should have correct source titles" do
+          actual = parsed_response_body.map { |e| e["title"] }
+          assert_equal @source_titles, actual.sort
+        end
+
+        docs_properties %w(title url raw categories id created_at updated_at)
+      end
+    end
+  end
+
+end

data/examples/datacatalog/test/resources/sources/sources_get_many_test.rb

@@ -7,18 +7,17 @@ class SourcesGetManyResourceTest < ResourceTestCase
   def app; Sources end
 
   before do
-    raise "Unexpected Source count" unless Source.count == 0
+    Source.destroy_all unless Source.count == 0
     @sources = 3.times.map do |i|
       create_source(:title => "Source #{i}")
     end
+    @source_titles = ["Source 0", "Source 1", "Source 2"].sort
   end
   
   after do
     @sources.each { |x| x.destroy } if @sources
   end
   
-  SOURCES = ["Source 0", "Source 1", "Source 2"].sort
-
   context "get /" do
     context "anonymous" do
       before do
@@ -51,7 +50,7 @@ class SourcesGetManyResourceTest < ResourceTestCase
       
       test "body should have correct source titles" do
         actual = parsed_response_body.map { |e| e["title"] }
-        assert_equal SOURCES, actual.sort
+        assert_equal @source_titles, actual.sort
       end
       
       docs_properties %w(title url raw categories id created_at updated_at)

data/examples/datacatalog/test/resources/users/users_get_many_test.rb

@@ -7,7 +7,9 @@ class UsersGetManyResourceTest < ResourceTestCase
   def app; Users end
 
   before do
-    raise "Unexpected Source count" unless User.count == 3
+    unless 3 == (c = User.count)
+      raise "Expected 3 for User.count, found #{c}"
+    end
     @users = 3.times.map do |i|
       create_user(
         :name  => "User #{i}",

data/lib/builder/helpers.rb

@@ -4,6 +4,8 @@ module SinatraResource
 
     module Helpers
       
+      FILTER_KEY = "filter"
+      
       # Build a resource, based on +document+, appropriate for +role+.
       #
       # @param [Symbol] role
@@ -159,9 +161,13 @@ module SinatraResource
       #   a role (such as :anonymous, :basic, or :admin)
       def minimum_role(action, resource_config, property=nil)
         if property.nil?
-          resource_config[:permission][to_read_or_modify(action)]
+          hash = resource_config[:permission][to_read_or_modify(action)]
         else
-          resource_config[:properties][property][to_r_or_w(action)]
+          hash = resource_config[:properties][property]
+          unless hash
+            raise Error, "bad configuration for #{property.inspect}"
+          end
+          hash[to_r_or_w(action)]
         end || :anonymous
       end
       
@@ -246,7 +252,7 @@ module SinatraResource
       def lookup_role(document=nil)
         raise NotImplementedError
       end
-
+      
       # Are the params suitable for +action+? Raise 400 Bad Request if not.
       #
       # @param [Symbol] action
@@ -260,7 +266,7 @@ module SinatraResource
       def params_check_action(action)
         case action
         when :read
-          unless params.empty?
+          unless params.reject { |k, v| k == FILTER_KEY }.empty?
             error 400, convert(body_for(:non_empty_params))
           end
         when :create
@@ -292,7 +298,10 @@ module SinatraResource
       def params_check_action_and_role(action, role, resource_config)
         invalid = []
         params.each_pair do |property, value|
-          invalid << property if !authorized?(action, role, resource_config, property.intern)
+          next if property == FILTER_KEY
+          if !authorized?(action, role, resource_config, property.intern)
+            invalid << property
+          end 
         end
         unless invalid.empty?
           error 400, convert(body_for(:invalid_params, invalid))

data/lib/builder/mongo_helpers.rb

@@ -1,10 +1,12 @@
+gem 'query_string_filter', '>= 0.1.1'
+require 'query_string_filter'
+
 module SinatraResource
   
   class Builder
 
     module MongoHelpers
 
-
       # Make sure that +parent+ document is related to the +child+ document
       # by way of +association+. If not, return 404 Not Found.
       #
@@ -59,14 +61,16 @@ module SinatraResource
         document
       end
 
-      # Find all +model+ documents.
+      # Find +model+ documents: find all documents if no params, otherwise
+      # find selected documents.
       #
       # @param [Class] model
       #   a class that includes MongoMapper::Document
       #
       # @return [Array<MongoMapper::Document>]
       def find_documents!(model)
-        model.find(:all)
+        return(model.all) if params.empty?
+        model.all(make_conditions(params, model))
       end
       
       # Delegates to application, who should use custom logic to related
@@ -105,6 +109,10 @@ module SinatraResource
 
       # Update a document with +id+ from params. If not valid, returns 400.
       #
+      # @param [Hash] model
+      #
+      # @param [String] id
+      #
       # @return [MongoMapper::Document]
       def update_document!(model, id)
         document = model.update(id, params)
@@ -113,6 +121,41 @@ module SinatraResource
         end
         document
       end
+      
+      protected
+
+      PATTERNS = [
+        [ %r{^<=(.*)} , '$lte' ],
+        [ %r{^<(.*)}  , '$lt'  ],
+        [ %r{^>=(.*)} , '$gte' ],
+        [ %r{^>(.*)}  , '$gt'  ]
+      ]
+      
+      QS_FILTER = QueryStringFilter.new
+      
+      # Build conditions hash based on +params+.
+      #
+      # @param [Hash] params
+      #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
+      # @return [Hash]
+      def make_conditions(params, model)
+        filter_string = params["filter"]
+        return {} unless filter_string
+        QS_FILTER.parse(filter_string)
+      end
+
+      # Returns a typecasted +value+. (Uses +model+ and +key_string+ to
+      # figure out how to typecast it.)
+      #
+      # @return [Object]
+      def typecast(model, key_string, value)
+        dummy = model.new
+        dummy.send(:"#{key_string}=", value)
+        dummy.send(:"#{key_string}")
+      end
 
     end
 

data/sinatra_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]
-  s.date = %q{2009-10-26}
+  s.date = %q{2009-10-27}
   s.description = %q{A DSL for creating RESTful actions with Sinatra and MongoMapper. It embraces the Resource Oriented Architecture as explained by Leonard Richardson and Sam Ruby.}
   s.email = %q{djames@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -70,6 +70,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb",
      "examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb",
      "examples/datacatalog/test/resources/sources/sources_delete_test.rb",
+     "examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_many_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",
      "examples/datacatalog/test/resources/sources/sources_post_test.rb",
@@ -150,6 +151,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb",
      "examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb",
      "examples/datacatalog/test/resources/sources/sources_delete_test.rb",
+     "examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_many_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",
      "examples/datacatalog/test/resources/sources/sources_post_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_resource
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - David James
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 -04:00
+date: 2009-10-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -155,6 +155,7 @@ files:
 - examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb
 - examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb
 - examples/datacatalog/test/resources/sources/sources_delete_test.rb
+- examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_many_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_one_test.rb
 - examples/datacatalog/test/resources/sources/sources_post_test.rb
@@ -257,6 +258,7 @@ test_files:
 - examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb
 - examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb
 - examples/datacatalog/test/resources/sources/sources_delete_test.rb
+- examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_many_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_one_test.rb
 - examples/datacatalog/test/resources/sources/sources_post_test.rb