gdata_plus 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+gem "activesupport"
+gem "oauth"
+gem "typhoeus"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "sinatra"
+
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "mocha"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.10)
+      rake
+    oauth (0.4.4)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    sinatra (1.1.0)
+      rack (~> 1.1)
+      tilt (~> 1.1)
+    tilt (1.1)
+    typhoeus (0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  mocha
+  oauth
+  rcov
+  shoulda
+  sinatra
+  typhoeus

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brian Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,51 @@
+= gdata_plus
+
+{Source code}[https://github.com/balexand/gdata_plus] | {RDoc}[http://rubydoc.info/gems/gdata_plus/frames] | {Ruby Gem}[https://rubygems.org/gems/gdata_plus]
+
+Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client.
+
+== Installation
+
+  gem install gdata_plus
+
+== Authentication
+
+=== OAuth
+
+TODO
+
+==== Using an existing access token
+
+TODO
+
+=== ClientLogin
+
+TODO
+
+=== Serializing authenticators
+
+TODO
+
+== Making requests
+
+TODO
+
+== Error handling
+
+TODO
+
+== Ruby support
+
+This project is tested against Ruby 1.8.7 and Ruby 1.9.2. There is an {issue}[https://github.com/balexand/gdata_plus/issues/1] with international characters and OAuth that affects Ruby 1.8.7.
+
+== Contributions
+
+This project is actively maintained. Please submit an issue if you find any bugs or want to request a new feature. Contributions are welcome. Please run the tests with Ruby 1.9.2 and 1.8.7 before submitting a pull request:
+
+  rake test
+
+== Copyright
+
+Copyright (c) 2010 Brian Alexander. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gdata_plus"
+  gem.homepage = "http://github.com/balexand/gdata_plus"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client}
+  gem.description = %Q{Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client}
+  gem.email = "balexand@gmail.com"
+  gem.authors = ["Brian Alexander"]
+
+  gem.files.exclude "examples"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gdata_plus #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/client_login_example.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'gdata_plus'
+require 'highline/import' # gem install highline
+require 'typhoeus'
+
+# prompt for email/password
+email = ask("Enter your email:  ")
+password = ask("Enter your password:  ") { |q| q.echo = "x" }
+
+# authenticate using email/password
+authenticator = GDataPlus::Authenticator::ClientLogin.new(:service => "lh2", :source => "balexand-gdata_plus-1")
+authenticator.authenticate(email, password)
+
+response = authenticator.client.get("https://picasaweb.google.com/data/feed/api/user/default")
+puts response.inspect

data/examples/oauth_example.rb

@@ -0,0 +1,37 @@
+# you don't need the following line if you've installed the gem
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require 'gdata_plus'
+require 'sinatra'
+require 'typhoeus'
+
+# NOTE: put your consumer key and secret here or set environment vars
+CONSUMER_KEY = ENV["GDATA_CONSUMER_KEY"]
+CONSUMER_SECRET = ENV["GDATA_CONSUMER_SECRET"]
+
+set :sessions, true # enable Sinatra sessions
+
+get "/" do
+  oauth_callback = "#{request.scheme}://#{request.host}:#{request.port}/callback"
+
+  authenticator = GDataPlus::Authenticator::OAuth.new(:consumer_key => CONSUMER_KEY, :consumer_secret => CONSUMER_SECRET)
+  request_token = authenticator.fetch_request_token(:scope => "https://picasaweb.google.com/data/", :oauth_callback => oauth_callback)
+
+  # store authenticator in the session since we'll need it when exchanging request token for an access token
+  session[:gdata_authenticator] = authenticator
+
+  redirect request_token.authorize_url
+end
+
+get "/callback" do
+  authenticator = session[:gdata_authenticator]
+  authenticator.fetch_access_token(params[:oauth_verifier])
+  redirect "/picasa_album_list"
+end
+
+get "/picasa_album_list" do
+  authenticator = session[:gdata_authenticator]
+  response = authenticator.client.get("https://picasaweb.google.com/data/feed/api/user/default")
+
+  response.inspect
+end

data/gdata_plus.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gdata_plus}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Alexander"]
+  s.date = %q{2010-12-31}
+  s.description = %q{Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client}
+  s.email = %q{balexand@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "gdata_plus.gemspec",
+    "lib/gdata_plus.rb",
+    "lib/gdata_plus/authenticator/client_login.rb",
+    "lib/gdata_plus/authenticator/common.rb",
+    "lib/gdata_plus/authenticator/o_auth.rb",
+    "lib/gdata_plus/client.rb",
+    "lib/gdata_plus/exception.rb",
+    "lib/gdata_plus/util.rb",
+    "test/authenticator/client_login_test.rb",
+    "test/authenticator/o_auth_test.rb",
+    "test/client_test.rb",
+    "test/exception_test.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/balexand/gdata_plus}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client}
+  s.test_files = [
+    "examples/client_login_example.rb",
+    "examples/oauth_example.rb",
+    "test/authenticator/client_login_test.rb",
+    "test/authenticator/o_auth_test.rb",
+    "test/client_test.rb",
+    "test/exception_test.rb",
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<oauth>, [">= 0"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<oauth>, [">= 0"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/gdata_plus/authenticator/client_login.rb

@@ -0,0 +1,60 @@
+require 'typhoeus'
+
+module GDataPlus
+  module Authenticator
+    class ClientLogin
+      include Common
+
+      # {Account type GOOGLE}[http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request]
+      TYPE_GOOGLE = "GOOGLE"
+      # {Account type HOSTED}[http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request]
+      TYPE_HOSTED = "HOSTED"
+      # {Account type HOSTED_OR_GOOGLE}[http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request]
+      TYPE_HOSTED_OR_GOOGLE = "HOSTED_OR_GOOGLE"
+
+      attr_accessor :auth_token
+
+      # === Options
+      # [:service]
+      #   (required) Name of service to which you are authenticating.
+      #   {Click here for a list of possible values}[http://code.google.com/apis/gdata/faq.html#clientlogin].
+      # [:source]
+      #   (required) Short string identifying your application, for logging purposes. This string should take
+      #   the form: "companyName-applicationName-versionID".
+      # [:account_type]
+      #   Account type to login. Defaults to TYPE_HOSTED_OR_GOOGLE.
+      #   {Click here for details}[http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request].
+      def initialize(options = {})
+        options = Util.prepare_options(options, [:service, :source], [:account_type])
+        options[:account_type] ||= TYPE_HOSTED_OR_GOOGLE
+
+        @service = options[:service]
+        @source = options[:source]
+        @account_type = options[:account_type]
+      end
+
+      def authenticate(email, password, hydra = Typhoeus::Hydra.new)
+        request = Typhoeus::Request.new("https://www.google.com/accounts/ClientLogin", :method => :post, :params => {
+          :accountType => @accountType,
+          :Email => email,
+          :Passwd => password,
+          :service => @service,
+          :source => @source
+        })
+
+        hydra.queue request
+        hydra.run
+        response = request.response
+
+        Util.raise_if_error(response)
+        @auth_token = /Auth=(.+)$/.match(response.body)[1]
+      end
+
+      def sign_request(request)
+        raise ArgumentError, "request must be a Typeoeus::Request" unless request.is_a? ::Typhoeus::Request
+        request.headers["Authorization"] = "GoogleLogin auth=#{@auth_token}"
+        request
+      end
+    end
+  end
+end

data/lib/gdata_plus/authenticator/common.rb

@@ -0,0 +1,9 @@
+module GDataPlus
+  module Authenticator
+    module Common
+      def client(*args)
+        Client.new(self, *args)
+      end
+    end
+  end
+end

data/lib/gdata_plus/authenticator/o_auth.rb

@@ -0,0 +1,104 @@
+require 'oauth'
+require 'oauth/request_proxy/typhoeus_request'
+require 'typhoeus'
+
+# Methods prefixed with "fetch" indicate that a request is being made to Google.
+module GDataPlus
+  module Authenticator
+    class OAuth
+      include Common
+
+      # Create a new instance.
+      #
+      # === Options
+      # [:consumer_key] (required)
+      # [:consumer_secret] (required)
+      # TODO document optional options
+      def initialize(options = {})
+        required_options = [:consumer_key, :consumer_secret]
+        optional_options = [:request_token, :request_secret, :access_token, :access_secret]
+        options = Util.prepare_options(options, required_options, optional_options)
+
+        (required_options + optional_options).each do |option_name|
+          instance_variable_set :"@#{option_name}", options[option_name]
+        end
+      end
+
+      def consumer
+        ::OAuth::Consumer.new(@consumer_key, @consumer_secret,
+          :request_token_url => "https://www.google.com/accounts/OAuthGetRequestToken",
+          :authorize_url => "https://www.google.com/accounts/OAuthAuthorizeToken",
+          :access_token_url => "https://www.google.com/accounts/OAuthGetAccessToken"
+        )
+      end
+
+      # === Arguments
+      # [options] (required) see options documentation below
+      # [additional_oauth_options]
+      #   additional oauth params to pass to
+      #   {get_request_token}[http://rdoc.info/github/oauth/oauth-ruby/master/OAuth/Consumer#get_request_token-instance_method];
+      #   you will normally leave this blank
+      # [additional_request_params]
+      #   additional params to pass with request; you will normally leave this blank
+      #
+      # === Options
+      # [:scope]
+      #   (required) gdata {scope}[http://code.google.com/apis/gdata/faq.html#AuthScopes]; can be an Array or a String
+      # [:oauth_callback]
+      #   (required) Google will redirect the user back to this URL after authentication
+      def fetch_request_token(options = {}, additional_oauth_options = {}, additional_request_params = {})
+        options = ::GDataPlus::Util.prepare_options(options, [:scope, :oauth_callback])
+
+        additional_oauth_options.merge!(:oauth_callback => options[:oauth_callback])
+
+        scope = options[:scope]
+        scope = scope.join(" ") if scope.is_a? Array
+        additional_request_params.merge!(:scope => scope)
+
+        request_token = consumer.get_request_token(additional_oauth_options, additional_request_params)
+        @request_token = request_token.token
+        @request_secret = request_token.secret
+        request_token
+        # TODO deal with error response
+      end
+
+      def request_token
+        if @request_token && @request_secret
+          ::OAuth::RequestToken.new(consumer, @request_token, @request_secret)
+        end
+      end
+
+      # Exchanges the request token for the access token. The "oauth_verifier" is passed as a
+      # URL parameter when Google redirects the client back to your oauth_callback URL.
+      def fetch_access_token(oauth_verifier)
+        access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
+        @access_token = access_token.token
+        @access_secret = access_token.secret
+        @request_token = nil
+        @request_secret = nil
+        access_token
+
+        # TODO deal with error response
+      end
+
+      def access_token
+        if @access_token && @access_secret
+          ::OAuth::AccessToken.new(consumer, @access_token, @access_secret)
+        end
+      end
+
+      # Adds authorization header to the specified Typeoeus::Request. The same request is also returned.
+      def sign_request(request)
+        raise ArgumentError, "request must be a Typeoeus::Request" unless request.is_a? ::Typhoeus::Request
+
+        helper = ::OAuth::Client::Helper.new(request, {
+          :consumer => consumer,
+          :request_uri => request.url,
+          :token => access_token
+        })
+        request.headers.merge!({"Authorization" => helper.header})
+        request
+      end
+    end
+  end
+end

data/lib/gdata_plus/client.rb

@@ -0,0 +1,48 @@
+require 'typhoeus'
+
+module GDataPlus
+  class Client
+    attr_reader :authenticator, :default_gdata_version
+
+    def initialize(authenticator, default_gdata_version = "2.0")
+      @authenticator = authenticator
+      @default_gdata_version = default_gdata_version
+    end
+
+    # FIXME detect infinite redirect
+    def submit(request, options = {})
+      options = ::GDataPlus::Util.prepare_options(options, [], [:gdata_version, :hydra, :no_redirect])
+      hydra = options[:hydra] || Typhoeus::Hydra.hydra
+
+      request.headers.merge!("GData-Version" => options[:gdata_version] || default_gdata_version)
+      @authenticator.sign_request(request)
+
+      # add "If-Match: *" header if there is not already a conditional header
+      unless request.headers.keys.any? { |key| key =~ /^If-/ }
+        request.headers.merge!("If-Match" => "*")
+      end
+
+      hydra.queue(request)
+      hydra.run
+      response = request.response
+
+      # automatically follow redirects since some GData APIs (like Calendar) redirect GET requests
+      if request.method.to_sym == :get && !options[:no_redirect] && (300..399).include?(response.code)
+        response = submit ::Typhoeus::Request.new(response.headers_hash["Location"], :method => :get), options.merge(:no_redirect => true)
+      end
+
+      Util.raise_if_error(response)
+
+      response
+    end
+
+    [:delete, :get, :post, :put].each do |method|
+      define_method(method) do |*args|
+        args[1] ||= {}
+        args[1] = args[1].merge(:method => method)
+        request = ::Typhoeus::Request.new(*args)
+        submit request
+      end
+    end
+  end
+end

data/lib/gdata_plus/exception.rb

@@ -0,0 +1,15 @@
+module GDataPlus
+  class Exception < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+
+      if @response.respond_to? :body
+        super(@response.body)
+      else
+        super("no response provided")
+      end
+    end
+  end
+end

data/lib/gdata_plus/util.rb

@@ -0,0 +1,22 @@
+require 'active_support/core_ext/hash/keys'
+
+module GDataPlus
+  module Util
+    module_function
+
+    def prepare_options(options, required_keys, optional_keys = [])
+      options = options.symbolize_keys
+      options.assert_valid_keys(required_keys + optional_keys)
+      required_keys.each do |key|
+        raise ArgumentError, "#{key.inspect} option required" if options[key].nil?
+      end
+      options
+    end
+
+    def raise_if_error(response)
+      unless (200..299).include? response.code
+        raise Exception.new(response)
+      end
+    end
+  end
+end

data/lib/gdata_plus.rb

@@ -0,0 +1,11 @@
+module GDataPlus
+  autoload "Client", "gdata_plus/client"
+  autoload "Exception", "gdata_plus/exception"
+  autoload "Util", "gdata_plus/util"
+
+  module Authenticator
+    autoload "ClientLogin", "gdata_plus/authenticator/client_login"
+    autoload "Common", "gdata_plus/authenticator/common"
+    autoload "OAuth", "gdata_plus/authenticator/o_auth"
+  end
+end

data/test/authenticator/client_login_test.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+# TODO more tests for ClientLogin
+class ClientLoginTest < Test::Unit::TestCase
+  should "authenticate" do
+    GDataPlus::Authenticator::ClientLogin.new(:service => "lh2", :source => "balexand-gdata_plus-1")
+  end
+end

data/test/authenticator/o_auth_test.rb

@@ -0,0 +1,105 @@
+require 'helper'
+require 'typhoeus'
+
+class OAuthTest < Test::Unit::TestCase
+  def valid_constructor_options
+    {
+      :consumer_key => "1234",
+      "consumer_secret" => "5678"
+    }
+  end
+
+  def valid_request_token_options
+    {
+      :oauth_callback => "http://example.com/callback",
+      :scope => "https://docs.google.com/feeds/"
+    }
+  end
+
+  should "initialize" do
+    authenticator = GDataPlus::Authenticator::OAuth.new(valid_constructor_options)
+    assert authenticator.consumer.is_a? OAuth::Consumer
+  end
+
+  should "initialize raise if invalid options passed" do
+    assert_raises(ArgumentError) do
+      GDataPlus::Authenticator::OAuth.new(valid_constructor_options.merge(:consumer_key => nil))
+    end
+
+    assert_raises(ArgumentError) do
+      GDataPlus::Authenticator::OAuth.new(valid_constructor_options.merge(:foo => 'bar'))
+    end
+  end
+
+  should "fetch_request_token raise if invalid options passed" do
+    authenticator = GDataPlus::Authenticator::OAuth.new(valid_constructor_options)
+    assert_raises(ArgumentError) do
+      authenticator.fetch_request_token(valid_request_token_options.merge(:scope => nil))
+    end
+
+    assert_raises(ArgumentError) do
+      authenticator.fetch_request_token(valid_request_token_options.merge(:foo => "bar"))
+    end
+  end
+
+  should "sign_request raise if invalid request passed" do
+    authenticator = GDataPlus::Authenticator::OAuth.new(valid_constructor_options)
+    exception = assert_raises(ArgumentError) do
+      authenticator.sign_request("I'm not a request object")
+    end
+    assert_equal "request must be a Typeoeus::Request", exception.message
+  end
+
+  # uses "Example used in the OAuth Specification" from http://hueniverse.com/2008/10/beginners-guide-to-oauth-part-iv-signing-requests/
+  should "complete oauth workflow" do
+    authenticator = GDataPlus::Authenticator::OAuth.new(:consumer_key => "dpf43f3p2l4k3l03", :consumer_secret => "kd94hf93k423kf44")
+
+    request_token_stub = stub(:token => "foo_request_token", :secret => "bar_request_token_secret")
+    OAuth::Consumer.any_instance.expects(:get_request_token).once.returns(request_token_stub)
+
+    request_token = authenticator.fetch_request_token(:scope => "https://picasaweb.google.com/data/", :oauth_callback => "http://mysite.com/callback")
+    assert_equal request_token_stub, request_token
+
+    access_token_stub = stub(:token => "nnch734d00sl2jdk", :secret => "pfkkdhi9sl3r4s00")
+    OAuth::RequestToken.any_instance.expects(:get_access_token).once.returns(access_token_stub)
+
+    access_token = authenticator.fetch_access_token("foo_oauth_verifier")
+    assert_equal access_token_stub, access_token
+
+    OAuth::Client::Helper.any_instance.expects(:nonce).once.returns("kllo9940pd9333jh")
+    OAuth::Client::Helper.any_instance.expects(:timestamp).once.returns("1191242096")
+
+    request = Typhoeus::Request.new("http://photos.example.net/photos?size=original&file=vacation.jpg")
+    authenticator.sign_request(request)
+
+    assert request.headers["Authorization"] =~ /oauth_signature="tR3%2BTy81lMeYAr%2FFid0kMTYa%2FWM%3D"/,
+      "wrong oauth_signature in Authorization header"
+  end
+
+  # uses "Non-English Parameter" with some custom unicode params from
+  # http://hueniverse.com/2008/10/beginners-guide-to-oauth-part-iv-signing-requests/
+  should "sign_request with international characters" do
+    authenticator = GDataPlus::Authenticator::OAuth.new(
+      :consumer_key => "dpf43f3++p+#2l4k3l03",
+      :consumer_secret => "kd9@4h%%4f93k423kf44",
+      :access_token => "nnch734d(0)0sl2jdk",
+      :access_secret => "pfkkd#hi9_sl-3r=4s00"
+    )
+
+    params = {
+      :latin => "123abc\u00E7",
+      :hebrew => "\u05DC\u05E9",
+      :arabic => "\u0642\u0644"
+    }
+    param_string = params.collect {|k,v| "#{k}=#{CGI.escape(v)}"}.join("&")
+    request = Typhoeus::Request.new("https://bar.example.net/foo?#{param_string}")
+
+    # stub out nonce and timestamp methods
+    OAuth::Client::Helper.any_instance.expects(:nonce).once.returns("kllo~9940~pd9333jh")
+    OAuth::Client::Helper.any_instance.expects(:timestamp).once.returns("1191242096")
+
+    authenticator.sign_request(request)
+    assert request.headers["Authorization"] =~ /oauth_signature="dNDB%2Fb%2BPVt1mnLW0bJAhWo4Jkww%3D"/,
+      "wrong oauth_signature in Authorization header; this is know to fail in Ruby 1.8 but works in 1.9; anyone want to contribute a patch?"
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,66 @@
+require 'helper'
+require 'typhoeus'
+
+class ClientTest < Test::Unit::TestCase
+  # TODO add a test that ensures the If-Match: * is not added if there is already a conditional header
+  should "automatically add If-Match header if an If-* header not already present" do
+    url = "http://foo.com/bar"
+
+    hydra = Typhoeus::Hydra.new
+    hydra.stub(:get, url).and_return(
+      Typhoeus::Response.new(:code => 200, :body => "the body", :time => 0.1)
+    )
+
+    # stub authenticator to do nothing
+    authenticator = Object.new
+    authenticator.expects(:sign_request).once
+
+    client = ::GDataPlus::Client.new(authenticator)
+    request = Typhoeus::Request.new(url, :method => :get)
+    response = client.submit(request, :hydra => hydra)
+    assert_equal 200, response.code
+
+    assert_equal "*", request.headers["If-Match"]
+  end
+
+  should "automatically follow redirects" do
+    # stub Tyhoeus hydra to return dummy responses
+    hydra = Typhoeus::Hydra.new
+    urls = ["http://example.com/foo", "http://example.com/bar"]
+    hydra.stub(:get, urls[0]).and_return(
+      Typhoeus::Response.new(:code => 301, :headers => "Location: #{urls[1]}", :body => "", :time => 0.1)
+    )
+    hydra.stub(:get, urls[1]).and_return(
+      Typhoeus::Response.new(:code => 200, :body => "the body", :time => 0.1)
+    )
+
+    # stub authenticator to do nothing
+    authenticator = Object.new
+    authenticator.expects(:sign_request).twice
+
+    client = ::GDataPlus::Client.new(authenticator)
+    response = client.submit(Typhoeus::Request.new(urls[0], :method => :get), :hydra => hydra)
+    assert_equal 200, response.code
+    assert_equal "the body", response.body
+  end
+
+  should "prevent redirect loop by only automatically redirecting once" do
+    # stub Tyhoeus hydra to return dummy responses
+    hydra = Typhoeus::Hydra.new
+    urls = ["http://example.com/foo", "http://example.com/bar"]
+    urls.size.times do |index|
+      response = Typhoeus::Response.new(:code => 302, :headers => "Location: #{urls[(index+1)%2]}", :body => "", :time => 0.1)
+      hydra.stub(:get, urls[index]).and_return(response)
+    end
+
+    # stub authenticator to do nothing; if it's called more than two times then we're in a redirect loop
+    authenticator = Object.new
+    authenticator.expects(:sign_request).twice
+
+    client = ::GDataPlus::Client.new(authenticator)
+    exception = assert_raises(::GDataPlus::Exception) do
+      client.submit(Typhoeus::Request.new(urls[0], :method => :get), :hydra => hydra)
+    end
+    assert_equal 302, exception.response.code
+  end
+end

data/test/exception_test.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class ExceptionTest < Test::Unit::TestCase
+  should "initialize with unknown response" do
+    e = ::GDataPlus::Exception.new(nil)
+    assert_equal "no response provided", e.message
+  end
+
+  should "initialize with response" do
+    response_stub = stub(:body => "foo bar message")
+    e = ::GDataPlus::Exception.new(response_stub)
+    assert_equal "foo bar message", e.message
+    assert_equal response_stub, e.response
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gdata_plus'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification 
+name: gdata_plus
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brian Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-31 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+description: Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client
+email: balexand@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- gdata_plus.gemspec
+- lib/gdata_plus.rb
+- lib/gdata_plus/authenticator/client_login.rb
+- lib/gdata_plus/authenticator/common.rb
+- lib/gdata_plus/authenticator/o_auth.rb
+- lib/gdata_plus/client.rb
+- lib/gdata_plus/exception.rb
+- lib/gdata_plus/util.rb
+- test/authenticator/client_login_test.rb
+- test/authenticator/o_auth_test.rb
+- test/client_test.rb
+- test/exception_test.rb
+- test/helper.rb
+- examples/client_login_example.rb
+- examples/oauth_example.rb
+has_rdoc: true
+homepage: http://github.com/balexand/gdata_plus
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4078657378247043019
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeus as an HTTP client
+test_files: 
+- examples/client_login_example.rb
+- examples/oauth_example.rb
+- test/authenticator/client_login_test.rb
+- test/authenticator/o_auth_test.rb
+- test/client_test.rb
+- test/exception_test.rb
+- test/helper.rb