make_restful 0.1.0 → 0.1.1

data/lib/make_restful.rb

@@ -6,135 +6,34 @@ module MakeRestful
 
   autoload :ClassMethods
   autoload :ControllerAdditions
+  autoload :Loaders
+  autoload :RestMethods
+  autoload :Rendering
+  autoload :Specification
+
+  include Loaders
+  include RestMethods
+  include Rendering
+  include Specification
+
+  delegate :allow_method?, :allow_format?, to: :klass
 
   included do
 
-    cattr_accessor :allowed_methods, :allowed_formats, :finder, :pagination, :resource_class
+    class_attribute :allowed_methods, :allowed_formats, :finder, :pagination, :resource_class
+    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
 
-    ####################################
-    ## RESTful Methods
-    ####################################
-
-  end
-
-  # GET /resources
-  def index
-    head :method_not_allowed and return unless allow_method? :index, :list
-    @response = { :"#{self.class.resource_name}" => @collection }
-    @response.merge!(
-      {
-        current_page: results.current_page,
-        per_page: results.per_page,
-        total_entries: results.total_entries,
-      }
-    ) 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
-  def create
-    head :method_not_allowed and return unless allow_method? :post, :create
-    @response = @resource.create
-    render_formats
-  end
-
-  # PUT /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
-  end
-
-  # DELETE /resources/:id
-  def destroy
-    head :method_not_allowed and return unless allow_method? :delete, :destroy
-    @response = @instance.destroy
-    render_formats
-  end
-
-  # OPTIONS /resources
-  def spec
-    @response = {
-      supports: self.class.supported_methods,
-      specification: ( @resource.specification if @resource.respond_to?(:specification) ) || "No Specification"
-    }
-    render_formats
   end
 
   private
 
-  ## Rendering
-
-  def render_formats
-    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
-    end
-  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?
-  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?
-  end
-
-  def load_resource
-    @resource = self.class.resource_class
-    @resource.params = params.except(:action, :controller, :id) if @resource.respond_to?(:params=)
-  end
-
-  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
-    eval("@#{self.class.resource_name} = @collection")
-  end
-
-  def load_instance
-    @instance = eval "@#{self.class.instance_name} = #{@resource.send(:"find_by_#{self.class.finder}", params[:id])}" if params[:id] && @resource.respond_to?(:find)
-  end
-
-  def resource
-    @resource
-  end
-
-  def instance
-    @instance
-  end
-
-  def collection
-    @collection
+  def klass
+    self.class
   end
 
 end

data/lib/make_restful/class_methods.rb

@@ -8,6 +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?
+  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?
+  end
+
   private
 
   def resource(klass)

data/lib/make_restful/loaders.rb

@@ -0,0 +1,25 @@
+module MakeRestful::Loaders
+
+  def load_resource
+    @resource = self.class.resource_class
+    @resource.params = params.except(:action, :controller, :id) if @resource.respond_to?(:params=)
+  end
+
+  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
+    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])
+      eval "@#{self.class.instance_name} = @instance"
+    end
+  end
+
+end

data/lib/make_restful/rendering.rb

@@ -0,0 +1,14 @@
+module MakeRestful::Rendering
+
+  private
+
+  ## Rendering
+  def render_formats
+    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
+    end
+  end
+
+end

data/lib/make_restful/rest_methods.rb

@@ -0,0 +1,68 @@
+module MakeRestful::RestMethods
+
+  ####################################
+  ## RESTful Methods
+  ####################################
+
+  # GET /resources
+  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
+  def create
+    head :method_not_allowed and return unless allow_method? :post, :create
+    @response = @resource.create
+    render_formats
+  end
+
+  # PUT /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
+  end
+
+  # DELETE /resources/:id
+  def destroy
+    head :method_not_allowed and return unless allow_method? :delete, :destroy
+    @response = @instance.destroy
+    render_formats
+  end
+
+  # OPTIONS /resources
+  def spec
+    @response = specification
+    render_formats
+  end
+
+end

data/lib/make_restful/specification.rb

@@ -0,0 +1,25 @@
+module MakeRestful::Specification
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+
+  autoload :Builder
+  # autoload :MethodBuilder
+
+  def specification
+    nil
+  end
+
+  module ClassMethods
+
+    def specification(&block)
+
+      spec_result = MakeRestful::Specification::Builder.new(self, &block).freeze
+
+      define_method :specification do
+        spec_result.render
+      end
+    end
+
+  end
+
+end

data/lib/make_restful/specification/builder.rb

@@ -0,0 +1,67 @@
+class MakeRestful::Specification::Builder
+
+  attr_reader :controller, :_methods, :_description, :_formats, :_attributes, :_resource, :_default_methods, :_default_attributes, :_default_formats
+
+  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
+    instance_eval(&block) if block_given?
+  end
+
+  def method(method, options={})
+    method = {
+      method:   method,
+      path:     options[:path],
+      returns:  options[:returns]
+    }
+    @_methods << method
+    method
+  end
+
+  def description(string)
+    @_description = string
+  end
+
+  def resource(string)
+    @_resource = string
+  end
+
+  def attribute(attr)
+    @_attributes << attr
+    attr
+  end
+
+  def attributes(*args)
+    @_attributes += args.flatten
+  end
+
+  def format(attr)
+    @_formats << attr
+    attr
+  end
+
+  def formats(*args)
+    @_formats += args
+  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
+    }
+  end
+
+end

data/lib/make_restful/version.rb

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

data/make_restful.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.add_dependency "activesupport"
   gem.add_dependency "will_paginate"
+  gem.add_dependency "sourcify"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_restful
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! ' Enables rest on a resource '
 email:
 - jason@waldrip.net
@@ -59,6 +75,11 @@ files:
 - 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
+- lib/make_restful/specification.rb
+- lib/make_restful/specification/builder.rb
 - lib/make_restful/version.rb
 - make_restful.gemspec
 homepage: http://github.com/jwaldrip/make_restful