acts_as_api_sequel 0.0.1

data/spec/support/it_supports.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |c|
+  c.alias_it_should_behave_like_to :it_supports, 'supports:'
+end

data/spec/support/model_examples/associations.rb

@@ -0,0 +1,272 @@
+shared_examples_for "including an association in the api template" do
+  
+  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).keys
+    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).keys
+      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).keys
+      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
+      Task.class_eval do
+        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).keys
+    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).keys
+      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).keys
+      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

data/spec/support/model_examples/callbacks.rb

@@ -0,0 +1,38 @@
+shared_examples_for "defining a model callback" do
+
+  describe "for a" do
+    
+    describe "around_api_response" do
+      
+      it "skips rendering if not yielded" do
+        @luke.skip_api_response = true
+        @luke.as_api_response(:name_only).keys.should include(:skipped)
+      end
+      
+      it "renders if yielded" do
+        @luke.as_api_response(:name_only).keys.should_not include(:skipped)
+      end
+    
+    end
+    
+    describe "before_api_response" do 
+      
+      it "is called properly" do
+        @luke.as_api_response(:name_only)
+        @luke.before_api_response_called?.should eql(true)
+      end
+      
+    end
+    
+    describe "after_api_response" do 
+      
+      it "is called properly" do
+        @luke.as_api_response(:name_only)
+        @luke.after_api_response_called?.should eql(true)
+      end
+      
+    end
+    
+  end
+
+end

data/spec/support/model_examples/closures.rb

@@ -0,0 +1,49 @@
+shared_examples_for "calling a closure in the api template" do
+
+  describe "i.e. a proc (the record is passed as only parameter)" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:calling_a_proc)
+    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.sort_by(&:to_s).should eql([:all_caps_name, :without_param])
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.sort.should eql(["LUKE SKYWALKER", "Time"])
+    end
+  end
+
+  describe "i.e. a lambda (the record is passed as only parameter)" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:calling_a_lambda)
+    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.sort_by(&:to_s).should eql([:all_caps_name, :without_param])
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.sort.should eql(["LUKE SKYWALKER", "Time"])
+    end
+
+  end
+end

data/spec/support/model_examples/conditional_if.rb

@@ -0,0 +1,165 @@
+shared_examples_for "conditional if statements" do
+
+  describe "using the :if option" do
+
+    describe "passing a symbol" do
+
+      describe "that returns false" do
+
+        before(:each) do
+          @response = @luke.as_api_response(:if_over_thirty)
+        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).keys
+        end
+
+        it "won't add the conditional field but all others" do
+          @response.keys.should include(:first_name)
+          @response.keys.should_not include(:full_name)
+        end
+
+        it "the other specified fields have the correct value" do
+          @response.values.should include(@luke.first_name)
+        end
+
+      end
+
+      describe "that returns nil" do
+
+        before(:each) do
+          @response = @luke.as_api_response(:if_returns_nil)
+        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).keys
+        end
+
+        it "won't add the conditional field but all others" do
+          @response.keys.should include(:first_name)
+          @response.keys.should_not include(:full_name)
+        end
+
+        it "the other specified fields have the correct value" do
+          @response.values.should include(@luke.first_name)
+        end
+
+      end
+
+      describe "that returns true" do
+
+        before(:each) do
+          @response = @han.as_api_response(:if_over_thirty)
+        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 "won't add the conditional field but all others" do
+          @response.keys.should include(:first_name)
+          @response.keys.should include(:last_name)
+        end
+
+        it "the other specified fields have the correct value" do
+          @response.values.should include(@han.first_name, @han.last_name)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "passing a proc" do
+
+    describe "that returns false" do
+
+      before(:each) do
+        @response = @luke.as_api_response(:if_over_thirty_proc)
+      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).keys
+      end
+
+      it "won't add the conditional field but all others" do
+        @response.keys.should include(:first_name)
+        @response.keys.should_not include(:full_name)
+      end
+
+      it "the other specified fields have the correct value" do
+        @response.values.should include(@luke.first_name)
+      end
+
+    end
+
+    describe "that returns nil" do
+
+      before(:each) do
+        @response = @luke.as_api_response(:if_returns_nil_proc)
+      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).keys
+      end
+
+      it "won't add the conditional field but all others" do
+        @response.keys.should include(:first_name)
+        @response.keys.should_not include(:full_name)
+      end
+
+      it "the other specified fields have the correct value" do
+        @response.values.should include(@luke.first_name)
+      end
+
+    end
+
+    describe "that returns true" do
+
+      before(:each) do
+        @response = @han.as_api_response(:if_over_thirty_proc)
+      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 "won't add the conditional field but all others" do
+        @response.keys.should include(:first_name)
+        @response.keys.should include(:last_name)
+      end
+
+      it "the other specified fields have the correct value" do
+        @response.values.should include(@han.first_name, @han.last_name)
+      end
+
+    end
+
+  end
+end
+