acts_as_api 0.3.5 → 0.3.6

data/Gemfile

@@ -3,9 +3,9 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in acts_as_api.gemspec
 gemspec
 
-
 group :test do
   gem 'sqlite3-ruby'
+  gem 'mongoid', '>= 2.0.0'
   gem 'rspec-rails', '>= 2.4.1'
   gem 'webrat'
   gem 'rocco', :git => 'git://github.com/fabrik42/rocco.git'

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.3.6 2011-05-13
+
+* Finally added Mongoid Support out of the box
+* Support for Rails 3 Responders
+
 === 0.3.4 2011-04-26
 
 * Fixed a bug concerning the inheritance of sub templates/additional options

data/README.rdoc

@@ -4,7 +4,7 @@ acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.
 
 It provides a simple interface to determine the representation of your model data, that should be rendered in your API responses.
 
-In addition to Rails it theoretically can be used with any ruby app and any database as it only has few dependencies.
+In addition to Rails it theoretically can be used with any ruby app and any database (*ActiveRecord* and *Mongoid* are supported out of the box) as it only has few dependencies.
 
 == Introduction
 
@@ -44,8 +44,9 @@ https://github.com/fabrik42/acts_as_api/wiki
 * DRY templates for your api responses
 * Easy but very flexible syntax for defining the templates
 * XML, JSON and JSON-P support out of the  box, easy to extend
+* Support for Rails 3 Responders
 * Minimal dependecies (you can also use it without Rails)
-* Does not rely on ActiveRecord (can be used with other ORMs like Mongoid)
+* Ships with support for *ActiveRecord* and *Mongoid*
 * Supports multiple api rendering templates per model. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.
 
 === Requirements:
@@ -64,6 +65,12 @@ https://github.com/fabrik42/acts_as_api/wiki
 
 * Wiki: https://github.com/fabrik42/acts_as_api/wiki
 
+=== Tested with:
+
+* MRI 1.9.2-p180
+* MRI 1.8.7-p334
+* But it just should work fine with other versions too... :)
+
 === Downwards Compatibility
 
 Note that upgrading to 0.3.0 will break code that worked with previous versions due to a complete overhaul of the lib.

data/Rakefile

@@ -7,14 +7,28 @@ Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new
 
+namespace :spec do
+
+  desc "Run ActiveRecord RSpec code examples only"
+  RSpec::Core::RakeTask.new do |t|
+    t.name = :active_record
+    t.rspec_opts = ["--color", "--format", "documentation", "--tag", "orm:active_record"]
+  end
+
+end
+
+
+
+
 gemspec = Gem::Specification.load("acts_as_api.gemspec")
 
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title = "#{gemspec.name} #{gemspec.version}"
   rdoc.options += gemspec.rdoc_options
+  rdoc.options << '--line-numbers' << '--inline-source'  
   rdoc.rdoc_files.include(gemspec.extra_rdoc_files)
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc')
 end
 
 #bundle exec rocco examples/introduction/index.rb -t examples/introduction/layout.mustache

data/acts_as_api.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency('rack','>= 1.1.0')
     
   s.add_development_dependency('rails', ['>= 3.0.0'])
+  s.add_development_dependency('mongoid', ['>= 2.0.0'])
   
   s.has_rdoc      = true
   s.rdoc_options  = ['--main', 'README.rdoc', '--charset=UTF-8']

data/examples/introduction/index.html

@@ -58,8 +58,9 @@ You surely don’t want to expose your models always with all attributes.</p>
 <li>DRY templates for your api responses</li>
 <li>Easy but very flexible syntax for defining the templates</li>
 <li>XML, JSON and JSON-P support out of the  box, easy to extend</li>
+<li>Support for Rails 3 Responders</li>
 <li>Minimal dependecies (you can also use it without Rails)</li>
-<li>Does not rely on ActiveRecord (can be used with other ORMs like Mongoid)</li>
+<li>Ships with support for <strong>ActiveRecord</strong> and <strong>Mongoid</strong></li>
 <li>Supports multiple api rendering templates for a models. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.</li>
 </ul>
       </td>
@@ -191,7 +192,7 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
       </td>
       <td class=code>
         <div class='highlight'><pre><span class="k">class</span> <span class="nc">UsersController</span> <span class="o">&lt;</span> <span class="no">ApplicationController</span>
-  
+
   <span class="k">def</span> <span class="nf">index</span>
     <span class="vi">@users</span> <span class="o">=</span> <span class="no">User</span><span class="o">.</span><span class="n">all</span></pre></div>
       </td>
@@ -209,16 +210,16 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
       <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:json</span> <span class="o">=&gt;</span> <span class="vi">@users</span><span class="p">,</span> <span class="ss">:root</span> <span class="o">=&gt;</span> <span class="ss">:users</span> <span class="p">}</span>
     <span class="k">end</span>
   <span class="k">end</span>
-  
+
   <span class="k">def</span> <span class="nf">show</span>
     <span class="vi">@user</span> <span class="o">=</span> <span class="no">User</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">params</span><span class="o">[</span><span class="ss">:id</span><span class="o">]</span><span class="p">)</span>
-    
+
     <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
       <span class="nb">format</span><span class="o">.</span><span class="n">xml</span>  <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:xml</span>  <span class="o">=&gt;</span> <span class="vi">@user</span> <span class="p">}</span>
       <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:json</span> <span class="o">=&gt;</span> <span class="vi">@user</span> <span class="p">}</span>
     <span class="k">end</span>
   <span class="k">end</span>
-  
+
 <span class="k">end</span></pre></div>
       </td>
     </tr>
@@ -247,7 +248,7 @@ because they were not listed by <code>api_accessible</code> in the model.</p>
         <div class='highlight'><pre><span class="p">{</span>
   <span class="s2">&quot;user&quot;</span><span class="p">:</span> <span class="p">{</span>
     <span class="s2">&quot;first_name&quot;</span><span class="p">:</span> <span class="s2">&quot;John&quot;</span><span class="p">,</span>
-    <span class="s2">&quot;last_name&quot;</span><span class="p">:</span>  <span class="s2">&quot;Doe&quot;</span>    
+    <span class="s2">&quot;last_name&quot;</span><span class="p">:</span>  <span class="s2">&quot;Doe&quot;</span>
   <span class="p">}</span>
 <span class="p">}</span></pre></div>
       </td>

data/examples/introduction/index.rb

@@ -7,8 +7,9 @@
 # * DRY templates for your api responses
 # * Easy but very flexible syntax for defining the templates
 # * XML, JSON and JSON-P support out of the  box, easy to extend
+# * Support for Rails 3 Responders
 # * Minimal dependecies (you can also use it without Rails)
-# * Does not rely on ActiveRecord (can be used with other ORMs like Mongoid)
+# * Ships with support for **ActiveRecord** and **Mongoid**
 # * Supports multiple api rendering templates for a models. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.
 
 # ***
@@ -52,7 +53,7 @@ end
 
 # Now you just have to exchange the `render` method in your controller for the `render_for_api` method.
 class UsersController < ApplicationController
-  
+
   def index
     @users = User.all
     # Note that it's wise to add a `root` param when rendering lists.
@@ -61,28 +62,28 @@ class UsersController < ApplicationController
       format.json { render_for_api :name_only, :json => @users, :root => :users }
     end
   end
-  
+
   def show
     @user = User.find(params[:id])
-    
+
     respond_to do |format|
       format.xml  { render_for_api :name_only, :xml  => @user }
       format.json { render_for_api :name_only, :json => @user }
     end
   end
-  
+
 end
 
 #### That's it!
 
 # Try it. The JSON response of #show should now look like this:
 #
-# Other attributes of the model like `created_at` or `updated_at` won’t be included 
+# Other attributes of the model like `created_at` or `updated_at` won’t be included
 # because they were not listed by `api_accessible` in the model.
 {
   "user": {
     "first_name": "John",
-    "last_name":  "Doe"    
+    "last_name":  "Doe"
   }
 }
 
@@ -96,7 +97,7 @@ end
 #### What can I include in my responses?
 #
 # You can do basically anything:
-# 
+#
 # * [Include attributes and all other kinds of methods of your model][w1]
 # * [Include child associations (if they also act_as_api this will be considered)][w2]
 # * [Include lambdas and Procs][w3]

data/lib/acts_as_api.rb

@@ -3,7 +3,7 @@ require 'active_support/core_ext/class'
 
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-  
+
 require "acts_as_api/array"
 require "acts_as_api/rails_renderer"
 require "acts_as_api/exceptions"
@@ -20,16 +20,23 @@ module ActsAsApi
   autoload :Config,       "acts_as_api/config"
   autoload :ApiTemplate,  "acts_as_api/api_template"
   autoload :Base,         "acts_as_api/base"
-  autoload :Rendering,    "acts_as_api/rendering"    
+  autoload :Rendering,    "acts_as_api/rendering"
+  autoload :Responder,    "acts_as_api/responder"
+  autoload :Adapters,     "acts_as_api/adapters"
 end
 
-# Attach ourselves to active record
+# Attach ourselves to ActiveRecord
 if defined?(ActiveRecord::Base)
   ActiveRecord::Base.extend ActsAsApi::Base
 end
 
-# Attach ourselves to the action controller of rails
+# Attach ourselves to Mongoid
+if defined?(Mongoid::Document)
+  Mongoid::Document.send :include, ActsAsApi::Adapters::Mongoid
+end
+
+# Attach ourselves to the action controller of Rails
 if defined?(ActionController::Base)
   ActionController::Base.send :include, ActsAsApi::Rendering
   ActsAsApi::RailsRenderer.setup
-end
+end

data/lib/acts_as_api/adapters.rb

@@ -0,0 +1,5 @@
+module ActsAsApi
+  module Adapters
+    autoload :Mongoid, "acts_as_api/adapters/mongoid"
+  end
+end

data/lib/acts_as_api/adapters/mongoid.rb

@@ -0,0 +1,11 @@
+module ActsAsApi
+  module Adapters
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      included do
+        extend ActsAsApi::Base
+      end
+    end
+  end
+end

data/lib/acts_as_api/array.rb

@@ -8,18 +8,14 @@ class Array
   # If they don't, the item itself will be collected.
   def as_api_response(api_template)
 
-    sub_items = []
-
-    each do |item|
+    collect do |item|
       if item.respond_to?(:as_api_response)
-        sub_items << item.as_api_response(api_template)
+        item.as_api_response(api_template)
       else
-        sub_items << item
+        item
       end
     end
 
-    sub_items
-
   end
 
-end
+end

data/lib/acts_as_api/responder.rb

@@ -0,0 +1,40 @@
+module ActsAsApi
+  # A custom Rails responder class to automatically use render_for_api in your
+  # controller actions.
+  #
+  # Example:
+  #
+  #  class UsersController < ApplicationController
+  #    # Set this controller to use our custom responder
+  #    # (This could be done in a base controller class, if desired)
+  #    self.responder = ActsAsApi::Responder
+  #
+  #    respond_to :json, :xml
+  #
+  #    def index
+  #      @users = User.all
+  #      respond_with @users, :api_template => :name_only
+  #    end
+  #  end
+  #
+  # The `:api_template` parameter is required so the responder knows which api template it should render.
+
+  class Responder < ActionController::Responder
+
+    # Should be specified as an option to the `respond_with` call
+    attr_reader :api_template
+
+    # Grabs the required :api_template parameter, then hands control back to
+    # the base ActionController::Responder initializer.
+    def initialize(controller, resources, options={})
+      @api_template = options.delete(:api_template)
+      super(controller, resources, options)
+    end
+
+    # Overrides the base implementation of respond, replacing it with
+    # the render_for_api method.
+    def respond
+      controller.render_for_api api_template, options.merge!(format => resource)
+    end
+  end
+end

data/lib/acts_as_api/version.rb

@@ -1,3 +1,3 @@
 module ActsAsApi
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/spec/controllers/respond_with_users_controller_spec.rb

@@ -1,5 +1,33 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'spec_helper'
 
 describe RespondWithUsersController do
-  pending "we need to fix the root node for json first"
+
+  context "using active record", :orm => :active_record do
+  
+    before(:each) do
+      setup_active_record_models
+    end
+  
+    after(:each) do
+     clean_up_active_record_models
+    end
+  
+    # see spec/support/controller_examples.rb
+    it_behaves_like "a controller with ActsAsApi responses"
+  end
+
+  context "using mongoid", :orm => :mongoid do
+
+    before(:each) do
+      setup_mongoid_models
+    end
+
+    after(:each) do
+     clean_up_mongoid_models
+    end
+
+    # see spec/support/controller_examples.rb
+    it_behaves_like "a controller with ActsAsApi responses"
+  end
+
 end

data/spec/controllers/users_controller_spec.rb

@@ -1,250 +1,32 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'spec_helper'
 
-describe UsersController, :orm => :active_record do
-
-  include ApiTestHelpers
-
-  before(:each) do
-    @luke = User.create({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })
-    @han  = User.create({ :first_name => 'Han',       :last_name => 'Solo',      :age => 35, :active => true  })
-    @leia = User.create({ :first_name => 'Princess',  :last_name => 'Leia',      :age => 25, :active => false })
-  end
-
-  after(:each) do
-    User.delete_all
-  end
-
-  describe 'xml responses' do
-
-    describe 'get all users' do
-
-      before(:each) do
-        get :index, :format => 'xml', :api_template => :name_only
-      end
-
-      it "should have a root node named users" do
-        response_body.should have_selector("users")
-      end
-
-      it "should contain all users" do
-        response_body.should have_selector("users > user") do |users|
-          users.size.should eql(3)
-        end
-      end
-
-      it "should contain the specified attributes" do
-        response_body.should have_selector("users > user > first-name")
-        response_body.should have_selector("users > user > last-name")
-      end
-
-    end
-
-    describe 'get a single user' do
-
-      before(:each) do
-        get :show, :format => 'xml', :api_template => :name_only, :id => @luke.id
-      end
-
-      it "should have a root node named user" do
-        response_body.should have_selector("user")
-      end
-
-      it "should contain the specified attributes" do
-        response_body.should have_selector("user > first-name")
-        response_body.should have_selector("user > last-name")
-      end
-
-    end
-
-  end
-
-
-  describe 'json responses' do
-
-    describe 'get all users' do
-
-      before(:each) do
-        get :index, :format => 'json', :api_template => :name_only
-      end
-
-      it "should have a root node named users" do        
-        response_body_json.should have_key("users")
-      end
-
-      it "should contain all users" do
-        response_body_json["users"].should be_a(Array)
-      end
-
-      it "should contain the specified attributes" do
-        response_body_json["users"].first.should have_key("first_name")
-        response_body_json["users"].first.should have_key("last_name")
-      end
-
-      it "should contain the specified values" do
-        response_body_json["users"].first["first_name"].should eql("Luke")
-        response_body_json["users"].first["last_name"].should eql("Skywalker")
-      end
+describe UsersController do
 
+  context "using active record", :orm => :active_record do
+  
+    before(:each) do
+      setup_active_record_models
     end
-
-    describe 'get a single user' do
-
-      before(:each) do
-        get :show, :format => 'json', :api_template => :name_only, :id => @luke.id
-      end
-
-      it "should have a root node named user" do        
-        response_body_json.should have_key("user")
-      end
-
-      it "should contain the specified attributes" do
-        response_body_json["user"].should have_key("first_name")
-        response_body_json["user"].should have_key("last_name")
-      end
-
-      it "should contain the specified values" do
-        response_body_json["user"]["first_name"].should eql("Luke")
-        response_body_json["user"]["last_name"].should eql("Skywalker")
-      end
-
+  
+    after(:each) do
+     clean_up_active_record_models
     end
-    
-    describe 'get a single user with a nil profile' do
-
-      before(:each) do
-        Profile.acts_as_api
-        Profile.api_accessible :include_profile do |t|
-          t.add :avatar
-          t.add :homepage
-        end
-        
-        get :show, :format => 'json', :api_template => :include_profile, :id => @han.id
-      end
-
-      it "should have a root node named user" do
-        response_body_json.should have_key("user")
-      end
-
-      it "should contain the specified attributes" do
-        response_body_json["user"].should have(1).key        
-        response_body_json["user"].should have_key("profile")
-      end
-
-      it "should contain the specified values" do
-        response_body_json["user"]["profile"].should be_nil
-      end
-
-    end    
-
+  
+    # see spec/support/controller_examples.rb
+    it_behaves_like "a controller with ActsAsApi responses"
   end
 
-  describe 'Rails 3 default style json responses' do
+  context "using mongoid", :orm => :mongoid do
 
     before(:each) do
-      @org_include_root_in_json_collections = ActsAsApi::Config.include_root_in_json_collections
-      ActsAsApi::Config.include_root_in_json_collections = true
+      setup_mongoid_models
     end
 
     after(:each) do
-      ActsAsApi::Config.include_root_in_json_collections = @org_include_root_in_json_collections
-    end
-
-    describe 'get all users' do
-
-      before(:each) do
-        get :index, :format => 'json', :api_template => :name_only
-      end
-
-      it "should have a root node named users" do
-        response_body_json.should have_key("users")
-      end
-
-      it "should contain all users" do
-        response_body_json["users"].should be_a(Array)
-      end
-
-      it "should contain the specified attributes" do
-        response_body_json["users"].first["user"].should have_key("first_name")
-        response_body_json["users"].first["user"].should have_key("last_name")
-      end
-
-      it "contains the user root nodes" do
-        response_body_json["users"].collect(&:keys).flatten.uniq.should eql(["user"])
-      end
-
-      it "should contain the specified values" do
-        response_body_json["users"].first["user"]["first_name"].should eql("Luke")
-        response_body_json["users"].first["user"]["last_name"].should eql("Skywalker")
-      end
-
-    end
-
-    describe 'get a single user' do
-
-      before(:each) do
-        get :show, :format => 'json', :api_template => :name_only, :id => @luke.id
-      end
-
-      it "should have a root node named user" do
-        response_body_json.should have_key("user")
-      end
-
-      it "should contain the specified attributes" do
-        response_body_json["user"].should have_key("first_name")
-        response_body_json["user"].should have_key("last_name")
-      end
-
-      it "should contain the specified values" do
-        response_body_json["user"]["first_name"].should eql("Luke")
-        response_body_json["user"]["last_name"].should eql("Skywalker")
-      end
+     clean_up_mongoid_models
     end
 
+    # see spec/support/controller_examples.rb
+    it_behaves_like "a controller with ActsAsApi responses"
   end
-
-  describe 'jsonp responses with callback' do
-
-    it "should be disabled by default" do
-      @callback = "mycallback"
-      get :index, :format => 'json', :api_template => :name_only, :callback => @callback
-      response_body_jsonp(@callback).should be_nil
-    end
-
-    describe "enabled jsonp callbacks" do
-
-      before(:each) do
-        @callback = "mycallback"
-
-        User.acts_as_api do |config|
-          config.allow_jsonp_callback = true
-        end
-      end
-
-      describe 'get all users' do
-
-        before(:each) do
-          get :index, :format => 'json', :api_template => :name_only, :callback => @callback
-        end
-
-        it "should wrap the response in the callback" do        
-          response_body_jsonp(@callback).should_not be_nil
-        end
-
-      end
-
-      describe 'get a single user' do
-
-        before(:each) do
-          get :show, :format => 'json', :api_template => :name_only, :id => @luke.id, :callback => @callback
-        end
-
-        it "should wrap the response in the callback" do          
-          response_body_jsonp(@callback).should_not be_nil
-        end
-
-      end
-
-    end
-  end
-
 end