dewey 0.2.2 → 0.2.3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.2.3 (October 30, 2010)
+
+  Additions:
+  
+    - #delete and #delete! accept an optional :trash option to send a resource
+      to the trash, rather than being fully deleted.
+    - #get and #elete by title. Handles exact matches only.
+  
+  Bugfixes:
+    
+    - Not setting the :format option on #get no longers raises
+
 ## 0.2.2 (October 27, 2010)
 
   Changes:

data/README.md

@@ -42,35 +42,55 @@ first operation.
 ### Putting a Document
 
     document = File.new('my_document.doc')
-    resource = Dewey.put(document, :title => 'My First Upload') # Returns the id when successful
+    resource = Dewey.put(document, :title => 'My First Upload') #=> 'document:12345'
 
 ### Searching Documents
 
 Exact search
 
-    id = Dewey.search('My Document', :exact => true) # 'document:12345'
+    Dewey.search('My Document', :exact => true) #=> ['document:12345']
 
 Loose search
 
-    ids = Dewey.search('notes') # ['document:12', 'document:456']
+    ids = Dewey.search('notes') #=> ['document:12', 'document:456']
 
 ### Getting a Document
 
 Upload your file
 
     id = Dewey.put(File.new('my_document.doc'), 'My Second Upload')
-    
+
 Get it in various formats
 
     original = Dewey.get(id)                #=> Tempfile
     pdf  = Dewey.get(id, :format => :pdf)   #=> Tempfile
     html = Dewey.get(id, :format => :html)  #=> Tempfile
-    
+
 A tempfile is returned, so you'll have to move it
 
     FileUtils.mv html.path, 'path/to/destination'
 
+Getting a document by title. Unmatched searches return nil
+
+    Dewey.get('My Document') #=> Tempfile
+    Dewey.get('No Match')    #=> nil
+
 ### Deleting a Document
 
+Deleting a document from a resource id
+
     id = Dewey.put(File.new('my_spreadsheet.xls'))
-    result = Dewey.delete(id) # -> true
+    Dewey.delete(id) #=> true
+
+Deleting by title. Unmatched searches return false
+
+    Dewey.delete('My Document') #=> true
+    Dewey.delete('No Match')    #=> false
+
+Sending to the trash rather than deleting
+
+    Dewey.delete('My Document', :trash => true) #=> true
+
+If you would prefer an error when deletion fails
+
+    Dewey.delete!('My Document') #=> raise DeweyException

data/lib/dewey/core.rb

@@ -1,6 +1,5 @@
 require 'uri'
 require 'net/https'
-require 'open-uri'
 require 'rexml/document'
 require 'tempfile'
 
@@ -88,22 +87,26 @@ module Dewey
 
     # Download a file. You may optionally specify a format for export.
     #
-    # @param [String] id       A resource id, for example `document:12345`
+    # @param [String] query    A resource id or title, `document:12345` or
+    #                          `My Document` for example
     # @param [Hash]   options  Options for downloading the document
     # @option options [Symbol] :format The output format
     # 
-    # @return [Tempfile] The downloaded file
+    # @return [Tempfile, nil] The downloaded file, otherwise `nil` if the file
+    #                         couldn't be found.
     #
     # @see Dewey::Validation::DOCUMENT_EXPORT_FORMATS
     # @see Dewey::Validation::SPREADSHEET_EXPORT_FORMATS
     # @see Dewey::Validation::PRESENTATION_EXPORT_FORMATS
-    def get(id, options = {})
-      service, id = id.split(':')
-      format = options[:format].to_s
+    def get(query, options = {})
+      resource_id = is_id?(query) ? query : search(query, :exact => true).first
 
-      raise DeweyException, "Invalid format: #{format}" unless Dewey::Validation.valid_export_format?(format, service)
+      return nil if resource_id.nil?
+
+      service, id = resource_id.split(':')
+      format      = options[:format].to_s
+      url         = ''
 
-      url = ''
       case service
       when 'document'
         url << GOOGLE_DOCUMENT_URL
@@ -113,28 +116,47 @@ module Dewey
         url << "?key=#{id}"
       end
 
-      url << "&exportFormat=#{format}" unless format.blank?
-  
-      file = Tempfile.new([id, format].join('.'))
-      file.binmode
-  
-      open(url, base_headers) { |data| file.write data.read }
-  
-      file
+      unless format.blank?
+        if Dewey::Validation.valid_export_format?(format, service)
+          url << "&exportFormat=#{format}" unless format.blank?
+        else
+          raise DeweyException, "Invalid format: #{format}" 
+        end
+      end
+
+      response = get_request(url, base_headers)
+      
+      if response.kind_of?(Net::HTTPOK)
+        file = Tempfile.new([id, format].join('.'))
+        file.binmode
+        file.write(response.body)
+        file
+      else
+        nil
+      end
     end
 
-    # Deletes a document referenced by id.
+    # Deletes a document. The default behavior is to delete the document
+    # permanently, rather than trashing it. 
     #
-    # @param [String] id An id matching a document
+    # @param [String] query    A resource id or title. If a title is provided
+    #                          a search will be performed automatically.
+    # @param [Hash]   options  Options for deleting the document
+    # @option options [Symbol] :trash If `true` the resource will be sent to
+    #                          the trash, rather than being permanently deleted.
     #
     # @return [Boolean] `true` if delete was successful, `false` otherwise
-    def delete(id)
-      headers = base_headers(false)
-      headers['If-Match'] = '*' # We don't care if others have modified
-  
-      url  = ''
-      url << GOOGLE_FEED_URL
-      url << "/#{Dewey::Utils.escape(id)}?delete=true"
+    def delete(query, options = {})
+
+      # We use 'If-Match' => '*' to make sure we delete regardless of others
+      headers = base_headers(false).merge({'If-Match' => '*'}) 
+      trash   = options.delete(:trash) || false
+      id      = (is_id?(query)) ? query : search(query, :exact => true).first
+      
+      return false if id.nil?
+
+      url   = "#{GOOGLE_FEED_URL}/#{Dewey::Utils.escape(id)}"
+      url << "?delete=true" unless trash
 
       response = delete_request(url, headers)
   
@@ -145,8 +167,8 @@ module Dewey
     # the request fails.
     # 
     # @see #delete
-    def delete!(id)
-      delete(id) || raise(DeweyException, "Unable to delete document")
+    def delete!(query, options = {})
+      delete(query, options) || raise(DeweyException, "Unable to delete document")
     end
 
     [:search, :put, :get, :delete].each do |method|
@@ -237,5 +259,10 @@ module Dewey
       xml = REXML::Document.new(response)
       xml.elements.collect('//id') { |e| e.text.gsub('%3A', ':') }.reject(&:blank?)
     end
+
+    # Is the string an id or a search query?
+    def is_id?(string)
+      string.match(/^(doc|spr|pres).+:.+$/)
+    end
   end
 end

data/lib/dewey/version.rb

@@ -1,3 +1,3 @@
 module Dewey
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Parker Selbert
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 -05:00
+date: 2010-10-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency