google-spreadsheet-ruby 0.2.1 → 0.3.0

data/README.rdoc

@@ -1,64 +1,17 @@
-This is a Ruby 1.8/1.9 library to read/write Google Spreadsheet.
+This library is now part of google_drive gem: https://github.com/gimite/google-drive-ruby
 
+<b>For new code</b>: I suggest to use google_drive gem directly.
 
-= How to install
+<b>For existing code</b>: You can keep using google-spreadsheet-ruby gem. Now google-spreadsheet-ruby is a library which simply does:
 
-  $ sudo gem install google-spreadsheet-ruby
-
-Note that gimite-google-spreadsheet-ruby at gems.github.com is no longer updated, because github stopped hosting it.
-
-
-= How to use
-
-Example:
-  
-  require "rubygems"
-  require "google_spreadsheet"
-  
-  # Logs in.
-  # You can also use OAuth. See document of
-  # GoogleSpreadsheet.login_with_oauth for details.
-  session = GoogleSpreadsheet.login("username@gmail.com", "mypassword")
-  
-  # First worksheet of
-  # https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg
-  ws = session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg").worksheets[0]
-  
-  # Gets content of A2 cell.
-  p ws[2, 1] #==> "hoge"
-  
-  # Changes content of cells.
-  # Changes are not sent to the server until you call ws.save().
-  ws[2, 1] = "foo"
-  ws[2, 2] = "bar"
-  ws.save()
-  
-  # Dumps all cells.
-  for row in 1..ws.num_rows
-    for col in 1..ws.num_cols
-      p ws[row, col]
-    end
-  end
-  
-  # Yet another way to do so.
-  p ws.rows #==> [["fuga", ""], ["foo", "bar]]
-  
-  # Reloads the worksheet to get changes by other clients.
-  ws.reload()
-
-API document: http://gimite.net/gimite/rubymess/google-spreadsheet-ruby/
+  require "google_drive"
+  GoogleSpreadsheet = GoogleDrive
 
+and it provides the same API as before.
 
-= Source code
-
-http://github.com/gimite/google-spreadsheet-ruby
-
-The license of this source is "New BSD Licence"
-
-
-= Supported environments
+Note that gimite-google-spreadsheet-ruby at gems.github.com is no longer updated, because github stopped hosting it.
 
-Ruby 1.8.x and Ruby 1.9.x. Checked with Ruby 1.8.7 and Ruby 1.9.3.
+API document: http://gimite.net/doc/google-drive-ruby/
 
 
 = Author

data/lib/google_spreadsheet.rb

@@ -1,120 +1,8 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_spreadsheet/session"
+require "rubygems"
+require "google_drive"
 
 
-module GoogleSpreadsheet
-
-    # 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.
-    def self.login(mail, password, proxy = nil)
-      return Session.login(mail, password, proxy)
-    end
-
-    # 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.login_with_oauth(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.login_with_oauth(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:
-    #
-    # - https://github.com/intridea/oauth2
-    # - http://code.google.com/apis/accounts/docs/OAuth2.html
-    # - http://oauth.rubyforge.org/
-    # - http://code.google.com/apis/accounts/docs/OAuth.html
-    def self.login_with_oauth(oauth_token)
-      return Session.login_with_oauth(oauth_token)
-    end
-
-    # Restores session using return value of auth_tokens method of previous session.
-    #
-    # See GoogleSpreadsheet.login for description of parameter +proxy+.
-    def self.restore_session(auth_tokens, proxy = nil)
-      return Session.restore_session(auth_tokens, proxy)
-    end
-    
-    # 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: http://rubyforge.org/projects/highline/
-    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.login(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
-    
-end
+GoogleSpreadsheet = GoogleDrive

data/lib/google_spreadsheet/acl.rb

@@ -1,124 +1,4 @@
-# Author: Guy Boertje <https://github.com/guyboertje>
-# Author: David R. Albrecht <https://github.com/eldavido>
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_spreadsheet/acl_entry"
-
-
-module GoogleSpreadsheet
-    
-    # ACL (access control list) of a spreadsheet.
-    #
-    # Use GoogleSpreadsheet::Spreadsheet#acl to get GoogleSpreadsheet::Acl object.
-    # See GoogleSpreadsheet::Spreadsheet#acl for usage example.
-    #
-    # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
-    class Acl
-        
-        include(Util)
-        extend(Forwardable)
-        
-        def initialize(session, acls_feed_url) #:nodoc:
-          @session = session
-          @acls_feed_url = acls_feed_url
-          header = {"GData-Version" => "3.0"}
-          doc = @session.request(:get, @acls_feed_url, :header => header, :auth => :writely)
-          @acls = doc.css("entry").map(){ |e| AclEntry.new(entry_to_params(e)) }
-        end
-        
-        def_delegators(:@acls, :size, :[], :each)
-        
-        # Adds a new entry. +entry+ is either a GoogleSpreadsheet::AclEntry or a Hash with keys
-        # :scope_type, :scope and :role. See GoogleSpreadsheet::AclEntry#scope_type and
-        # GoogleSpreadsheet::AclEntry#role for the document of the fields.
-        #
-        # NOTE: This sends email to the new people.
-        #
-        # e.g.
-        #   spreadsheet.acl.push(
-        #       {:scope_type => "user", :scope => "example2@gmail.com", :role => "reader"})
-        #   spreadsheet.acl.push(
-        #       {:scope_type => "user", :scope => "example3@gmail.com", :role => "writer"})
-        def push(entry)
-          
-          entry = AclEntry.new(entry) if entry.is_a?(Hash)
-          
-          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
-          value_attr = entry.scope ? "value='#{h(entry.scope)}'" : ""
-          xml = <<-EOS
-            <entry
-                xmlns='http://www.w3.org/2005/Atom'
-                xmlns:gAcl='http://schemas.google.com/acl/2007'>
-              <category scheme='http://schemas.google.com/g/2005#kind'
-                  term='http://schemas.google.com/acl/2007#accessRule'/>
-              <gAcl:role value='#{h(entry.role)}'/>
-              <gAcl:scope type='#{h(entry.scope_type)}' #{value_attr}/>
-            </entry>
-          EOS
-          doc = @session.request(
-              :post, @acls_feed_url, :data => xml, :header => header, :auth => :writely)
-          
-          entry.params = entry_to_params(doc.root)
-          @acls.push(entry)
-          return entry
-          
-        end
-        
-        # Deletes an ACL entry.
-        #
-        # e.g.
-        #   spreadsheet.acl.delete(spreadsheet.acl[1])
-        def delete(entry)
-          header = {"GData-Version" => "3.0"}
-          @session.request(:delete, entry.edit_url, :header => header, :auth => :writely)
-          @acls.delete(entry)
-        end
-        
-        def update_role(entry, role) #:nodoc:
-          
-          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
-          value_attr = entry.scope ? "value='#{h(entry.scope)}'" : ""
-          xml = <<-EOS
-            <entry
-                xmlns='http://www.w3.org/2005/Atom'
-                xmlns:gAcl='http://schemas.google.com/acl/2007'
-                xmlns:gd='http://schemas.google.com/g/2005'
-                gd:etag='#{h(entry.etag)}'>
-              <category
-                  scheme='http://schemas.google.com/g/2005#kind'
-                  term='http://schemas.google.com/acl/2007#accessRule'/>
-              <gAcl:role value='#{h(role)}'/>
-              <gAcl:scope type='#{h(entry.scope_type)}' #{value_attr}/>
-            </entry>
-          EOS
-          doc = @session.request(
-              :put, entry.edit_url, :data => xml, :header => header, :auth => :writely)
-          
-          entry.params = entry_to_params(doc.root)
-          return entry
-          
-        end
-        
-        def inspect
-          return "\#<%p %p>" % [self.class, @acls]
-        end
-        
-      private
-        
-        def entry_to_params(entry)
-          # TODO Support with-link roles.
-          return {
-            :acl => self,
-            :scope_type => entry.css("gAcl|scope")[0]["type"],
-            :scope => entry.css("gAcl|scope")[0]["value"],
-            :role => entry.css("gAcl|role")[0]["value"],
-            :title => entry.css("title").text,
-            :edit_url => entry.css("link[rel='edit']")[0]["href"],
-            :etag => entry["etag"],
-          }
-        end
-        
-    end
-    
-end
+require "google_spreadsheet"

data/lib/google_spreadsheet/acl_entry.rb

@@ -1,58 +1,4 @@
-# Author: Guy Boertje <https://github.com/guyboertje>
-# Author: David R. Albrecht <https://github.com/eldavido>
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-# acl.rb, derived from https://github.com/guyboertje/gdata-spreadsheet-ruby/blob/master/lib/document.rb
-# more frankensteining of the original library
-
-module GoogleSpreadsheet
-    
-    # An entry of an ACL (access control list) of a spreadsheet.
-    #
-    # Use GoogleSpreadsheet::Acl#[] to get GoogleSpreadsheet::AclEntry object.
-    #
-    # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
-    class AclEntry
-        
-        include(Util)
-        
-        PARAM_NAMES = [:acl, :scope_type, :scope, :role, :title, :edit_url, :etag]  #:nodoc:
-        
-        # +params+ is a Hash object with keys +:scope_type+, +:scope+ and +:role+.
-        # See scope_type and role for the document of the fields.
-        def initialize(params)
-          @params = {:role => "reader"}
-          for name, value in params
-            if !PARAM_NAMES.include?(name)
-              raise(ArgumentError, "Invalid key: %p" % name)
-            end
-            @params[name] = value
-          end
-        end
-        
-        attr_accessor(:params)  #:nodoc:
-        
-        PARAM_NAMES.each() do |name|
-          define_method(name) do
-            return @params[name]
-          end
-        end
-        
-        # Changes the role of the scope.
-        #
-        # e.g.
-        #   spreadsheet.acl[1].role = "writer"
-        def role=(role)
-          @params[:acl].update_role(self, role)
-        end
-        
-        def inspect
-          return "\#<%p scope_type=%p, scope=%p, role=%p>" %
-              [self.class, @params[:scope_type], @params[:scope], @params[:role]]
-        end
-        
-    end
-    
-end
-
+require "google_spreadsheet"

data/lib/google_spreadsheet/authentication_error.rb

@@ -1,14 +1,4 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_spreadsheet/error"
-
-
-module GoogleSpreadsheet
-
-    # Raised when GoogleSpreadsheet.login has failed.
-    class AuthenticationError < GoogleSpreadsheet::Error
-
-    end
-    
-end
+require "google_spreadsheet"

data/lib/google_spreadsheet/client_login_fetcher.rb

@@ -1,56 +1,4 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "net/https"
-require "uri"
-Net::HTTP.version_1_2
-
-
-module GoogleSpreadsheet
-
-    class ClientLoginFetcher #:nodoc:
-        
-        def initialize(auth_tokens, proxy)
-          @auth_tokens = auth_tokens
-          if proxy
-            @proxy = proxy
-          elsif ENV["http_proxy"] && !ENV["http_proxy"].empty?
-            proxy_url = URI.parse(ENV["http_proxy"])
-            @proxy = Net::HTTP.Proxy(proxy_url.host, proxy_url.port)
-          else
-            @proxy = Net::HTTP
-          end
-        end
-        
-        attr_accessor(:auth_tokens)
-        
-        def request_raw(method, url, data, extra_header, auth)
-          uri = URI.parse(url)
-          http = @proxy.new(uri.host, uri.port)
-          http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          http.start() do
-            path = uri.path + (uri.query ? "?#{uri.query}" : "")
-            header = auth_header(auth).merge(extra_header)
-            if method == :delete || method == :get
-              return http.__send__(method, path, header)
-            else
-              return http.__send__(method, path, data, header)
-            end
-          end
-        end
-        
-      private
-        
-        def auth_header(auth)
-          token = auth == :none ? nil : @auth_tokens[auth]
-          if token
-            return {"Authorization" => "GoogleLogin auth=#{token}"}
-          else
-            return {}
-          end
-        end
-
-    end
-    
-end
+require "google_spreadsheet"