api_logic 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in api_controller.gemspec
+gemspec

data/README.mdown

@@ -0,0 +1,81 @@
+# API Logic
+
+A lightweight mixin for making API controllers
+
+# Usage
+
+Extend a controller with `ApiLogic` and call `exposes_model`
+to generate the default REST actions.
+    
+    class MyApiController < ApplicationController
+      extend ApiLogic
+      exposes_model Widget
+      respond_to :json, :xml
+    end
+    
+or if the controller's name looks like #{resource}ApiController then
+exposes_model will automatically be called with the resource:
+    
+    class CalendarApiController < ApplicationController
+      extend ApiLogic
+      respond_to :json, :xml
+    end
+    
+# Customization
+
+### Responder
+
+ApiLogic calls `respond_with` for each REST action, so you can change
+how it renders by replacing the Responder:
+
+    class CalendarApiController < ApplicationController
+      extend ApiLogic
+      responder = MyResponder
+      respond_to :json, :xml
+    end
+
+### Templates
+
+The recommended way of customizing how a model is rendered to JSON or XML
+is to supply a RABL template for the action.
+
+### Overriding methods
+
+You can always override one of ApiLogic's actions by defining your own, but
+ApiLogic gives a few finer-grained ways of controlling its default behavior.
+
+You can override the method `find_models` to change how the index action
+fetches models. By default `find_models` looks like this:
+
+    def find_models
+      model_class.all
+    end
+
+You can override the method `find_model` to change how the show, update, and
+destroy actions look up a model for the given URL. By default `find_model` looks
+like this:
+
+    def find_model
+      @model = model_class.find(params[:id])
+      instance_variable_set "@#{model_singular}", @model
+    end
+
+`create_attributes` and `update_attributes` return the attributes supplied
+to `model_class.create` and `@model.update_attributes` in the create and 
+update actions. Their default implementations are:
+
+    def create_attributes
+      model_params
+    end
+
+    def update_attributes
+      model_params
+    end
+
+And, finally, you can change how a model's attributes are pulled out of params
+by overriding `model_params`. Its default implementation looks like this:
+
+    def model_params
+      params[model_singular]
+    end
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/api_logic/responder.rb

@@ -0,0 +1,33 @@
+require 'action_controller/metal/responder'
+
+module ApiLogic
+  class Responder < ActionController::Responder
+    
+    
+    def respond
+      
+      # An API controller might want to tailor its response
+      # with a RABL template. If a template exists, render that.
+      #
+      # Also, if the resource is nil or if it doesn't respond to
+      # :to_#{format}, fall back to the default render functionality.
+      #
+      template_path = File.join(controller.controller_path, controller.action_name)
+      if resource.nil? || !resourceful? || controller.template_exists?(template_path)
+        render
+      else
+        
+        # api_behavior takes as a parameter the error it will throw if
+        # the resource does not respond to :to_#{format}. (Since we've
+        # already checked :resourceful?, this error should never be thrown,
+        # but just in case, we'll supply NotImplementedError.)
+        api_behavior(NotImplementedError)
+      end
+    end
+    
+    
+  end
+end
+
+# Refer to the source of ActionController::Responder:
+# https://github.com/rails/rails/blob/v3.0.3/actionpack/lib/action_controller/metal/responder.rb#L155

data/lib/api_logic/version.rb

@@ -0,0 +1,3 @@
+module ApiController
+  VERSION = "0.0.1"
+end

data/lib/api_logic.rb

@@ -0,0 +1,129 @@
+require "api_logic/version"
+require "api_logic/responder"
+
+module ApiLogic
+  extend ActiveSupport::Concern
+  
+  
+  
+  included do
+    guess_model
+    
+    def self.inherited(subclass)
+      super
+      subclass.guess_model
+    end
+  end
+  
+  
+  
+  module ClassMethods
+    
+    resonder = ::ApiLogic::Responder
+    
+    attr_reader :model_class
+    alias :model :model_class
+    attr_reader :model_collection
+    attr_reader :model_singular
+    
+    
+    def guess_model
+      # puts "[api_logic] guessing model for #{self.name}"
+      if self.name =~ /(?:.*::)(.*?)ApiController/
+        model_name = $1.singularize
+        begin
+          exposes_model $1.singularize.constantize
+        rescue NameError
+          # puts "  there is no model \"#{model_name}\""
+        end
+      else
+        # puts "  the controller does not match the pattern /(?:.*::)(.*?)ApiController/"
+      end
+    end
+    
+    
+    def exposes_model(model_class)
+      # puts "[api_logic] exposing model #{model_class} on #{self.name}"
+      
+      @model_class = model_class
+      @model_collection = model_class.name.tableize
+      @model_singular = @model_collection.singularize
+      
+      before_filter :find_model, :only => [:show, :update, :destroy]
+      
+    public
+      
+      define_method :index do
+        collection = find_models
+        instance_variable_set "@#{model_collection}", collection
+        respond_with collection
+      end
+      
+      define_method :show do
+        respond_with @model
+      end
+      
+      define_method :create do
+        @model = create_model
+        instance_variable_set "@#{model_singular}", @model
+        respond_with @model
+      end
+      
+      define_method :update do
+        @model.update_attributes(update_attributes)
+        respond_with @model
+      end
+      
+      define_method :destroy do
+        @model.destroy
+        respond_with @model
+      end
+      
+    end
+    
+  end
+  
+  
+  
+  def find_models
+    model_class.all
+  end
+  
+  def find_model
+    @model = model_class.find(params[:id])
+    instance_variable_set "@#{model_singular}", @model
+  end
+  
+  def create_model
+    model_class.create(create_attributes)
+  end
+  
+  
+  def create_attributes
+    model_params
+  end
+  
+  def update_attributes
+    model_params
+  end
+  
+  def model_params
+    params[model_singular]
+  end
+  
+  
+  def model_class
+    self.class.model
+  end
+  
+  def model_collection
+    self.class.model_collection
+  end
+  
+  def model_singular
+    self.class.model_singular
+  end
+  
+  
+  
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: api_logic
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Lail
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-18 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Mixes in to ActionController and generates default RESTful actions automatically in a highly customizable way.
+email: 
+- robert.lail@cph.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/api_logic/responder.rb
+- lib/api_logic/version.rb
+- lib/api_logic.rb
+- Gemfile
+- Rakefile
+- README.mdown
+has_rdoc: true
+homepage: https://github.com/boblail/api_logic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: api_logic
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A lightweight mixin for making API controllers
+test_files: []
+