gdata_19 1.1.2

data/lib/gdata/client.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+# 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.
+
+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
+  module Client
+
+    # Base class for GData::Client errors
+    class Error < RuntimeError
+    end
+
+    # Base class for errors raised due to requests
+    class RequestError < Error
+
+      # The Net::HTTPResponse that caused this error.
+      attr_accessor :response
+
+      # Creates a new RequestError from Net::HTTPResponse +response+ with a
+      # message containing the error code and response body.
+      def initialize(response)
+        @response = response
+
+        super "request error #{response.status_code}: #{response.body}"
+      end
+
+    end
+
+    class AuthorizationError < RequestError
+    end
+    
+    class BadRequestError < RequestError
+    end
+    
+    # An error caused by ClientLogin issuing a CAPTCHA error.
+    class CaptchaError < RuntimeError
+      # The token identifying the CAPTCHA
+      attr_reader :token
+      # The URL to the CAPTCHA image
+      attr_reader :url
+      
+      def initialize(token, url)
+        @token = token
+        @url = url
+      end
+    end
+    
+    class ServerError < RequestError
+    end
+    
+    class UnknownError < RequestError
+    end
+    
+    class VersionConflictError < RequestError
+    end  
+    
+  end
+end

data/lib/gdata/http/default_service.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+# 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.
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module GData
+  module HTTP
+  
+    # This is the default implementation of the HTTP layer that uses
+    # Net::HTTP. You could roll your own if you have different requirements
+    # or cannot use Net::HTTP for some reason.
+    class DefaultService
+    
+      # Take a GData::HTTP::Request, execute the request, and return a
+      # GData::HTTP::Response object.
+      def make_request(request)
+        url = URI.parse(request.url)
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = (url.scheme == 'https')
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        
+        case request.method
+        when :get
+          req = Net::HTTP::Get.new(url.request_uri)
+        when :put
+          req = Net::HTTP::Put.new(url.request_uri)
+        when :post
+          req = Net::HTTP::Post.new(url.request_uri)
+        when :delete
+          req = Net::HTTP::Delete.new(url.request_uri)
+        else
+          raise ArgumentError, "Unsupported HTTP method specified."
+        end
+        
+        case request.body
+        when String
+          req.body = request.body
+        when Hash
+          req.set_form_data(request.body)
+        when File
+          req.body_stream = request.body
+          request.chunked = true
+        when GData::HTTP::MimeBody
+          req.body_stream = request.body
+          request.chunked = true
+        else
+          req.body = request.body.to_s
+        end
+        
+        request.headers.each do |key, value|
+          req[key] = value
+        end
+        
+        request.calculate_length!
+        
+        res = http.request(req)
+        
+        response = Response.new
+        response.body = res.body
+        response.headers = Hash.new
+        res.each do |key, value|
+          response.headers[key] = value
+        end
+        response.status_code = res.code.to_i
+        return response
+      end
+    end
+  end
+end

data/lib/gdata/http/mime_body.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+# 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 HTTP
+  
+    # Class acts as a virtual file handle to a MIME multipart message body
+    class MimeBody
+      
+      # The MIME boundary being used.
+      attr_reader :boundary
+      
+      # All fields are required, the entry should be a string and is assumed
+      # to be XML.
+      def initialize(entry, file, file_mime_type)
+        @boundary = "END_OF_PART_#{rand(64000)}"
+        entry = wrap_entry(entry, file_mime_type)
+        closing_boundary = MimeBodyString.new("\r\n--#{@boundary}--")
+        @parts = [entry, file, closing_boundary]
+        @current_part = 0
+      end
+      
+      # Implement read so that this class can be treated as a stream.
+      def read(bytes_requested)
+        if @current_part >= @parts.length
+          return false
+        end
+        
+        buffer = @parts[@current_part].read(bytes_requested)
+        
+        until buffer.length == bytes_requested
+          @current_part += 1
+          next_buffer = self.read(bytes_requested - buffer.length)
+          break if not next_buffer
+          buffer += next_buffer
+        end
+        
+        return buffer
+      end
+      
+      # Returns the content type of the message including boundary.
+      def content_type
+        return "multipart/related; boundary=\"#{@boundary}\""
+      end
+      
+      private
+      
+      # Sandwiches the entry body into a MIME message
+      def wrap_entry(entry, file_mime_type)
+        wrapped_entry = "--#{@boundary}\r\n"
+        wrapped_entry += "Content-Type: application/atom+xml\r\n\r\n"
+        wrapped_entry += entry
+        wrapped_entry += "\r\n--#{@boundary}\r\n"
+        wrapped_entry += "Content-Type: #{file_mime_type}\r\n\r\n"
+        return MimeBodyString.new(wrapped_entry)
+      end
+    
+    end
+    
+    # Class makes a string into a stream-like object
+    class MimeBodyString
+      
+      def initialize(source_string)
+        @string = source_string
+        @bytes_read = 0
+      end
+      
+      # Implement read so that this class can be treated as a stream.
+      def read(bytes_requested)
+        if RUBY_VERSION < '1.9'
+          max_bytes = @string.length
+        else
+          max_bytes = @string.bytesize
+        end
+        if @bytes_read == max_bytes
+          return false
+        elsif bytes_requested > max_bytes - @bytes_read
+          bytes_requested = max_bytes - @bytes_read
+        end
+        
+        buffer = @string[@bytes_read, bytes_requested]
+        @bytes_read += bytes_requested
+        
+        return buffer
+      end
+    end
+  end
+end

data/lib/gdata/http/request.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+# 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.
+
+require "rexml/document"
+
+module GData
+  module HTTP
+  
+    # Very simple class to hold everything about an HTTP request.
+    class Request
+    
+      # The URL of the request.
+      attr_accessor :url
+      # The body of the request.
+      attr_accessor :body
+      # The HTTP method being used in the request.
+      attr_accessor :method
+      # The HTTP headers of the request.
+      attr_accessor :headers
+      
+      # Only the URL itself is required, everything else is optional.
+      def initialize(url, options = {})
+        @url = url
+        options.each do |key, value|
+          self.send("#{key}=", value)
+        end
+        
+        @method ||= :get
+        @headers ||= {}
+      end
+      
+      # Returns whether or not a request is chunked.
+      def chunked?
+        if @headers['Transfer-Encoding'] == 'chunked'
+          return true
+        else
+          return false
+        end
+      end
+      
+      # Sets if the request is using chunked transfer-encoding.
+      def chunked=(enabled)
+        if enabled
+          @headers['Transfer-Encoding'] = 'chunked'
+        else
+          @headers.delete('Transfer-Encoding')
+        end
+      end
+      
+      # Calculates and sets the length of the body.
+      def calculate_length!
+        if not @headers['Content-Length'] and not chunked? \
+          and method != :get and method != :delete
+          if @body
+            @headers['Content-Length'] = @body.length
+          else
+            @headers['Content-Length'] = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gdata/http/response.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+# 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.
+
+require 'gdata/client'
+
+module GData
+  module HTTP
+  
+    # An extremely simple class to hold the values of an HTTP response.
+    class Response
+    
+      # The HTTP response code.
+      attr_accessor :status_code
+      # The body of the HTTP response.
+      attr_accessor :body
+      # The headers of the HTTP response.
+      attr_accessor :headers
+      
+      # Converts the response body into a REXML::Document
+      def to_xml
+        if @body
+          begin
+            return REXML::Document.new(@body).root
+          rescue
+            raise GData::Client::Error, "Response body not XML."
+          end
+        else
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/gdata/http.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+# 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.
+
+require 'gdata/http/default_service'
+require 'gdata/http/mime_body'
+require 'gdata/http/request'
+require 'gdata/http/response'

data/lib/gdata.rb

@@ -0,0 +1,24 @@
+# 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.
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'gdata/http'
+require 'gdata/client'
+require 'gdata/auth'
+if RUBY_VERSION < '1.9'
+  # This is for Unicode "support" in Ruby 1.8
+  $KCODE = 'UTF8'
+  require 'jcode'
+end

data/test/tc_gdata_auth_authsub.rb

@@ -0,0 +1,53 @@
+# 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.
+
+$:.unshift(File.dirname(__FILE__))
+require 'test_helper'
+
+class TC_GData_Auth_AuthSub < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def test_make_authenticated_request
+    token = self.get_authsub_token()
+    key = self.get_authsub_private_key()
+    service = GData::Client::YouTube.new
+    if token
+      
+      service.authsub_token = token
+      if key
+        service.authsub_private_key = key
+      end
+      
+      feed = service.get('http://gdata.youtube.com/feeds/api/users/default/uploads?max-results=1')
+      self.assert_not_nil(feed, 'Feed should not be nil')
+    end
+  end
+  
+  def test_generate_url
+    scope = 'http://gdata.youtube.com'
+    next_url = 'http://example.com'
+    secure = true
+    session = false
+    url = GData::Auth::AuthSub.get_url(next_url, scope, secure, session)
+    self.assert_equal('https://www.google.com/accounts/AuthSubRequest?next=http%3A%2F%2Fexample.com&scope=http%3A%2F%2Fgdata.youtube.com&session=0&secure=1', url)
+    
+    # test generating with a pre-populated scope
+    yt = GData::Client::YouTube.new
+    client_url = yt.authsub_url(next_url, secure, session)
+    self.assert_equal(url, client_url)
+    
+  end
+  
+end

data/test/tc_gdata_auth_clientlogin.rb

@@ -0,0 +1,59 @@
+# 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.
+
+$:.unshift(File.dirname(__FILE__))
+require 'test_helper'
+
+class TC_GData_Auth_ClientLogin < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def test_has_config
+    self.assert_not_nil(self.get_username(), 
+      'Must have a username in test_config.yml')
+    self.assert_not_nil(self.get_password(), 
+      'Must have a password in test_config.yml')
+  end
+  
+  def test_get_token
+    client_login = GData::Auth::ClientLogin.new('cl')
+    source = 'GDataUnitTest'
+    assert_nothing_raised do
+      token = client_login.get_token(self.get_username(), self.get_password(), source)
+    end
+  end
+  
+  def test_all_clients
+    source = 'GDataUnitTest'
+    GData::Client.constants.each do |const_name|
+      const = GData::Client.const_get(const_name)
+      if const.superclass == GData::Client::Base
+        instance = const.new
+        assert_nothing_raised do
+          instance.clientlogin(self.get_username(), self.get_password(), source)
+        end
+      end
+    end
+  end
+  
+  def test_specify_account_type
+    gp = GData::Client::Photos.new
+    gp.source = 'GDataUnitTest'
+    assert_nothing_raised do
+      token = gp.clientlogin(self.get_username(), self.get_password(), nil, nil, nil, 'GOOGLE')
+    end
+  end
+  
+  
+end

data/test/tc_gdata_client_base.rb

@@ -0,0 +1,37 @@
+# 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.
+
+$:.unshift(File.dirname(__FILE__))
+require 'test_helper'
+
+class TC_GData_Client_Base < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def test_simple_gdata_get
+    service = GData::Client::Base.new
+    feed = service.get('http://gdata.youtube.com/feeds/base/videos?max-results=1').to_xml
+    assert_not_nil(feed, 'feed can not be nil')
+  end
+  
+  def test_clientlogin_with_service
+    service = GData::Client::Base.new
+    service.clientlogin(self.get_username(), self.get_password(), nil, nil, 
+      'youtube')
+    feed = service.get('http://gdata.youtube.com/feeds/api/users/default/uploads?max-results=1').to_xml
+    assert_not_nil(feed, 'feed can not be nil')
+  end
+  
+end
+    

data/test/tc_gdata_client_calendar.rb

@@ -0,0 +1,40 @@
+# 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.
+
+$:.unshift(File.dirname(__FILE__))
+require 'test_helper'
+
+class TC_GData_Client_Calendar < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    @cl = GData::Client::Calendar.new
+    @cl.clientlogin(self.get_username, self.get_password)
+  end
+  
+  def test_get_all_calendars    
+    response = @cl.get('http://www.google.com/calendar/feeds/default/allcalendars/full')
+    self.assert_equal(200, response.status_code, 'Must not be a redirect.')
+    self.assert_not_nil(@cl.session_cookie, 'Must have a session cookie.')
+    feed = response.to_xml
+    self.assert_not_nil(feed, 'feed can not be nil')
+    
+    #login again to make sure the session cookie gets cleared
+    @cl.clientlogin(self.get_username, self.get_password)
+    self.assert_nil(@cl.session_cookie, 'Should clear session cookie.')
+  end
+
+  
+end