google_drive 1.0.4 → 1.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGZjNmU4ZTlhY2MxNmI0YTQ0OTIzNDQ5MTBlZjZhMWEyZTliZWNjYQ==
-  data.tar.gz: !binary |-
-    MGNlNTYxMjlkNGMyMzg0MTY5ODcwZjA0ZTk4ZDIwMjdlZTQ4Mjg1Nw==
+SHA1:
+  metadata.gz: 6b4bb25ca507e0809ba9fc7a57f5a49667b61536
+  data.tar.gz: d6664ab492c6a12051d75890179eb06738df6821
 SHA512:
-  metadata.gz: !binary |-
-    NjI5MmFjZjgyZWRiZDdkODNlZTU5NzY0ZDRiNjM0NDdlOTQzZjYyMmNkZWZm
-    ZGRjNTQ5NDhjNjljNWMwN2FiMWRmMjIwMDYxMGZhODdjYjA3NWQ0OTgwM2I3
-    YzdmNzRlMTk4NWUyZGRiMWIyYTc0YWM4YWE4ZjJlYjVlNTlkMzg=
-  data.tar.gz: !binary |-
-    Yzk1MThlNjc3NWY4NzAxMDE1M2Q0MjQxYTUxOTQ0YTIwMmUzZjM4N2FhZjZj
-    NjZkNGEzNzIyMmIwYWVhNDk4MjhhNTFjNzFlOTA5MTA3MWUwMTkxNzc5OTFk
-    YzRiOTU4Mjk2M2Q5YjE0ODkyMTE3NzAxYzg4ODFjNjc3YjU1ZTM=
+  metadata.gz: b0a978d591952834520f3c8832c6c795de5936893a492e885eff1589b422a60aa61b094bd52067258f3e7158b669d6fbd9152ee924100baddb629667c9e655dc
+  data.tar.gz: 14a9596a037ffbceb349c2f2c95bdb688ddbcbef68a5a1460d9426ecc10f52d82e415e3208991cd99ee18fa16469a32e7cd2462d29a6936f06ce9a0d8a1e9cec

data/README.rdoc

@@ -19,22 +19,21 @@ Ver. 1.0.x is not 100% backward compatible with 0.3.x. Some methods have been re
 
 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 crient secret you got above, which looks like:
+
+  {
+    "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+    "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
+  }
+
 Example to read/write files in Google Drive:
 
   require "google/api_client"
   require "google_drive"
 
-  # The client ID and client secret you obtained in the step above.
-  CLIENT_ID = ...
-  CLIENT_SECRET = ...
-
   # Creates a session. This will prompt the credential via command line for the
-  # first time and save it to ./stored_token.json file for later usages.
-  #
-  # If you are developing a Web app, and you want to ask the user to log in in
-  # the Web app instead of via command line, follow the example code in:
-  # http://gimite.net/doc/google-drive-ruby/GoogleDrive.html#method-c-login_with_oauth
-  session = GoogleDrive.saved_session("./stored_token.json", nil, CLIENT_ID, CLIENT_SECRET)
+  # first time and save it to config.json file for later usages.
+  session = GoogleDrive.saved_session("config.json")
 
   # Gets list of remote files.
   session.files.each do |file|
@@ -50,16 +49,15 @@ Example to read/write files in Google Drive:
 
   # Updates content of the remote file.
   file.update_from_file("/path/to/hello.txt")
-  
+
 Example to read/write spreadsheets:
 
   require "google/api_client"
   require "google_drive"
 
-  # Same as the code above to get access_token...
-
-  # Creates a session.
-  session = GoogleDrive.login_with_oauth(access_token)
+  # 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")
 
   # First worksheet of
   # https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg
@@ -88,8 +86,7 @@ Example to read/write spreadsheets:
   # Reloads the worksheet to get changes by other clients.
   ws.reload
 
-API document: http://gimite.net/doc/google-drive-ruby/
-
+API document: http://www.rubydoc.info/gems/google_drive
 
 = Source code
 
@@ -100,7 +97,7 @@ The license of this source is "New BSD Licence"
 
 = Supported environments
 
-Ruby 1.9.x or later. Checked with Ruby 1.9.3 and 2.1.3.
+Ruby 1.9.x or later. Checked with Ruby 1.9.3 and 2.2.1.
 
 
 = Author

data/lib/google_drive.rb

@@ -1,14 +1,12 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "json"
-require "google/api_client"
-
-require "google_drive/session"
+require 'json'
+require 'google/api_client'
 
+require 'google_drive/session'
 
 module GoogleDrive
-
     # Authenticates with given OAuth2 token.
     #
     # +access_token+ can be either OAuth2 access_token string, or OAuth2::AccessToken.
@@ -79,77 +77,86 @@ module GoogleDrive
       return Session.new(client_or_access_token, proxy)
     end
 
-    # Restores GoogleDrive::Session from +path+ and returns it.
-    # If +path+ doesn't exist or authentication has failed, prompts the user to authorize the access,
-    # stores the session to +path+ and returns it.
+    # 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".
     #
-    # You can specify your own OAuth +client_id+ and +client_secret+. Otherwise the default one is used.
-    def self.saved_session(path = nil, proxy = nil, client_id = nil, client_secret = nil)
+    # 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.
+    def self.saved_session(
+        path = nil, proxy = nil, client_id = nil, client_secret = nil)
+      config = Config.new(path || ENV['HOME'] + '/.ruby_google_drive.token')
+
+      config.scope ||= [
+          'https://www.googleapis.com/auth/drive',
+          'https://spreadsheets.google.com/feeds/',
+      ]
 
-      if proxy
-        raise(
-            ArgumentError,
-            "Specifying a proxy object is no longer supported. Set ENV[\"http_proxy\"] instead.")
+      if client_id && client_secret
+        config.client_id = client_id
+        config.client_secret = client_secret
       end
-
-      if !client_id && !client_secret
-        client_id = "452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com"
-        client_secret = "1U3-Krii5x1oLPrwD5zgn-ry"
-      elsif !client_id || !client_secret
+      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
         raise(ArgumentError, "client_id and client_secret must be both specified or both omitted")
       end
 
-      path ||= ENV["HOME"] + "/.ruby_google_drive.token"
-      if ::File.exist?(path)
-        lines = ::File.readlines(path)
-        case lines.size
-          when 1
-            token_data = JSON.parse(lines[0].chomp())
-          when 2
-            # Old format.
-            token_data = nil
-          else
-            raise(ArgumentError, "Not a token file: %s" % path)
-        end
-      else
-        token_data = nil
+      if proxy
+        raise(
+            ArgumentError,
+            'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
       end
 
+      refresh_token = config.refresh_token
+
       client = Google::APIClient.new(
-          :application_name => "google_drive Ruby library",
-          :application_version => "0.4.0"
+        :application_name => 'google_drive Ruby library',
+        :application_version => '0.4.0'
       )
-      auth = client.authorization
-      auth.client_id = client_id
-      auth.client_secret = client_secret
-      auth.scope = [
-          "https://www.googleapis.com/auth/drive",
-          "https://spreadsheets.google.com/feeds/"
-      ]
-      auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
-
-      if token_data
-
-        auth.refresh_token = token_data["refresh_token"]
-        auth.fetch_access_token!()
 
+      auth = client.authorization
+      auth.client_id = config.client_id
+      auth.client_secret = config.client_secret
+      auth.scope = config.scope
+      auth.redirect_uri = 'urn:ietf:wg:oauth:2.0:oob'
+
+      if config.refresh_token
+        auth.refresh_token = config.refresh_token
+        auth.fetch_access_token!
       else
-
         $stderr.print("\n1. Open this page:\n%s\n\n" % auth.authorization_uri)
-        $stderr.print("2. Enter the authorization code shown in the page: ")
-        auth.code = $stdin.gets().chomp()
-        auth.fetch_access_token!()
-        token_data = {"refresh_token" => auth.refresh_token}
-        open(path, "w", 0600) do |f|
-          f.puts(JSON.dump(token_data))
-        end
-
+        $stderr.print('2. Enter the authorization code shown in the page: ')
+        auth.code = $stdin.gets.chomp
+        auth.fetch_access_token!
+        config.refresh_token = auth.refresh_token
       end
 
-      return GoogleDrive.login_with_oauth(client)
+      config.save
 
+      return GoogleDrive.login_with_oauth(client)
     end
-    
 end

data/lib/google_drive/config.rb

@@ -0,0 +1,37 @@
+# Author: Mateusz Czerwinski <mtczerwinski@gmail.com>
+# The license of this source is "New BSD Licence"
+
+require 'json'
+
+module GoogleDrive
+    class Config #:nodoc:
+
+        FIELDS = %w(client_id client_secret scope refresh_token).freeze
+        attr_accessor(*FIELDS)
+
+        def initialize(config_path)
+          @config_path = config_path
+          if ::File.exist?(config_path)
+            JSON.parse(::File.read(config_path)).each do |key, value|
+              instance_variable_set("@#{key}", value) if FIELDS.include?(key)
+            end
+          end
+        end
+
+        def save
+          ::File.open(@config_path, 'w', 0600) { |f| f.write(to_json()) }
+        end
+
+      private
+
+        def to_json
+          hash = {}
+          FIELDS.each do |field|
+            value = __send__(field)
+            hash[field] = value if value
+          end
+          return JSON.pretty_generate(hash)
+        end
+
+    end
+end

data/lib/google_drive/error.rb

@@ -1,12 +1,8 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-
 module GoogleDrive
-
     # Raised on errors in this library.
     class Error < RuntimeError
-
     end
-    
 end

data/lib/google_drive/session.rb

@@ -19,6 +19,7 @@ require "google_drive/spreadsheet"
 require "google_drive/worksheet"
 require "google_drive/collection"
 require "google_drive/file"
+require "google_drive/config"
 
 
 module GoogleDrive
@@ -212,7 +213,7 @@ module GoogleDrive
         def spreadsheet_by_title(title)
           return spreadsheets("q" => ["title = ?", title], "maxResults" => 1)[0]
         end
-        
+
         # Returns GoogleDrive::Worksheet with given +url+.
         # You must specify URL of cell-based feed of the worksheet.
         #
@@ -229,12 +230,12 @@ module GoogleDrive
           worksheet_feed_entry = request(:get, worksheet_feed_url)
           return Worksheet.new(self, nil, worksheet_feed_entry)
         end
-        
+
         # Returns the root collection.
         def root_collection
           return @root_collection ||= file_by_id("root")
         end
-        
+
         # Returns the top-level collections (direct children of the root collection).
         #
         # By default, it returns the first 100 collections. See document of files method for how to get
@@ -242,7 +243,7 @@ module GoogleDrive
         def collections
           return self.root_collection.subcollections
         end
-        
+
         # Returns a top-level collection whose title exactly matches +title+ as
         # GoogleDrive::Collection.
         # Returns nil if not found. If multiple collections with the +title+ are found, returns
@@ -250,7 +251,7 @@ module GoogleDrive
         def collection_by_title(title)
           return self.root_collection.subcollection_by_title(title)
         end
-        
+
         # Returns GoogleDrive::Collection with given +url+.
         # You must specify either of:
         # - URL of the page you get when you go to https://docs.google.com/ with your browser and
@@ -286,7 +287,7 @@ module GoogleDrive
               :body_object => file)
           return wrap_api_file(api_result.data)
         end
-        
+
         # Uploads a file with the given +title+ and +content+.
         # Returns a GoogleSpreadsheet::File object.
         #
@@ -294,11 +295,11 @@ module GoogleDrive
         #   # Uploads and converts to a Google Docs document:
         #   session.upload_from_string(
         #       "Hello world.", "Hello", :content_type => "text/plain")
-        #   
+        #
         #   # Uploads without conversion:
         #   session.upload_from_string(
         #       "Hello world.", "Hello", :content_type => "text/plain", :convert => false)
-        #   
+        #
         #   # Uploads and converts to a Google Spreadsheet:
         #   session.upload_from_string("hoge\tfoo\n", "Hoge", :content_type => "text/tab-separated-values")
         #   session.upload_from_string("hoge,foo\n", "Hoge", :content_type => "text/tsv")
@@ -306,20 +307,20 @@ module GoogleDrive
           media = new_upload_io(StringIO.new(content), params)
           return upload_from_media(media, title, params)
         end
-        
+
         # Uploads a local file.
         # Returns a GoogleSpreadsheet::File object.
         #
         # e.g.
         #   # Uploads a text file and converts to a Google Docs document:
         #   session.upload_from_file("/path/to/hoge.txt")
-        #   
+        #
         #   # Uploads without conversion:
         #   session.upload_from_file("/path/to/hoge.txt", "Hoge", :convert => false)
-        #   
+        #
         #   # Uploads with explicit content type:
         #   session.upload_from_file("/path/to/hoge", "Hoge", :content_type => "text/plain")
-        #   
+        #
         #   # Uploads a text file and converts to a Google Spreadsheet:
         #   session.upload_from_file("/path/to/hoge.csv", "Hoge")
         #   session.upload_from_file("/path/to/hoge", "Hoge", :content_type => "text/csv")
@@ -393,11 +394,11 @@ module GoogleDrive
             return items
 
           end
-          
+
         end
-        
+
         def request(method, url, params = {}) #:nodoc:
-          
+
           # Always uses HTTPS.
           url = url.gsub(%r{^http://}, "https://")
           data = params[:data]
@@ -424,9 +425,9 @@ module GoogleDrive
             end
             return convert_response(response, response_type)
           end
-          
+
         end
-        
+
         def inspect
           return "#<%p:0x%x>" % [self.class, self.object_id]
         end

metadata

@@ -1,115 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.5.1
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.5.1
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
 description: A library to read/write files/spreadsheets in Google Drive/Docs.
@@ -129,6 +129,7 @@ files:
 - lib/google_drive/api_client_fetcher.rb
 - lib/google_drive/authentication_error.rb
 - lib/google_drive/collection.rb
+- lib/google_drive/config.rb
 - lib/google_drive/error.rb
 - lib/google_drive/file.rb
 - lib/google_drive/list.rb
@@ -138,49 +139,29 @@ files:
 - lib/google_drive/spreadsheet.rb
 - lib/google_drive/util.rb
 - lib/google_drive/worksheet.rb
-- lib/google_drive_v0.rb
-- lib/google_drive_v0/acl.rb
-- lib/google_drive_v0/acl_entry.rb
-- lib/google_drive_v0/api_client_fetcher.rb
-- lib/google_drive_v0/authentication_error.rb
-- lib/google_drive_v0/basic_fetcher.rb
-- lib/google_drive_v0/client_login_fetcher.rb
-- lib/google_drive_v0/collection.rb
-- lib/google_drive_v0/error.rb
-- lib/google_drive_v0/file.rb
-- lib/google_drive_v0/list.rb
-- lib/google_drive_v0/list_row.rb
-- lib/google_drive_v0/oauth1_fetcher.rb
-- lib/google_drive_v0/oauth2_fetcher.rb
-- lib/google_drive_v0/record.rb
-- lib/google_drive_v0/session.rb
-- lib/google_drive_v0/spreadsheet.rb
-- lib/google_drive_v0/table.rb
-- lib/google_drive_v0/util.rb
-- lib/google_drive_v0/worksheet.rb
 homepage: https://github.com/gimite/google-drive-ruby
 licenses:
 - New BSD
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A library to read/write files/spreadsheets in Google Drive/Docs.