dewey 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.2.1 (October 26, 2010)
+
+Additions:
+
+  - delete! method. Raises an exception rather than returning false when
+    operations fail.
+  - search method. For retrieving one or more document:ids from a title query.
+
+Bugfixes:
+
+  - Actually delete files rather than sending them to the trash
+
 ## 0.2.0 (October 20, 2010)
 
 Additions:
@@ -49,4 +61,4 @@ Bugfixes:
 Bugfixes:
 
   - Mandate ~ 1.3 version of rspec
-  - Clear up YAML load issues
+  - Clear up YAML load issues

data/README.md

@@ -39,25 +39,38 @@ Be sure to set up authorization before attempting any file operations! You don't
 need to explictely call authorize though, as it will attempt to do that on the
 first operation.
 
-Putting a document:
+### Putting a Document
 
     document = File.new('my_document.doc')
     resource = Dewey.put(document, 'My First Upload') # Returns the id when successful
 
-Getting a document:
+### Searching Documents
+
+Exact search
+
+    id = Dewey.search('My Document', :exact => true) # 'document:12345'
+
+Loose search
+
+    ids = Dewey.search('notes') # ['document:12', 'document:456']
+
+### Getting a Document
+
+Upload your file
 
-    # Upload your file
     id = Dewey.put(File.new('my_document.doc'), 'My Second Upload')
     
-    # Get it in various formats
+Get it in various formats
+
     original = Dewey.get(id)     # -> Tempfile
     pdf  = Dewey.get(id, :pdf)   # -> Tempfile
     html = Dewey.get(id, :html)  # -> Tempfile
     
-    # A tempfile is returned, so you'll have to move it
+A tempfile is returned, so you'll have to move it
+
     FileUtils.mv html.path, 'path/to/destination'
 
-Deleting a document:
+### Deleting a Document
 
     id = Dewey.put(File.new('my_spreadsheet.xls'))
     result = Dewey.delete(id) # -> true

data/lib/dewey/core.rb

@@ -6,6 +6,11 @@ require 'tempfile'
 
 module Dewey
   class << self
+    
+    # Set the authentication strategy. You can currently only use ClientAuth,
+    # but you must provide +email+ and +password+ options. You must set up
+    # authentication before using any file operations.
+    #
     def authentication(strategy, options)
       case strategy
       when :client
@@ -13,18 +18,42 @@ module Dewey
       end
     end
     
+    # Report whether Dewey has both an authentication strategy selected, and has
+    # been authenticated. Delegates to the chosen authenticator.
+    #
     def authenticated?
       !@@authenticator.nil? && @@authenticator.authenticated?
     end
     
+    # Tell the authentication strategy to authenticate. Not necessary though, as
+    # any file operation will authenticate automatically.
+    #
     def authenticate!
       @@authenticator.authenticate!
     end
-    
+   
+    def search(query, options = {})
+      authenticate! unless authenticated?
+      
+      title    = query.gsub(/\s+/, '+')
+      headers  = base_headers(false)
+      url      = "#{GOOGLE_FEED_URL}?title=#{title}"
+      url     << "&title-exact=true" if options[:exact]
+      response = get_request(url, headers)
+      
+      case response
+      when Net::HTTPOK
+        extract_ids(response.body)
+      else
+        nil
+      end
+    end
+
     # Upload a file to the account. A successful upload will return the resource
     # id, which is useful for downloading the file without doing a title search.
     # * file  - A File reference
     # * title - An alternative title, to be used instead of the filename
+    #
     def put(file, title = nil)
       authenticate! unless authenticated?
   
@@ -49,7 +78,7 @@ module Dewey
   
       case response
       when Net::HTTPCreated
-        extract_rid(response.body)
+        extract_ids(response.body)
       else
         false
       end
@@ -58,6 +87,7 @@ module Dewey
     # Download, or export more accurately, a file to a specified format
     # * rid    - A resource id, for example +document:12345+
     # * format - The output format, see *_EXPORT_FORMATS for possiblibilites
+    #
     def get(rid, format = nil)
       authenticate! unless authenticated?
   
@@ -79,15 +109,19 @@ module Dewey
       file
     end
 
-    # Deletes a document referenced either by resource id or by name.
+    # Deletes a document referenced either by resource id.
     # * id - A resource id or exact file name matching a document in the account
+    #
     def delete(id)
       authenticate! unless authenticated?
   
-      headers = base_headers
+      headers = base_headers(false)
       headers['If-Match'] = '*' # We don't care if others have modified
   
-      url = GOOGLE_FEED_URL + "/#{Dewey::Utils.escape(id)}?delete=true"
+      url  = ''
+      url << GOOGLE_FEED_URL
+      url << "/#{Dewey::Utils.escape(id)}?delete=true"
+
       response = delete_request(url, headers)
   
       case response
@@ -97,13 +131,20 @@ module Dewey
         false
       end
     end
+    
+    # The same as delete, except that it will raise +Dewey::DeweyException+ if
+    # the request fails.
+    #
+    def delete!(id)
+      delete(id) || raise(DeweyException, "Unable to delete document")
+    end
 
     # Convenience method for +put+, +get+, +delete+. Returns a Tempfile
     # with in the provided type. Note that if you omit the format option it will
     # simply upload the file and return it.
     # * file    - The file that will be converted
-    # * options - Takes :title and :format. See +upload+ for title, and +download+
-    #             for format.
+    # * options - Takes :title and :format. See +upload+ for title, and +download+ for format.
+    #
     def convert(file, options = {})
       rid = put(file, options[:title])
       con = get(rid, options[:format])
@@ -113,6 +154,12 @@ module Dewey
       con
     end
 
+    protected
+   
+    def get_request(url, headers) #:nodoc:
+      http_request(:get, url, headers)
+    end
+
     def post_request(url, data, headers) #:nodoc:
       http_request(:post, url, headers, data)
     end
@@ -125,33 +172,41 @@ module Dewey
       url = URI.parse(url) if url.kind_of? String
 
       connection = (url.scheme == 'https') ? Net::HTTPS.new(url.host, url.port) : Net::HTTP.new(url.host, url.port)
-  
+      full_path  = url.path
+      full_path << "?#{url.query}" unless url.query.nil?
+
       case method
+      when :get
+        connection.get(full_path, headers)
       when :post
-        connection.post(url.path, data, headers)
+        connection.post(full_path, data, headers)
       when :delete
-        connection.delete(url.path, headers)
+        connection.delete(full_path, headers)
       else
-        raise DeweyException, "Invalid request type. Valid options are :post and :delete"
+        raise DeweyException, "Invalid request type. Valid options are :get, :post and :delete"
       end
     end
 
-    def base_headers #:nodoc:
+    def base_headers(put_or_post = true) #:nodoc:
       base = {}
       base['GData-Version'] = '3.0'
-      base['Content-Type']  = 'application/x-www-form-urlencoded'
+      base['Content-Type']  = 'application/x-www-form-urlencoded'         if put_or_post
       base['Authorization'] = "GoogleLogin auth=#{@@authenticator.token}" if authenticated?
   
       base
     end
 
-    def extract_rid(response) #:nodoc:
+    def extract_ids(response) #:nodoc:
       xml = REXML::Document.new(response)
-  
-      begin
-        "#{$1}:#{$2}" if xml.elements['//id'].text =~ /.*(document|spreadsheet|presentation)%3A([0-9a-zA-Z_-]+)$/
-      rescue 
-        raise DeweyException, "id could not be extracted from: #{response}"
+      ids = xml.elements.
+            collect('//id') { |e| "#{$1}:#{$2}" if e.text =~ /.*(document|spreadsheet|presentation)(?:%3A|:)([0-9a-zA-Z_-]+)$/ }.
+            reject(&:nil?)
+      
+      case ids.length
+      when 0 then nil
+      when 1 then ids.first
+      else
+        ids
       end
     end
   end

data/lib/dewey/version.rb

@@ -1,3 +1,3 @@
 module Dewey
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Parker Selbert
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 -05:00
+date: 2010-10-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency