Module: GoogleSpreadsheet

Defined in:
lib/google_spreadsheet/acl_entry.rb,
lib/google_spreadsheet.rb,
lib/google_spreadsheet/acl.rb,
lib/google_spreadsheet/list.rb,
lib/google_spreadsheet/util.rb,
lib/google_spreadsheet/table.rb,
lib/google_spreadsheet/error.rb,
lib/google_spreadsheet/record.rb,
lib/google_spreadsheet/session.rb,
lib/google_spreadsheet/list_row.rb,
lib/google_spreadsheet/worksheet.rb,
lib/google_spreadsheet/collection.rb,
lib/google_spreadsheet/spreadsheet.rb,
lib/google_spreadsheet/oauth1_fetcher.rb,
lib/google_spreadsheet/oauth2_fetcher.rb,
lib/google_spreadsheet/authentication_error.rb,
lib/google_spreadsheet/client_login_fetcher.rb

Overview

acl.rb, derived from github.com/guyboertje/gdata-spreadsheet-ruby/blob/master/lib/document.rb more frankensteining of the original library

Defined Under Namespace

Modules: Util Classes: Acl, AclEntry, AuthenticationError, ClientLoginFetcher, Collection, Error, List, ListRow, OAuth1Fetcher, OAuth2Fetcher, Record, Session, Spreadsheet, Table, Worksheet

Class Method Summary (collapse)

Class Method Details

+ (Object) login(mail, password, proxy = nil)

Authenticates with given mail and password, and returns GoogleSpreadsheet::Session if succeeds. Raises GoogleSpreadsheet::AuthenticationError if fails. Google Apps account is supported.

proxy can be nil or return value of Net::HTTP.Proxy. If proxy is specified, all HTTP access in the session uses the proxy. If proxy is nil, it uses the proxy specified by http_proxy environment variable if available. Otherwise it performs direct access.



17
18
19
 
# File 'lib/google_spreadsheet.rb', line 17

def self.(mail, password, proxy = nil)
  return Session.(mail, password, proxy)
end

+ (Object) login_with_oauth(oauth_token)

Authenticates with given OAuth1 or OAuth2 token.

OAuth2 code example:

client = OAuth2::Client.new(
    your_client_id, your_client_secret,
    :site => "https://accounts.google.com",
    :token_url => "/o/oauth2/token",
    :authorize_url => "/o/oauth2/auth")
auth_url = client.auth_code.authorize_url(
    :redirect_uri => "http://example.com/",
    "scope" => "https://spreadsheets.google.com/feeds https://docs.google.com/feeds/")
# Redirect the user to auth_url and get authorization code from redirect URL.
auth_token = client.auth_code.get_token(
    authorization_code, :redirect_uri => "http://example.com/")
session = GoogleSpreadsheet.(auth_token)

Or, from existing refresh token:

access_token = OAuth2::AccessToken.from_hash(client,
    {:refresh_token => refresh_token, :expires_at => expires_at})
access_token = access_token.refresh!
session = GoogleSpreadsheet.(access_token)

OAuth1 code example:

1) First generate OAuth consumer object with key and secret for your site by registering site

 with Google.
@consumer = OAuth::Consumer.new( "key","secret", {:site=>"https://agree2"})

2) Request token with OAuth.

@request_token = @consumer.get_request_token
session[:request_token] = @request_token
redirect_to @request_token.authorize_url

3) Create an oauth access token.

@oauth_access_token = @request_token.get_access_token
@access_token = OAuth::AccessToken.new(
    @consumer, @oauth_access_token.token, @oauth_access_token.secret)

See these documents for details:



65
66
67
 
# File 'lib/google_spreadsheet.rb', line 65

def self.(oauth_token)
  return Session.(oauth_token)
end

+ (Object) restore_session(auth_tokens, proxy = nil)

Restores session using return value of auth_tokens method of previous session.

See GoogleSpreadsheet.login for description of parameter proxy.



72
73
74
 
# File 'lib/google_spreadsheet.rb', line 72

def self.restore_session(auth_tokens, proxy = nil)
  return Session.restore_session(auth_tokens, proxy)
end

+ (Object) saved_session(path = ENV["HOME"] + "/.ruby_google_spreadsheet.token", proxy = nil)

Restores GoogleSpreadsheet::Session from path and returns it. If path doesn't exist or authentication has failed, prompts mail and password on console, authenticates with them, stores the session to path and returns it.

See login for description of parameter proxy.

This method requires Highline library: rubyforge.org/projects/highline/



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google_spreadsheet.rb', line 83

def self.saved_session(path = ENV["HOME"] + "/.ruby_google_spreadsheet.token", proxy = nil)
  tokens = {}
  if File.exist?(path)
    open(path) do |f|
      for auth in [:wise, :writely]
        line = f.gets()
        tokens[auth] = line && line.chomp()
      end
    end
  end
  session = Session.new(tokens, nil, proxy)
  session.on_auth_fail = proc() do
    begin
      require "highline"
    rescue LoadError
      raise(LoadError,
        "GoogleSpreadsheet.saved_session requires Highline library.\n" +
        "Run\n" +
        "  \$ sudo gem install highline\n" +
        "to install it.")
    end
    highline = HighLine.new()
    mail = highline.ask("Mail: ")
    password = highline.ask("Password: "){ |q| q.echo = false }
    session.(mail, password)
    open(path, "w", 0600) do |f|
      f.puts(session.auth_token(:wise))
      f.puts(session.auth_token(:writely))
    end
    true
  end
  if !session.auth_token
    session.on_auth_fail.call()
  end
  return session
end