sinatra_resource 0.4.7 → 0.4.8

data/VERSION

@@ -1 +1 @@
-0.4.7
+0.4.8

data/examples/datacatalog/resources/sources.rb

@@ -18,7 +18,7 @@ module DataCatalog
 
     property :title
     property :url
-    property :raw, :w => :admin
+    property :raw, :w => :admin, :hide_by_default => true
     
     property :categories do |source|
       source.categorizations.map do |categorization|

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

@@ -59,7 +59,7 @@ class SourcesGetManyFilterResourceTest < ResourceTestCase
         end
 
         test "members should only have correct attributes" do
-          correct = %w(title url raw categories id created_at updated_at)
+          correct = %w(title url categories id created_at updated_at)
           @members.each do |member|
             assert_properties(correct, member)
           end
@@ -92,7 +92,7 @@ class SourcesGetManyFilterResourceTest < ResourceTestCase
         end
 
         test "members should only have correct attributes" do
-          correct = %w(title url raw categories id created_at updated_at)
+          correct = %w(title url categories id created_at updated_at)
           @members.each do |member|
             assert_properties(correct, member)
           end

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

@@ -88,7 +88,7 @@ class SourcesGetManySearchResourceTest < ResourceTestCase
         end
         
         test "members should only have correct attributes" do
-          correct = %w(title url raw categories id created_at updated_at)
+          correct = %w(title url categories id created_at updated_at)
           @members.each do |member|
             assert_properties(correct, member)
           end

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

@@ -55,7 +55,7 @@ class SourcesGetManyResourceTest < ResourceTestCase
       end
 
       test "members should only have correct attributes" do
-        correct = %w(title url raw categories id created_at updated_at)
+        correct = %w(title url categories id created_at updated_at)
         @members.each do |member|
           assert_properties(correct, member)
         end

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

@@ -50,15 +50,15 @@ class SourcesGetOneResourceTest < ResourceTestCase
         )
         get "/#{@source.id}", :api_key => api_key_for(role)
       end
-
+    
       after do
         @category.destroy
         @categorization.destroy
       end
-
+    
       use "return 200 Ok"
-      doc_properties %w(title url raw categories id created_at updated_at)
-
+      doc_properties %w(title url categories id created_at updated_at)
+    
       test "body should have correct categories" do
         expected = [
           {
@@ -70,6 +70,15 @@ class SourcesGetOneResourceTest < ResourceTestCase
         assert_equal expected, parsed_response_body["categories"]
       end
     end
+    
+    context "#{role} : get /:id?show=all" do
+      before do
+        get "/#{@source.id}?show=all", :api_key => api_key_for(role)
+      end
+    
+      use "return 200 Ok"
+      doc_properties %w(title url raw categories id created_at updated_at)
+    end
   end
 
 end

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

@@ -105,7 +105,7 @@ class SourcesPostResourceTest < ResourceTestCase
       use "return 201 Created"
       location_header "sources"
       use "one new source"
-      doc_properties %w(title url raw id created_at updated_at categories)
+      doc_properties %w(title url id created_at updated_at categories)
 
       test "should set all fields in database" do
         source = Source.find_by_id(parsed_response_body["id"])
@@ -156,7 +156,7 @@ class SourcesPostResourceTest < ResourceTestCase
       use "return 201 Created"
       location_header "sources"
       use "one new source"
-      doc_properties %w(title url raw id created_at updated_at categories)
+      doc_properties %w(title url id created_at updated_at categories)
 
       test "should set all fields in database" do
         source = Source.find_by_id(parsed_response_body["id"])

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

@@ -137,7 +137,7 @@ class SourcesPutResourceTest < ResourceTestCase
         end
       
         use "return 200 Ok"
-        doc_properties %w(title url raw id created_at updated_at categories)
+        doc_properties %w(title url id created_at updated_at categories)
 
         test "should change correct fields in database" do
           source = Source.find_by_id(@source.id)
@@ -164,7 +164,7 @@ class SourcesPutResourceTest < ResourceTestCase
       end
       
       use "return 200 Ok"
-      doc_properties %w(title url raw id created_at updated_at categories)
+      doc_properties %w(title url id created_at updated_at categories)
 
       test "should change correct fields in database" do
         source = Source.find_by_id(@source.id)
@@ -242,7 +242,7 @@ class SourcesPutResourceTest < ResourceTestCase
         end
       
         use "return 200 Ok"
-        doc_properties %w(title url raw id created_at updated_at categories)
+        doc_properties %w(title url id created_at updated_at categories)
 
         test "should change correct fields in database" do
           source = Source.find_by_id(@source.id)
@@ -269,7 +269,7 @@ class SourcesPutResourceTest < ResourceTestCase
       end
       
       use "return 200 Ok"
-      doc_properties %w(title url raw id created_at updated_at categories)
+      doc_properties %w(title url id created_at updated_at categories)
 
       test "should change all fields in database" do
         source = Source.find_by_id(@source.id)

data/lib/builder/helpers.rb

@@ -17,7 +17,12 @@ module SinatraResource
       def build_resource(role, document, resource_config)
         resource = {}
         resource_config[:properties].each_pair do |property, hash|
-          if authorized?(:read, role, resource_config, property)
+          hide = if params[SHOW_KEY] == "all"
+            false
+          else
+            resource_config[:properties][property][:hide_by_default]
+          end
+          if authorized?(:read, role, resource_config, property) && !hide
             resource[property.to_s] = value(property, document, hash)
           end
         end
@@ -388,7 +393,12 @@ module SinatraResource
             error 400, convert(body_for(:non_empty_params))
           end
         when :read
-          unless params.empty?
+          p = params.reject { |k, v| k == SHOW_KEY }
+          unless [nil, "all"].include?(params[SHOW_KEY])
+            error 400, convert(body_for(:invalid_params,
+              { SHOW_KEY => params[SHOW_KEY] }))
+          end
+          unless p.empty?
             error 400, convert(body_for(:non_empty_params))
           end
         when :create
@@ -422,7 +432,7 @@ module SinatraResource
       def params_check_action_and_role(action, role, resource_config)
         invalid = []
         params.each_pair do |property, value|
-          next if [FILTER_KEY, SEARCH_KEY].include?(property)
+          next if [FILTER_KEY, SEARCH_KEY, SHOW_KEY].include?(property)
           if !authorized?(action, role, resource_config, property.intern)
             invalid << property
           end 

data/lib/builder.rb

@@ -4,6 +4,7 @@ module SinatraResource
     
     FILTER_KEY = "filter"
     SEARCH_KEY = "search"
+    SHOW_KEY   = "show"
 
     ITEMS_PER_PAGE = 20
     

data/lib/resource.rb

@@ -142,7 +142,9 @@ module SinatraResource
       # @param [Hash] access_rules
       #
       # @return [undefined]
-      def property(name, access_rules={}, &block)
+      def property(name, options={}, &block)
+        hide = options.delete(:hide_by_default) || false
+        access_rules = options
         if @resource_config[:properties][name]
           raise DefinitionError, "property #{name.inspect} already declared in #{self}"
         end
@@ -160,6 +162,7 @@ module SinatraResource
         access_rules.each_pair do |kind, role|
           @resource_config[:roles].validate_role(role)
           @resource_config[:properties][name][kind] = role
+          @resource_config[:properties][name][:hide_by_default] = hide
         end
       end
       

data/sinatra_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.4.7"
+  s.version = "0.4.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]
-  s.date = %q{2009-12-15}
+  s.date = %q{2010-01-14}
   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 = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_resource
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - David James
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 -05:00
+date: 2010-01-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency