acts_as_api 0.3.3 → 0.3.4

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.3.4 2011-04-26
+
+* Fixed a bug concerning the inheritance of sub templates/additional options
+
 === 0.3.3 2011-04-24
 
 * Added support for :if and :unless options

data/lib/acts_as_api.rb

@@ -6,6 +6,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   
 require "acts_as_api/array"
 require "acts_as_api/rails_renderer"
+require "acts_as_api/exceptions"
 
 # acts_as_api is a gem that aims to make the construction of JSON and XML
 # responses in rails 3 easy and fun.

data/lib/acts_as_api/api_template.rb

@@ -2,15 +2,17 @@ module ActsAsApi
   # Represents an api template for a model.
   # This class should not be initiated by yourself, api templates
   # are created by defining them in the model by calling: +api_accessible+.
-  # 
+  #
   # The api template is configured in the block passed to +api_accessible+.
-  # 
+  #
   # Please note that +ApiTemplate+ inherits from +Hash+ so you can use all
   # kind of +Hash+ and +Enumerable+ methods to manipulate the template.
   class ApiTemplate < Hash
 
     # The name of the api template as a Symbol.
     attr_accessor :api_template
+    
+    attr_reader :options
 
     # Returns a new ApiTemplate with the api template name
     # set to the passed template.
@@ -20,7 +22,16 @@ module ActsAsApi
       return t
     end
 
-    # Adds an item to the api template
+    def initialize
+      @options ||= {}
+    end
+
+    def merge!(other_hash, &block)
+      super
+      self.options.merge!(other_hash.options) if other_hash.respond_to?(:options)
+    end
+
+    # Adds a field to the api template
     #
     # The value passed can be one of the following:
     #  * Symbol - the method with the same name will be called on the model when rendering.
@@ -35,42 +46,43 @@ module ActsAsApi
 
       self[item_key] = val
 
-      @options ||= {}
       @options[item_key] = options
     end
 
-    # Removes an item from the template
-    def remove(item)
-      self.delete(item)
+    # Removes a field from the template
+    def remove(field)
+      self.delete(field)
     end
 
-    # Returns the options of an item in the api template
-    def options_for(item)
-      @options[item]
+    # Returns the options of a field in the api template
+    def options_for(field)
+      @options[field]
     end
 
-    # Returns the passed option of an item in the api template
-    def option_for(item, option)
-      @options[item][option] if @options[item]
+    # Returns the passed option of a field in the api template
+    def option_for(field, option)
+      @options[field][option] if @options[field]
     end
-    
+
     # If a special template name for the passed item is specified
     # it will be returned, if not the original api template.
-    def api_template_for(parent, item)
-      return api_template unless parent.is_a? ActsAsApi::ApiTemplate
-      parent.option_for(item, :template) || api_template
+    def api_template_for(fieldset, field)
+      return api_template unless fieldset.is_a? ActsAsApi::ApiTemplate
+      fieldset.option_for(field, :template) || api_template
     end
-    
+
     # Decides if the passed item should be added to
-    # the response.
-    def allowed_to_render?(parent, item, model)
-      return true unless parent.is_a? ActsAsApi::ApiTemplate
+    # the response based on the conditional options passed.
+    def allowed_to_render?(fieldset, field, model)
+      return true unless fieldset.is_a? ActsAsApi::ApiTemplate
       allowed = true
-      allowed = condition_fulfilled?(model, parent.option_for(item, :if)) if parent.option_for(item, :if)
-      allowed = !(condition_fulfilled?(model, parent.option_for(item, :unless))) if parent.option_for(item, :unless)
+      allowed = condition_fulfilled?(model, fieldset.option_for(field, :if)) if fieldset.option_for(field, :if)
+      allowed = !(condition_fulfilled?(model, fieldset.option_for(field, :unless))) if fieldset.option_for(field, :unless)
       return allowed
     end
-    
+
+    # Checks if a condition is fulfilled
+    # (result is not nil or false)
     def condition_fulfilled?(model, condition)
       case condition
       when Symbol
@@ -86,48 +98,51 @@ module ActsAsApi
     def to_response_hash(model)
       queue = []
       api_output = {}
-      queue << { :parent =>  api_output, :item => self }
+      
+      queue << { :output =>  api_output, :item => self }
 
       until queue.empty? do
-          leaf = queue.pop
-
-          leaf[:item].each do |k,v|
+        leaf = queue.pop
+        fieldset = leaf[:item]
+                
+        fieldset.each do |field, value|
 
-            next unless allowed_to_render?(leaf[:item], k, model)
+          next unless allowed_to_render?(fieldset, field, model)
 
-            case v
-            when Symbol
-              if model.respond_to?(v)
-                out = model.send v
-              end
-
-            when Proc
-              out = v.call(model)
+          case value
+          when Symbol
+            if model.respond_to?(value)
+              out = model.send value
+            end
 
-            when String
-              # go up the call chain
-              out = model
-              v.split(".").each do |method|
-                out = out.send(method.to_sym)
-              end
+          when Proc
+            out = value.call(model)
 
-            when Hash
-              leaf[:parent][k] ||= {}
-              queue << { :parent =>  leaf[:parent][k], :item => v}
-              next
+          when String
+            # go up the call chain
+            out = model
+            value.split(".").each do |method|
+              out = out.send(method.to_sym)
             end
 
-            if out.respond_to?(:as_api_response)
-              sub_template = api_template_for(leaf[:item], k)
-              out = out.send(:as_api_response, sub_template)
-            end
+          when Hash
+            leaf[:output][field] ||= {}
+            queue << { :output =>  leaf[:output][field], :item => value }
+            next
+          end
 
-            leaf[:parent][k] = out
+          if out.respond_to?(:as_api_response)
+            sub_template = api_template_for(fieldset, field)
+            out = out.send(:as_api_response, sub_template)
           end
-        end
 
-        api_output
+          leaf[:output][field] = out
+        end
+        
       end
-
+      
+      api_output
     end
+    
   end
+end

data/lib/acts_as_api/base.rb

@@ -58,7 +58,7 @@ 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?
+        raise ActsAsApi::TemplateNotFoundError.new("acts_as_api template :#{api_template.to_s} was not found for model #{self.class}") if api_attributes.nil?
         
         api_attributes.to_response_hash(self)
       end

data/lib/acts_as_api/exceptions.rb

@@ -0,0 +1,4 @@
+module ActsAsApi
+  class ActsAsApiError < RuntimeError; end
+  class TemplateNotFoundError < ActsAsApiError; end  
+end

data/lib/acts_as_api/version.rb

@@ -1,3 +1,3 @@
 module ActsAsApi
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/spec/models/base/extending_spec.rb

@@ -70,5 +70,56 @@ describe ActsAsApi::Base do
       end
 
     end
+
+    describe "and inherit a field using another template name", :meow => true do
+
+      before(:each) do
+        Task.acts_as_api
+        Task.api_accessible :other_template do |t|
+          t.add :description
+          t.add :time_spent
+        end
+        User.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
 end

data/spec/models/base/undefined_spec.rb

@@ -13,7 +13,7 @@ describe ActsAsApi::Base do
     end
 
     it "raises an descriptive error" do
-      lambda{ @luke.as_api_response(:does_not_exist) }.should raise_error(RuntimeError)
+      lambda{ @luke.as_api_response(:does_not_exist) }.should raise_error(ActsAsApi::TemplateNotFoundError)
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_api
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - "Christian B\xC3\xA4uerlein"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-24 00:00:00 +02:00
+date: 2011-04-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,7 @@ files:
 - lib/acts_as_api/array.rb
 - lib/acts_as_api/base.rb
 - lib/acts_as_api/config.rb
+- lib/acts_as_api/exceptions.rb
 - lib/acts_as_api/rails_renderer.rb
 - lib/acts_as_api/rendering.rb
 - lib/acts_as_api/version.rb