make_restful 0.1.4 → 0.1.5

data/lib/make_restful.rb

@@ -14,7 +14,6 @@ module MakeRestful
   autoload :PermissibleActions
 
   extend  Callbacks
-  include Loaders
   include RestMethods
   include Rendering
   include Sugar
@@ -22,6 +21,9 @@ module MakeRestful
   delegate :allow_method?, :allow_format?, :resource_name, :instance_name, to: :klass
 
   included do
+    class_attribute :json_root_node, :collection_loader, :instance_loader, instance_writer: false
+
+    extend ClassMethods
 
     class_attribute :allowed_actions, :allowed_formats, :finder, :pagination, :resource_class, instance_writer: false
     attr_reader :resource, :instance, :collection
@@ -35,6 +37,8 @@ module MakeRestful
     resource name.underscore.gsub(/(.*)_controller/,'\1').singularize rescue nil
     find_by :id
 
+    include Loaders
+
   end
 
   def klass

data/lib/make_restful/class_methods.rb

@@ -10,9 +10,16 @@ module MakeRestful::ClassMethods
 
   private
 
+  def json_collection_root_node(true_or_name=true)
+    self.json_root_node = if true_or_name === true
+      resource_name
+    elsif true_or_name.is_a?(Symbol) || true_or_name.is_a?(String)
+      true_or_name
+    end
+  end
+
   def resource(klass)
 
-    before_filter :verify_method!
     before_filter :load_resource
     before_filter :load_collection, only: [:index]
     before_filter :load_instance, only: [:show, :destroy, :update]
@@ -25,6 +32,14 @@ module MakeRestful::ClassMethods
     self.finder = key.to_sym
   end
 
+  def collection(&block)
+    self.collection_loader = block if block_given?
+  end
+
+  def instance(&block)
+    self.collection_loader = block if block_given?
+  end
+
   def actions(*actions)
     
     options = actions.extract_options!
@@ -46,7 +61,7 @@ module MakeRestful::ClassMethods
   end
 
   def paginates!(opts={})
-    opts.reverse_merge!({ per_page: 25 })
+    opts.assert_valid_keys :node
     self.pagination = opts
   end
 

data/lib/make_restful/loaders.rb

@@ -1,4 +1,36 @@
 module MakeRestful::Loaders
+  extend ActiveSupport::Concern
+
+  included do
+
+    before_filter :verify_method!
+    before_filter :verify_format!
+
+    collection do
+      if pagination && !params.has_key?(:all)
+        paginated_collection = @resource.paginate page: params[:page], per_page: (params[:per_page] || pagination[:per_page] || 25)
+        { resource_name.to_sym => paginated_collection,
+          pagination: {
+              current_page:   paginated_collection.current_page,
+              per_page:       paginated_collection.per_page,
+              total_entries:  paginated_collection.total_entries,
+              total_pages:    paginated_collection.total_pages
+          }
+        }
+      else
+        @resource.all
+      end
+    end
+
+    instance do
+      if finder && @resource.respond_to?(:where)
+        @resource.where(finder.to_sym => finder_value).first
+      else
+        @resource.find(finder_value)
+      end
+    end
+
+  end
 
   private
 
@@ -16,21 +48,9 @@ module MakeRestful::Loaders
   end
 
   def load_collection
-    @collection = if pagination && !params.has_key?(:all)
-      paginated_collection = @resource.paginate page: params[:page], per_page: (params[:per_page] || pagination[:per_page] || 25)
-      { resource_name.to_sym => paginated_collection,
-        pagination: {
-          current_page:   paginated_collection.current_page,
-          per_page:       paginated_collection.per_page,
-          total_entries:  paginated_collection.total_entries,
-          total_pages:    paginated_collection.total_pages
-        }
-      }
-    else
-      @resource.all
-    end
+    @collection = instance_eval(&collection_loader)
 
-    if @collection.empty?
+    unless @collection.present?
       @response = { error: 'no results found' }
       @status = :not_found
       render(load_template: false) and return
@@ -43,11 +63,7 @@ module MakeRestful::Loaders
     finder = opts[:finder] || send(:finder)
     finder_value = params[finder]
 
-    @instance = if finder && @resource.respond_to?(:where)
-       @resource.where(finder.to_sym => finder_value).first
-    else
-       @resource.find(finder_value)
-    end
+    @instance = instance_eval(&instance_loader)
     eval "@#{instance_name} = @instance"
 
     unless @instance
@@ -65,6 +81,13 @@ module MakeRestful::Loaders
     render(load_template: false)
   end
 
+  def verify_format!
+    return if allowed_formats.allowed?(request.format.symbol)
+    @response = { error: "Format:#{request.format} is unsupported" }
+    @status = :unsupported_media_type
+    render(load_template: false)
+  end
+
   alias :verify_action! :verify_method!
 
 end

data/lib/make_restful/rendering.rb

@@ -9,14 +9,20 @@ module MakeRestful::Rendering
     options[:load_template] = true if options[:load_template].nil?
     cleaned_options = options.reject{ |k,v| [:load_template, :status].include?(k) }
 
-    super and return if (( template_present && options[:load_template]) || cleaned_options.present? ) && allowed_formats.allowed?(formats)
+    super and return if (( template_present && options[:load_template]) || cleaned_options.present? )
 
     # Set the response from the chain
-    response = @response || @instance || @collection
+    response = if @response.present?
+                 @response
+               elsif @instance.present?
+                @instance
+               elsif @collection.present?
+                 wrap_collection
+               end
 
     respond_to do |format|
-      format.json { super json: response, status: @status, callback: ( params[:callback] if allowed_formats.allowed? :jsonp )} if allowed_formats.allowed? :json, :jsonp
-      format.xml  { super xml:  response, status: @status } if allowed_formats.allowed? :xml
+      format.json { super json: response, status: @status, callback: ( params[:callback] if allowed_formats.allowed? :jsonp )}
+      format.xml  { super xml:  response, status: @status }
       format.any  do
         head @status and return if @status
         super
@@ -24,4 +30,28 @@ module MakeRestful::Rendering
     end
   end
 
+  def wrap_collection
+
+    response = if json_root_node
+      { json_root_node.to_sym => @collection }
+    else
+      @collection
+    end
+
+    if @collection.respond_to? :current_page
+
+      pagination = {}
+      pagination[:current_page] = @collection.current_page if @collection.respond_to? :current_page
+      pagination[:per_page] = @collection.current_page if @collection.respond_to? :per_page
+      pagination[:total_entries] = @collection.total_entries if @collection.respond_to? :total_entries
+      pagination[:total_pages] = @collection.total_pages if @collection.respond_to? :total_pages
+
+      pagination = { klass.pagination[:node] => pagination } if klass.pagination[:node]
+
+      response.merge!(pagination)
+    end
+
+    response
+  end
+
 end

data/lib/make_restful/version.rb

@@ -1,3 +1,3 @@
 module MakeRestful
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_restful
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,4 +107,3 @@ signing_key:
 specification_version: 3
 summary: Enables rest on a resource
 test_files: []
-has_rdoc: