gdata 0.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README

@@ -0,0 +1,71 @@
+= GData
+
+* http://code.google.com/p/gdata
+
+== DESCRIPTION:
+
+Ruby wrapper for working with Google Data APIs
+
+== SYNOPSIS:
+
+  yt = GData::Client::YouTube.new
+  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')
+  
+  # creating, updating, and deleting a playlist
+  
+  entry = <<-EOF
+  <entry xmlns="http://www.w3.org/2005/Atom"
+      xmlns:yt="http://gdata.youtube.com/schemas/2007">
+    <title type="text">Ruby Utility Unit Test</title>
+    <summary>This is a test playlist.</summary>
+  </entry>
+  EOF
+  
+  response = yt.post('http://gdata.youtube.com/feeds/api/users/default/playlists', entry)
+  
+  edit_uri = response.elements["link[@rel='edit']"].attributes['href']
+  
+  response.elements["summary"].text = "Updated description"
+  
+  response = yt.put(edit_uri, response.to_s)
+  
+  yt.delete(edit_uri)
+
+== REQUIREMENTS:
+
+* A sunny disposition
+
+Tested against Ruby 1.8.6 patch level 114
+
+== INSTALL:
+
+  sudo gem install gdata
+
+To generate documentation:
+
+  rake rdoc
+  
+To run unit tests:
+  
+  cp test/test_config.yml.example test/test_config.yml
+  # edit test/test_config.yml
+  rake test
+
+== LICENSE:
+
+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.

data/Rakefile

@@ -0,0 +1,72 @@
+# 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 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+task :default => [:test]
+task :doc => [:rdoc]
+
+task :test do
+  ruby "test/ts_gdata.rb"
+end
+
+task :prepdoc do
+  doc_files = FileList.new('doc/**/*.html')
+  doc_files.each do |file|
+    system "svn propset svn:mime-type 'text/html' #{file}"
+  end
+  css_files = FileList.new('doc/**/*.css')
+  css_files.each do |file|
+    system "svn propset svn:mime-type 'text/css' #{file}"
+  end
+end
+
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README'
+  rd.rdoc_files.include('README', 'lib/**/*.rb')
+  rd.rdoc_dir = 'doc'
+end
+
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Jeff Fisher'
+  s.email = 'jfisher@youtube.com'
+  s.homepage = 'http://code.google.com/p/gdata-ruby-util'
+  s.summary = "Google Data APIs Ruby Utility Library"
+  s.rubyforge_project = 'gdata'
+  s.name = 'gdata'
+  s.version = '0.0.1'
+  s.requirements << 'none'
+  s.require_path = 'lib'
+  s.test_files = FileList['test/ts_gdata.rb']
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.rdoc_options << '--main' << 'README'
+  s.files = FileList.new('[A-Z]*', 'lib/**/*.rb', 'test/**/*') do |fl|
+    fl.exclude(/test_config\.yml$/)
+  end
+  s.description = <<EOF
+This gem provides a set of wrappers designed to make it easy to work with 
+the Google Data APIs.
+EOF
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/lib/gdata.rb

@@ -0,0 +1,19 @@
+# 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'

data/lib/gdata/auth.rb

@@ -0,0 +1,22 @@
+# 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/auth/clientlogin'
+require 'gdata/auth/authsub'
+
+module GData
+  module Auth
+    SOURCE_LIB_STRING = 'GoogleDataRubyUtil-'
+  end
+end

data/lib/gdata/auth/authsub.rb

@@ -0,0 +1,168 @@
+# 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 'cgi'
+require 'openssl'
+require 'base64'
+
+module GData
+  module Auth
+    
+    # This class implements AuthSub signatures for Data API requests.
+    # 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.
+      SESSION_HANDLER = 'https://www.google.com/accounts/AuthSubSessionToken'
+      # The URL of AuthSubRevokeToken.
+      REVOKE_HANDLER = 'https://www.google.com/accounts/AuthSubRevokeToken'
+      # The URL of AuthSubInfo.
+      INFO_HANDLER =  'https://www.google.com/accounts/AuthSubTokenInfo'
+      # 2 ** 64, the largest 64 bit unsigned integer
+      BIG_INT_MAX = 18446744073709551616
+      
+      # AuthSub access token.
+      attr_accessor :token
+      # Private RSA key used to sign secure requests.
+      attr_accessor :private_key
+      
+      # Initialize the class with a new token. Optionally pass a private
+      # key or custom URLs.
+      def initialize(token, options = {})
+        if token.nil?
+          raise ArgumentError, "Token cannot be nil."
+        elsif token.class != String
+          raise ArgumentError, "Token must be a String."
+        end
+        
+        @token = token
+        
+        options = DEFAULT_OPTIONS.merge(options)
+        options.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      end
+      
+      # Set the private key to use with this AuthSub token.
+      # The key can be an OpenSSL::PKey::RSA object, a string containing a
+      # private key in PEM format, or a string specifying a path to a PEM
+      # file that contains the private key.
+      def private_key=(key)
+        begin
+          if key.nil? or key.class == OpenSSL::PKey::RSA
+            @private_key = key
+          elsif File.exists?(key)
+            key_from_file = File.read(key)
+            @private_key = OpenSSL::PKey::RSA.new(key_from_file)
+          else
+            @private_key = OpenSSL::PKey::RSA.new(key)
+          end
+        rescue
+          raise ArgumentError, "Not a valid private key."
+        end
+      end
+      
+      # Sign a GData::Http::Request object with a valid AuthSub Authorization
+      # header.
+      def sign_request!(request)
+        header = "AuthSub token=\"#{@token}\""
+        
+        if @private_key
+          time = Time.now.to_i
+          nonce = OpenSSL::BN.rand_range(BIG_INT_MAX)
+          method = request.method.to_s.upcase
+          data = "#{method} #{request.url} #{time} #{nonce}"
+          sig = @private_key.sign(OpenSSL::Digest::SHA1.new, data)
+          sig = Base64.encode64(sig).gsub(/\n/, '')
+          header = "#{header} sigalg=\"rsa-sha1\" data=\"#{data}\""
+          header = "#{header} sig=\"#{sig}\""
+        end
+        
+        request.headers['Authorization'] = header
+      end
+      
+      # Upgrade the current token into a session token.
+      def upgrade
+        request = GData::HTTP::Request.new(SESSION_HANDLER)
+        sign_request!(request)
+        service = GData::HTTP::DefaultService.new
+        response = service.make_request(request)
+        if response.status_code != 200
+          raise GData::Client::AuthorizationError, 
+            "#{response.status_code} : #{response.body}"
+        end
+        
+        @token = response.body[/Token=(.*)/,1]
+        return @token
+        
+      end
+      
+      # Return some information about the current token. If the current token
+      # is a one-time use token, this operation will use it up!
+      def info
+        request = GData::HTTP::Request.new(INFO_HANDLER)
+        sign_request!(request)
+        service = GData::HTTP::DefaultService.new
+        response = service.make_request(request)
+        if response.status_code != 200
+          raise GData::Client::AuthorizationError, 
+            "#{response.status_code} : #{response.body}"
+        end
+        
+        result = {}
+        result[:target] = response.body[/Target=(.*)/,1]
+        result[:scope] = response.body[/Scope=(.*)/,1]
+        result[:secure] = response.body[/Secure=(.*)/,1]
+        return result
+       
+      end
+      
+      # Revoke the token.
+      def revoke
+        request = GData::HTTP::Request.new(REVOKE_HANDLER)
+        sign_request!(request)
+        service = GData::HTTP::DefaultService.new
+        response = service.make_request(request)
+        if response.status_code != 200
+          raise GData::Client::AuthorizationError, 
+            "#{response.status_code} : #{response.body}"
+        end
+
+      end
+      
+      # Return the proper URL for an AuthSub approval page with the requested
+      # scope. next_url should be a URL that points back to your code that
+      # will receive the token. domain is optionally a Google Apps domain.
+      def self.get_url(next_url, scope, secure = false, session = true, 
+          domain = nil)
+        next_url = CGI.escape(next_url)
+        scope = CGI.escape(scope)
+        secure = secure ? 1 : 0
+        session = session ? 1 : 0
+        body = "next=#{next_url}&scope=#{scope}&session=#{session}" +
+               "&secure=#{secure}"
+        if domain
+          domain = CGI.escape(domain)
+          body = "#{body}&hd=#{domain}"
+        end
+        return "#{REQUEST_HANDLER}?#{body}"
+      end
+    end
+  end
+end