dewey 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.3 (June 29, 2010)
+
+Bugfixes:
+
+  - Handle mime type changes for files with no extension
+
 ## 0.1.2 (June 28, 2010)
 
 Features:

data/README.md

@@ -1,11 +1,21 @@
+    :::::::::  :::::::::: :::       ::: :::::::::: :::   ::: 
+    :+:    :+: :+:        :+:       :+: :+:        :+:   :+: 
+    +:+    +:+ +:+        +:+       +:+ +:+         +:+ +:+  
+    +#+    +:+ +#++:++#   +#+  +:+  +#+ +#++:++#     +#++:   
+    +#+    +#+ +#+        +#+ +#+#+ +#+ +#+           +#+    
+    #+#    #+# #+#         #+#+# #+#+#  #+#           #+#    
+    #########  ##########   ###   ###   ##########    ###
+
 Dewey allows you to simply upload, download and delete files from your Google
-Docs account. Let Google do all of the hard work of converting your documents!
+Docs account.
+
+Let Google do all of the hard work of converting your documents!
 
-# Note
+## Note
 
 Dewey is in alpha. It is not recommended you use this in production code.
 
-## Usage
+## Getting Started
 
 First, create a new Dewey::Document instance using your google docs account and
 password.

data/TODO.md

@@ -1,4 +1,5 @@
 ## Dewey TODO List
-  - Enable proper feed / service synchronization
-  - Correct spreadsheet support
-  - Add presentation support
+  - Implement the OAuth gem to manage service switching
+  - Add presentation support
+  - Documents: list
+  - Add support for folders

data/lib/dewey.rb

@@ -6,23 +6,17 @@ require 'tempfile'
 require 'dewey/https'
 require 'dewey/mime'
 require 'dewey/utils'
+require 'dewey/validation'
 
 module Dewey
-  GOOGLE_BASE_URL  = "https://www.google.com"
   GOOGLE_DOCS_URL  = "https://docs.google.com"
   GOOGLE_SPRD_URL  = "https://spreadsheets.google.com"
-  GOOGLE_LOGIN_URL = GOOGLE_BASE_URL + "/accounts/ClientLogin"
-  GOOGLE_FEED_URL  = GOOGLE_DOCS_URL + "/feeds/default/private/full"
+  GOOGLE_LOGIN_URL = "https://www.google.com/accounts/ClientLogin"
   
+  GOOGLE_FEED_URL        = GOOGLE_DOCS_URL + "/feeds/default/private/full"
   GOOGLE_DOCUMENT_URL    = GOOGLE_DOCS_URL + "/feeds/download/documents/Export"
   GOOGLE_SPREADSHEET_URL = GOOGLE_SPRD_URL + "/feeds/download/spreadsheets/Export"
   
-  GOOGLE_SERVICES = { :document => 'writely', :spreadsheet => 'wise' }
-  
-  DOCUMENT_EXPORT_FORMATS     = %w(txt odt pdf html rtf doc png zip)
-  PRESENTATION_EXPORT_FORMATS = %w(swf pdf png ppt)
-  SPREADSHEET_EXPORT_FORMATS  = %W(xls csv pdf ods tsv html)
-  
   class DeweyException < Exception
   end
   
@@ -30,37 +24,7 @@ module Dewey
   # This base class handles authentication and requests
   #
   class Document
-    attr_accessor :account, :password, :service, :token, :cached
-    
-    # Determine wether or not a format is available for download.
-    #
-    # * format  - The file format to check, i.e. 'txt', 'doc', 'pdf'
-    # * service - The service that would be used. Must be document, presentation,
-    #   or spreadsheet.
-    def self.valid_upload_format?(format, service = :document)
-      case service
-      when :document     then Dewey::DOCUMENT_MIMETYPES.has_key?(format.to_sym)
-      when :presentation then Dewey::PRESENTATION_MIMETYPES.has_key?(format.to_sym)
-      when :spreadsheet  then Dewey::SPREADSHEET_MIMETYPES.has_key?(format.to_sym)
-      else
-        raise DeweyException, "Unknown service: #{service}"
-      end
-    end
-    
-    # Determine whether or not a format is available for export.
-    #
-    # * format  - The file format to check, i.e. 'txt', 'doc', 'pdf'
-    # * service - The service that would be used. Must be document, presentation,
-    #   or spreadsheet.
-    def self.valid_export_format?(format, service = :document)
-      case service
-      when :document     then DOCUMENT_EXPORT_FORMATS.include?(format)
-      when :presentation then PRESENTATION_EXPORT_FORMATS.include?(format)
-      when :spreadsheet  then SPREADSHEET_EXPORT_FORMATS.include?(format)
-      else
-        raise DeweyException, "Unknown service: #{service}"
-      end
-    end
+    attr_accessor :account, :password, :token
     
     # Create a new Doc object
     # Options specified in +opts+ consist of:
@@ -68,12 +32,9 @@ module Dewey
     # * :account - The Google Doc's account that will be used for authentication.
     #   This will most typically be a gmail account, i.e. +example@gmail.com+
     # * :password - The password for the Google Doc's account.
-    # * :service - The default service to connect to, either :document or :spreadsheet
     def initialize(options = {})
       @account  = options[:account]
       @password = options[:password]
-      @service  = options[:service] || :document
-      @cached   = {}
     end
     
     # Returns true if this instance has been authorized
@@ -91,7 +52,7 @@ module Dewey
       
       url = URI.parse(GOOGLE_LOGIN_URL)
       params = { 'accountType' => 'HOSTED_OR_GOOGLE', 'Email' => @account,
-                 'Passwd' => @password, 'service'=> GOOGLE_SERVICES[@service] }
+                 'Passwd' => @password, 'service'=> 'writely' }
       
       response = Net::HTTPS.post_form(url, params)
       
@@ -105,8 +66,14 @@ module Dewey
         raise DeweyException, "Unexpected response: #{response}"
       end
     end
-        
-    def upload(file, title = nil)
+    
+    # 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)
+      authorize! unless authorized?
+      
       extension = File.extname(file.path).sub('.', '')
       basename  = File.basename(file.path, ".#{extension}")
       mimetype  = Dewey::Mime.mime_type(file)
@@ -114,12 +81,12 @@ module Dewey
       
       title ||= basename
       
-      raise DeweyException, "Invalid file type: #{extension}" unless Dewey::Document.valid_upload_format?(extension, service)
+      raise DeweyException, "Invalid file type: #{extension}" unless Dewey::Validation.valid_upload_format?(extension, service)
       
       headers = base_headers
       headers['Content-Length'] = File.size?(file).to_s
-      headers['Content-Type']   = mimetype
       headers['Slug']           = Dewey::Utils.escape(title)
+      headers['Content-Type']   = mimetype unless mimetype =~ /Can't expand summary_info/
       
       # Rewind the file in the case of multiple uploads, or conversions
       file.rewind
@@ -128,25 +95,31 @@ module Dewey
       
       case response
       when Net::HTTPCreated
-        rid = @cached[basename] = extract_rid(response.body)
+        extract_rid(response.body)
       else
         nil
       end
     end
     
+    alias :upload :put
+    
     # Download, or export more accurately, a file to a specified format
-    # * id     - A resource id or exact file name matching a document in the account
+    # * rid    - A resource id, for example +document:12345+
     # * format - The output format, see *_EXPORT_FORMATS for possiblibilites
-    def download(id, format = nil)
-      spreadsheet = !! id.match(/spreadsheet/)
+    def get(rid, format = nil)
+      authorize! unless authorized?
       
-      url  = (spreadsheet ? GOOGLE_SPREADSHEET_URL : GOOGLE_DOCUMENT_URL)
+      spreadsheet = !! rid.match(/^spreadsheet/)
+      id = rid.sub(/[a-z]+:/, '')
+      
+      url  = ''
+      url << (spreadsheet ? GOOGLE_SPREADSHEET_URL : GOOGLE_DOCUMENT_URL)
       url << (spreadsheet ? "?key=#{id}" : "?docID=#{id}")
       url << "&exportFormat=#{format.to_s}" unless format.nil?
       
       headers = base_headers
       
-      file = Tempfile.new([id, format].join('.'))
+      file = Tempfile.new([rid, format].join('.'))
       file.binmode
       
       open(url, headers) { |data| file.write data.read }
@@ -154,8 +127,13 @@ module Dewey
       file
     end
     
+    alias :download :get
+    
     # Deletes a document referenced either by resource id or by name.
+    # * id - A resource id or exact file name matching a document in the account
     def delete(id)
+      authorize! unless authorized?
+      
       headers = base_headers
       headers['If-Match'] = '*' # We don't care if others have modified
       
@@ -196,9 +174,8 @@ module Dewey
     
     def http_request(method, url, headers, data = nil) #:nodoc:      
       url = URI.parse(url) if url.kind_of? String
-      
-      connection = Net::HTTP.new(url.host, url.port)
-      connection.use_ssl = (url.scheme == 'https')
+
+      connection = (url.scheme == 'https') ? Net::HTTPS.new(url.host, url.port) : Net::HTTP.new(url.host, url.port)
       
       case method
       when :post
@@ -219,13 +196,13 @@ module Dewey
       base
     end
     
-    def extract_rid(source) #:nodoc:
-      xml = REXML::Document.new(source)
+    def extract_rid(response) #:nodoc:
+      xml = REXML::Document.new(response)
       
       begin
-        "#{$1}:#{$2}" if xml.elements['//id'].text =~ /.+(document|spreadsheet|presentation)%3A([0-9a-zA-Z]+)/
+        "#{$1}:#{$2}" if xml.elements['//id'].text =~ /.+(document|spreadsheet|presentation)%3A([0-9a-zA-Z_-]+)$/
       rescue 
-        raise DeweyException, "id could not be extracted from: #{body}"
+        raise DeweyException, "id could not be extracted from: #{response}"
       end
     end
   end

data/lib/dewey/https.rb

@@ -1,11 +1,12 @@
 require 'net/http'
 
-# Shortcut method for using +http.use_ssl+.
-module Net
+module Net # :nodoc:
   class HTTPS < Net::HTTP
     def initialize(address, port = 443)
       super(address, port)
       self.use_ssl = true
+      @ssl_context = OpenSSL::SSL::SSLContext.new
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
   end
 end

data/lib/dewey/mime.rb

@@ -1,8 +1,3 @@
-# (c) Copyright 2010 Parker Selbert <parker@sorentwo.com>
-#
-# Dewey is freely distributable under the terms of an MIT-style license.
-# See LICENSE or http://www.opensource.org/licenses/mit-license.php
-
 module Dewey
   
   DOCUMENT_MIMETYPES = {
@@ -63,8 +58,8 @@ module Dewey
     # cast them to one that Google Docs will accept.
     def self.coerce(mime_type)
       case mime_type
-      when /vnd.ms-office/ then 'application/msword'
-      when /x-docx/        then 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      when /vnd.ms-office/       then 'application/msword'
+      when /x-docx/              then 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
       else mime_type
       end
     end

data/lib/dewey/utils.rb

@@ -9,7 +9,7 @@ module Dewey
     
     module_function :escape
     
-    # Return the bytesize of String; uses String#length under Ruby 1.8 and
+    # Return the bytesize of String; uses String#length under Ruby 1.8
      def bytesize(string)
        string.bytesize
      end

data/lib/dewey/validation.rb

@@ -0,0 +1,38 @@
+module Dewey
+  
+  DOCUMENT_EXPORT_FORMATS     = %w(txt odt pdf html rtf doc png zip)
+  PRESENTATION_EXPORT_FORMATS = %w(swf pdf png ppt)
+  SPREADSHEET_EXPORT_FORMATS  = %W(xls csv pdf ods tsv html)
+  
+  class Validation
+    # Determine wether or not a format is available for download.
+    #
+    # * format  - The file format to check, i.e. 'txt', 'doc', 'pdf'
+    # * service - The service that would be used. Must be document, presentation,
+    #   or spreadsheet.
+    def self.valid_upload_format?(format, service = :document)
+      case service
+      when :document     then Dewey::DOCUMENT_MIMETYPES.has_key?(format.to_sym)
+      when :presentation then Dewey::PRESENTATION_MIMETYPES.has_key?(format.to_sym)
+      when :spreadsheet  then Dewey::SPREADSHEET_MIMETYPES.has_key?(format.to_sym)
+      else
+        raise DeweyException, "Unknown service: #{service}"
+      end
+    end
+
+    # Determine whether or not a format is available for export.
+    #
+    # * format  - The file format to check, i.e. 'txt', 'doc', 'pdf'
+    # * service - The service that would be used. Must be document, presentation,
+    #   or spreadsheet.
+    def self.valid_export_format?(format, service = :document)
+      case service
+      when :document     then Dewey::DOCUMENT_EXPORT_FORMATS.include?(format)
+      when :presentation then Dewey::PRESENTATION_EXPORT_FORMATS.include?(format)
+      when :spreadsheet  then Dewey::SPREADSHEET_EXPORT_FORMATS.include?(format)
+      else
+        raise DeweyException, "Unknown service: #{service}"
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Parker Selbert
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-29 00:00:00 -04:00
+date: 2010-10-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/dewey/https.rb
 - lib/dewey/mime.rb
 - lib/dewey/utils.rb
+- lib/dewey/validation.rb
 - lib/dewey.rb
 - README.md
 - CHANGELOG.md