acts_as_api 0.3.1 → 0.3.2

data/README.rdoc

@@ -2,22 +2,35 @@
 
 acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.
 
+It provides a simple interface to determine the representation of your model data, that should be rendered in your API responses.
+
+In addition to Rails it theoretically can be used with any ruby app and any database as it only has few dependencies.
+
 == Introduction
 
-acts_as_api enriches the models and controllers of your app in a rails-like way so you can easily determine how your API responses should look like:
+acts_as_api enriches the models and controllers of your app in a Rails-like way so you can easily determine how your API responses should look like:
 
     class User < ActiveRecord::Base
 
       acts_as_api
 
-      api_accessible :name_only do |template|
+      api_accessible :public do |template|
+        template.add :first_name
+        template.add :age        
+      end
+
+      api_accessible :private do |template|
         template.add :first_name
         template.add :last_name
+        template.add :age
+        template.add :birthday                
       end
 
     end
 
 
+== Getting started
+
 A nice introduction about acts_as_api with examples can be found here:
 
 http://fabrik42.github.com/acts_as_api
@@ -30,7 +43,7 @@ http://fabrik42.github.com/acts_as_api
 * XML, JSON and JSON-P support out of the  box, easy to extend
 * Minimal dependecies (you can also use it without Rails)
 * Does not rely on ActiveRecord (can be used with other ORMs like Mongoid)
-* Supports multiple api rendering templates for a models. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.
+* Supports multiple api rendering templates per model. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.
 
 === Requirements:
 
@@ -40,13 +53,13 @@ http://fabrik42.github.com/acts_as_api
 
 === Links
 
-* Introduction: http://fabrik42.github.com/acts_as_api/
+* Introduction: http://fabrik42.github.com/acts_as_api
 
 * Docs: http://rdoc.info/projects/fabrik42/acts_as_api
 
 * Found a bug? http://github.com/fabrik42/acts_as_api/issues
 
-* Wiki: https://github.com/fabrik42/acts_as_api/wiki/
+* Wiki: https://github.com/fabrik42/acts_as_api/wiki
 
 === Downwards Compatibility
 

data/Rakefile

@@ -17,4 +17,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-#bundle exec rocco examples/introduction/intro.rb -t examples/introduction/intro.mustache
+#bundle exec rocco examples/introduction/index.rb -t examples/introduction/layout.mustache

data/examples/introduction/index.html

@@ -287,17 +287,17 @@ provides you some tools to customize your API responses.</p>
 <p>You can do basically anything:</p>
 
 <ul>
-<li>Include attributes and all other kinds of methods of your model</li>
-<li>Include child associations (if they also act_as_api this will be considered)</li>
-<li>Include lambdas and Procs</li>
-<li>Call methods of a parent association</li>
-<li>Call scopes of your model or child associations</li>
-<li>Rename attributes, methods, associations</li>
-<li>Create your own hierarchies</li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Include attributes and all other kinds of methods of your model</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Including-a-child-association">Include child associations (if they also act_as_api this will be considered)</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-lambda-in-the-api-template">Include lambdas and Procs</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Call methods of a parent association</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-scope-of-a-sub-resource">Call scopes of your model or child associations</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Renaming-an-attribute">Rename attributes, methods, associations</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Creating-a-completely-different-response-structure">Create your own hierarchies</a></li>
 </ul>
 
 
-<p>You can find advanced examples in the <a href="https://github.com/fabrik42/acts_as_api/wiki/">Github Wiki</a></p>
+<p>You can find more advanced examples in the <a href="https://github.com/fabrik42/acts_as_api/wiki/">Github Wiki</a></p>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>

data/examples/introduction/index.rb

@@ -97,17 +97,24 @@ end
 #
 # You can do basically anything:
 # 
-# * Include attributes and all other kinds of methods of your model
-# * Include child associations (if they also act_as_api this will be considered)
-# * Include lambdas and Procs
-# * Call methods of a parent association
-# * Call scopes of your model or child associations
-# * Rename attributes, methods, associations
-# * Create your own hierarchies
+# * [Include attributes and all other kinds of methods of your model][w1]
+# * [Include child associations (if they also act_as_api this will be considered)][w2]
+# * [Include lambdas and Procs][w3]
+# * [Call methods of a parent association][w4]
+# * [Call scopes of your model or child associations][w5]
+# * [Rename attributes, methods, associations][w6]
+# * [Create your own hierarchies][w7]
 #
-# You can find advanced examples in the [Github Wiki][wi]
+# You can find more advanced examples in the [Github Wiki][wi]
 #
 #  [wi]: https://github.com/fabrik42/acts_as_api/wiki/
+#  [w1]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model
+#  [w2]: https://github.com/fabrik42/acts_as_api/wiki/Including-a-child-association
+#  [w3]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-lambda-in-the-api-template
+#  [w4]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model
+#  [w5]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-scope-of-a-sub-resource
+#  [w6]: https://github.com/fabrik42/acts_as_api/wiki/Renaming-an-attribute
+#  [w7]: https://github.com/fabrik42/acts_as_api/wiki/Creating-a-completely-different-response-structure
 
 # ***
 

data/lib/acts_as_api/base.rb

@@ -64,6 +64,8 @@ module ActsAsApi
       def as_api_response(api_template)
         api_attributes = self.class.api_accessible_attributes(api_template)
 
+        raise "acts_as_api template :#{api_template.to_s} was not found for model #{self.class}" if api_attributes.nil?
+
         api_output = {}
 
         return api_output if api_attributes.nil?

data/lib/acts_as_api/version.rb

@@ -1,4 +1,4 @@
 module ActsAsApi
   
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/controllers/users_controller_spec.rb

@@ -108,6 +108,33 @@ describe UsersController, :orm => :active_record do
       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).key        
+        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    
 
   end
 

data/spec/models/base_spec.rb

@@ -67,6 +67,14 @@ describe "acts_as_api", :orm => :active_record do
     
     end
     
+    describe "trying to render an api template that is not defined" do
+      
+      it "should raise an descriptive error" do
+        lambda{ @luke.as_api_response(:does_not_exist) }.should raise_error(RuntimeError)
+      end
+      
+    end
+    
     describe "calling a method in the api template" do
     
       before(:each) do
@@ -407,7 +415,70 @@ describe "acts_as_api", :orm => :active_record do
         @response[:tasks].should eql task_hash
       end
     
-    end        
+    end
+    
+    describe "handling nil values in associations" 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 "should return a hash" do
+          @response.should be_kind_of(Hash)
+        end
+    
+        it "should return the correct number of keys" do
+          @response.should have(1).key
+        end
+    
+        it "should return all specified fields" do
+          @response.keys.should include(:tasks)
+        end
+    
+        it "should return the correct values for the specified fields" do
+          @response[:tasks].should be_kind_of(Array)
+        end
+    
+        it "should contain the associated child models with the determined api template" 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 "should return a hash" do
+          @response.should be_kind_of(Hash)
+        end
+        
+        it "should return the correct number of keys" do
+          @response.should have(1).key
+        end
+        
+        it "should return all specified fields" do
+          @response.keys.should include(:profile)
+        end
+        
+        it "should return the correct values for the specified fields" do
+          @response[:profile].should be_nil
+        end
+      end
+    end
     
     describe "including a scoped association in the api template" do
     
@@ -528,5 +599,37 @@ describe "acts_as_api", :orm => :active_record do
     end
 
   end
+  
+  describe "creating a sub hash in the api template using a method" do
+
+    before(:each) do
+      @response = @luke.as_api_response(:nested_sub_hash)      
+    end
+
+    it "should return a hash" do
+      @response.should be_kind_of(Hash)
+    end
+
+    it "should return the correct number of keys" do
+      @response.should have(1).key
+    end
+
+    it "should return all specified fields" do
+      @response.keys.should include(:sub_hash)
+    end
+
+    it "should provide the correct number of sub nodes" do
+      @response[:sub_hash].should have(2).keys
+    end
+    
+    it "should provide the correct sub nodes" do
+      @response[:sub_hash].keys.should include(:foo, :hello)
+    end
+    
+    it "should provide the correct values in its sub nodes" do
+      @response[:sub_hash].values.should include("bar", "world")
+    end    
+
+  end  
 
 end

data/spec/rails_app/app/models/user.rb

@@ -65,8 +65,11 @@ class User < ActiveRecord::Base
   
   api_accessible :nested_sub_node do |t| 
     t.add Hash[:foo, Hash[:bar, :last_name]], :as => :sub_nodes
-  end  
+  end
     
+  api_accessible :nested_sub_hash do |t| 
+    t.add :sub_hash
+  end
 
   def full_name
     '' << first_name.to_s << ' ' << last_name.to_s
@@ -75,5 +78,12 @@ class User < ActiveRecord::Base
   def say_something
     "something"
   end
+  
+  def sub_hash
+    {
+      :foo => "bar",
+      :hello => "world"
+    }
+  end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_api
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - "Christian B\xC3\xA4uerlein"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 +02:00
+date: 2011-04-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency