acts_as_api 0.3.5 → 0.3.6

data/spec/models/active_record_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe ActiveRecord, :orm => "active_record" do
+  
+  before(:each) do
+    setup_active_record_models
+  end
+
+  after(:each) do
+    clean_up_active_record_models
+  end
+  
+  describe :act_as_api do
+    it_supports "including an association in the api template"
+    it_supports "calling a closure in the api template"
+    it_supports "conditional if statements"
+    it_supports "conditional unless statements" 
+    it_supports "acts_as_api is enabled"
+    it_supports "extending a given api template"
+    it_supports "calling a method in the api template"
+    it_supports "renaming"
+    it_supports "listing attributes in the api template"
+    it_supports "creating a sub hash in the api template"
+    it_supports "trying to render an api template that is not defined"
+    it_supports "untouched models" 
+  end
+  
+end

data/spec/models/mongoid_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Mongoid, :orm => "mongoid" do
+  
+  before(:each) do
+    setup_mongoid_models
+  end
+
+  after(:each) do
+    clean_up_mongoid_models
+  end
+  
+  describe :act_as_api do
+    it_supports "including an association in the api template"
+    it_supports "calling a closure in the api template"
+    it_supports "conditional if statements"
+    it_supports "conditional unless statements" 
+    it_supports "acts_as_api is enabled"
+    it_supports "extending a given api template"
+    it_supports "calling a method in the api template"
+    it_supports "renaming"
+    it_supports "listing attributes in the api template"
+    it_supports "creating a sub hash in the api template"
+    it_supports "trying to render an api template that is not defined"
+    it_supports "untouched models" 
+  end
+  
+end

data/spec/rails_app/app/controllers/respond_with_users_controller.rb

@@ -1,15 +1,26 @@
 class RespondWithUsersController < ApplicationController
-  
+
   respond_to :json, :xml
+
+  self.responder = ActsAsApi::Responder
   
+  before_filter do
+    if params[:orm] == :active_record
+      @user_model = User
+    elsif params[:orm] == :mongoid
+      @user_model = MongoUser
+    end
+  end
+
   def index
-    @users = User.all
-    respond_with @users, :api_template => params[:api_template].to_sym
+    @users = @user_model.all
+    respond_with @users, :api_template => params[:api_template].to_sym, :root => :users
   end
-  
+
   def show
-    @user = User.find(params[:id])
-    respond_with @user, :api_template => params[:api_template].to_sym
-  end  
-  
+    @user = @user_model.find(params[:id])
+    # :root => :user is only used here because we need it for the node name of the MongoUser model
+    respond_with @user, :api_template => params[:api_template].to_sym, :root => :user
+  end
+
 end

data/spec/rails_app/app/controllers/users_controller.rb

@@ -1,7 +1,15 @@
 class UsersController < ApplicationController
   
+  before_filter do
+    if params[:orm] == :active_record
+      @user_model = User
+    elsif params[:orm] == :mongoid
+      @user_model = MongoUser
+    end
+  end
+  
   def index
-    @users = User.all
+    @users = @user_model.all
 
     respond_to do |format|
       format.xml  { render_for_api params[:api_template].to_sym, :xml => @users, :root => :users }
@@ -10,11 +18,12 @@ class UsersController < ApplicationController
   end
   
   def show
-    @user = User.find(params[:id])
+    @user = @user_model.find(params[:id])
 
     respond_to do |format|
-      format.xml  { render_for_api params[:api_template].to_sym, :xml => @user }
-      format.json { render_for_api params[:api_template].to_sym, :json => @user }
+      # :root => :user is only used here because we need it for the node name of the MongoUser model
+      format.xml  { render_for_api params[:api_template].to_sym, :xml => @user, :root => :user }
+      format.json { render_for_api params[:api_template].to_sym, :json => @user, :root => :user }
     end
   end  
   

data/spec/rails_app/app/models/mongo_profile.rb

@@ -0,0 +1,10 @@
+class MongoProfile
+  include Mongoid::Document
+
+  field :avatar, :type => String
+  field :homepage, :type => String
+  field :created_at, :type => DateTime
+  field :updated_at, :type => DateTime
+
+  embedded_in :user, :class_name => "MongoUser", :inverse_of => :profile
+end

data/spec/rails_app/app/models/mongo_task.rb

@@ -0,0 +1,12 @@
+class MongoTask
+  include Mongoid::Document
+  
+  field :heading, :type => String
+  field :description, :type => String
+  field :time_spent, :type => Integer
+  field :done, :type => Boolean
+  field :created_at, :type => DateTime
+  field :updated_at, :type => DateTime  
+  
+  embedded_in :user, :class_name => "MongoUser", :inverse_of => :task
+end

data/spec/rails_app/app/models/mongo_untouched.rb

@@ -0,0 +1,7 @@
+class MongoUntouched
+  include Mongoid::Document
+  
+  field :nothing, :type => String
+  field :created_at, :type => DateTime
+  field :updated_at, :type => DateTime  
+end

data/spec/rails_app/app/models/mongo_user.rb

@@ -0,0 +1,149 @@
+class MongoUser
+  
+  include Mongoid::Document
+  
+  field :first_name, :type => String
+  field :last_name, :type => String
+  field :age, :type => Integer
+  field :active, :type => Boolean
+  field :created_at, :type => DateTime
+  field :updated_at, :type => DateTime
+
+  embeds_one :profile, :class_name => "MongoProfile", :inverse_of => :user
+  embeds_many :tasks, :class_name => "MongoTask", :inverse_of => :user
+
+  acts_as_api
+  
+  api_accessible :name_only do |t|
+    t.add :first_name
+    t.add :last_name
+  end
+  
+  api_accessible :only_full_name do |t|
+    t.add :full_name
+  end
+  
+  api_accessible :rename_last_name do |t|
+    t.add :last_name, :as => :family_name
+  end
+  
+  api_accessible :rename_full_name do |t|
+    t.add :full_name, :as => :other_full_name
+  end  
+    
+  api_accessible :with_former_value do |t|
+    t.add :first_name
+    t.add :last_name          
+  end
+  
+  api_accessible :age_and_first_name, :extend => :with_former_value do |t|
+    t.add :age
+    t.remove :last_name
+  end
+  
+  api_accessible :calling_a_proc do |t|
+    t.add Proc.new{|model| model.full_name.upcase  }, :as => :all_caps_name
+    t.add Proc.new{|model| Time.now.class.to_s  }, :as => :without_param
+  end  
+  
+  api_accessible :calling_a_lambda do |t|
+    t.add lambda{|model| model.full_name.upcase  }, :as => :all_caps_name
+    t.add lambda{|model| Time.now.class.to_s  }, :as => :without_param
+  end
+  api_accessible :include_tasks do |t| 
+    t.add :tasks
+  end
+     
+  api_accessible :include_profile do |t| 
+    t.add :profile
+  end     
+        
+  api_accessible :other_sub_template do |t|
+    t.add :first_name
+    t.add :tasks, :template => :other_template
+  end
+   
+  api_accessible :include_completed_tasks do |t| 
+    t.add "tasks.completed.all", :as => :completed_tasks
+  end
+  
+  api_accessible :sub_node do |t| 
+    t.add Hash[:foo => :say_something], :as => :sub_nodes
+  end
+  
+  api_accessible :nested_sub_node do |t| 
+    t.add Hash[:foo, Hash[:bar, :last_name]], :as => :sub_nodes
+  end
+    
+  api_accessible :nested_sub_hash do |t| 
+    t.add :sub_hash
+  end
+  
+  api_accessible :if_over_thirty do |t| 
+    t.add :first_name
+    t.add :last_name, :if => :over_thirty? 
+  end  
+
+  api_accessible :if_returns_nil do |t| 
+    t.add :first_name
+    t.add :last_name, :if => :return_nil
+  end
+  
+  api_accessible :if_over_thirty_proc do |t| 
+    t.add :first_name
+    t.add :last_name, :if => lambda{|u| u.over_thirty? }
+  end  
+
+  api_accessible :if_returns_nil_proc do |t| 
+    t.add :first_name
+    t.add :last_name, :if => lambda{|u| nil }
+  end
+  
+  api_accessible :unless_under_thirty do |t| 
+    t.add :first_name
+    t.add :last_name, :unless => :under_thirty? 
+  end  
+
+  api_accessible :unless_returns_nil do |t| 
+    t.add :first_name
+    t.add :last_name, :unless => :return_nil
+  end
+  
+  api_accessible :unless_under_thirty_proc do |t| 
+    t.add :first_name
+    t.add :last_name, :unless => lambda{|u| u.under_thirty? }
+  end  
+
+  api_accessible :unless_returns_nil_proc do |t| 
+    t.add :first_name
+    t.add :last_name, :unless => lambda{|u| nil }
+  end  
+
+  def over_thirty?
+    age > 30
+  end
+  
+  def under_thirty?
+    age < 30
+  end  
+
+  def return_nil
+    nil
+  end
+
+  def full_name
+    '' << first_name.to_s << ' ' << last_name.to_s
+  end
+
+  def say_something
+    "something"
+  end
+  
+  def sub_hash
+    {
+      :foo => "bar",
+      :hello => "world"
+    }
+  end
+  
+end

data/spec/rails_app/app/models/user.rb

@@ -35,14 +35,14 @@ class User < ActiveRecord::Base
   
   api_accessible :calling_a_proc do |t|
     t.add Proc.new{|model| model.full_name.upcase  }, :as => :all_caps_name
-    t.add Proc.new{ Time.now.class.to_s  }, :as => :without_param
+    t.add Proc.new{|model| Time.now.class.to_s  }, :as => :without_param
   end  
   
   api_accessible :calling_a_lambda do |t|
     t.add lambda{|model| model.full_name.upcase  }, :as => :all_caps_name
-    t.add lambda{ Time.now.class.to_s  }, :as => :without_param
+    t.add lambda{|model| Time.now.class.to_s  }, :as => :without_param
   end
-  User.api_accessible :include_tasks do |t| 
+  api_accessible :include_tasks do |t| 
     t.add :tasks
   end
      
@@ -88,7 +88,7 @@ class User < ActiveRecord::Base
 
   api_accessible :if_returns_nil_proc do |t| 
     t.add :first_name
-    t.add :last_name, :if => lambda{ nil }
+    t.add :last_name, :if => lambda{|u| nil }
   end
   
   api_accessible :unless_under_thirty do |t| 
@@ -108,7 +108,7 @@ class User < ActiveRecord::Base
 
   api_accessible :unless_returns_nil_proc do |t| 
     t.add :first_name
-    t.add :last_name, :unless => lambda{ nil }
+    t.add :last_name, :unless => lambda{|u| nil }
   end  
 
   def over_thirty?
@@ -138,4 +138,4 @@ class User < ActiveRecord::Base
     }
   end
 
-end
+end

data/spec/rails_app/config/initializers/acts_as_api_mongoid.rb

@@ -0,0 +1,6 @@
+# At the moment we need to include the Mongoid adapter here
+# in the initializers, as it doesn't get recognized in the
+# lib itself!
+if defined?(Mongoid::Document)
+  Mongoid::Document.send :include, ActsAsApi::Adapters::Mongoid	
+end

data/spec/rails_app/config/mongoid.yml

@@ -0,0 +1,23 @@
+defaults: &defaults
+  host: localhost
+  # slaves:
+  #   - host: slave1.local
+  #     port: 27018
+  #   - host: slave2.local
+  #     port: 27019
+
+development:
+  <<: *defaults
+  database: acts_as_api_example_development
+
+test:
+  <<: *defaults
+  database: acts_as_api_example_test
+
+# set these environment variables on your prod server
+production:
+  host: <%= ENV['MONGOID_HOST'] %>
+  port: <%= ENV['MONGOID_PORT'] %>
+  username: <%= ENV['MONGOID_USERNAME'] %>
+  password: <%= ENV['MONGOID_PASSWORD'] %>
+  database: <%= ENV['MONGOID_DATABASE'] %>

data/spec/support/controller_examples.rb

@@ -0,0 +1,246 @@
+shared_examples_for "a controller with ActsAsApi responses" do
+
+  include ApiTestHelpers
+
+  describe 'xml responses' do
+
+    describe 'get all users' do
+
+      before(:each) do
+        get :index, :format => 'xml', :api_template => :name_only, :orm => @orm_for_testing
+      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, :orm => @orm_for_testing
+      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, :orm => @orm_for_testing
+      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
+
+    end
+
+    describe 'get a single user' do
+
+      before(:each) do
+        get :show, :format => 'json', :api_template => :name_only, :id => @luke.id, :orm => @orm_for_testing
+      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
+
+    end
+
+    describe 'get a single user with a nil profile' do
+
+      before(:each) do
+        @profile_model.acts_as_api
+        @profile_model.api_accessible :include_profile do |t|
+          t.add :avatar
+          t.add :homepage
+        end
+
+        get :show, :format => 'json', :api_template => :include_profile, :id => @han.id, :orm => @orm_for_testing
+      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).keys
+        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
+
+  end
+
+  describe 'Rails 3 default style json responses' 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
+    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, :orm => @orm_for_testing
+      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, :orm => @orm_for_testing
+      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
+    end
+
+  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, :orm => @orm_for_testing
+      response_body_jsonp(@callback).should be_nil
+    end
+
+    describe "enabled jsonp callbacks" do
+
+      before(:each) do
+        @callback = "mycallback"
+
+        @user_model.acts_as_api do |config|
+          config.allow_jsonp_callback = true
+        end
+      end
+
+      after(:each) do
+        # put things back to the way they were
+        @user_model.acts_as_api do |config|
+          config.allow_jsonp_callback = false
+        end
+      end
+
+      describe 'get all users' do
+
+        before(:each) do
+          get :index, :format => 'json', :api_template => :name_only, :callback => @callback, :orm => @orm_for_testing
+        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, :orm => @orm_for_testing
+        end
+
+        it "should wrap the response in the callback" do
+          response_body_jsonp(@callback).should_not be_nil
+        end
+
+      end
+
+    end
+  end
+
+
+end