purzelrakete-restful 0.2.14 → 0.2.15

data/CHANGES.markdown

@@ -21,4 +21,8 @@
     
     * arrays names now use base_class of content models
     * restful_path defaults to using base_class in path
-    * if array responds to name, use this as collection name
+    * if array responds to name, use this as collection name
+
+  - 0.2.15
+
+    * :includes like active record to_xml to_json

data/lib/restful/rails/active_record/configuration.rb

@@ -4,6 +4,32 @@
 module Restful
   module Rails
     module ActiveRecord
+      module Utils
+        
+        def self.get_includes(config)
+          if config && config.is_a?(Hash) && config.keys.size == 1 && includes = config[:include] 
+            add_to_whitelist = [*includes].map { |el| el.is_a?(String) ? el.to_sym : el  }
+            return nil, add_to_whitelist
+          else
+            return config, []
+          end
+        end
+        
+        def self.convert_to_single_resource(config_parameter, el)
+          config = if config_parameter
+            returning Configuration::Config.new(config_parameter) do |c|
+              config, includes = Utils.get_includes(config_parameter)
+              c.whitelisted += el.class.restful_config.whitelisted unless config
+              c.whitelisted += includes unless includes.blank?
+            end
+          else
+            el.class.restful_config
+          end
+          
+          Restful::Converters::ActiveRecord.convert(el, config)
+        end  
+      end
+      
       module Configuration
         def self.included(base)
           base.send :class_inheritable_accessor, :restful_config
@@ -36,13 +62,7 @@ module Restful
           #  by passing in something like @pet.to_restful(:name, :species).
           #
           def to_restful(config_parameter = nil)
-            config = config_parameter
-            add_to_whitelist = []
-
-            if config && config.is_a?(Hash) && config.keys.size == 1 && includes = config[:include] 
-              add_to_whitelist = [*includes].map { |el| el.is_a?(String) ? el.to_sym : el  }
-              config = nil
-            end
+            config, add_to_whitelist = Utils.get_includes(config_parameter)
             
             config ||= self.class.restful_config.clone if self.class.respond_to?(:restful_config)
             config ||= []
@@ -73,7 +93,7 @@ module Restful
 
               elements = self.map do |el|
                 raise TypeError.new("Not all array elements respond to #to_restful. ") unless el.respond_to?(:to_restful)
-                Restful::Converters::ActiveRecord.convert(el, !config_parameter.nil? ? Config.new(config_parameter) : el.class.restful_config)
+                Utils.convert_to_single_resource(config_parameter, el)
               end
               
               returning Restful.collection(element_name, elements, :array) do |collection|
@@ -81,11 +101,12 @@ module Restful
               end
                         
             elsif self.is_a?(Hash)
+              
               elements = self.map do |k,v|
-                if v.respond_to?(:to_restful) and v.class.respond_to?(:restful_config)
-                  value = Restful::Converters::ActiveRecord.convert(v, !config_parameter.nil? ? Config.new(config_parameter) : v.class.restful_config)
+                value = if v.respond_to?(:to_restful) and v.class.respond_to?(:restful_config)
+                  Utils.convert_to_single_resource(config_parameter, v)
                 else
-                  value =  v.respond_to?(:to_restful) ? v.to_restful : v
+                  v.respond_to?(:to_restful) ? v.to_restful : v
                 end
                 Restful::ApiModel::Attribute.new(k, value, :map)
               end
@@ -97,7 +118,7 @@ module Restful
               Restful::Converters::ActiveRecord.convert(self, config)
             end
           end
-          
+                    
           # FIXME: read Restful::Serializers::Base.serializers. Load order problems?
           [:atom_like, :hash, :json, :params, :xml].each do |format|
             define_method("to_restful_#{ format }") do |*args|
@@ -149,7 +170,7 @@ module Restful
           end
 
           private
-          
+                    
             def split_into_whitelist_and_restful_options(array)
               options = {}
         

data/restful.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "restful"
-  s.version = "0.2.14"
+  s.version = "0.2.15"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Bornkessel", "Rany Keddo"] 
   s.date = "2009-08-11"

data/test/converters/active_record_converter_test.rb

@@ -131,5 +131,17 @@ context "active record converter" do
 
     xml_should_eql_fixture(@person.to_restful_xml(:wallet), "people", :joe_with_zwiebelleder)
   end
+
+  specify "should include attributes when include parameter is passed to to_restful" do
+    Person.restful_publish(:name)
+    Pet.restful_publish(:name)
+    
+    @person = Person.create
+    @pet = @person.pets.create(:name => "Mietze")
+
+    @pet.to_restful(:include => :owner).values.map(&:name).should.include :owner
+    Pet.restful_config.whitelisted.include?(:owner).should.equal false
+  end
   
-end
+end
+

data/test/converters/basic_types_converter_test.rb

@@ -66,4 +66,34 @@ context "basic types converter" do
     collection = people.to_restful
     collection.name.should.== "people"
   end
+end
+
+context "basic types converter :includes" do
+  
+  specify "should include extra attributes for hashes" do
+    Person.restful_publish(:name)
+    Pet.restful_publish(:name)
+    
+    @person = Person.create
+    @pet = @person.pets.create(:name => "Mietze")
+
+    map = { :pet => @pet }.to_restful(:include => :owner)
+    map.values.first.name.should.== :pet
+    map.values.first.value.values.map(&:name).should.include :owner
+    
+    Pet.restful_config.whitelisted.include?(:owner).should.equal false
+  end
+  
+  specify "should include extra attributes for arrays" do
+    Person.restful_publish(:name)
+    Pet.restful_publish(:name)
+    
+    @person = Person.create
+    @pet = @person.pets.create(:name => "Mietze")
+
+    collection = [@pet].to_restful(:include => :owner)
+    collection.value.first.values.map(&:name).should.include :owner
+    
+    Pet.restful_config.whitelisted.include?(:owner).should.equal false
+  end
 end

data/test/fixtures/people.json.yaml

@@ -91,4 +91,17 @@ hash_with_people:
         "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
         "name": "Joe Bloggs"
       }]
+    }
+
+hash_with_rich_person:
+  |
+    {
+      "person": {
+        "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+        "name": "Joe Bloggs", 
+        "wallet": {
+          "restful_url": "http://example.com:3000/wallets/<%= @person.wallet.to_param %>",
+          "contents": "<%= @person.wallet.contents %>"
+        }
+      }
     }

data/test/rails/restful_publish_test.rb

@@ -17,17 +17,6 @@ context "restful publish" do
     Person.restful_publish(:name, :pets => [:name, :species])
     Person.restful_config.restful_options.should.==({})
   end
-  
-  specify "should include attributes when publishe parameter is passed to to_restful" do
-    Person.restful_publish(:name)
-    Pet.restful_publish(:name)
-    
-    @person = Person.create
-    @pet = @person.pets.create(:name => "Mietze")
-
-    @pet.to_restful(:include => :owner).values.map(&:name).should.include :owner
-    Pet.restful_config.whitelisted.include?(:owner).should.equal false
-  end
 end
 
 context "api publishing with nesting" do

data/test/serializers/json_serializer_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 context "json serializer" do
-  
+
   setup do 
     Person.restful_publish(:name, :current_location, :pets, :wallet, :created_at)
     Pet.restful_publish(:name)
@@ -66,7 +66,7 @@ context "json serializer" do
   specify "should be able to serialize collections with total entries info" do
     pets = PaginatedCollection.new(@person.pets)
     pets.total_entries = 1001
-
+    
     json_should_eql_fixture(pets.to_restful_json, "pets", :pets_array_with_total_entries)
   end
   
@@ -79,4 +79,12 @@ context "json serializer" do
     Person.restful_publish(:name)
     json_should_eql_fixture({ "total_hits" => 2, "people" => [ @person, @person ] }.to_restful_json, "people", :hash_with_people)
   end
-end
+
+  specify 'should serialize a hash with include option correctly - the include option should be passed to the values' do
+    Person.restful_publish(:name)
+    Wallet.restful_publish(:contents)
+    
+    json = {:person => @person}.to_restful_json(:include => :wallet)
+    json_should_eql_fixture(json, "people", :hash_with_rich_person)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: purzelrakete-restful
 version: !ruby/object:Gem::Version 
-  version: 0.2.14
+  version: 0.2.15
 platform: ruby
 authors: 
 - Daniel Bornkessel