acts_as_api_sequel 0.0.1

data/spec/shared_engine/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/shared_engine/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/shared_engine/shared_engine.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "shared_engine/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "shared_engine"
+  s.version     = SharedEngine::VERSION
+  s.authors     = ["TODO: Your name"]
+  s.email       = ["TODO: Your email"]
+  s.homepage    = "TODO"
+  s.summary     = "TODO: Summary of SharedEngine."
+  s.description = "TODO: Description of SharedEngine."
+
+  s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
+
+  s.add_dependency "rails", "~> 3.2.16"
+  # s.add_dependency "jquery-rails"
+
+  s.add_development_dependency "sqlite3"
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV["RAILS_ENV"] = "test"
+
+if ENV['ACTS_AS_API_ORM'] == 'active_record'
+  require "active_record_dummy/config/environment"
+
+  load_schema = lambda {
+    load "#{Rails.root.to_s}/db/schema.rb" # use db agnostic schema by default
+    # ActiveRecord::Migrator.up('db/migrate') # use migrations
+  }
+  silence_stream(STDOUT, &load_schema)
+
+elsif ENV['ACTS_AS_API_ORM'] == 'mongoid'
+
+  require "mongoid_dummy/config/environment"
+
+end
+
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|file| require file }

data/spec/support/api_test_helpers.rb

@@ -0,0 +1,23 @@
+module ApiTestHelpers
+  
+  def response_body
+    response.body.strip
+  end
+  
+  def response_body_json
+    ActiveSupport::JSON.decode(response_body)
+  end
+  
+  def response_body_jsonp(callback)
+    jsonp_callback(callback).match(response_body)
+  end
+  
+  def jsonp_callback(callback)
+    /\A#{callback}\((.*),\s+\d{3}\)\z/
+  end
+  
+end
+
+RSpec.configure do |c|
+  c.include ApiTestHelpers
+end

data/spec/support/controller_examples.rb

@@ -0,0 +1,458 @@
+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
+      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
+
+    describe 'get a user without specifying an api template' do
+
+      before(:each) do
+        get :show_default, :format => 'xml', :id => @luke.id
+      end
+
+      it "should respond with HTTP 200" do
+        response.code.should == "200"
+      end
+
+      it "should render the model with standard to_xml" do
+        # TODO: figure out how to compare xml generated by mongo models.
+
+        # This line works fine with ActiveRecord, but not Mongoid:
+        # response.body.should == @luke.to_xml
+
+        response.body.length.should == @luke.to_xml.length
+      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("Han")
+        response_body_json["users"].first["last_name"].should eql("Solo")
+      end
+
+    end
+    
+    describe 'get all users as a ActiveRecord::Relation (or similar chained) object, autodetecting the root node name' do
+
+      before(:each) do
+        get :index_relation, :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("Han")
+        response_body_json["users"].first["last_name"].should eql("Solo")
+      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
+
+    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).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
+
+    describe 'get a user without specifying an api template' do
+
+      before(:each) do
+        get :show_default, :format => 'json', :id => @luke.id
+      end
+
+      it "should respond with HTTP 200" do
+        response.code.should == "200"
+      end
+
+      it "should render the model with to_json" do
+        response.body.should == @luke.to_json
+      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
+      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("Han")
+        response_body_json["users"].first["user"]["last_name"].should eql("Solo")
+      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
+    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
+      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
+
+      after(:each) do
+        # put things back to the way they were
+        User.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
+        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
+
+  describe 'config.add_root_node_for is empty, so no root node is created' do
+    before(:each) do
+      @org_add_root_node_for_config = ActsAsApi::Config.add_root_node_for.dup
+      ActsAsApi::Config.add_root_node_for = []
+    end
+
+    after(:each) do
+      ActsAsApi::Config.add_root_node_for = @org_add_root_node_for_config
+    end
+
+    describe 'get all users' do
+      before(:each) do
+        get :index, :format => 'json', :api_template => :name_only, :callback => @callback
+      end
+
+      its "response has no named root node" do
+        response_body_json.should be_an(Array)
+      end
+    end
+
+    describe 'get a single user' do
+      before(:each) do
+        get :show, :format => 'json', :api_template => :name_only, :id => @luke.id
+      end
+
+      its "response has no named root node" do
+        response_body_json.should be_a(Hash)
+        response_body_json.should have_key("first_name")
+      end
+    end
+  end
+
+  describe 'pass meta information on rendering' do
+
+    describe 'get all users' do
+      before(:each) do
+        get :index_meta, :format => 'json', :api_template => :name_only
+      end
+
+      it "shows model response fields" do
+        response_body_json.should be_a(Hash)
+        response_body_json.should have_key("users")
+        response_body_json["users"].should be_an(Array)
+      end
+
+      it "shows page field" do
+        response_body_json.should have_key("page")
+      end
+
+      it "shows total field" do
+        response_body_json.should have_key("total")
+      end
+    end
+
+    describe 'get a single user' do
+      before(:each) do
+        get :show_meta, :format => 'json', :api_template => :name_only, :id => @luke.id
+      end
+
+      it "shows model response fields" do
+        response_body_json.should be_a(Hash)
+        response_body_json.should have_key("user")
+      end
+
+      it "shows page field" do
+        response_body_json.should have_key("page")
+      end
+
+      it "shows total field" do
+        response_body_json.should have_key("total")
+      end
+
+    end
+  end
+
+
+  describe 'api prefix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_prefix => :with_prefix, :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 > prefix")
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+      end
+
+      it "should not contain the specified attributes" do
+        response_body.should_not have_selector("user > postfix")
+      end
+
+    end
+
+  end
+
+  describe 'api postfix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_postfix => :with_postfix, :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")
+        response_body.should have_selector("user > postfix")
+      end
+
+      it "should not contain the specified attributes" do
+        response_body.should_not have_selector("user > prefix")
+      end
+
+    end
+
+  end
+
+  describe 'api prefix and api postfix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_prefix => :with_prefix, :api_postfix => :with_postfix, :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 > prefix")
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+        response_body.should have_selector("user > postfix")
+      end
+
+    end
+
+  end
+
+end