Changeset 558

Timestamp:

06/17/08 10:36:32 (2 months ago)

Author:

mahlon

Message:

• Added manual page for higher-level "cookbook-y" type stuff.
  
• End-to-end completion of related resource additions. (Recursive
  storage for appended resources, DefaultHandler? support.)
  
• Remove 'appended' related resources when performing an update (PUT).
  
• Minor prep work (in the form of comments) for the removal of bodykey
  stuff.
  

Files:

• thingfish/branches/mp3-jukebox/docs/manual/src/Developers_Guide/cookbook.page (added)
• thingfish/branches/mp3-jukebox/docs/manual/src/Developers_Guide/index.page (modified) (1 diff)
• thingfish/branches/mp3-jukebox/docs/manual/src/Hackers_Guide/writing-filestores.page (modified) (1 diff)
• thingfish/branches/mp3-jukebox/docs/manual/src/Hackers_Guide/writing-filters.page (modified) (3 diffs)
• thingfish/branches/mp3-jukebox/lib/thingfish/daemon.rb (modified) (1 diff)
• thingfish/branches/mp3-jukebox/lib/thingfish/handler/default.rb (modified) (2 diffs)
• thingfish/branches/mp3-jukebox/lib/thingfish/request.rb (modified) (5 diffs)
• thingfish/branches/mp3-jukebox/plugins/thingfish-handler-mp3jukebox/resources/static/js/singfish.js (modified) (1 prop)
• thingfish/branches/mp3-jukebox/spec/thingfish/daemon_spec.rb (modified) (1 diff)
• thingfish/branches/mp3-jukebox/spec/thingfish/handler/default_spec.rb (modified) (8 diffs)
• thingfish/branches/mp3-jukebox/utils.rb (modified) (1 diff)

thingfish/branches/mp3-jukebox/docs/manual/src/Developers_Guide/index.page

@@ -15 +15 @@
-* <?link The Javascript Client Library ?>
-* <?link Writing Your Own Client Library ?>
+* <?link ThingFish Usage Cookbook ?>

thingfish/branches/mp3-jukebox/docs/manual/src/Hackers_Guide/writing-filestores.page

@@ -11 +11 @@
-h2. <%= page.config['title'] %>
-
-
+
+
+
+
+
+
+
+
+
-
-
+
+

thingfish/branches/mp3-jukebox/docs/manual/src/Hackers_Guide/writing-filters.page

@@ -60 +60 @@
-| 5 | Import some useful constants, like the @HTTP::OK@ a little further down |
-| 8 | Actions are defined in special methods that match the naming convention
-<C2><AB>METHOD<C2><BB>
+«METHOD»
-These special methods receive a @ThingFish::Request@@ and a @ThingFish::Response@ object 
-to fiddle with as you see fit. |
@@ -67 +67 @@
-to the client. |
-| 10 | Set the content type of the response. |
- <E2><80><93>
+;
-the content we want, setting this to @OK@ stops further processing, and lets the response 
-through successfully. |
@@ -86 +86 @@
-
-
+h3. Appending Related Resources
-
+(Describe how to append things like thumbnails, previews, etc.)
-

thingfish/branches/mp3-jukebox/lib/thingfish/daemon.rb

@@ -234 +234 @@
-        return uuid
-    end
+    
+    
+    ### Recursively store all resources in the specified +request+ that are related to +body+.
+    ### Use the specified +uuid+ for the 'related_to' metadata value.
+    def store_related_resources( body, uuid, request )
+        request.related_resources[ body ].each do |related_resource, related_metadata|
+            related_metadata[ :related_to ] = uuid
+            metadata = request.metadata[related_resource].merge( related_metadata )
+
+            subuuid = self.store_resource( related_resource, metadata )
+            self.store_related_resources( related_resource, subuuid, request )
+        end
+    rescue => err
+        self.log.error "%s while storing related resource: %s" % [ err.class.name, err.message ]
+        self.log.debug "Backtrace: %s" % [ err.backtrace.join("\n  ") ]
+    end
+    
+    
+    ### Remove any resources that have a +related_to+ of the given UUID, and a +relation+ of 
+    ### 'appended'.
+    def purge_related_resources( uuid )
+        uuids = @metastore.find_by_exact_properties( :related_to => uuid.to_s, :relation => 'appended' )
+        uuids.each do |subuuid|
+            self.log.debug "purging appended resource %s for %s" % [ subuuid, uuid ]
+            @metastore.delete_resource( subuuid )
+            @filestore.delete( subuuid )
+        end
+    end
+    
-    
-

thingfish/branches/mp3-jukebox/lib/thingfish/handler/default.rb

@@ -245 +245 @@
-        uuid = nil
-        
+        # Store the primary resource
-        body, metadata = request.get_body_and_metadata
-        uuid = self.daemon.store_resource( body, metadata )
+    
+        # Store any related resources, linked to the primary
+        self.daemon.store_related_resources( body, uuid, request )
-
-        response.status = HTTP::CREATED
@@ -267 +271 @@
-        body, metadata = request.get_body_and_metadata
-        self.daemon.store_resource( body, metadata, uuid )
+        
+        # Purge any old related resources, then store any new ones linked to the primary
+        self.daemon.purge_related_resources( uuid )
+        self.daemon.store_related_resources( body, uuid, request )
-        
-        response.content_type = RUBY_MIMETYPE

thingfish/branches/mp3-jukebox/lib/thingfish/request.rb

@@ -314 +314 @@
-        end
-
+        related_bodykey = self.make_body_key( related_body )
+        @body_key_mapping[ related_bodykey ] = related_body
+
-        related_metadata[:relation] ||= 'appended'
-        related_bodykey = self.make_body_key( related_body )
-        self.metadata[ related_body ] = {}
-        @body_key_mapping[ related_bodykey ] = related_body
-        self.related_resources[ original_body ][ related_body ] = related_metadata
-    end
@@ -324 +324 @@
-    ### Append the specified additional +metadata+ for the given +resource+, which should be one
-    ### of the entity bodies yielded by #each_body
+    ###
+    ### TODO: Do we need this method after bodykey removal?
+    ###
-    def append_metadata_for( resource, metadata )
-        # Convert the body to the key of the related resources hash
@@ -385 +388 @@
-            hash.each do |body, _|
-                if body.closed?
+                    
+                    # TODO asap:  :)
+                    # substitute body for a fresh and clean filehandle,
+                    # since filehandle closure has been such a poopy problem
+                    # in the past.  this will remove the need for bodykeys, as well.
+                    
-                    self.log.warn "Entity body closed: %p" % [ body ]
-                    body.open 
-                end
+                
-                body.rewind
-            end
@@ -536 +546 @@
-        return @entity_bodies
-    end
-
+
-
-    ### For each resource => metadata pair returned by the current +iterator+, merge the
@@ -550 +560 @@
-            body_metadata[ :format ] ||= DEFAULT_CONTENT_TYPE
-            extracted_metadata = self.metadata[body] || {}
-
+
-            # Content metadata is determined per-multipart section
-            merged = extracted_metadata.merge( @form_metadata )

thingfish/branches/mp3-jukebox/spec/thingfish/daemon_spec.rb

@@ -699 +699 @@
-            
-            
+            it "knows how to store related resources" do
+                related_body = mock( "related body IO" )
+                request = mock( "request object" )
+                extracted_metadata = { 'stuff' => 'do good vote charlie' }
+                related_metadata = { 'format' => 'image/png' }
+
+                request.should_receive( :related_resources ).
+                    at_least( :once ).
+                    and_return({ :body => { related_body => related_metadata } })
+                request.should_receive( :metadata ).
+                    and_return({ related_body => extracted_metadata })
+
+                metadata = extracted_metadata.merge( related_metadata )
+                metadata[ :related_to ] = TEST_UUID
+                
+                @daemon.should_receive( :store_resource ).with( related_body, metadata )
+        
+                @daemon.store_related_resources( :body, TEST_UUID, request )
+            end
+
+    
+            it "knows how to purge related resources" do
+                filestore = mock( "filestore", :null_object => true )
+                @daemon.instance_variable_set( :@filestore, filestore )
+                metastore = mock( "metastore", :null_object => true )
+                @daemon.instance_variable_set( :@metastore, metastore )
+                
+                search_criteria = {
+                    :related_to => TEST_UUID,
+                    :relation   => 'appended'
+                }
+                metastore.should_receive( :find_by_exact_properties ).
+                    with( search_criteria ).
+                    and_return( [ TEST_UUID2, TEST_UUID3 ])
+
+                metastore.should_receive( :delete_resource ).with( TEST_UUID2 )
+                metastore.should_receive( :delete_resource ).with( TEST_UUID3 )
+                filestore.should_receive( :delete ).with( TEST_UUID2 )
+                filestore.should_receive( :delete ).with( TEST_UUID3 )
+                
+                @daemon.purge_related_resources( TEST_UUID )                
+            end
+            
+            
+            it "doesn't propagate errors that occur while storing a related resource" do
+                related_body = mock( "related body IO" )
+                request = mock( "request object" )
+                extracted_metadata = { 'stuff' => 'do good vote charlie' }
+                related_metadata = { 'format' => 'image/png' }
+
+                request.should_receive( :related_resources ).
+                    at_least( :once ).
+                    and_return({ :body => { related_body => related_metadata } })
+                request.should_receive( :metadata ).
+                    and_return({ related_body => extracted_metadata })
+
+                metadata = extracted_metadata.merge( related_metadata )
+                metadata[ :related_to ] = TEST_UUID
+                
+                @daemon.should_receive( :store_resource ).
+                    and_raise( ThingFish::FileStoreQuotaError.new("centipede-infested") )
+        
+                lambda {
+                    @daemon.store_related_resources( :body, TEST_UUID, request )
+                }.should_not raise_error()
+            end
+            
+            
-            it "removes spoolfiles on successful uploads" do
-                filestore = mock( "filestore", :null_object => true )

thingfish/branches/mp3-jukebox/spec/thingfish/handler/default_spec.rb

@@ -50 +50 @@
-        resdir = Pathname.new( __FILE__ ).expand_path.dirname.parent.parent + 'var/www'
-        @handler          = ThingFish::DefaultHandler.new( 'resource_dir' => resdir )
-listener
+daemon  
-        @filestore        = mock( "thingfish filestore", :null_object => true )
-        @metastore        = mock( "thingfish metastore", :null_object => true )
@@ -58 +58 @@
-        @mockmetadata.stub!( :modified ).and_return('Wed Aug 29 21:24:09 -0700 2007')
-
-listener
-listener
-listener
+daemon
+daemon
+daemon
-
-        @request          = mock( "request", :null_object => true )
@@ -83 +83 @@
-        @request.should_receive( :uri ).at_least( :once ).and_return( uri )
-
-listener
+daemon
-        @response.should_receive( :body= ).with( an_instance_of(Hash) )
-        @response.should_receive( :content_type= ).with( RUBY_MIMETYPE )
@@ -120 +120 @@
-        @response.should_receive( :content_type= ).with( RUBY_MIMETYPE )
-        
-listener
+daemon
-            with( body, metadata ).
-            and_return( TEST_UUID )
+        @daemon.should_receive( :store_related_resources ).
+            with( body, TEST_UUID, @request )
-
-        @handler.handle_post_request( @request, @response )
@@ -136 +138 @@
-        
-        @request.should_receive( :get_body_and_metadata ).and_return([ body, md ])
-listener
+daemon
-            with( body, md ).
-            and_return { raise ThingFish::FileStoreQuotaError, "too NARROW, sucka!" }
@@ -392 +394 @@
-
-        @request.should_receive( :get_body_and_metadata ).once.and_return([ io, {} ])
-listener
+daemon
-            with( io, an_instance_of(Hash), TEST_UUID_OBJ ).
-            and_return( TEST_CHECKSUM )
-
+
+
+
-        @response.should_receive( :status= ).with( HTTP::OK )
-
@@ -413 +417 @@
-
-        @request.should_receive( :get_body_and_metadata ).and_return([ io, {} ])
-listener
+daemon
-            with( io, an_instance_of(Hash), TEST_UUID_OBJ ).
-            and_return( TEST_CHECKSUM )
+    
+        @daemon.should_receive( :purge_related_resources ).with( TEST_UUID_OBJ )
-            
-        @response.should_receive( :status= ).with( HTTP::CREATED )
@@ -432 +438 @@
-
-        @request.should_receive( :get_body_and_metadata ).and_return([ body, md ])
-listener
+daemon
-            with( body, md, TEST_UUID_OBJ ).
-            and_return { raise ThingFish::FileStoreQuotaError, "too large, sucka!" }

thingfish/branches/mp3-jukebox/utils.rb

@@ -1 +1 @@
-#
-Install
+Whatever
-#   $Id$
-#