dewey 0.2.6 → 0.2.7

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.7 (December 12, 2010)
+
+  * Documents, Drawings and Presentations are actually downloadable again. The
+    Google Docs API documentation wasn't updated to reflect that the docID
+    param was now just id.
+  * Minor internal improvements
+
 ## 0.2.6 (November 3, 2010)
   
   * Downloaded files are automatically rewound

data/README.md

@@ -19,17 +19,13 @@ Dewey is in alpha. It is not recommended you use this in production code.
 
 ## Authentication
 
-You can configure Dewey to connect with either ClientLogin or OAuth. If you choose
-OAuth you'll only have to authenticate the first time you connect and subsequent
-connections will use the saved token.
+You can configure Dewey to connect with ClientLogin. 
 
 ClientLogin
 
     Dewey.authentication :client, :email => 'example@gmail.com', :password => 'password'
 
-OAuth
-
-    Dewey.authentication :oauth, :idontknowwhatgoeshereyet
+AuthSub and OAuth support is planned for a future release.
 
 ## File Operations
 
@@ -72,11 +68,20 @@ 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
+Getting a document by title. Since only one file will be returned at a time you
+must use an exact match.
 
     Dewey.get('My Document') #=> Tempfile
     Dewey.get('No Match')    #=> nil
 
+Other file types are supported as well, including spreadsheets, drawings and
+presentations:
+
+    Dewey.get('Mine')               #=> ['presentation:12345', 'spreadsheet:12345', 'drawing:12345']
+    Dewey.get('presentation:12345') #=> Tempfile
+    Dewey.get('spreadsheet:12345')  #=> Tempfile
+    Dewey.get('drawing:12345')      #=> Tempfile
+
 ### Deleting a Document
 
 Deleting a document from a resource id

data/lib/dewey.rb

@@ -9,8 +9,8 @@ module Dewey
   GOOGLE_PRESENTATION_URL = GOOGLE_DOCS_URL + "/feeds/download/presentations/Export"
   GOOGLE_SPREADSHEET_URL  = GOOGLE_SPRD_URL + "/feeds/download/spreadsheets/Export"
   
-  class DeweyException < Exception; end
-  class DeweyAuthorizationException < Exception; end
+  class DeweyError < StandardError; end
+  class DeweyAuthorizationError < StandardError; end
 end
 
 require 'dewey/core'

data/lib/dewey/client_auth.rb

@@ -36,7 +36,7 @@ module Dewey
       when Net::HTTPForbidden
         false
       else
-        raise DeweyAuthorizationException, "Unexpected response: #{response}"
+        raise DeweyError, "Unexpected response: #{response}"
       end
     end
     
@@ -51,6 +51,7 @@ module Dewey
     def guard(service)
       case service
       when nil           then :writely
+      when 'document'    then :writely
       when 'spreadsheet' then :wise
       else
         service.to_sym

data/lib/dewey/core.rb

@@ -42,7 +42,7 @@ module Dewey
     # @return [Array] An array of matched ids. No matches return an empty array
     def search(query, options = {})
       title    = query.gsub(/\s+/, '+')
-      headers  = base_headers(false)
+      headers  = base_headers
       url      = "#{GOOGLE_FEED_URL}?title=#{title}"
       url     << "&title-exact=true" if options[:exact]
       response = http_request(:get, url, headers)
@@ -66,11 +66,11 @@ module Dewey
       service   = Dewey::Mime.guess_service(mimetype)
       title     = options[:title] || basename
   
-      raise DeweyException, "Invalid file type: #{extension}" unless Dewey::Validation.valid_upload_format?(extension, service)
+      raise DeweyError, "Invalid file type: #{extension}" unless Dewey::Validation.valid_upload_format?(extension, service)
   
       headers = base_headers
       headers['Content-Length'] = File.size?(file).to_s
-      headers['Slug']           = Dewey::Utils.escape(title)
+      headers['Slug']           = Dewey::Utils.slug(title)
       headers['Content-Type']   = mimetype unless mimetype =~ /Can't expand summary_info/
   
       # Rewind the file in the case of multiple uploads, or conversions
@@ -89,7 +89,7 @@ module Dewey
     #
     # @see put
     def put!(file, options = {})
-      put(file, options) || raise(DeweyException, "Unable to put document")
+      put(file, options) || raise(DeweyError, "Unable to put document")
     end
 
     # Download a file. You may optionally specify a format for export.
@@ -117,18 +117,18 @@ module Dewey
       case service
       when 'document'
         url << GOOGLE_DOCUMENT_URL
-        url << "?docID=#{id}"
+        url << "?id=#{id}"
       when 'drawing'
         url << GOOGLE_DRAWING_URL
-        url << "?docID=#{id}"
+        url << "?id=#{id}"
       when 'presentation'
         url << GOOGLE_PRESENTATION_URL
-        url << "?docID=#{id}"
+        url << "?id=#{id}"
       when 'spreadsheet'
         url << GOOGLE_SPREADSHEET_URL
         url << "?key=#{id}"
       else
-        raise DeweyException, "Invalid service: #{service}"
+        raise DeweyError, "Invalid service: #{service}"
       end
 
       unless format.empty?
@@ -137,15 +137,14 @@ module Dewey
           url << "&format=#{format}"       if service == 'document'
           url << "&gid=#{options[:sheet]}" if service == 'spreadsheet' && options[:sheet]
         else
-          raise DeweyException, "Invalid format: #{format}" 
+          raise DeweyError, "Invalid format: #{format}" 
         end
       end
 
-      response = http_request(:get, url, base_headers(true, service))
+      response = http_request(:get, url, base_headers(service))
       
       if response.kind_of?(Net::HTTPOK)
-        file = Tempfile.new([id, format].join('.'))
-        file.binmode
+        file = Tempfile.new([id, format].join('.')).binmode
         file.write(response.body)
         file.rewind
         file
@@ -167,13 +166,13 @@ module Dewey
     def delete(query, options = {})
 
       # We use 'If-Match' => '*' to make sure we delete regardless of others
-      headers = base_headers(false).merge({'If-Match' => '*'}) 
+      headers = base_headers.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   = "#{GOOGLE_FEED_URL}/#{URI.escape(id)}"
       url << "?delete=true" unless trash
 
       response = http_request(:delete, url, headers)
@@ -181,12 +180,12 @@ module Dewey
       response.kind_of?(Net::HTTPOK)
     end
     
-    # The same as delete, except that it will raise `Dewey::DeweyException` if
+    # The same as delete, except that it will raise `Dewey::DeweyError` if
     # the request fails.
     # 
     # @see #delete
     def delete!(query, options = {})
-      delete(query, options) || raise(DeweyException, "Unable to delete document")
+      delete(query, options) || raise(DeweyError, "Unable to delete document")
     end
 
     # Convenience method for `put`, `get`, `delete`.
@@ -218,6 +217,7 @@ module Dewey
       @@authenticator
     end
 
+    # Perform the actual request heavy lifting
     def http_request(method, url, headers, data = nil) #:nodoc:      
       url = URI.parse(url) if url.kind_of? String
 
@@ -229,22 +229,20 @@ module Dewey
       when :get
         connection.get(full_path, headers)
       when :post
+        headers['Content-Type'] = 'application/x-www-form-urlencoded'
         connection.post(full_path, data, headers)
       when :delete
         connection.delete(full_path, headers)
-      else
-        raise DeweyException, "Invalid request type. Valid options are :get, :post and :delete"
       end
     end
 
     # A hash of default headers. Considers authentication and put/post headers.
     #
-    # @param [Boolean] form If true the Content-Type will be set accordingly
+    # @param [String] service The document type or service eg. (document/writely)
     # @return [Hash] Headers hash
-    def base_headers(form = true, service = nil) #:nodoc:
+    def base_headers(service = nil) #:nodoc:
       base = {}
       base['GData-Version'] = '3.0'
-      base['Content-Type']  = 'application/x-www-form-urlencoded'         if form
       base['Authorization'] = "GoogleLogin auth=#{authenticator.token(service)}"
   
       base
@@ -261,7 +259,7 @@ module Dewey
 
     # Is the string an id or a search query?
     def is_id?(string)
-      string.match(/^[a-z]+:.+$/)
+      string =~ /^[a-z]+:.+$/
     end
   end
 end

data/lib/dewey/utils.rb

@@ -1,19 +1,17 @@
 module Dewey
   module Utils #:nodoc:
-    # Performs URI escaping. (Stolen from Camping via Rake).
-    def escape(s)
-      s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
-        '%'+$1.unpack('H2' * bytesize($1)).join('%').upcase
-      }.tr(' ', '+')
+    # Perform string escaping for Atom slugs
+    def slug(string)
+      string.chars.to_a.map do |char|
+        decimal = char.unpack('U').join('').to_i
+        if decimal < 32 || decimal > 126 || decimal == 37
+          char = "%#{char.unpack('H2').join('%').upcase}"
+        end
+
+        char
+      end.join('')
     end
-    
-    module_function :escape
-    
-    # Return the bytesize of String; uses String#length under Ruby 1.8
-     def bytesize(string)
-       string.bytesize
-     end
-     
-     module_function :bytesize
+
+    module_function :slug
   end
-end
+end

data/lib/dewey/validation.rb

@@ -18,7 +18,7 @@ module Dewey
       #
       # @return [Boolean] `true` if the format is supported, `false` otherwise
       #
-      # @raise [DeweyException] Raised when an unknown service is given
+      # @raise [DeweyError] Raised when an unknown service is given
       def valid_upload_format?(format, service = nil)
         format  = format.to_sym
         service = default_service(service)
@@ -29,7 +29,7 @@ module Dewey
         when :presentation then Dewey::PRESENTATION_MIMETYPES.has_key?(format)
         when :spreadsheet  then Dewey::SPREADSHEET_MIMETYPES.has_key?(format)
         else
-          raise DeweyException, "Unknown service: #{service}"
+          raise DeweyError, "Unknown service: #{service}"
         end
       end
 
@@ -41,7 +41,7 @@ module Dewey
       #
       # @return [Boolean] `true` if the format is supported, `false` otherwise
       #
-      # @raise [DeweyException] Raised when an unknown service is given
+      # @raise [DeweyError] Raised when an unknown service is given
       def valid_export_format?(format, service = nil)
         format  = format.to_sym
         service = default_service(service) 
@@ -52,7 +52,7 @@ module Dewey
         when :presentation then Dewey::PRESENTATION_EXPORT_FORMATS.include?(format)
         when :spreadsheet  then Dewey::SPREADSHEET_EXPORT_FORMATS.include?(format)
         else
-          raise DeweyException, "Unknown service: #{service}"
+          raise DeweyError, "Unknown service: #{service}"
         end
       end
 

data/lib/dewey/version.rb

@@ -1,3 +1,3 @@
 module Dewey
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Parker Selbert
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -05:00
+date: 2010-12-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency