gdata_plus 0.0.0 → 0.1.0

data/README.rdoc

@@ -8,27 +8,52 @@ Simple, easy to use GData API that supports OAuth, Ruby 1.8/1.9 and uses Typhoeu
 
   gem install gdata_plus
 
+== Making requests
+
+Start by getting the client from the authenticator (see Authentication below).
+
+  client = authenticator.client
+
+Then make a request.
+
+  response = client.get("https://picasaweb.google.com/data/feed/api/user/default")
+
+Then parse the response using your preferred XML library. I'll use {Nokogiri}[http://nokogiri.org/tutorials/searching_a_xml_html_document.html] for this example.
+
+  feed = Nokogiri::XML(response.body)
+  album_titles = feed.xpath("//xmlns:entry/xmlns:title/text()").collect {|i| "#{i}"}
+
+If you need more control over the request, then you can create your own {Typhoeus}[https://github.com/pauldix/typhoeus] request and submit it to the client.
+
+  request = Typhoeus::Request.new(...)
+  client.submit request
+
 == Authentication
 
+{OAuth}[http://code.google.com/apis/gdata/docs/auth/oauth.html] and {ClientLogin}[http://code.google.com/apis/gdata/docs/auth/clientlogin.html] are supported. OAuth is preferred for web apps and ClientLogin is convenient for installed apps and command-line utilities.
+
 === OAuth
 
-TODO
+Before using OAuth, you will need to {register your domain}[http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html] and get a consumer key and consumer secret from Google. See {the OAuth example}[https://github.com/balexand/gdata_plus/blob/master/examples/oauth_example.rb] for getting started with OAuth.
 
 ==== Using an existing access token
 
-TODO
+If you already have an access token and access token secret, then you can construct an OAuth authenticator as follows:
+
+  GDataPlus::Authenticator::OAuth.new(
+    :consumer_key => CONSUMER_KEY,
+    :consumer_secret => CONSUMER_SECRET,
+    :access_token => access_token,
+    :access_secret => access_secret
+  )
 
 === ClientLogin
 
-TODO
+See the {ClientLogin example}[https://github.com/balexand/gdata_plus/blob/master/examples/client_login_example.rb].
 
 === Serializing authenticators
 
-TODO
-
-== Making requests
-
-TODO
+Both the OAuth and ClientLogin authenticators can be serialized using a method like to_yaml.
 
 == Error handling
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/examples/client_login_example.rb

@@ -1,6 +1,8 @@
+# Highline is required for this example: gem install highline
+
 require 'rubygems'
 require 'gdata_plus'
-require 'highline/import' # gem install highline
+require 'highline/import'
 require 'typhoeus'
 
 # prompt for email/password
@@ -11,5 +13,6 @@ password = ask("Enter your password:  ") { |q| q.echo = "x" }
 authenticator = GDataPlus::Authenticator::ClientLogin.new(:service => "lh2", :source => "balexand-gdata_plus-1")
 authenticator.authenticate(email, password)
 
+# Make a signed request (fetch a list of Picasa albums in this case)
 response = authenticator.client.get("https://picasaweb.google.com/data/feed/api/user/default")
 puts response.inspect

data/examples/oauth_example.rb

@@ -1,7 +1,6 @@
-# you don't need the following line if you've installed the gem
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-
+require 'rubygems'
 require 'gdata_plus'
+require 'nokogiri'
 require 'sinatra'
 require 'typhoeus'
 
@@ -9,29 +8,33 @@ require 'typhoeus'
 CONSUMER_KEY = ENV["GDATA_CONSUMER_KEY"]
 CONSUMER_SECRET = ENV["GDATA_CONSUMER_SECRET"]
 
-set :sessions, true # enable Sinatra sessions
+set :sessions, true
 
+# STEP #1: Obtain and store request token, and redirect browser to Google for authorization
 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
 
+# STEP #2: Exchange request token for access token when user is redirected back to your site
 get "/callback" do
   authenticator = session[:gdata_authenticator]
   authenticator.fetch_access_token(params[:oauth_verifier])
   redirect "/picasa_album_list"
 end
 
+# STEP #3: Make a signed request (fetch a list of Picasa albums in this case)
 get "/picasa_album_list" do
   authenticator = session[:gdata_authenticator]
   response = authenticator.client.get("https://picasaweb.google.com/data/feed/api/user/default")
 
-  response.inspect
+  feed = Nokogiri::XML(response.body)
+  album_titles = feed.xpath("//xmlns:entry/xmlns:title/text()").collect {|i| "#{i}"}
+  album_titles.collect {|title| "<li>#{title}</li>"}
 end

data/gdata_plus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gdata_plus}
-  s.version = "0.0.0"
+  s.version = "0.1.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.date = %q{2011-01-02}
   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 = [

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Brian Alexander
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-31 00:00:00 -08:00
+date: 2011-01-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -184,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4078657378247043019
+      hash: 2629317293349709897
       segments: 
       - 0
       version: "0"