acts_as_api 0.3.5 → 0.3.6

data/spec/support/model_examples/conditional_unless.rb

@@ -0,0 +1,165 @@
+shared_examples_for "conditional unless statements" do
+
+  describe "using the :unless option" do
+
+    describe "passing a symbol" do
+
+      describe "that returns false" do
+
+        before(:each) do
+          @response = @luke.as_api_response(:unless_under_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(:unless_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(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(@luke.first_name, @luke.last_name)
+        end
+
+      end
+
+      describe "that returns true" do
+
+        before(:each) do
+          @response = @han.as_api_response(:unless_under_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(:unless_under_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(:unless_under_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

data/spec/support/model_examples/enabled.rb

@@ -0,0 +1,10 @@
+shared_examples_for "acts_as_api is enabled" do
+
+  it "indicates that acts_as_api is enabled" do
+    @user_model.acts_as_api?.should be_true
+  end
+
+  it "does respond to api_accessible" do
+    @user_model.should respond_to :api_accessible
+  end
+end

data/spec/support/model_examples/extending.rb

@@ -0,0 +1,112 @@
+shared_examples_for "extending a given api template" do
+
+  describe "multiple times" do
+
+    before(:each) do
+      @user_model.api_accessible :public do |t|
+        t.add :first_name
+      end
+
+      @user_model.api_accessible :for_buddies, :extend => :public do |t|
+        t.add :age
+      end
+
+      @user_model.api_accessible :private, :extend => :for_buddies do |t|
+        t.add :last_name
+      end
+      @response = @luke.as_api_response(:private)
+    end
+
+    it "returns a hash" do
+      @response.should be_kind_of(Hash)
+    end
+
+    it "returns the correct number of fields" do
+      @response.should have(3).keys
+    end
+
+    it "returns all specified fields" do
+      @response.keys.sort_by(&:to_s).should eql([:age, :first_name, :last_name])
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.sort_by(&:to_s).should eql([@luke.age, @luke.first_name, @luke.last_name].sort_by(&:to_s))
+    end
+
+  end
+
+  describe "and removing a former added value" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:age_and_first_name)
+    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([:first_name, :age].sort_by(&:to_s))
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.sort_by(&:to_s).should eql([@luke.first_name, @luke.age].sort_by(&:to_s))
+    end
+
+  end
+
+  describe "and inherit a field using another template name", :meow => true do
+
+    before(:each) do
+      @task_model.acts_as_api
+      @task_model.api_accessible :other_template do |t|
+        t.add :description
+        t.add :time_spent
+      end
+      @user_model.api_accessible :extending_other_template, :extend => :other_sub_template
+      @response = @luke.as_api_response(:extending_other_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
+
+end

data/spec/support/model_examples/methods.rb

@@ -0,0 +1,23 @@
+shared_examples_for "calling a method in the api template" do
+
+  before(:each) do
+    @response = @luke.as_api_response(:only_full_name)
+  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 by name" do
+    @response.keys.should include(:full_name)
+  end
+
+  it "returns the correct values for the specified fields" do
+    @response.values.should include(@luke.full_name)
+  end
+
+end

data/spec/support/model_examples/renaming.rb

@@ -0,0 +1,50 @@
+shared_examples_for "renaming" do
+
+  describe "an attribute in the api template" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:rename_last_name)
+    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(:family_name)
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.should include(@luke.last_name)
+    end
+
+  end
+
+  describe "the node/key of a method in the api template" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:rename_full_name)
+    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(:other_full_name)
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response.values.should include(@luke.full_name)
+    end
+
+  end
+end

data/spec/support/model_examples/simple.rb

@@ -0,0 +1,23 @@
+shared_examples_for "listing attributes in the api template" do
+
+  before(:each) do
+    @response = @luke.as_api_response(:name_only)
+  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 the specified fields only" do
+    @response.keys.should include(:first_name, :last_name)
+  end
+
+  it "the specified fields have the correct value" do
+    @response.values.should include(@luke.first_name, @luke.last_name)
+  end
+
+end

data/spec/support/model_examples/sub_nodes.rb

@@ -0,0 +1,105 @@
+shared_examples_for "creating a sub hash in the api template" do
+
+  describe "and putting an attribute in it" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:sub_node)
+    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(:sub_nodes)
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response[:sub_nodes].should be_a Hash
+    end
+
+    it "provides the correct number of sub nodes" do
+      @response[:sub_nodes].should have(1).keys
+    end
+
+    it "provides the correct sub nodes values" do
+      @response[:sub_nodes][:foo].should eql("something")
+    end
+  end
+
+  describe "multiple times and putting an attribute in it" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:nested_sub_node)
+    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(:sub_nodes)
+    end
+
+    it "returns the correct values for the specified fields" do
+      @response[:sub_nodes].should be_a Hash
+    end
+
+    it "provides the correct number of sub nodes" do
+      @response[:sub_nodes].should have(1).keys
+    end
+
+    it "provides the correct number of sub nodes in the second level" do
+      @response[:sub_nodes][:foo].should have(1).keys
+    end
+
+    it "provides the correct sub nodes values" do
+      @response[:sub_nodes][:foo].tap do |foo|
+        foo[:bar].tap do |bar|
+          bar.should eql(@luke.last_name)
+        end
+      end
+    end
+
+  end
+
+  describe "using a method" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:nested_sub_hash)
+    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(:sub_hash)
+    end
+
+    it "provides the correct number of sub nodes" do
+      @response[:sub_hash].should have(2).keys
+    end
+
+    it "provides the correct sub nodes" do
+      @response[:sub_hash].keys.should include(:foo, :hello)
+    end
+
+    it "provides the correct values in its sub nodes" do
+      @response[:sub_hash].values.should include("bar", "world")
+    end
+
+  end
+end