sinatra_resource 0.4.21 → 0.4.22

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

@@ -21,34 +21,34 @@ class UsersPutResourceTest < ResourceTestCase
   after do
     @user.destroy
   end
-  
+
   context "put /:id" do
     context "anonymous" do
       before do
         put "/#{@user.id}", @valid_params
       end
-    
+
       use "return 401 because the API key is missing"
       use "user unchanged"
     end
-  
+
     context "incorrect API key" do
       before do
         put "/#{@user.id}", @valid_params.merge(:api_key => BAD_API_KEY)
       end
-  
+
       use "return 401 because the API key is invalid"
       use "user unchanged"
     end
   end
-  
+
   %w(basic curator).each do |role|
     [:created_at, :updated_at, :junk].each do |invalid|
       context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@user.id}", valid_params_for(role).merge(invalid => 9)
         end
-  
+
         use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
@@ -59,7 +59,7 @@ class UsersPutResourceTest < ResourceTestCase
         before do
           put "/#{@user.id}", valid_params_for(role).merge(erase => "")
         end
-      
+
         use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
@@ -71,7 +71,7 @@ class UsersPutResourceTest < ResourceTestCase
           put "/#{@user.id}", valid_params_for(role).
             delete_if { |k, v| k == missing }
         end
-      
+
         use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
@@ -81,7 +81,7 @@ class UsersPutResourceTest < ResourceTestCase
       before do
         put "/#{FAKE_ID}", valid_params_for(role)
       end
-    
+
       use "return 401 because the API key is unauthorized"
       use "user unchanged"
     end
@@ -90,7 +90,7 @@ class UsersPutResourceTest < ResourceTestCase
       before do
         put "/#{@user.id}", valid_params_for(role)
       end
-    
+
       use "return 401 because the API key is unauthorized"
       use "user unchanged"
     end
@@ -122,7 +122,7 @@ class UsersPutResourceTest < ResourceTestCase
           put "/#{@user.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(invalid => 9)
         end
-  
+
         use "return 400 Bad Request"
         use "user unchanged"
         invalid_param invalid
@@ -135,7 +135,7 @@ class UsersPutResourceTest < ResourceTestCase
           put "/#{@user.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(erase => "")
         end
-      
+
         use "return 400 Bad Request"
         use "user unchanged"
         missing_param erase
@@ -148,7 +148,7 @@ class UsersPutResourceTest < ResourceTestCase
           put "/#{FAKE_ID}", valid_params_for(role).
             merge(@extra_admin_params).delete_if { |k, v| k == missing }
         end
-      
+
         use "return 404 Not Found with empty response body"
         use "user unchanged"
       end
@@ -160,11 +160,11 @@ class UsersPutResourceTest < ResourceTestCase
           put "/#{@user.id}", valid_params_for(role).
             merge(@extra_admin_params).delete_if { |k, v| k == missing }
         end
-      
+
         use "return 200 Ok"
         doc_properties %w(name email role _api_key token
           id created_at updated_at)
-  
+
         test "should change correct fields in database" do
           user = User.find_by_id(@user.id)
           @valid_params.merge(@extra_admin_params).each_pair do |key, value|
@@ -179,7 +179,7 @@ class UsersPutResourceTest < ResourceTestCase
       before do
         put "/#{FAKE_ID}", valid_params_for(role).merge(@extra_admin_params)
       end
-    
+
       use "return 404 Not Found with empty response body"
       use "user unchanged"
     end
@@ -188,11 +188,11 @@ class UsersPutResourceTest < ResourceTestCase
       before do
         put "/#{@user.id}", valid_params_for(role).merge(@extra_admin_params)
       end
-      
+
       use "return 200 Ok"
       doc_properties %w(name email role _api_key token
         id created_at updated_at)
-  
+
       test "should change all fields in database" do
         user = User.find_by_id(@user.id)
         @valid_params.merge(@extra_admin_params).each_pair do |key, value|

data/lib/builder/action_definitions.rb

@@ -1,5 +1,5 @@
 module SinatraResource
-  
+
   class Builder
 
     module ActionDefinitions
@@ -16,7 +16,7 @@ module SinatraResource
           find_document!(model, id)
         end
       end
-      
+
       def document_count_for_get_many(model, resource_config, parent_document, child_assoc)
         if resource_config[:parent]
           count_nested_documents(parent_document, child_assoc, model)
@@ -24,7 +24,7 @@ module SinatraResource
           count_documents(model)
         end
       end
-      
+
       def documents_for_get_many(role, model, resource_config, page, items_per_page, leaf, parent_document, child_assoc)
         check_permission(:list, role, resource_config)
         check_params(:list, role, resource_config, leaf)
@@ -37,7 +37,7 @@ module SinatraResource
           authorized?(:read, lookup_role(doc), resource_config)
         end
       end
-      
+
       def document_for_post(role, model, resource_config, leaf, parent_document, child_assoc)
         check_permission(:create, role, resource_config)
         check_params(:create, role, resource_config, leaf)
@@ -53,7 +53,7 @@ module SinatraResource
         do_callback(:after_create, resource_config, document, parent_document)
         document
       end
-      
+
       def document_for_put(role, model, resource_config, leaf, id, parent_document, child_assoc)
         check_permission(:update, role, resource_config)
         if resource_config[:parent]
@@ -74,7 +74,7 @@ module SinatraResource
         do_callback(:after_update, resource_config, document, parent_document)
         document
       end
-      
+
       def document_for_delete(role, model, resource_config, leaf, id, parent_document, child_assoc)
         check_permission(:delete, role, resource_config)
         if resource_config[:parent]
@@ -97,7 +97,7 @@ module SinatraResource
       end
 
     end
-    
+
   end
-  
+
 end

data/lib/builder/helpers.rb

@@ -1,9 +1,9 @@
 module SinatraResource
-  
+
   class Builder
 
     module Helpers
-      
+
       # Build a resource, based on +document+, appropriate for +role+.
       #
       # @param [Symbol] role
@@ -102,7 +102,7 @@ module SinatraResource
           error 401, convert(body_for(:unauthorized))
         end
       end
-      
+
       # Convert +object+ to desired format.
       #
       # For example, an application might want to convert +object+ to JSON or
@@ -143,7 +143,7 @@ module SinatraResource
         end
         convert(object)
       end
-      
+
       # Execute a callback.
       #
       # @param [Symbol] name
@@ -224,7 +224,7 @@ module SinatraResource
       def role_for(model, id)
         lookup_role(model.find_by_id(id))
       end
-      
+
       # Get role for a nested resource situation. Delegates to +lookup_role+.
       #
       # @params [MongoMapper::Document] parent
@@ -265,7 +265,7 @@ module SinatraResource
           hash ? hash[to_r_or_w(action)] : :nobody
         end || :anonymous
       end
-      
+
       protected
 
       # Is +role+ authorized for +action+, and, if specified, +property+?
@@ -330,8 +330,6 @@ module SinatraResource
           { "errors" => { "invalid_filter" => object } }
         when :no_params
           { "errors" => "no_params" }
-        when :non_empty_params
-          { "errors" => "non_empty_params" }
         when :not_found
           ""
         when :unauthorized
@@ -383,7 +381,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
@@ -401,7 +399,7 @@ module SinatraResource
             [FILTER_KEY, SEARCH_KEY].include?(k)
           end
           unless p.empty?
-            error 400, convert(body_for(:non_empty_params))
+            error 400, convert(body_for(:invalid_params, p))
           end
         when :read
           p = params.reject { |k, v| k == SHOW_KEY }
@@ -410,7 +408,7 @@ module SinatraResource
               { SHOW_KEY => params[SHOW_KEY] }))
           end
           unless p.empty?
-            error 400, convert(body_for(:non_empty_params))
+            error 400, convert(body_for(:invalid_params, p))
           end
         when :create
           # No need to complain. If there are problems,
@@ -421,7 +419,7 @@ module SinatraResource
           end
         when :delete
           unless params.empty?
-            error 400, convert(body_for(:non_empty_params))
+            error 400, convert(body_for(:invalid_params, p))
           end
         else
           raise Error, "Unexpected: #{action.inspect}"

data/lib/builder/mongo_helpers.rb

@@ -1,8 +1,7 @@
-gem 'query_string_filter', '>= 0.1.4'
 require 'query_string_filter'
 
 module SinatraResource
-  
+
   class Builder
 
     module MongoHelpers
@@ -34,7 +33,7 @@ module SinatraResource
         conditions = params.empty? ? {} : make_conditions(params, model)
         model.count(conditions)
       end
-      
+
       def count_nested_documents(parent, child_assoc, child_model)
         #
         # This code needs significant improvement.
@@ -57,7 +56,7 @@ module SinatraResource
         end
         documents.length
       end
-      
+
       # Create a document from params. If not valid, returns 400.
       #
       # @param [Class] model
@@ -105,7 +104,7 @@ module SinatraResource
         end
         child
       end
-      
+
       # Delete a document with +id+.
       #
       # @param [Class] model
@@ -213,7 +212,7 @@ module SinatraResource
           child_model.find_by_id(child_id)
         end
       end
-      
+
       # Find a nested document. If not found, returns 404.
       #
       # @param [MongoMapper::Document] parent_document
@@ -235,7 +234,7 @@ module SinatraResource
         end
         document
       end
-      
+
       # Find +model+ documents: find all documents if no params, otherwise
       # find selected documents.
       #
@@ -286,7 +285,7 @@ module SinatraResource
           select_related(parent, child_assoc, children)
         end
       end
-      
+
       # Delegates to application, who should use custom logic to relate
       # +parent+ and +child+.
       #
@@ -303,7 +302,7 @@ module SinatraResource
         proc.call(parent, child) if proc
         child
       end
-      
+
       # Update a document with +id+ from params. If not valid, returns 400.
       #
       # @param [Class] model
@@ -319,7 +318,7 @@ module SinatraResource
         end
         document
       end
-      
+
       # Update a nested document with params. If not valid, returns 400.
       #
       # @param [MongoMapper::Document] parent
@@ -350,11 +349,11 @@ module SinatraResource
           update_document!(child_model, child_id)
         end
       end
-      
+
       protected
-      
+
       QS_FILTER = QueryStringFilter.new
-      
+
       # Build conditions hash based on +params+.
       #
       # @param [Hash] params
@@ -382,7 +381,7 @@ module SinatraResource
           {}
         end
       end
-      
+
       # Filter out +conditions+ that do not have corresponding keys in
       # +model+. This is part of the process that prevents a user from
       # searching for parameters that they do not have access to.

data/lib/builder.rb

@@ -1,13 +1,13 @@
 module SinatraResource
 
   class Builder
-    
+
     FILTER_KEY = "filter"
     SEARCH_KEY = "search"
     SHOW_KEY   = "show"
 
     ITEMS_PER_PAGE = 20
-    
+
     def initialize(klass)
       @klass  = klass
 
@@ -21,7 +21,7 @@ module SinatraResource
         @parent_model           = @parent_resource_config[:model]
       end
     end
-    
+
     def build
       build_get_one
       build_get_many
@@ -30,7 +30,7 @@ module SinatraResource
       build_delete
       build_helpers
     end
-    
+
     def build_get_one
       model           = @model
       resource_config = @resource_config
@@ -96,7 +96,7 @@ module SinatraResource
         end
       end
     end
-    
+
     def build_post
       model           = @model
       resource_config = @resource_config
@@ -124,7 +124,7 @@ module SinatraResource
         end
       end
     end
-    
+
     def build_put
       model           = @model
       resource_config = @resource_config
@@ -154,7 +154,7 @@ module SinatraResource
         end
       end
     end
-    
+
     def build_delete
       model           = @model
       resource_config = @resource_config
@@ -182,7 +182,7 @@ module SinatraResource
         end
       end
     end
-    
+
     def build_helpers
       @klass.helpers do
         include ActionDefinitions
@@ -190,7 +190,7 @@ module SinatraResource
         include MongoHelpers
       end
     end
-    
+
   end
-  
+
 end

data/lib/exceptions.rb

@@ -1,7 +1,7 @@
 module SinatraResource
 
   class Error < RuntimeError; end
-    
+
   class DefinitionError < Error; end
   class NotImplemented  < Error; end
   class UndefinedRole   < Error; end

data/lib/resource.rb

@@ -1,19 +1,19 @@
 module SinatraResource
-  
+
   module Resource
     def self.included(includee)
       includee.extend ClassMethods
       includee.setup
     end
-    
+
     def resource_config
       self.class.resource_config
     end
 
     module ClassMethods
-      
+
       attr_reader :resource_config
-      
+
       # Specify a callback.
       #
       # @param [Symbol] method
@@ -29,7 +29,7 @@ module SinatraResource
         end
         @resource_config[:callbacks][name] = block
       end
-      
+
       # Specify the association +method+ of a parent model that points to
       # its child model.
       #
@@ -45,7 +45,7 @@ module SinatraResource
         end
         @resource_config[:child_assoc] = method
       end
-      
+
       # Build the Sinatra actions based on the DSL statements in this class.
       # You will want to do this last.
       #
@@ -58,7 +58,7 @@ module SinatraResource
         validate
         Builder.new(self).build
       end
-      
+
       # Specify the underlying +model+
       #
       # @example
@@ -79,7 +79,7 @@ module SinatraResource
         end
         @resource_config[:model] = model
       end
-      
+
       # Specify the parent +resource+. Only used for nested resources.
       #
       # @param [Class] resource
@@ -106,7 +106,7 @@ module SinatraResource
         end
         @resource_config[:path] = name
       end
-      
+
       # Specify the minimal role needed to access this resource for reading
       # or writing.
       #
@@ -129,7 +129,7 @@ module SinatraResource
           @resource_config[:permission][verb] = role
         end
       end
-      
+
       # Declare a property and its access rules.
       #
       # @example
@@ -165,7 +165,7 @@ module SinatraResource
           @resource_config[:properties][name][:hide_by_default] = hide
         end
       end
-      
+
       # Declare a relation with a block of code.
       #
       # Only needed with nested resources. 
@@ -192,12 +192,12 @@ module SinatraResource
         end
         @resource_config[:relation][name] = block
       end
-      
+
       # Specify the role definitions for this resource.
       #
       # @example
       #   roles Roles
-      #   
+      # 
       #   # which refers to, for example ...
       #   # module Roles
       #   #   include SinatraResource::Roles
@@ -241,9 +241,9 @@ module SinatraResource
           :roles            => nil,
         }
       end
-      
+
       protected
-      
+
       # Set some defaults, only if they haven't been set already.
       #
       # @return [undefined]
@@ -251,7 +251,7 @@ module SinatraResource
         set_default_path
         set_default_properties
       end
-      
+
       # Set the default relative path for a resource.
       #
       # @return [undefined]
@@ -271,7 +271,7 @@ module SinatraResource
         if keys.include?("_id")
           property :id, :w => :nobody
         end
-        
+
         if keys.include?("created_at")
           property :created_at, :w => :nobody
         end
@@ -280,7 +280,7 @@ module SinatraResource
           property :updated_at, :w => :nobody
         end
       end
-      
+
       # Verifies correctness of resource.
       #
       # @raise [ValidationError] if invalid
@@ -291,8 +291,8 @@ module SinatraResource
           raise ValidationError, "model required"
         end
       end
-      
+
     end
   end
-  
+
 end

data/lib/roles.rb

@@ -5,7 +5,7 @@ module SinatraResource
       includee.extend ClassMethods
       includee.setup
     end
-    
+
     module ClassMethods
 
       # High-level way to define a role. You can also specify what role it
@@ -164,5 +164,5 @@ module SinatraResource
 
     end
   end
-  
+
 end

data/lib/utility.rb

@@ -15,8 +15,8 @@ module SinatraResource
     # (This method was adapted from ActiveSupport 2.3.5)
     def self.underscore(camel_cased_word)
       camel_cased_word.to_s.
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
         tr("-", "_").
         downcase
     end

data/notes/permissions.mdown

@@ -70,7 +70,7 @@ know whether to allow or disallow.
     def allow?(user_type, action, resource)
       # logic depends solely on params
     end
-    
+
     def disallow?(user_type, action, resource)
       # logic depends solely on params
     end
@@ -86,14 +86,14 @@ the 'user at hand' is different from the 'user type'.
     :basic_user can   :read   some         Notes # less useful
     :basic_user can   :read   an   owned   Note
     :basic_user can't :read   an   unowned Note
-    
+
     :basic_user can   :create a            Note
-    
+
     :basic_user can't :update any          Note  # less useful
     :basic_user can   :update some         Notes # less useful
     :basic_user can   :update an   owned   Note
     :basic_user can't :update an   unowned Note
-    
+
     :basic_user can't :delete any          Note  # less useful
     :basic_user can   :delete some         Notes # less useful
     :basic_user can   :delete an   owned   Note
@@ -147,7 +147,7 @@ Which brings us back to the 'allow?' and 'disallow?' methods:
     def allow?(user_type, user, action, resource, instance, relation)
       # logic depends solely on params
     end
-    
+
     def disallow?(user_type, user, action, resource, instance, relation)
       # logic depends solely on params
     end
@@ -157,7 +157,7 @@ I would expect that user_type can be derived from user, so we can simplify:
     def allow?(user, action, resource, instance, relation)
       # logic depends solely on params
     end
-    
+
     def disallow?(user, action, resource, instance, relation)
       # logic depends solely on params
     end