acts_as_api 0.3.2 → 0.3.3

data/spec/models/base/closures_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "calling a closure in the api template", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+    end
+
+    after(:each) do
+      clean_up
+    end
+
+    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
+end

data/spec/models/base/conditional_if_spec.rb

@@ -0,0 +1,178 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "conditional statements", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+    end
+
+    after(:each) do
+      clean_up
+    end
+
+    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
+ end

data/spec/models/base/conditional_unless_spec.rb

@@ -0,0 +1,178 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "conditional statements", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+    end
+
+    after(:each) do
+      clean_up
+    end
+
+    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
+end

data/spec/models/base/enabled_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "acts_as_api is enabled", :orm => :active_record do
+
+    it "indicates that acts_as_api is enabled" do
+      User.acts_as_api?.should be_true
+    end
+
+    it "does respond to api_accessible" do
+      User.should respond_to :api_accessible
+    end
+  end
+end

data/spec/models/base/extending_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "extending a given api template", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+    end
+
+    after(:each) do
+      clean_up
+    end
+
+    describe "multiple times" do
+
+      before(:each) do
+        User.api_accessible :public do |t|
+          t.add :first_name
+        end
+
+        User.api_accessible :for_buddies, :extend => :public do |t|
+          t.add :age
+        end
+
+        User.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
+  end
+end

data/spec/models/base/methods_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "calling a method in the api template", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+      @response = @luke.as_api_response(:only_full_name)
+    end
+
+    after(:each) do
+      clean_up
+    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 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
+end

data/spec/models/base/renaming_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "renaming", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+    end
+
+    after(:each) do
+      clean_up
+    end
+
+    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).key
+      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).key
+      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
+end

data/spec/models/base/simple_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe ActsAsApi::Base do
+
+  describe "listing attributes in the api template", :orm => :active_record do
+
+    before(:each) do
+      setup_models
+      @response = @luke.as_api_response(:name_only)
+    end
+
+    after(:each) do
+      clean_up
+    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
+end