google_drive 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f3de00c7d9e7589646ba3b4a85c5f94ffec2d2f
-  data.tar.gz: 09aea7b2c3900145d6415c6614f254ab347562c2
+  metadata.gz: 6fa325ec359ec66d6e6ee9260d96d204249c8b62
+  data.tar.gz: cc7719032cb68583fd38f69ad59b11a7c5a4f494
 SHA512:
-  metadata.gz: d8357b2b90f33bc5a655904983a2ee77e46c768142ddc0e3ead86c313938a100992d89c2ee02f6d9a1e58ff696829f541859a1a9d7bf5741e0a51d7d6c05864b
-  data.tar.gz: f4aed23d0b698072149e54ac154667a4ea78eceaa19364962a89431035aa6131fdae58b1f83a5494431499c8d08a218dc4efce5f50f874692ea13d55fb423a5c
+  metadata.gz: 23434caab95532f6739a88ebba51e2a9aadcf16131dbd28a5df23795ef3d7cb86b9fb4d0778acec63d4a28e94f2b4eb867e1761e4dd4226849b731661113beb9
+  data.tar.gz: 8ed3cf51a8f2799f7abb45e61271fa7f2b78129e51e4604edbc3fdd0e409b83a6e7037c9bb6fdc0ebc3494e0f98066b65103859353ca9bf91084443637cdf0cd

data/README.md

@@ -37,35 +37,18 @@ $ sudo gem install google_drive
 
 ## How to use
 
-First, follow Step 1 and 2 of "Authorizing requests with OAuth 2.0" in [this
-page](https://developers.google.com/drive/v3/web/about-auth) to get a client
-ID and client secret for OAuth. Set "Application type" to "Other" in the form
-to create a client ID if you use GoogleDrive.saved_session method as in the
-example below.
-
-Next, create a file config.json which contains the client ID and crient secret
-you got above, which looks like:
-
-```json
-{
-  "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
-  "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
-}
-```
+### Authorization
 
-Note that when using the OAuth flow, the client will be able to access all files
-belonging to the the user who generated the token. To set permissions more
-specifically, you may want to consider using a service account.  [See full docs 
-in the login_with_oauth method.](https://github.com/gimite/google-drive-ruby/blob/lib/google_drive.rb)
+Follow one of the options in [Authorization](https://github.com/gimite/google-drive-ruby/doc/authorization.md) to construct a session object. The example code below assumes "On behalf of you" option.
 
-### Example to read/write files in Google Drive:
+### Example to read/write files in Google Drive
 
 ```ruby
 require "google_drive"
 
 # Creates a session. This will prompt the credential via command line for the
 # first time and save it to config.json file for later usages.
-session = GoogleDrive.saved_session("config.json")
+session = GoogleDrive::Session.from_config("config.json")
 
 # Gets list of remote files.
 session.files.each do |file|
@@ -83,14 +66,14 @@ file.download_to_file("/path/to/hello.txt")
 file.update_from_file("/path/to/hello.txt")
 ```
 
-### Example to read/write spreadsheets:
+### Example to read/write spreadsheets
 
 ```ruby
 require "google_drive"
 
 # Creates a session. This will prompt the credential via command line for the
 # first time and save it to config.json file for later usages.
-session = GoogleDrive.saved_session("config.json")
+session = GoogleDrive::Session.from_config("config.json")
 
 # First worksheet of
 # https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg

data/lib/google_drive.rb

@@ -7,157 +7,24 @@ require 'googleauth'
 require 'google_drive/session'
 
 module GoogleDrive
-  # Authenticates with given OAuth2 token.
-  #
-  # +access_token+ can be either OAuth2 access_token string, OAuth2::AccessToken
-  # or credentials generated by googleauth library.
-  #
-  # OAuth2 code example for Web apps:
-  #
-  #   require "googleauth"
-  #   
-  #   credentials = Google::Auth::UserRefreshCredentials.new(
-  #     client_id: "YOUR CLIENT ID",
-  #     client_secret: "YOUR CLIENT SECRET",
-  #     scope: [
-  #       "https://www.googleapis.com/auth/drive",
-  #       "https://spreadsheets.google.com/feeds/",
-  #     ],
-  #     redirect_uri: "http://example.com/redirect")
-  #   auth_url = credentials.authorization_uri
-  #   # Redirect the user to auth_url and get authorization code from redirect URL.
-  #   credentials.code = authorization_code
-  #   credentials.fetch_access_token!
-  #   session = GoogleDrive.login_with_oauth(credentials)
-  #
-  # credentials.access_token expires in 1 hour. If you want to restore a session afterwards, you can store
-  # credentials.refresh_token somewhere after auth.fetch_access_token! above, and use this code:
-  #
-  #   require "googleauth"
-  #   
-  #   credentials = Google::Auth::UserRefreshCredentials.new(
-  #     client_id: "YOUR CLIENT ID",
-  #     client_secret: "YOUR CLIENT SECRET",
-  #     scope: [
-  #       "https://www.googleapis.com/auth/drive",
-  #       "https://spreadsheets.google.com/feeds/",
-  #     ],
-  #     redirect_uri: "http://example.com/redirect")
-  #   credentials.refresh_token = refresh_token
-  #   credentials.fetch_access_token!
-  #   session = GoogleDrive.login_with_oauth(credentials.access_token)
-  #
-  # For command-line apps, it would be easier to use saved_session method instead.
-  #
-  # To use service account authentication:
-  #
-  #  1. Go to the Credentials tab for your project in the Google API console: https://console.developers.google.com/apis/credentials
-  #  2. Create a service account key, and download the keys as JSON.  (This address ends in iam.gserviceaccount.com.)
-  #  3. Share the Drive folders or files with the client_email address in the JSON you downloaded.
-  #  3. Set a GOOGLE_CLIENT_EMAIL environmental variable based on the client_email.
-  #  4. Set a GOOGLE_PRIVATE_KEY environmental variable based on the private_key in the JSON.  Be careful to preserve newlines.
-  #  5. Create a GoogleDrive session from these environmental variables:
-  #
-  # session = GoogleDrive.login_with_oauth(Google::Auth::ServiceAccountCredentials.from_env(
-  #   'https://www.googleapis.com/auth/drive'
-  # ))
-  # The scope can be adjusted to be as broad or specific as necessary.
-  # The full list of scopes is available here: https://developers.google.com/drive/v2/web/scopes.
-  #
+  # Equivalent of either GoogleDrive::Session.from_credentials or
+  # GoogleDrive::Session.from_access_token.
   def self.login_with_oauth(client_or_access_token, proxy = nil)
     Session.new(client_or_access_token, proxy)
   end
 
-  # Returns GoogleDrive::Session constructed from a config JSON file at +path+.
-  #
-  # Follow the following steps to use this method:
-  #
-  # First, follow "Create a client ID and client secret" in
-  # {this page}[https://developers.google.com/drive/web/auth/web-server] to get a client ID
-  # and client secret for OAuth. Set "Application type" to "Other" in the form to create a
-  # client ID if you use GoogleDrive.saved_session method as in the example below.
-  #
-  # Next, create a file config.json which contains the client ID and client secret you got
-  # above, which looks like:
-  #
-  #   {
-  #     "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
-  #     "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
-  #   }
-  #
-  # Then you can construct a GoogleDrive::Session by:
-  #
-  #   session = GoogleDrive.saved_session("config.json")
-  #
-  # This will prompt the credential via command line for the first time and save it to
-  # config.json file for later usages.
-  #
-  # +path+ defaults to ENV["HOME"] + "/.ruby_google_drive.token".
-  #
-  # If the file doesn't exist or client ID/secret are not given in the file, the default client
-  # ID/secret embedded in the library is used.
-  #
-  # You can also provide a config object that must respond to:
-  #   client_id
-  #   client_secret
-  #   refesh_token
-  #   refresh_token=
-  #   scope
-  #   scope=
-  #   save
+  # Alias of GoogleDrive::Session.from_config.
   def self.saved_session(
-      path_or_config = nil, proxy = nil, client_id = nil, client_secret = nil)
-    config =
-      case path_or_config
-      when String
-        Config.new(path_or_config)
-      when nil
-        Config.new(ENV['HOME'] + '/.ruby_google_drive.token')
-      else
-        path_or_config
-      end
-
-    config.scope ||= [
-      'https://www.googleapis.com/auth/drive',
-      'https://spreadsheets.google.com/feeds/'
-    ]
-
-    if client_id && client_secret
-      config.client_id = client_id
-      config.client_secret = client_secret
-    end
-    if !config.client_id && !config.client_secret
-      config.client_id = '452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com'
-      config.client_secret = '1U3-Krii5x1oLPrwD5zgn-ry'
-    elsif !config.client_id || !config.client_secret
-      fail(ArgumentError, 'client_id and client_secret must be both specified or both omitted')
-    end
-
+      config = ENV['HOME'] + '/.ruby_google_drive.token',
+      proxy = nil,
+      client_id = nil,
+      client_secret = nil)
     if proxy
       fail(
         ArgumentError,
         'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
     end
 
-    credentials = Google::Auth::UserRefreshCredentials.new(
-      client_id: config.client_id,
-      client_secret: config.client_secret,
-      scope: config.scope,
-      redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
-
-    if config.refresh_token
-      credentials.refresh_token = config.refresh_token
-      credentials.fetch_access_token!
-    else
-      $stderr.print("\n1. Open this page:\n%s\n\n" % credentials.authorization_uri)
-      $stderr.print('2. Enter the authorization code shown in the page: ')
-      credentials.code = $stdin.gets.chomp
-      credentials.fetch_access_token!
-      config.refresh_token = credentials.refresh_token
-    end
-
-    config.save
-
-    GoogleDrive.login_with_oauth(credentials)
+    Session.from_config(config, client_id: client_id, client_secret: client_secret)
   end
 end

data/lib/google_drive/session.rb

@@ -26,7 +26,12 @@ module GoogleDrive
     include(Util)
     extend(Util)
 
-    # The same as GoogleDrive.login_with_oauth.
+    DEFAULT_SCOPE = [
+      'https://www.googleapis.com/auth/drive',
+      'https://spreadsheets.google.com/feeds/'
+    ]
+
+    # Equivalent of either from_credentials or from_access_token.
     def self.login_with_oauth(credentials_or_access_token, proxy = nil)
       Session.new(credentials_or_access_token, proxy)
     end
@@ -36,6 +41,93 @@ module GoogleDrive
       Session.new(nil)
     end
 
+    # Constructs a GoogleDrive::Session object from OAuth2 credentials such as
+    # Google::Auth::UserRefreshCredentials.
+    #
+    # See https://github.com/gimite/google-drive-ruby/doc/authorization.md for a usage example.
+    def self.from_credentials(credentials)
+      Session.new(credentials)
+    end
+
+    # Constructs a GoogleDrive::Session object from OAuth2 access token string.
+    def self.from_access_token(access_token)
+      Session.new(access_token)
+    end
+
+    # Constructs a GoogleDrive::Session object from a service account key JSON.
+    #
+    # You can pass either the path to a JSON file, or an IO-like object with the JSON.
+    #
+    # See https://github.com/gimite/google-drive-ruby/doc/authorization.md for a usage example.
+    def self.from_service_account_key(json_key_path_or_io, scope = DEFAULT_SCOPE)
+      if json_key_path_or_io.is_a?(String)
+        open(json_key_path_or_io) do |f|
+          from_service_account_key(f, scope)
+        end
+      else
+        credentials = Google::Auth::ServiceAccountCredentials.make_creds(
+            json_key_io: json_key_path_or_io, scope: scope)
+        Session.new(credentials)
+      end
+    end
+
+    # Returns GoogleDrive::Session constructed from a config JSON file at +config+.
+    #
+    # +config+ is the path to the config file.
+    #
+    # This will prompt the credential via command line for the first time and save it to
+    # +config+ for later usages.
+    #
+    # See https://github.com/gimite/google-drive-ruby/doc/authorization.md for a usage example.
+    #
+    # You can also provide a config object that must respond to:
+    #   client_id
+    #   client_secret
+    #   refesh_token
+    #   refresh_token=
+    #   scope
+    #   scope=
+    #   save
+    def self.from_config(config, options = {})
+      if config.is_a?(String)
+        config = Config.new(config)
+      end
+
+      config.scope ||= DEFAULT_SCOPE
+
+      if options[:client_id] && options[:client_secret]
+        config.client_id = options[:client_id]
+        config.client_secret = options[:client_secret]
+      end
+      if !config.client_id && !config.client_secret
+        config.client_id = '452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com'
+        config.client_secret = '1U3-Krii5x1oLPrwD5zgn-ry'
+      elsif !config.client_id || !config.client_secret
+        fail(ArgumentError, 'client_id and client_secret must be both specified or both omitted')
+      end
+
+      credentials = Google::Auth::UserRefreshCredentials.new(
+        client_id: config.client_id,
+        client_secret: config.client_secret,
+        scope: config.scope,
+        redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
+
+      if config.refresh_token
+        credentials.refresh_token = config.refresh_token
+        credentials.fetch_access_token!
+      else
+        $stderr.print("\n1. Open this page:\n%s\n\n" % credentials.authorization_uri)
+        $stderr.print('2. Enter the authorization code shown in the page: ')
+        credentials.code = $stdin.gets.chomp
+        credentials.fetch_access_token!
+        config.refresh_token = credentials.refresh_token
+      end
+
+      config.save
+
+      Session.new(credentials)
+    end
+
     def initialize(credentials_or_access_token, proxy = nil)
       if proxy
         fail(

data/lib/google_drive/worksheet.rb

@@ -257,7 +257,7 @@ module GoogleDrive
       self.max_rows += rows.size
       num_rows.downto(row_num) do |r|
         (1..num_cols).each do |c|
-          self[r + rows.size, c] = self[r, c]
+          self[r + rows.size, c] = self.input_value(r, c)
         end
       end
 
@@ -285,7 +285,7 @@ module GoogleDrive
       end
       for r in row_num..(self.max_rows - rows)
         for c in 1..num_cols
-          self[r, c] = self[r + rows, c]
+          self[r, c] = self.input_value(r + rows, c)
         end
       end
       self.max_rows -= rows

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri