gdata 0.0.1 → 1.0.0

data/README

@@ -9,10 +9,11 @@ Ruby wrapper for working with Google Data APIs
 == SYNOPSIS:
 
   yt = GData::Client::YouTube.new
+  yt.source = 'my_cool_application'
   yt.clientlogin('username', 'password')
   yt.client_id = 'CLIENT_ID'
   yt.developer_key = 'DEVELOPER_KEY'
-  feed = yt.get('http://gdata.youtube.com/feeds/api/users/default/uploads')
+  feed = yt.get('http://gdata.youtube.com/feeds/api/users/default/uploads').to_xml
   
   # creating, updating, and deleting a playlist
   
@@ -24,15 +25,40 @@ Ruby wrapper for working with Google Data APIs
   </entry>
   EOF
   
-  response = yt.post('http://gdata.youtube.com/feeds/api/users/default/playlists', entry)
+  response = yt.post('http://gdata.youtube.com/feeds/api/users/default/playlists', entry).to_xml
   
   edit_uri = response.elements["link[@rel='edit']"].attributes['href']
   
   response.elements["summary"].text = "Updated description"
   
-  response = yt.put(edit_uri, response.to_s)
+  response = yt.put(edit_uri, response.to_s).to_xml
   
-  yt.delete(edit_uri)
+  yt.delete(edit_uri).to_xml
+  
+  # uploading a video
+  
+  test_movie = '/path/to/a/movie.mov'
+  mime_type = 'video/quicktime'
+  feed = 'http://uploads.gdata.youtube.com/feeds/api/users/default/uploads'
+
+  entry = <<EOF
+  <entry xmlns="http://www.w3.org/2005/Atom"
+    xmlns:media="http://search.yahoo.com/mrss/"
+    xmlns:yt="http://gdata.youtube.com/schemas/2007">
+    <media:group>
+      <media:title type="plain">Test Movie</media:title>
+      <media:description type="plain">
+        This is a test with the Ruby library
+      </media:description>
+      <media:category
+        scheme="http://gdata.youtube.com/schemas/2007/categories.cat">People
+      </media:category>
+      <media:keywords>test,lame</media:keywords>
+    </media:group>
+  </entry>
+  EOF
+   
+  response = @yt.post_file(feed, test_movie, mime_type, entry).to_xml
 
 == REQUIREMENTS:
 
@@ -46,7 +72,7 @@ Tested against Ruby 1.8.6 patch level 114
 
 To generate documentation:
 
-  rake rdoc
+  rake doc
   
 To run unit tests:
   

data/Rakefile

@@ -15,15 +15,19 @@
 require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
+require 'rake/testtask'
 
 task :default => [:test]
-task :doc => [:rdoc]
 
 task :test do
   ruby "test/ts_gdata.rb"
 end
 
 task :prepdoc do
+  all_doc_files = FileList.new('doc/**/*')
+  all_doc_files.each do |file|
+    system "svn add #{file}"
+  end
   doc_files = FileList.new('doc/**/*.html')
   doc_files.each do |file|
     system "svn propset svn:mime-type 'text/html' #{file}"
@@ -34,14 +38,10 @@ task :prepdoc do
   end
 end
 
-
-Rake::RDocTask.new do |rd|
-  rd.main = 'README'
-  rd.rdoc_files.include('README', 'lib/**/*.rb')
-  rd.rdoc_dir = 'doc'
+task :doc do
+  system "rdoc -U --title 'gdata module documentation' -m README README lib/"
 end
 
-
 spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.author = 'Jeff Fisher'
@@ -50,7 +50,7 @@ spec = Gem::Specification.new do |s|
   s.summary = "Google Data APIs Ruby Utility Library"
   s.rubyforge_project = 'gdata'
   s.name = 'gdata'
-  s.version = '0.0.1'
+  s.version = '1.0.0'
   s.requirements << 'none'
   s.require_path = 'lib'
   s.test_files = FileList['test/ts_gdata.rb']

data/lib/gdata.rb

@@ -16,4 +16,7 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'gdata/http'
 require 'gdata/client'
-require 'gdata/auth'
+require 'gdata/auth'
+# This is for Unicode "support"
+require 'jcode'
+$KCODE = 'UTF8'

data/lib/gdata/auth/authsub.rb

@@ -23,9 +23,6 @@ module GData
     # It can be used with a GData::Client::GData object.
     class AuthSub
       
-      DEFAULT_OPTIONS = {
-        :private_key => nil }
-      
       # The URL of AuthSubRequest.
       REQUEST_HANDLER = 'https://www.google.com/accounts/AuthSubRequest'
       # The URL of AuthSubSessionToken.
@@ -40,7 +37,7 @@ module GData
       # AuthSub access token.
       attr_accessor :token
       # Private RSA key used to sign secure requests.
-      attr_accessor :private_key
+      attr_reader :private_key
       
       # Initialize the class with a new token. Optionally pass a private
       # key or custom URLs.
@@ -53,7 +50,6 @@ module GData
         
         @token = token
         
-        options = DEFAULT_OPTIONS.merge(options)
         options.each do |key, value|
           self.send("#{key}=", value)
         end

data/lib/gdata/auth/clientlogin.rb

@@ -21,10 +21,6 @@ module GData
     # It can be used with a GData::Client::GData object.
     class ClientLogin
       
-      DEFAULT_OPTIONS = {
-        :auth_url => 'https://www.google.com/accounts/ClientLogin',
-        :account_type => 'HOSTED_OR_GOOGLE' }
-      
       # The ClientLogin authentication handler
       attr_accessor :auth_url
       # One of 'HOSTED_OR_GOOGLE', 'GOOGLE', or 'HOSTED'. 
@@ -45,10 +41,12 @@ module GData
         
         @service = service
         
-        options = DEFAULT_OPTIONS.merge(options)
         options.each do |key, value|
           self.send("#{key}=", value)
         end
+        
+        @auth_url ||= 'https://www.google.com/accounts/ClientLogin'
+        @account_type ||= 'HOSTED_OR_GOOGLE'
       end
       
       # Retrieves a token for the given username and password.
@@ -57,13 +55,15 @@ module GData
       # to a previously issued CAPTCHA challenge.
       def get_token(username, password, source, login_token = nil, 
           login_captcha = nil)
-        source = CGI.escape(source)
-        password = CGI.escape(password)
-        username = CGI.escape(username)
-        body = "accountType=#{@account_type}&Email=#{username}" +
-               "&Passwd=#{password}&service=#{@service}&source=#{source}"
+        body = Hash.new
+        body['accountType'] = @account_type
+        body['Email'] = username
+        body['Passwd'] = password
+        body['service'] = @service
+        body['source'] = source
         if login_token and login_captcha
-          body += "&logintoken=#{login_token}&logincaptcha=#{login_captcha}"
+          body['logintoken'] = login_token
+          body['logincaptcha'] = login_captcha
         end
         
         request = GData::HTTP::Request.new(@auth_url, :body => body, 

data/lib/gdata/client.rb

@@ -12,7 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'gdata/client/gdata'
+require 'gdata/client/base'
+require 'gdata/client/apps'
+require 'gdata/client/blogger'
+require 'gdata/client/booksearch'
+require 'gdata/client/calendar'
+require 'gdata/client/contacts'
+require 'gdata/client/doclist'
+require 'gdata/client/finance'
+require 'gdata/client/gbase'
+require 'gdata/client/gmail'
+require 'gdata/client/health'
+require 'gdata/client/notebook'
+require 'gdata/client/photos'
+require 'gdata/client/spreadsheets'
+require 'gdata/client/webmaster_tools'
 require 'gdata/client/youtube'
   
 module GData

data/lib/gdata/client/apps.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GData
+  module Client
+    
+    # Client class to wrap working with the Apps Provisioning API.
+    class Apps < Base
+      
+      def initialize(options = {})
+        options[:clientlogin_service] ||= 'apps'
+        super(options)
+      end
+    end
+  end
+end

data/lib/gdata/client/{gdata.rb → base.rb}

@@ -19,16 +19,6 @@ module GData
     
     # A client object used to interact with different Google Data APIs.
     class Base
-      
-      DEFAULT_OPTIONS = {
-        :auth_handler => nil,
-        :http_service => GData::HTTP::DefaultService,
-        :version => "2",
-        :clientlogin_url => nil,
-        :clientlogin_service => nil,
-        :authsub_scope => nil,
-        :headers => {},
-        :source => 'AnonymousApp' }
     
       # A subclass of GData::Auth that handles authentication signing.
       attr_accessor :auth_handler
@@ -49,13 +39,37 @@ module GData
       attr_accessor :source
       
       def initialize(options = {})
-        options = DEFAULT_OPTIONS.merge(options)
         options.each do |key, value|
           self.send("#{key}=", value)
         end
+        
+        @headers ||= {}
+        @http_service ||= GData::HTTP::DefaultService
+        @version ||= '2'
+        @source ||= 'AnonymousApp'
+      end
+      
+      # Sends an HTTP request with the given file as a stream
+      def make_file_request(method, url, file_path, mime_type, entry = nil)
+        if not File.readable?(file_path)
+          raise ArgumentError, "File #{file_path} is not readable."
+        end
+        file = File.open(file_path, 'rb')
+        @headers['Slug'] = File.basename(file_path)
+        if entry
+          @headers['MIME-Version'] = '1.0'
+          body = GData::HTTP::MimeBody.new(entry, file, mime_type)
+          @headers['Content-Type'] = body.content_type
+          response = self.make_request(method, url, body)
+        else
+          @headers['Content-Type'] = mime_type
+          response = self.make_request(method, url, file)
+        end
+        file.close
+        return response
       end
       
-      # Sends an HTTP request and parses the result with REXML.
+      # Sends an HTTP request and return the response.
       def make_request(method, url, body = '')
         headers = self.prepare_headers
         request = GData::HTTP::Request.new(url, :headers => headers, 
@@ -80,21 +94,10 @@ module GData
         when 500
           raise ServerError, response.body
         else
-          raise UnknownError, response.status_code + ' ' + response.body
+          raise UnknownError, "#{response.status_code} #{response.body}"
         end
         
-        if response.body
-          begin
-            document = REXML::Document.new(response.body).root
-            if document.nil?
-              return response.body
-            else
-              return document
-            end
-          rescue
-            return response.body
-          end
-        end
+        return response
       end
       
       # Performs an HTTP GET against the API.
@@ -107,11 +110,21 @@ module GData
         return self.make_request(:put, url, body)
       end
       
+      # Performs an HTTP PUT with the given file
+      def put_file(url, file_path, mime_type, entry = nil)
+        return self.make_file_request(:put, url, file_path, mime_type, entry)
+      end
+      
       # Performs an HTTP POST against the API.
       def post(url, body)
         return self.make_request(:post, url, body)
       end
       
+      # Performs an HTTP POST with the given file
+      def post_file(url, file_path, mime_type, entry = nil)
+        return self.make_file_request(:post, url, file_path, mime_type, entry)
+      end
+      
       # Performs an HTTP DELETE against the API.
       def delete(url)
         return self.make_request(:delete, url)
@@ -122,7 +135,10 @@ module GData
         headers = @headers
         headers['GData-Version'] = @version
         headers['User-Agent'] = GData::Auth::SOURCE_LIB_STRING + @source
-        headers['Content-Type'] = 'application/atom+xml'
+        # by default we assume we are sending Atom entries
+        if not headers.has_key?('Content-Type')
+          headers['Content-Type'] = 'application/atom+xml'
+        end
         return headers
       end
       

data/lib/gdata/client/blogger.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GData
+  module Client
+    
+    # Client class to wrap working with the Blogger API.
+    class Blogger < Base
+      
+      def initialize(options = {})
+        options[:clientlogin_service] ||= 'blogger'
+        options[:authsub_scope] ||= 'http://www.blogger.com/feeds/'
+        super(options)
+      end
+    end
+  end
+end

data/lib/gdata/client/booksearch.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GData
+  module Client
+    
+    # Client class to wrap working with the Book Search Data API.
+    class BookSearch < Base
+      
+      def initialize(options = {})
+        options[:clientlogin_service] ||= 'print'
+        options[:authsub_scope] ||= 'http://www.google.com/books/feeds/'
+        super(options)
+      end
+    end
+  end
+end

data/lib/gdata/client/calendar.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GData
+  module Client
+    
+    # Client class to wrap working with the Calendar Data API.
+    class Calendar < Base
+      
+      def initialize(options = {})
+        options[:clientlogin_service] ||= 'cl'
+        options[:authsub_scope] ||= 'http://www.google.com/calendar/feeds/'
+        super(options)
+      end
+    end
+  end
+end