baccigalupi-aqua 0.1.4 → 0.1.5

data/doc/Time.html

@@ -68,12 +68,12 @@
           <pre class="lines">
 
 
-56
-57
-58</pre>
+59
+60
+61</pre>
         </td>
         <td>
-          <pre class="code"><span class="info file"># File 'lib/aqua/support/initializers.rb', line 56</span>
+          <pre class="code"><span class="info file"># File 'lib/aqua/support/initializers.rb', line 59</span>
 
 <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='aqua_init identifier id'>aqua_init</span><span class='lparen token'>(</span> <span class='init identifier id'>init</span> <span class='rparen token'>)</span>
   <span class='parse identifier id'>parse</span><span class='lparen token'>(</span> <span class='init identifier id'>init</span> <span class='rparen token'>)</span>
@@ -93,7 +93,7 @@
 </div>
     </div>
     <div id="yard_info">
-  Generated on Thursday, August 27 2009 at 05:50:24 PM by 
+  Generated on Monday, August 31 2009 at 03:23:22 PM by 
   <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr> 
   0.2.3.5 (ruby-1.8.6).
 </div>

data/doc/TrueClass.html

@@ -68,12 +68,12 @@
           <pre class="lines">
 
 
-38
-39
-40</pre>
+41
+42
+43</pre>
         </td>
         <td>
-          <pre class="code"><span class="info file"># File 'lib/aqua/support/initializers.rb', line 38</span>
+          <pre class="code"><span class="info file"># File 'lib/aqua/support/initializers.rb', line 41</span>
 
 <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='aqua_init identifier id'>aqua_init</span><span class='lparen token'>(</span> <span class='init identifier id'>init</span> <span class='rparen token'>)</span>
   <span class='true true kw'>true</span>
@@ -93,7 +93,7 @@
 </div>
     </div>
     <div id="yard_info">
-  Generated on Thursday, August 27 2009 at 05:50:20 PM by 
+  Generated on Monday, August 31 2009 at 03:23:17 PM by 
   <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr> 
   0.2.3.5 (ruby-1.8.6).
 </div>

data/doc/all-methods.html

@@ -211,6 +211,69 @@
           
         </li>
       
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#add-instance_method" title="#add">#add</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#add%21-instance_method" title="#add!">#add!</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#delete%21-instance_method" title="#delete!">#delete!</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#get-instance_method" title="#get">#get</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#get%21-instance_method" title="#get!">#get!</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#initialize-instance_method" title="#initialize">#initialize</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#update_doc_rev-instance_method" title="#update_doc_rev">#update_doc_rev</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#uri_for-instance_method" title="#uri_for">#uri_for</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/Attachments.html#validate_hash-class_method" title="validate_hash">validate_hash</a> 
+          
+            <em>(class Attachments)</em>
+          
+        </li>
+      
         <li nowrap="nowrap" class="">
           <a href="Aqua/Store/CouchDB/Database.html#add_to_bulk_cache-instance_method" title="#add_to_bulk_cache">#add_to_bulk_cache</a> 
           
@@ -295,6 +358,41 @@
           
         </li>
       
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/DesignDocument.html#initialize-instance_method" title="#initialize">#initialize</a> 
+          
+            <em>(class DesignDocument)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/DesignDocument.html#name-instance_method" title="#name">#name</a> 
+          
+            <em>(class DesignDocument)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/DesignDocument.html#name%3D-instance_method" title="#name=">#name=</a> 
+          
+            <em>(class DesignDocument)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/DesignDocument.html#update_version-instance_method" title="#update_version">#update_version</a> 
+          
+            <em>(class DesignDocument)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/DesignDocument.html#uri-instance_method" title="#uri">#uri</a> 
+          
+            <em>(class DesignDocument)</em>
+          
+        </li>
+      
         <li nowrap="nowrap" class="">
           <a href="Aqua/Store/CouchDB/Server.html#database-instance_method" title="#database">#database</a> 
           
@@ -407,6 +505,13 @@
           
         </li>
       
+        <li nowrap="nowrap" class="">
+          <a href="Aqua/Store/CouchDB/StorageMethods/InstanceMethods.html#attachments-instance_method" title="#attachments">#attachments</a> 
+          
+            <em>(module InstanceMethods)</em>
+          
+        </li>
+      
         <li nowrap="nowrap" class="">
           <a href="Aqua/Store/CouchDB/StorageMethods/InstanceMethods.html#commit-instance_method" title="#commit">#commit</a> 
           
@@ -806,6 +911,13 @@
           
         </li>
       
+        <li nowrap="nowrap" class="">
+          <a href="Range.html#aqua_init-class_method" title="aqua_init">aqua_init</a> 
+          
+            <em>(class Range)</em>
+          
+        </li>
+      
         <li nowrap="nowrap" class="">
           <a href="Rational.html#to_aqua_init-instance_method" title="#to_aqua_init">#to_aqua_init</a> 
           
@@ -911,6 +1023,20 @@
           
         </li>
       
+        <li nowrap="nowrap" class="">
+          <a href="Set.html#to_aqua-instance_method" title="#to_aqua">#to_aqua</a> 
+          
+            <em>(class Set)</em>
+          
+        </li>
+      
+        <li nowrap="nowrap" class="">
+          <a href="Set.html#to_aqua_init-instance_method" title="#to_aqua_init">#to_aqua_init</a> 
+          
+            <em>(class Set)</em>
+          
+        </li>
+      
         <li nowrap="nowrap" class="">
           <a href="Time.html#aqua_init-class_method" title="aqua_init">aqua_init</a> 
           

data/doc/all-namespaces.html

@@ -44,10 +44,14 @@
       
         <li class=""><a href="Aqua/Store/CouchDB.html" title="Aqua::Store::CouchDB">Aqua::Store::CouchDB</a> <em>(module)</em></li>
       
+        <li class=""><a href="Aqua/Store/CouchDB/Attachments.html" title="Aqua::Store::CouchDB::Attachments">Aqua::Store::CouchDB::Attachments</a> <em>(class)</em></li>
+      
         <li class=""><a href="Aqua/Store/CouchDB/Conflict.html" title="Aqua::Store::CouchDB::Conflict">Aqua::Store::CouchDB::Conflict</a> <em>(class)</em></li>
       
         <li class=""><a href="Aqua/Store/CouchDB/Database.html" title="Aqua::Store::CouchDB::Database">Aqua::Store::CouchDB::Database</a> <em>(class)</em></li>
       
+        <li class=""><a href="Aqua/Store/CouchDB/DesignDocument.html" title="Aqua::Store::CouchDB::DesignDocument">Aqua::Store::CouchDB::DesignDocument</a> <em>(class)</em></li>
+      
         <li class=""><a href="Aqua/Store/CouchDB/RequestFailed.html" title="Aqua::Store::CouchDB::RequestFailed">Aqua::Store::CouchDB::RequestFailed</a> <em>(class)</em></li>
       
         <li class=""><a href="Aqua/Store/CouchDB/RequestTimeout.html" title="Aqua::Store::CouchDB::RequestTimeout">Aqua::Store::CouchDB::RequestTimeout</a> <em>(class)</em></li>
@@ -94,12 +98,16 @@
       
         <li class=""><a href="OpenStruct.html" title="OpenStruct">OpenStruct</a> <em>(class)</em></li>
       
+        <li class=""><a href="Range.html" title="Range">Range</a> <em>(class)</em></li>
+      
         <li class=""><a href="Rational.html" title="Rational">Rational</a> <em>(class)</em></li>
       
         <li class=""><a href="RestAPI.html" title="RestAPI">RestAPI</a> <em>(module)</em></li>
       
         <li class=""><a href="RestClientAdapter.html" title="RestClientAdapter">RestClientAdapter</a> <em>(module)</em></li>
       
+        <li class=""><a href="Set.html" title="Set">Set</a> <em>(class)</em></li>
+      
         <li class=""><a href="Time.html" title="Time">Time</a> <em>(class)</em></li>
       
         <li class=""><a href="TrueClass.html" title="TrueClass">TrueClass</a> <em>(class)</em></li>

data/doc/top-level-namespace.html

@@ -16,7 +16,7 @@
       
     </div>
     <div id="yard_info">
-  Generated on Thursday, August 27 2009 at 05:50:25 PM by 
+  Generated on Monday, August 31 2009 at 03:23:22 PM by 
   <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr> 
   0.2.3.5 (ruby-1.8.6).
 </div>

data/lib/aqua/object/pack.rb

@@ -212,7 +212,7 @@ module Aqua::Pack
         index = self.__pack[:stubs].length 
         stub = { :class => obj.class.to_s, :id => obj } 
         # deal with cached methods
-        if obj._embed_me.keys && stub_methods = obj._embed_me[:stub]
+        if obj._embed_me && obj._embed_me.keys && stub_methods = obj._embed_me[:stub]
           stub[:methods] = {}
           if stub_methods.class == Symbol || stub_methods.class == String
             stub_method = stub_methods.to_sym 

data/lib/aqua/store/couch_db/attachments.rb

@@ -0,0 +1,152 @@
+require 'mime/types'
+require 'tempfile'
+
+module Aqua
+  module Store
+    module CouchDB 
+      # Attachments is a Hash-like container with keys that are attacment names and values that are file-type
+      # objects. Initializing and adding to the collection assures the types of both keys and values. The 
+      # collection implements a lazy-loading scheme, such that when an attachment is requested and not found,
+      # it will try to load it from CouchDB.
+      class Attachments < Mash
+        attr_reader :document
+        attr_reader :stub
+        
+        # Creates a new attachment collection with keys that are attachment names and values that are
+        # file-type objects. The collection manages both the key and the value types.
+        # 
+        # @param [String] Document uri; used to save and retrieve attachments directly
+        # @param [Hash] Initialization values
+        #
+        # @api public 
+        def initialize( doc, hash={} )
+          raise ArgumentError, "must be initialized with a document" unless doc.respond_to?( :retrieve ) 
+          @document = doc
+          self.class.validate_hash( hash ) unless hash.empty?
+          super( hash )
+        end  
+        
+        # Adds an attachment to the collection, checking for type. Does not add directly to the database.
+        #
+        # @param [String, Symbol] Name of the attachment as a string or symbol
+        # @param [File] The attachment
+        #
+        # @api public
+        def add( name, file )
+          self.class.validate_hash( name => file )
+          self[name] = file
+        end 
+        
+        # Adds an attachment to the collection and to the database. Document doesn't have to be saved, 
+        # but it does need to have an id.
+        #
+        # @param [String, Symbol] Name of the attachment as a string or symbol
+        # @param [File] The attachment
+        #
+        # @api public
+        def add!( name, file )
+          add( name, file )
+          content_type = MIME::Types.type_for(file.path) 
+          content_type = content_type.empty? ? 'text\/plain' : content_type
+          data = {
+            'content-type' => content_type,
+            'data'         => Base64.encode64( file.read ).gsub(/\s/,'') 
+          }
+          response = CouchDB.put( uri_for( name ), data )
+          update_doc_rev( response )
+          file
+        end  
+        
+        # Deletes an attachment from the collection, and from the database. Use #delete (from Hash) to just
+        # delete the attachment from the collection.
+        # 
+        # @param [String, Symbol] Name of the attachment as a string or symbol
+        # @return [File, nil] File at that location or nil if no file found
+        # 
+        # @api public
+        def delete!( name )
+          if self[name]
+            file = delete( name ) 
+            unless document.new?
+              CouchDB.delete( uri_for( name ) )
+            end 
+            file 
+          end  
+        end
+        
+        # Gets an attachment from the collection first. If not found, it will be requested from the database.
+        #
+        # @param [String, Symbol] Name of the attachment
+        # @return [File, nil] File for that name, or nil if not found in hash or in database
+        #
+        # @api public
+        def get( name, stream=false )
+          file = self[name] 
+          unless file
+            file = get!( name, stream )
+          end
+          file  
+        end  
+        
+        # Gets an attachment from the database. Stores it in the hash.
+        #
+        # @param [String, Symbol] Name of the attachment
+        # @param [true, false] Stream boolean flag indicating whether the data should be converted to 
+        #   a file or kept as a stream
+        # @return [File, nil] File for that name, or nil if not found in the database 
+        # @raise Any error encountered on retrieval of the attachment, json, http_client, Aqua etc
+        # 
+        # @todo make this more memory favorable, maybe streaming/saving in a max number of bytes
+        # @api public
+        def get!( name, stream=false ) 
+          file = nil
+          response = CouchDB.get( uri_for( name, false ) ) rescue nil
+          data = Base64.decode64( response['data'] ) if response 
+          if data
+            file = Tempfile.new( CGI.escape( name.to_s ) ) 
+            file.binmode if file.respond_to?( :binmode )
+            file.write( data )
+            file.rewind 
+            self[name] = file
+          end  
+          stream ? file.read : file
+        end  
+        
+        # Constructs the standalone attachment uri for PUT and DELETE actions.
+        # 
+        # @param [String] Name of the attachment as a string or symbol
+        # 
+        # @api private
+        def uri_for( name, include_rev = true )
+          raise ArgumentError, 'Document must have id in order to save an attachment' if document.id.nil? || document.id.empty?
+          document.uri + "/#{CGI.escape( name.to_s )}" + ( document.rev && include_rev ? "?rev=#{document.rev}" : "" )
+        end
+        
+        
+        # Validates and throws an error on a hash, insisting that the key is a string or symbol, 
+        # and the value is a file. 
+        #
+        # @param [Hash]
+        #
+        # @api private
+        def self.validate_hash( hash )
+          hash.each do |name, file|
+            raise ArgumentError, "Attachment name, #{name.inspect}, must be a Symbol or a String" unless [Symbol, String ].include?( name.class )
+            raise ArgumentError, "Attachment file, #{file.inspect}, must be a File-like object"  unless file.respond_to?( :read ) 
+          end  
+        end 
+        
+        # Goes into the document and updates it's rev to match the returned rev. That way #new? will return false
+        # when an attachment is created before the document is saved. It also means that future attempts to save 
+        # the doc won't fail with a conflict.
+        #
+        # @param [Hash] response from the put request
+        # @api private
+        def update_doc_rev( response )
+          document[:_rev] = response['rev']
+        end  
+         
+      end # Attachments
+    end # CouchDB
+  end # Store
+end # Aqua        

data/lib/aqua/store/couch_db/couch_db.rb

@@ -1,7 +1,9 @@
 require File.dirname(__FILE__) + '/http_client/rest_api'
 require File.dirname(__FILE__) + '/server'
 require File.dirname(__FILE__) + '/database'
+require File.dirname(__FILE__) + '/attachments'
 require File.dirname(__FILE__) + '/storage_methods'
+require File.dirname(__FILE__) + '/design_document'
 
 module Aqua
   module Store

data/lib/aqua/store/couch_db/database.rb

@@ -146,7 +146,7 @@ module Aqua
           CouchDB.delete( uri )
         end  
     
-        # # Query the <tt>_all_docs</tt> view. Accepts all the same arguments as view.
+        # # Query the <tt>documents</tt> view. Accepts all the same arguments as view.
         def documents(params = {})
           keys = params.delete(:keys)
           url = CouchDB.paramify_url( "#{uri}/_all_docs", params )

data/lib/aqua/store/couch_db/design_document.rb

@@ -0,0 +1,57 @@
+# Design documents are responsible for saving views. It is also the place that Aqua will
+# be saving the Class code. There will be one design document per class. There may be additional
+# design documents created without being tied to a class. Don't know yet. 
+module Aqua
+  module Store 
+    module CouchDB
+      class DesignDocument < Mash
+        
+        # the DesignDocument is essentially a special type of Document.
+        include Aqua::Store::CouchDB::StorageMethods
+        
+        # In the design document the name is the same as the id. That way initialization can 
+        # include a name parameter, which will change the id, and therefore the address of the 
+        # document. This method returns the id.
+        # @return [String] id for document
+        # @api public
+        def name
+          id
+        end
+        
+        # Sets the id and is an alias for id=.
+        # @param [String] Unique identifier
+        # @return [String] Escaped identifier 
+        # @api public
+        def name=( n )
+          self.id = ( n )
+        end
+        
+        alias :document_initialize :initialize
+        
+        def initialize( hash={} )
+          hash = Mash.new( hash ) unless hash.empty?
+          self.id = hash.delete(:name) if hash[:name]
+          document_initialize( hash )
+        end      
+        
+        # couchdb database url for the design document
+        # @return [String] representing CouchDB uri for document 
+        # @api public
+        def uri
+          raise ArgumentError, 'DesignDocument must have a name' if name.nil? || name.empty?
+          database.uri + '/_design/' + name
+        end 
+        
+        # Updates the id and rev after a design document is successfully saved. The _design/ 
+        # portion of the id has to be stripped. 
+        # @param [Hash] Result returned by CouchDB document save
+        # @api private
+        def update_version( result ) 
+          self.id     = result['id'].gsub(/\A_design\//, '')
+          self.rev    = result['rev']
+        end 
+        
+      end
+    end
+  end
+end