acts_as_api 0.3.5 → 0.3.6

data/spec/support/model_examples/undefined.rb

@@ -0,0 +1,7 @@
+shared_examples_for "trying to render an api template that is not defined" do
+
+  it "raises an descriptive error" do
+    lambda{ @luke.as_api_response(:does_not_exist) }.should raise_error(ActsAsApi::TemplateNotFoundError)
+  end
+
+end

data/spec/support/model_examples/untouched.rb

@@ -0,0 +1,13 @@
+shared_examples_for "untouched models" do
+
+  describe "has disabled acts_as_api by default" do
+    it "indicates that acts_as_api is disabled" do
+      @untouched_model.acts_as_api?.should be_false
+    end
+
+    it "does not respond to api_accessible" do
+      @untouched_model.should_not respond_to :api_accessible
+    end
+  end
+
+end

data/spec/support/simple_fixtures.rb

@@ -1,22 +1,53 @@
 module SimpleFixtures
   
-  def setup_models
-    @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 })
+  def setup_active_record_models
+    @orm_for_testing  = :active_record
+    @user_model       = User
+    @task_model       = Task
+    @profile_model    = Profile
+    @untouched_model  = Untouched
 
-    @luke.profile = Profile.create({ :avatar => 'picard.jpg', :homepage => 'lukasarts.com' })
+    @luke = @user_model.create({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })  
+    @han  = @user_model.create({ :first_name => 'Han',       :last_name => 'Solo',      :age => 35, :active => true  })
+    @leia = @user_model.create({ :first_name => 'Princess',  :last_name => 'Leia',      :age => 25, :active => false })
+
+    @luke.profile = @profile_model.create({ :avatar => 'picard.jpg', :homepage => 'lukasarts.com' })
 
     @destroy_deathstar = @luke.tasks.create({ :heading => "Destroy Deathstar", :description => "XWing, Shoot, BlowUp",  :time_spent => 30,  :done => true })
     @study_with_yoda   = @luke.tasks.create({ :heading => "Study with Yoda",   :description => "Jedi Stuff, ya know",   :time_spent => 60,  :done => true })
     @win_rebellion     = @luke.tasks.create({ :heading => "Win Rebellion",     :description => "no idea yet...",        :time_spent => 180, :done => false })    
   end
   
-  def clean_up
-    User.delete_all
-    Task.delete_all    
+  def clean_up_active_record_models
+    @user_model.delete_all
+    @task_model.delete_all
+  end  
+  
+  def setup_mongoid_models
+    @orm_for_testing  = :mongoid    
+    @user_model       = MongoUser
+    @task_model       = MongoTask
+    @profile_model    = MongoProfile
+    @untouched_model  = MongoUntouched
+    
+    @luke = @user_model.new({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })  
+    @han  = @user_model.new({ :first_name => 'Han',       :last_name => 'Solo',      :age => 35, :active => true  })
+    @leia = @user_model.new({ :first_name => 'Princess',  :last_name => 'Leia',      :age => 25, :active => false })
+
+    @luke.build_profile({ :avatar => 'picard.jpg', :homepage => 'lukasarts.com' })
+
+    @destroy_deathstar = @luke.tasks.new({ :heading => "Destroy Deathstar", :description => "XWing, Shoot, BlowUp",  :time_spent => 30,  :done => true })
+    @study_with_yoda   = @luke.tasks.new({ :heading => "Study with Yoda",   :description => "Jedi Stuff, ya know",   :time_spent => 60,  :done => true })
+    @win_rebellion     = @luke.tasks.new({ :heading => "Win Rebellion",     :description => "no idea yet...",        :time_spent => 180, :done => false })    
+    
+    @luke.save!
+    @han.save!
+    @leia.save!    
   end
   
+  def clean_up_mongoid_models
+    @user_model.delete_all
+  end
   
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_api
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - "Christian B\xC3\xA4uerlein"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 +02:00
+date: 2011-05-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,22 @@ dependencies:
         version: 3.0.0
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id005
 description: acts_as_api enriches the models and controllers of your app in a rails-like way so you can easily determine how your XML/JSON API responses should look like.
 email: 
 - christian@ffwdme.com
@@ -103,6 +119,8 @@ files:
 - examples/introduction/index.rb
 - examples/introduction/layout.mustache
 - lib/acts_as_api.rb
+- lib/acts_as_api/adapters.rb
+- lib/acts_as_api/adapters/mongoid.rb
 - lib/acts_as_api/api_template.rb
 - lib/acts_as_api/array.rb
 - lib/acts_as_api/base.rb
@@ -110,27 +128,22 @@ files:
 - lib/acts_as_api/exceptions.rb
 - lib/acts_as_api/rails_renderer.rb
 - lib/acts_as_api/rendering.rb
+- lib/acts_as_api/responder.rb
 - lib/acts_as_api/version.rb
 - spec/controllers/respond_with_users_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
-- spec/models/base/associations_spec.rb
-- spec/models/base/closures_spec.rb
-- spec/models/base/conditional_if_spec.rb
-- spec/models/base/conditional_unless_spec.rb
-- spec/models/base/enabled_spec.rb
-- spec/models/base/extending_spec.rb
-- spec/models/base/methods_spec.rb
-- spec/models/base/renaming_spec.rb
-- spec/models/base/simple_spec.rb
-- spec/models/base/sub_nodes_spec.rb
-- spec/models/base/undefined_spec.rb
-- spec/models/base/untouched_spec.rb
+- spec/models/active_record_spec.rb
+- spec/models/mongoid_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile
 - spec/rails_app/app/controllers/application_controller.rb
 - spec/rails_app/app/controllers/respond_with_users_controller.rb
 - spec/rails_app/app/controllers/users_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/app/models/mongo_profile.rb
+- spec/rails_app/app/models/mongo_task.rb
+- spec/rails_app/app/models/mongo_untouched.rb
+- spec/rails_app/app/models/mongo_user.rb
 - spec/rails_app/app/models/profile.rb
 - spec/rails_app/app/models/task.rb
 - spec/rails_app/app/models/untouched.rb
@@ -144,12 +157,14 @@ files:
 - spec/rails_app/config/environments/development.rb
 - spec/rails_app/config/environments/production.rb
 - spec/rails_app/config/environments/test.rb
+- spec/rails_app/config/initializers/acts_as_api_mongoid.rb
 - spec/rails_app/config/initializers/backtrace_silencers.rb
 - spec/rails_app/config/initializers/inflections.rb
 - spec/rails_app/config/initializers/mime_types.rb
 - spec/rails_app/config/initializers/secret_token.rb
 - spec/rails_app/config/initializers/session_store.rb
 - spec/rails_app/config/locales/en.yml
+- spec/rails_app/config/mongoid.yml
 - spec/rails_app/config/routes.rb
 - spec/rails_app/db/migrate/20110214201640_create_tables.rb
 - spec/rails_app/db/schema.rb
@@ -173,6 +188,20 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/api_test_helpers.rb
+- spec/support/controller_examples.rb
+- spec/support/it_supports.rb
+- spec/support/model_examples/associations.rb
+- spec/support/model_examples/closures.rb
+- spec/support/model_examples/conditional_if.rb
+- spec/support/model_examples/conditional_unless.rb
+- spec/support/model_examples/enabled.rb
+- spec/support/model_examples/extending.rb
+- spec/support/model_examples/methods.rb
+- spec/support/model_examples/renaming.rb
+- spec/support/model_examples/simple.rb
+- spec/support/model_examples/sub_nodes.rb
+- spec/support/model_examples/undefined.rb
+- spec/support/model_examples/untouched.rb
 - spec/support/simple_fixtures.rb
 has_rdoc: true
 homepage: https://github.com/fabrik42/acts_as_api
@@ -213,24 +242,18 @@ summary: Makes creating XML/JSON responses in Rails 3 easy and fun.
 test_files: 
 - spec/controllers/respond_with_users_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
-- spec/models/base/associations_spec.rb
-- spec/models/base/closures_spec.rb
-- spec/models/base/conditional_if_spec.rb
-- spec/models/base/conditional_unless_spec.rb
-- spec/models/base/enabled_spec.rb
-- spec/models/base/extending_spec.rb
-- spec/models/base/methods_spec.rb
-- spec/models/base/renaming_spec.rb
-- spec/models/base/simple_spec.rb
-- spec/models/base/sub_nodes_spec.rb
-- spec/models/base/undefined_spec.rb
-- spec/models/base/untouched_spec.rb
+- spec/models/active_record_spec.rb
+- spec/models/mongoid_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile
 - spec/rails_app/app/controllers/application_controller.rb
 - spec/rails_app/app/controllers/respond_with_users_controller.rb
 - spec/rails_app/app/controllers/users_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/app/models/mongo_profile.rb
+- spec/rails_app/app/models/mongo_task.rb
+- spec/rails_app/app/models/mongo_untouched.rb
+- spec/rails_app/app/models/mongo_user.rb
 - spec/rails_app/app/models/profile.rb
 - spec/rails_app/app/models/task.rb
 - spec/rails_app/app/models/untouched.rb
@@ -244,12 +267,14 @@ test_files:
 - spec/rails_app/config/environments/development.rb
 - spec/rails_app/config/environments/production.rb
 - spec/rails_app/config/environments/test.rb
+- spec/rails_app/config/initializers/acts_as_api_mongoid.rb
 - spec/rails_app/config/initializers/backtrace_silencers.rb
 - spec/rails_app/config/initializers/inflections.rb
 - spec/rails_app/config/initializers/mime_types.rb
 - spec/rails_app/config/initializers/secret_token.rb
 - spec/rails_app/config/initializers/session_store.rb
 - spec/rails_app/config/locales/en.yml
+- spec/rails_app/config/mongoid.yml
 - spec/rails_app/config/routes.rb
 - spec/rails_app/db/migrate/20110214201640_create_tables.rb
 - spec/rails_app/db/schema.rb
@@ -273,4 +298,18 @@ test_files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/api_test_helpers.rb
+- spec/support/controller_examples.rb
+- spec/support/it_supports.rb
+- spec/support/model_examples/associations.rb
+- spec/support/model_examples/closures.rb
+- spec/support/model_examples/conditional_if.rb
+- spec/support/model_examples/conditional_unless.rb
+- spec/support/model_examples/enabled.rb
+- spec/support/model_examples/extending.rb
+- spec/support/model_examples/methods.rb
+- spec/support/model_examples/renaming.rb
+- spec/support/model_examples/simple.rb
+- spec/support/model_examples/sub_nodes.rb
+- spec/support/model_examples/undefined.rb
+- spec/support/model_examples/untouched.rb
 - spec/support/simple_fixtures.rb

data/spec/models/base/associations_spec.rb

@@ -1,284 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-describe ActsAsApi::Base do
-
-  describe "including an association in the api template", :orm => :active_record do
-
-    before(:each) do
-      setup_models
-    end
-
-    after(:each) do
-      clean_up
-    end
-
-    describe "which doesn't acts_as_api" do
-
-      before(:each) do
-        @response = @luke.as_api_response(:include_tasks)
-      end
-
-      it "returns a hash" do
-        @response.should be_kind_of(Hash)
-      end
-
-      it "returns the correct number of fields" do
-        @response.should have(1).key
-      end
-
-      it "returns all specified fields" do
-        @response.keys.should include(:tasks)
-      end
-
-      it "returns the correct values for the specified fields" do
-        @response[:tasks].should be_an Array
-        @response[:tasks].should have(3).tasks
-      end
-
-      it "should contain the associated sub models" do
-        @response[:tasks].should include(@destroy_deathstar, @study_with_yoda, @win_rebellion)
-      end
-    end
-
-    describe "which does acts_as_api" do
-
-      context "has_many" do
-
-        before(:each) do
-          Task.acts_as_api
-          Task.api_accessible :include_tasks do |t|
-            t.add :heading
-            t.add :done
-          end
-          @response = @luke.as_api_response(:include_tasks)
-        end
-
-        it "returns a hash" do
-          @response.should be_kind_of(Hash)
-        end
-
-        it "returns the correct number of fields" do
-          @response.should have(1).key
-        end
-
-        it "returns all specified fields" do
-          @response.keys.should include(:tasks)
-        end
-
-        it "returns the correct values for the specified fields" do
-          @response[:tasks].should be_an Array
-          @response[:tasks].should have(3).tasks
-        end
-
-        it "contains the associated child models with the determined api template" do
-          @response[:tasks].each do |task|
-            task.keys.should include(:heading, :done)
-            task.keys.should have(2).attributes
-          end
-        end
-
-        it "contains the correct data of the child models" do
-          task_hash = [  @destroy_deathstar, @study_with_yoda, @win_rebellion  ].collect{|t| { :done => t.done, :heading => t.heading } }
-          @response[:tasks].should eql task_hash
-        end
-      end
-
-      context "has_one" do
-
-        before(:each) do
-          Profile.acts_as_api
-          Profile.api_accessible :include_profile do |t|
-            t.add :avatar
-            t.add :homepage
-          end
-          @response = @luke.as_api_response(:include_profile)
-        end
-
-        it "returns a hash" do
-          @response.should be_kind_of(Hash)
-        end
-
-        it "returns the correct number of fields" do
-          @response.should have(1).key
-        end
-
-        it "returns all specified fields" do
-          @response.keys.should include(:profile)
-        end
-
-        it "returns the correct values for the specified fields" do
-          @response[:profile].should be_a Hash
-          @response[:profile].should have(2).attributes
-        end
-
-        it "contains the associated child models with the determined api template" do
-          @response[:profile].keys.should include(:avatar, :homepage)
-        end
-
-        it "contains the correct data of the child models" do
-          profile_hash = { :avatar => @luke.profile.avatar, :homepage => @luke.profile.homepage }
-          @response[:profile].should eql profile_hash
-        end
-
-      end
-    end
-
-    describe "which does acts_as_api, but with using another template name" do
-
-      before(:each) do
-        Task.acts_as_api
-        Task.api_accessible :other_template do |t|
-          t.add :description
-          t.add :time_spent
-        end
-        @response = @luke.as_api_response(:other_sub_template)
-      end
-
-      it "returns a hash" do
-        @response.should be_kind_of(Hash)
-      end
-
-      it "returns the correct number of fields" do
-        @response.should have(2).keys
-      end
-
-      it "returns all specified fields" do
-        @response.keys.should include(:first_name)
-      end
-
-      it "returns the correct values for the specified fields" do
-        @response.values.should include(@luke.first_name)
-      end
-
-      it "returns all specified fields" do
-        @response.keys.should include(:tasks)
-      end
-
-      it "returns the correct values for the specified fields" do
-        @response[:tasks].should be_an Array
-        @response[:tasks].should have(3).tasks
-      end
-
-      it "contains the associated child models with the determined api template" do
-        @response[:tasks].each do |task|
-          task.keys.should include(:description, :time_spent)
-          task.keys.should have(2).attributes
-        end
-      end
-
-      it "contains the correct data of the child models" do
-        task_hash = [  @destroy_deathstar, @study_with_yoda, @win_rebellion  ].collect{|t| { :description => t.description, :time_spent => t.time_spent } }
-        @response[:tasks].should eql task_hash
-      end
-    end
-
-    describe "that is scoped" do
-
-      before(:each) do
-        # extend task model with scope
-        class Task < ActiveRecord::Base
-          scope :completed, where(:done => true)
-        end
-        Task.acts_as_api
-        Task.api_accessible :include_completed_tasks do |t|
-          t.add :heading
-          t.add :done
-        end
-
-        @response = @luke.as_api_response(:include_completed_tasks)
-      end
-
-      it "returns a hash" do
-        @response.should be_kind_of(Hash)
-      end
-
-      it "returns the correct number of fields" do
-        @response.should have(1).key
-      end
-
-      it "returns all specified fields" do
-        @response.keys.should include(:completed_tasks)
-      end
-
-      it "returns the correct values for the specified fields" do
-        @response[:completed_tasks].should be_an Array
-        @response[:completed_tasks].should have(2).tasks
-      end
-
-      it "contains the associated child models with the determined api template" do
-        @response[:completed_tasks].each do |task|
-          task.keys.should include(:heading, :done)
-          task.keys.should have(2).attributes
-        end
-      end
-
-      it "contains the correct data of the child models" do
-        task_hash = [  @destroy_deathstar, @study_with_yoda  ].collect{|t| { :done => t.done, :heading => t.heading } }
-        @response[:completed_tasks].should eql task_hash
-      end
-    end
-
-    describe "handling nil values" do
-
-      context "has_many" do
-
-        before(:each) do
-          Task.acts_as_api
-          Task.api_accessible :include_tasks do |t|
-            t.add :heading
-            t.add :done
-          end
-          @response = @han.as_api_response(:include_tasks)
-        end
-
-        it "returns a hash" do
-          @response.should be_kind_of(Hash)
-        end
-
-        it "returns the correct number of fields" do
-          @response.should have(1).key
-        end
-
-        it "returns all specified fields" do
-          @response.keys.should include(:tasks)
-        end
-
-        it "returns the correct values for the specified fields" do
-          @response[:tasks].should be_kind_of(Array)
-        end
-
-        it "contains no associated child models" do
-          @response[:tasks].should have(0).items
-        end
-
-      end
-
-      context "has one" do
-        before(:each) do
-          Profile.acts_as_api
-          Profile.api_accessible :include_profile do |t|
-            t.add :avatar
-            t.add :homepage
-          end
-          @response = @han.as_api_response(:include_profile)
-        end
-
-        it "returns a hash" do
-          @response.should be_kind_of(Hash)
-        end
-
-        it "returns the correct number of fields" do
-          @response.should have(1).key
-        end
-
-        it "returns all specified fields" do
-          @response.keys.should include(:profile)
-        end
-
-        it "returns nil for the association" do
-          @response[:profile].should be_nil
-        end
-      end
-    end
-  end
-end