rocket_pants 1.3.0 → 1.4.0

data/lib/rocket_pants/controller/respondable.rb

@@ -83,39 +83,27 @@ module RocketPants
       render_json normalise_object(object, options), options
     end
 
+    def respond_with_object_and_type(object, options, type, singular)
+      pre_process_exposed_object object, type, singular
+      options = options.reverse_merge(:compact => true) unless singular
+      meta = expose_metadata metadata_for(object, options, type, singular)
+      render_json({:response => normalise_object(object, options)}.merge(meta), options)
+      post_process_exposed_object object, type, singular
+    end
+
     # Renders a single resource.
     def resource(object, options = {})
-      pre_process_exposed_object object, :resource, true
-      render_json({
-       :response => normalise_object(object, options)
-      }, options)
-      post_process_exposed_object object, :resource, true
+      respond_with_object_and_type object, options, :resource, true
     end
 
     # Renders a normal collection to JSON.
     def collection(collection, options = {})
-      pre_process_exposed_object collection, :collection, false
-      options = options.reverse_merge(:compact => true)
-      meta = expose_metadata(:count => collection.length)
-      render_json({
-        :response => normalise_object(collection, options),
-        :count    => collection.length
-      }.merge(meta), options)
-      post_process_exposed_object collection, :collection, false
+      respond_with_object_and_type collection, options, :collection, false
     end
 
     # Renders a paginated collecton to JSON.
     def paginated(collection, options = {})
-      pre_process_exposed_object collection, :paginated, false
-      options = options.reverse_merge(:compact => true)
-      meta = expose_metadata({
-        :count      => collection.length,
-        :pagination => Respondable.extract_pagination(collection)
-      })
-      render_json({
-        :response   => normalise_object(collection, options),
-      }.merge(meta), options)
-      post_process_exposed_object collection, :paginated, false
+      respond_with_object_and_type collection, options, :paginated, false
     end
 
     # Exposes an object to the response - Essentiall, it tells the
@@ -160,5 +148,20 @@ module RocketPants
       metadata
     end
 
+    # Extracts the metadata for the current response, merging in options etc.
+    # Implements a simple hook to allow adding extra metadata to your api.
+    #
+    # @param [Object] object the data being exposed
+    # @param [Hash{Symbol => Object}] options expose options optionally including new metadata.
+    # @param [Symbol] type the type of the current object
+    # @param [true,false] singular true iff the current object is a singular resource
+    def metadata_for(object, options, type, singular)
+      {}.tap do |metadata|
+        metadata[:count]      = object.length unless singular
+        metadata[:pagination] = Respondable.extract_pagination(object) if type == :paginated
+        metadata.merge! options[:metadata] if options[:metadata]
+      end
+    end
+
   end
 end

data/lib/rocket_pants/exceptions.rb

@@ -106,6 +106,7 @@ module RocketPants
     register! :invalid_version, :http_status => :not_found
     register! :not_implemented, :http_status => :service_unavailable
     register! :not_found,       :http_status => :not_found
+    register! :bad_request,     :http_status => :bad_request
     
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocket_pants
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-06 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: JSON API love for Rails and ActionController