purzelrakete-restful 0.2.10 → 0.2.11

data/CHANGES.markdown

@@ -6,3 +6,7 @@
 
 * fixed issue where configurations where overwriting each other. 
 * added hash#to_restful
+
+19. Aug 2009 - 0.2.11
+
+* added ability to publish :wallet-restful-url (explicitly collapsed)

data/README.markdown

@@ -33,6 +33,9 @@ restful_publish :name, :pets, :wallet => :contents, :restful_options => { :expan
 restful_publish :name, :pets, :restful_options => { :collapsed => :pets } # collapsed pets, even though they are on the second level. 
 restful_publish :name, :pets, :restful_options => { :force_expanded => [:pets, :wallet] }
 
+## explicitly collapsed
+restful_options :wallet-restful-url
+
 # Pet
 restful_publish :name, :person # expands person per default because it is on the second level. Does not expand person.pets.first.person, since this is higher than second level.
 

data/lib/restful/converters/active_record.rb

@@ -15,6 +15,10 @@ module Restful
             :url => model.restful_url
         })
         
+        explicit_links = config.whitelisted.select { |x| x.class == Symbol && x.to_s.ends_with?("_restful_url") }
+        explicit_links.each { |link| config.whitelisted.delete(link) }
+        explicit_links.map! { |link| link.to_s.chomp("_restful_url").to_sym  }
+        
         # simple attributes
         resource.values += Restful::Rails.tools.simple_attributes_on(model).map do |key, value|
           convert_to_simple_attribute(key, value, config, published, model)
@@ -22,31 +26,27 @@ module Restful
         
         # has_many, has_one
         resource.values += model.class.reflections.keys.map do |key|
-          if config.published?(key.to_sym)
+          explicit_link = !!explicit_links.include?(key)
+
+          if config.published?(key.to_sym) || explicit_link
             
-            # grab the associated resource(s) and run them through conversion
             nested_config = config.nested(key.to_sym)
             published << key.to_sym
             
-            if model.class.reflections[key].macro == :has_many && !nested
+            if has_many?(model, key) && !nested
               convert_to_collection(model, key, nested_config, published) do |key, resources, extended_type|
                 Restful.collection(key, resources, extended_type)
               end
-            elsif model.class.reflections[key].macro == :has_one or model.class.reflections[key].macro == :belongs_to
+            elsif has_one?(model, key) or belongs_to?(model, key)
 
-              if(config.expanded?(key, nested)) 
+              if config.expanded?(key, nested) && !explicit_link
                 convert_to_collection(model, key, nested_config, published) do |key, resources, extended_type|
                   returning(resources.first) do |res|
                     res.name = key
                   end
                 end
               else
-          
-                value = model.send(key)
-                restful_path = value ? value.restful_path : nil
-                basename = value ? Restful::Rails.api_hostname : nil
-                
-                Restful.link("#{ key }-restful-url", basename, restful_path, compute_extended_type(model, key))
+                link_to(model, key)
               end
             end
           end
@@ -54,7 +54,9 @@ module Restful
 
         # Links
         if model.class.apiable_association_table
+          
           resource.values += model.class.apiable_association_table.keys.map do |key|
+                        
             if config.published?(key.to_sym)
               published << key.to_sym
               base, path = model.resolve_association_restful_url(key)
@@ -65,17 +67,20 @@ module Restful
         
         # public methods
         resource.values += (model.public_methods - Restful::Rails.tools.simple_attributes_on(model).keys.map(&:to_s)).map do |method_name|
-          if config.published?(method_name.to_sym) and not published.include?(method_name.to_sym)
+
+          explicit_link = !!explicit_links.include?(method_name.to_sym)          
+          
+          if (config.published?(method_name.to_sym) && !published.include?(method_name.to_sym)) || explicit_link
             value = model.send(method_name.to_sym)
               sanitized_method_name = method_name.tr("!?", "").tr("_", "-").to_sym
               
               if value.is_a? ::ActiveRecord::Base
-                if config.expanded?(method_name.to_sym, nested)
+                if config.expanded?(method_name.to_sym, nested) && !explicit_link
                   returning Restful::Rails.tools.expand(value, config.nested(method_name.to_sym)) do |expanded|
                     expanded.name = sanitized_method_name
                   end
                 else
-                  Restful.link("#{ sanitized_method_name }-restful-url", Restful::Rails.api_hostname, value ? value.restful_path : "", compute_extended_type(model, key))
+                  Restful.link("#{ sanitized_method_name }-restful-url", Restful::Rails.api_hostname, value ? value.restful_path : "", compute_extended_type(model, method_name.to_sym))
                 end
               else
                 Restful.attr(sanitized_method_name, value, compute_extended_type(model, method_name))
@@ -86,6 +91,26 @@ module Restful
         resource
       end
 
+      def self.has_one?(model, key)
+        macro(model, key) == :has_one
+      end
+      
+      def self.has_many?(model, key)
+        macro(model, key) == :has_many
+      end
+      
+      def self.belongs_to?(model, key)
+        macro(model, key) == :belongs_to
+      end
+
+      def self.link_to(model, key)
+        value = model.send(key)
+        restful_path = value ? value.restful_path : nil
+        basename = value ? Restful::Rails.api_hostname : nil
+        
+        Restful.link("#{ key }-restful-url", basename, restful_path, compute_extended_type(model, key))
+      end
+      
       def self.convert_to_simple_attribute(key, value, config,  published, model = nil)
         if config.published?(key.to_sym)
           published << key.to_sym
@@ -95,6 +120,10 @@ module Restful
       end
       
       private
+      
+        def self.macro(model, key)
+          model.class.reflections[key].macro
+        end
    
         def self.convert_to_collection(model, key, nested_config, published)
           if resources = Restful::Rails.tools.convert_collection_to_resources(model, key, nested_config)

data/restful.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "restful"
-  s.version = "0.2.10"
+  s.version = "0.2.11"
   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

@@ -17,6 +17,16 @@ context "active record converter" do
     reset_config
   end
   
+  specify "should publish link and not resource when :oldest_pet_restful_url, where oldest_pet is a defined method" do
+    Person.restful_publish(:oldest_pet_restful_url)  
+    @person.to_restful.links.should.not.be.empty
+  end
+  
+  specify "should publish link and not a nested resource with :wallet_restful_url" do
+    Person.restful_publish(:wallet_restful_url)  
+    @person.to_restful.links.should.not.be.empty
+  end
+  
   specify "should be able to force expansion. force expanded attributes can never be collapsed. " do
     Wallet.restful_publish(:contents)
     Person.restful_publish(:name, :wallet, :current_location, { :pets => [:name, :species], :restful_options => { :force_expand => :wallet } })

data/test/rails/restful_publish_test.rb

@@ -4,7 +4,7 @@ context "restful publish" do
   teardown do
     reset_config
   end
-   
+      
   specify "should result in a method .published?(:attr_key) return true for published attributes" do
     Pet.restful_publish(:person_id, :name) # person_id gets converted to a link automagically.
     

metadata

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