make_restful 0.1.1 → 0.1.2

data/lib/make_restful/class_methods.rb

@@ -8,33 +8,26 @@ module MakeRestful::ClassMethods
     resource_name.singularize
   end
 
-  def supported_methods
-    methods ||= []
-    methods << { method: :get, path: "/", returns: "collection" }     if allow_method?(:list)   || allow_method?(:index)
-    methods << { method: :post, path: "/", returns: "resource" }      if allow_method?(:create) || allow_method?(:post)
-    methods << { method: :get, path: "/:id", returns: "resource" }    if allow_method?(:show)   || allow_method?(:get)
-    methods << { method: :put, path: "/:id", returns: "resource" }    if allow_method?(:update) || allow_method?(:put)
-    methods << { method: :delete, path: "/:id", returns: "success" }  if allow_method?(:destroy) || allow_method?(:delete)
-    methods
-  end
-
   # Is a format allowed?
   def allow_format?(*formats)
-    true if formats.map(&:to_sym).select { |i| allowed_formats.map(&:to_sym).include? i }.present?
+    true if formats.flatten.map(&:to_sym).select { |i| allowed_formats.map(&:to_sym).include? i }.present?
   end
 
   # Is a method allowed?
   def allow_method?(*methods)
-    true if methods.map(&:to_sym).select { |i| allowed_methods.map(&:to_sym).include? i }.present?
+    true if methods.flatten.map(&:to_sym).select { |i| allowed_methods.map(&:to_sym).include? i }.present?
   end
 
+  alias :allow_action? :allow_method?
+
   private
 
   def resource(klass)
 
+    before_filter :verify_method!
     before_filter :load_resource
-    before_filter :load_collection, on: [:index]
-    before_filter :load_instance, on: [:show, :destroy, :update]
+    before_filter :load_collection, only: [:index]
+    before_filter :load_instance, only: [:show, :destroy, :update]
 
     begin
       klass = klass.to_s.camelize.constantize
@@ -52,13 +45,25 @@ module MakeRestful::ClassMethods
     self.finder = key.to_sym
   end
 
-  def allow_methods(*methods)
-    self.allowed_methods = methods.flatten
+  def allow_method(*methods)
+    self.allowed_methods += methods.flatten
+  end
+  alias :allow_methods :allow_method
+
+  def allow_format(*formats)
+    self.allowed_formats += formats.flatten
+  end
+  alias :allow_formats :allow_format
+
+  def deny_method(*methods)
+    self.allowed_methods -= methods
   end
+  alias :deny_methods :deny_method
 
-  def allow_formats(*formats)
-    self.allowed_formats = formats.flatten
+  def deny_format(*methods)
+    self.allowed_formats -= methods
   end
+  alias :deny_formats :deny_format
 
   def paginates!(opts={})
     opts.reverse_merge!({ per_page: 25 })

data/lib/make_restful/loaders.rb

@@ -1,5 +1,7 @@
 module MakeRestful::Loaders
 
+  private
+
   def load_resource
     @resource = self.class.resource_class
     @resource.params = params.except(:action, :controller, :id) if @resource.respond_to?(:params=)
@@ -7,19 +9,64 @@ module MakeRestful::Loaders
 
   def load_collection
     @collection = if self.class.pagination && !params.has_key?(:all)
-                    @resource.paginate page: params[:page], per_page: (params[:per_page] || self.class.pagination[:per_page] || 25)
-                  else
-                    @resource.all
-                  end
+      paginated_collection = @resource.paginate page: params[:page], per_page: (params[:per_page] || self.class.pagination[:per_page] || 25)
+      { :"#{self.class.resource_name}" => 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
+
+    if @collection.empty?
+      @response = { error: 'no results found' }
+      @status = :not_found
+    end
+
     eval("@#{self.class.resource_name} = @collection")
   end
 
   def load_instance(opts={})
-    if (params[opts[:finder]] || params[:id]) && @resource.respond_to?(:find)
-      finder = (opts[:finder] || self.class.finder) == :id ? :find : "find_by_#{(opts[:finder] || self.class.finder)}".to_sym
-      @instance = @resource.send finder, (params[opts[:finder]] || params[:id])
+
+    finder = opts[:finder] || self.class.finder
+    finder_value = params[finder]
+
+    if finder && @resource.respond_to?(:find)
+      @instance = @resource.where(finder.to_sym => finder_value).first
       eval "@#{self.class.instance_name} = @instance"
     end
+
+    unless @instance
+      @response = { error: "Could not find record with #{finder}: #{finder_value}"  }
+      @status = :not_found
+      render_formats(load_template: false) and return
+    end
+
+  end
+
+  def verify_method!
+    return if allow_method? params[:action]
+    @response = { error: "Method not allowed"}
+    @status = :method_not_allowed
+    render
+  end
+
+  alias :verify_action! :verify_method!
+
+  def method_missing(m, *args, &block)
+    if /load_instance_by_(?<finder>[a-z_]+)/ =~ m.to_s
+      load_instance(finder: finder.to_sym)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    true if /load_instance_by_(?<finder>[a-z_]+)/ =~ method_name.to_s
   end
 
 end

data/lib/make_restful/rendering.rb

@@ -3,11 +3,17 @@ module MakeRestful::Rendering
   private
 
   ## Rendering
-  def render_formats
+  def render(options = {}, deprecated_status = nil, &block)
+
+    super and return if template_exists?([params[:controller], params[:action]].join('/')) && allow_format?(formats) unless options[:load_template] == false
+
+    # Set the response from the chain
+    response = @response || @instance || @collection
+
     respond_to do |format|
-      format.json { render json: @response, status: @status, callback: ( params[:callback] if allow_format? :jsonp )} if allow_format? :json, :jsonp
-      format.xml { render xml: @response, status: @status } if allow_format? :xml
-      format.html { render status: @status } if allow_format? :html
+      format.json { super json: response, status: @status, callback: ( params[:callback] if allow_format? :jsonp )} if allow_format? :json, :jsonp
+      format.xml  { super xml:  response, status: @status } if allow_format? :xml
+      format.any  { super }
     end
   end
 

data/lib/make_restful/rest_methods.rb

@@ -5,64 +5,33 @@ module MakeRestful::RestMethods
   ####################################
 
   # GET /resources
+  # Verified by :list
   def index
-    head :method_not_allowed and return unless allow_method? :index, :list
-    @response = { :"#{self.class.resource_name}" => @collection }
-    @response.merge!(
-      {
-        pagination: {
-          current_page:   @collection.current_page,
-          per_page:       @collection.per_page,
-          total_entries:  @collection.total_entries,
-          total_pages:    @collection.total_pages
-        }
-      }
-    ) if self.class.pagination && !params.has_key?(:all)
-
-    if @collection.empty?
-      @response = { error: 'no results found' }
-      @status = :not_found
-    end
-
-    render_formats
   end
 
   # POST /resources
+  # Verified by :create
   def create
-    head :method_not_allowed and return unless allow_method? :post, :create
-    @response = @resource.create
-    render_formats
+    @instance = @resource.create
   end
 
-  # PUT /resources/:id
+  # GET /resources/:id
   def show
-    head :method_not_allowed and return unless allow_method? :get, :show
-    @response = @instance
-    unless @response
-      @response = { error: 'record_not_found' }
-      @status = :not_found
-    end
-    render_formats
   end
 
   # PUT /resources/:id
   def update
-    head :method_not_allowed and return unless allow_method? :put, :patch, :update
-    @response = @instance.update_attributes(params[@resource.to_s.underscore])
-    render_formats
+    @instance.update_attributes(params[@resource.to_s.underscore])
   end
 
   # DELETE /resources/:id
   def destroy
-    head :method_not_allowed and return unless allow_method? :delete, :destroy
-    @response = @instance.destroy
-    render_formats
+    @response = { success: @instance.destroy }
   end
 
   # OPTIONS /resources
   def spec
     @response = specification
-    render_formats
   end
 
 end

data/lib/make_restful/specification/builder.rb

@@ -1,20 +1,20 @@
 class MakeRestful::Specification::Builder
 
-  attr_reader :controller, :_methods, :_description, :_formats, :_attributes, :_resource, :_default_methods, :_default_attributes, :_default_formats
+  attr_reader :_controller_, :_methods_, :_description_, :_formats_, :_attributes_, :_resource_, :_default_methods_, :_default_attributes_, :_default_formats_
+
+  private
 
   def initialize(controller, &block)
-    @_controller = controller
-    @_methods = []
-    @_default_methods = controller.supported_methods.collect do |m|
-      method m[:method], path: m[:path], returns: m[:returns]
-    end
-    @_methods = []
-    @_attributes = []
-    @_default_attributes = controller.resource_class.new.attributes.keys
-    @_default_formats = controller.allowed_formats
-    @_formats = []
-    @_description = "Api for #{controller.resource_name.titleize}"
-    @_resource = controller.instance_name
+    @_controller_ = controller
+    @_methods_ = []
+    @_default_methods_ = default_supported_methods
+    @_methods_ = []
+    @_attributes_ = []
+    @_default_attributes_ = controller.resource_class.new.attributes.keys
+    @_default_formats_ = controller.allowed_formats
+    @_formats_ = []
+    @_description_ = "Api for #{controller.resource_name.titleize}"
+    @_resource_ = controller.instance_name
     instance_eval(&block) if block_given?
   end
 
@@ -24,43 +24,51 @@ class MakeRestful::Specification::Builder
       path:     options[:path],
       returns:  options[:returns]
     }
-    @_methods << method
+    @_methods_ << method
     method
   end
 
   def description(string)
-    @_description = string
+    @_description_ = string
   end
 
   def resource(string)
-    @_resource = string
+    @_resource_ = string
   end
 
   def attribute(attr)
-    @_attributes << attr
+    @_attributes_ << attr
     attr
   end
 
   def attributes(*args)
-    @_attributes += args.flatten
+    @_attributes_ += args.flatten
   end
 
   def format(attr)
-    @_formats << attr
+    @_formats_ << attr
     attr
   end
 
   def formats(*args)
-    @_formats += args
+    @_formats_ += args
+  end
+
+  def default_supported_methods
+    method  :get,     path: "/",        returns: "collection" if _controller_.allow_method?(:list)    || _controller_.allow_method?(:index)
+    method  :post,    path: "/",        returns: "resource"   if _controller_.allow_method?(:create)  || _controller_.allow_method?(:post)
+    method  :get,     path: "/:id",     returns: "resource"   if _controller_.allow_method?(:show)    || _controller_.allow_method?(:get)
+    method  :put,     path: "/:id",     returns: "resource"   if _controller_.allow_method?(:update)  || _controller_.allow_method?(:put)
+    method  :delete,  path: "/:id",     returns: "success"    if _controller_.allow_method?(:destroy) || _controller_.allow_method?(:delete)
   end
 
   def render
     {
-      resource:     _resource,
-      formats:      _formats.present? ? _formats : _default_formats,
-      description:  _description,
-      attributes:   _attributes.present? ? _attributes : _default_attributes,
-      methods:      _methods.present? ? _methods : _default_methods
+      resource:     _resource_,
+      formats:      _formats_.present? ? _formats_ : _default_formats_,
+      description:  _description_,
+      attributes:   _attributes_.present? ? _attributes_ : _default_attributes_,
+      methods:      _methods_.present? ? _methods_ : _default_methods_
     }
   end
 

data/lib/make_restful/version.rb

@@ -1,3 +1,3 @@
 module MakeRestful
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/make_restful.rb

@@ -5,7 +5,6 @@ module MakeRestful
   extend ActiveSupport::Autoload
 
   autoload :ClassMethods
-  autoload :ControllerAdditions
   autoload :Loaders
   autoload :RestMethods
   autoload :Rendering
@@ -24,9 +23,9 @@ module MakeRestful
     attr_reader :resource, :instance, :collection
 
     resource name.underscore.gsub(/(.*)_controller/,'\1').singularize
-    allow_formats :json, :jsonp, :xml
-    allow_methods :index, :get, :put, :post, :delete
-    find_by :id
+    self.allowed_formats = [:json, :jsonp, :xml]
+    self.allowed_methods = [:index, :get, :put, :post, :delete]
+    self.finder = :id
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_restful
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,8 +73,6 @@ files:
 - Rakefile
 - lib/make_restful.rb
 - lib/make_restful/class_methods.rb
-- lib/make_restful/controller_additions.rb
-- lib/make_restful/controller_additions/oauth_resource.rb
 - lib/make_restful/loaders.rb
 - lib/make_restful/rendering.rb
 - lib/make_restful/rest_methods.rb

data/lib/make_restful/controller_additions/oauth_resource.rb

@@ -1,20 +0,0 @@
-module MakeRestful::ControllerAdditions::OauthResource
-  require 'oauth_resource'
-  extend ActiveSupport::Concern
-
-  included do ; end
-
-  module ClassMethods
-
-    def authorize_resource!(token, opts={})
-      skip_before_filter :load_instance, :load_collection
-      before_filter(opts) do
-        @resource = @resource.authorize(send(token))
-        load_instance if params[:action] =~ /show|destroy|update/
-        load_collection if params[:action] =~ /index/
-      end
-    end
-
-  end
-
-end

data/lib/make_restful/controller_additions.rb

@@ -1,6 +0,0 @@
-module MakeRestful::ControllerAdditions
-  extend ActiveSupport::Autoload
-
-  autoload :OauthResource
-
-end