google_drive 1.0.6 → 2.0.0.pre1

data/lib/google_drive/acl_entry.rb

@@ -5,127 +5,171 @@
 # The license of this source is "New BSD Licence"
 
 module GoogleDrive
+  # An entry of an ACL (access control list) of a spreadsheet.
+  #
+  # Use GoogleDrive::Acl#[] to get GoogleDrive::AclEntry object.
+  #
+  # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
+  class AclEntry
+    include(Util)
+
+    # +params_or_api_permission+ is a Hash object with keys
+    # +:type+, +:email_address+, +:domain+, +:role+ and +:allow_file_discovery+.
+    # See GoogleDrive::Acl#push for description of the parameters.
+    def initialize(params_or_api_permission, acl = nil)
+      @acl = acl
+      if acl
+        @api_permission = params_or_api_permission
+        @params = nil
+        delegate_api_methods(self, @api_permission)
+      else
+        @api_permission = nil
+        @params = convert_params(params_or_api_permission)
+      end
+    end
 
-    # An entry of an ACL (access control list) of a spreadsheet.
-    #
-    # Use GoogleDrive::Acl#[] to get GoogleDrive::AclEntry object.
+    attr_reader(:acl)
+    attr_reader(:params) #:nodoc:
+    attr_accessor(:api_permission) #:nodoc:
+
+    # The role given to the scope. One of:
+    # - "owner": The owner.
+    # - "writer": With read/write access.
+    # - "reader": With read-only access.
+    def role
+      @params ? @params[:role] : @api_permission.role
+    end
+
+    # Type of the scope. One of:
     #
-    # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
-    class AclEntry
-
-        include(Util)
-
-        # +params_or_api_permission+ is a Hash object with keys +:type+, +:value+, +:role+ and +:withLink+.
-        # See GoogleDrive::Acl#push for description of the parameters.
-        def initialize(params_or_api_permission, acl = nil)
-          @acl = acl
-          if acl
-            @api_permission = params_or_api_permission
-            @params = nil
-            delegate_api_methods(self, @api_permission, ["value"])
-          else
-            @api_permission = nil
-            @params = convert_params(params_or_api_permission)
-          end
-        end
+    # - "user": a Google account specified by the email_address field.
+    # - "group": a Google Group specified by the email_address field.
+    # - "domain": a Google Apps domain specified by the domain field.
+    # - "anyone": Publicly shared with all users.
+    def type
+      @params ? @params[:type] : @api_permission.type
+    end
 
-        attr_reader(:acl)
-        attr_reader(:params) #:nodoc:
-        attr_accessor(:api_permission) #:nodoc:
+    alias_method :scope_type, :type
 
-        # The role given to the scope. One of:
-        # - "owner": The owner.
-        # - "writer": With read/write access.
-        # - "reader": With read-only access.
-        def role
-          return @params ? @params["role"] : @api_permission.role
-        end
+    def additional_roles
+      @params ? @params[:additionalRoles] : @api_permission.additional_roles
+    end
 
-        # Type of the scope. One of:
-        #
-        # - "user": value is a user's email address.
-        # - "group": value is a Google Group email address.
-        # - "domain": value is a Google Apps domain.
-        # - "anyone": Publicly shared with all users. value is +nil+.
-        def type
-          return @params ? @params["type"] : @api_permission.type
-        end
+    def id
+      @params ? @params[:id] : @api_permission.id
+    end
 
-        alias scope_type type
+    # Email address of the user or the group.
+    def email_address
+      @params ? @params[:email_address] : @api_permission.email_address
+    end
 
-        def additional_roles
-          return @params ? @params["additionalRoles"] : @api_permission.additional_roles
-        end
+    # The Google Apps domain name.
+    def domain
+      @params ? @params[:domain] : @api_permission.domain
+    end
 
-        def id
-          return @params ? @params["id"] : @api_permission.id
+    def value
+      if @params
+        case @params[:type]
+        when 'user', 'group'
+          @params[:email_address]
+        when 'domain'
+          @params[:domain]
+        else
+          nil
         end
-
-        # The value of the scope. See type.
-        def value
-          if @params
-            return @params["value"]
-          else
-            case @api_permission.type
-              when "user", "group"
-                return @api_permission.email_address
-              when "domain"
-                return @api_permission.domain
-              else
-                return nil
-            end
-          end
+      else
+        case @api_permission.type
+        when 'user', 'group'
+          @api_permission.email_address
+        when 'domain'
+          @api_permission.domain
+        else
+          nil
         end
+      end
+    end
 
-        alias scope value
+    alias_method :scope, :value
 
-        # If +true+, the file is shared only with people who know the link.
-        def with_link
-          return @params ? @params["withLink"] : @api_permission.with_link
-        end
+    # If +false+, the file is shared only with people who know the link.
+    # Only used for type "anyone".
+    def allow_file_discovery
+      @params ? @params[:allow_file_discovery] : @api_permission.allow_file_discovery
+    end
 
-        alias with_key with_link
-
-        # Changes the role of the scope.
-        #
-        # e.g.
-        #   spreadsheet.acl[1].role = "writer"
-        def role=(role)
-          if @params
-            @params["role"] = role
-          else
-            @api_permission.role = role
-            @acl.update_role(self)
-          end
-        end
+    # If +true+, the file is shared only with people who know the link.
+    # Only used for type "anyone".
+    def with_link
+      allow_file_discovery == false
+    end
 
-        def inspect
-          return "\#<%p type=%p, name=%p, role=%p>" %
-              [self.class, self.type, self.name, self.role]
-        end
+    alias_method :with_key, :with_link
 
-      private
-
-        # Normalizes the key to String, and converts parameters in the old version.
-        def convert_params(orig_params)
-          new_params = {}
-          for k, v in orig_params
-            k = k.to_s()
-            case k
-              when "scope_type"
-                new_params["type"] = (v == "default" ? "anyone" : v)
-              when "scope"
-                new_params["value"] = v
-              when "with_key"
-                new_params["withLink"] = v
-              else
-                new_params[k] = v
-            end
-          end
-          return new_params
-        end
+    # Changes the role of the scope.
+    #
+    # e.g.
+    #   spreadsheet.acl[1].role = "writer"
+    def role=(role)
+      if @params
+        @params[:role] = role
+      else
+        @api_permission.role = role
+        @acl.update_role(self)
+      end
+    end
 
+    def inspect
+      case type
+      when 'user', 'group'
+        "\#<%p type=%p, email_address=%p, role=%p>" %
+          [self.class, type, email_address, role]
+      when 'domain'
+        "\#<%p type=%p, domain=%p, role=%p>" %
+          [self.class, type, domain, role]
+      when 'anyone'
+        "\#<%p type=%p, role=%p, allow_file_discovery=%p>" %
+          [self.class, type, role, allow_file_discovery]
+      else
+        "\#<%p type=%p, role=%p>" %
+          [self.class, type, role]
+      end
     end
 
-end
+    private
+
+    # Normalizes the key to Symbol, and converts parameters in the old version.
+    def convert_params(orig_params)
+      new_params = {}
+      value = nil
+      orig_params.each do |k, v|
+        k = k.to_s
+        case k
+        when 'scope_type'
+          new_params[:type] = (v == 'default' ? 'anyone' : v)
+        when 'scope'
+          new_params[:value] = v
+        when 'with_key', 'withLink'
+          new_params[:allow_file_discovery] = !v
+        when 'value'
+          value = v
+        else
+          new_params[k.intern] = v
+        end
+      end
+
+      if value
+        case new_params[:type]
+        when 'user', 'group'
+          new_params[:email_address] = value
+        when 'domain'
+          new_params[:domain] = value
+        end
+      end
 
+      new_params
+    end
+  end
+end

data/lib/google_drive/api_client_fetcher.rb

@@ -1,52 +1,33 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "net/https"
-require "uri"
+require 'net/https'
+require 'uri'
+require 'google/apis/drive_v3'
 Net::HTTP.version_1_2
 
-
 module GoogleDrive
+  class ApiClientFetcher
+    class Response
+      def initialize(code, body)
+        @code = code
+        @body = body
+      end
+
+      attr_reader(:code, :body)
+    end
 
-    class ApiClientFetcher
-        
-        class Response
-
-            def initialize(client_response)
-              @client_response = client_response
-            end
-
-            def code
-              return @client_response.status.to_s()
-            end
-
-            def body
-              return @client_response.body
-            end
-
-            attr_reader(:client_response)
-
-        end
+    def initialize(authorization)
+      @drive = Google::Apis::DriveV3::DriveService.new
+      @drive.authorization = authorization
+    end
 
-        def initialize(client)
-          @client = client
-          # Sets virtually infinite default timeout because some operations (e.g., uploading
-          # a large files/spreadsheets) can take very long.
-          @client.connection.options[:timeout] ||= 100000000
-          @drive = @client.discovered_api("drive", "v2")
-        end
+    attr_reader(:drive)
 
-        attr_reader(:client, :drive)
-        
-        def request_raw(method, url, data, extra_header, auth)
-          client_response = @client.execute(
-              :http_method => method,
-              :uri => url,
-              :body => data,
-              :headers => extra_header)
-          return Response.new(client_response)
-        end
-        
+    def request_raw(method, url, data, extra_header, _auth)
+      options = Google::Apis::RequestOptions.default.merge(header: extra_header)
+      body = @drive.http(method, url, body: data, options: options)
+      Response.new('200', body)
     end
-    
+  end
 end

data/lib/google_drive/authentication_error.rb

@@ -1,14 +1,10 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive/response_code_error"
-
+require 'google_drive/response_code_error'
 
 module GoogleDrive
-
-    # Raised when GoogleDrive.login has failed.
-    class AuthenticationError < GoogleDrive::ResponseCodeError
-
-    end
-    
+  # Raised when GoogleDrive.login has failed.
+  class AuthenticationError < GoogleDrive::ResponseCodeError
+  end
 end

data/lib/google_drive/collection.rb

@@ -1,165 +1,143 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive/util"
-require "google_drive/error"
-require "google_drive/spreadsheet"
-
+require 'google_drive/util'
+require 'google_drive/error'
+require 'google_drive/spreadsheet'
 
 module GoogleDrive
+  # Use GoogleDrive::Session#root_collection, GoogleDrive::Collection#subcollections,
+  # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
+  class Collection < GoogleDrive::File
+    include(Util)
 
-    # Use GoogleDrive::Session#root_collection, GoogleDrive::Collection#subcollections,
-    # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
-    class Collection < GoogleDrive::File
-
-        include(Util)
-
-        alias collection_feed_url document_feed_url
-        
-        # Adds the given GoogleDrive::File to the collection.
-        def add(file)
-          new_child = @session.drive.children.insert.request_schema.new({
-              "id" => file.id,
-          })
-          @session.execute!(
-              :api_method => @session.drive.children.insert,
-              :body_object => new_child,
-              :parameters => {
-                  "folderId" => self.id,
-                  "childId" => file.id,
-              })
-          return nil
-        end
+    alias_method :collection_feed_url, :document_feed_url
 
-        # Creates a sub-collection with given title. Returns GoogleDrive::Collection object.
-        def create_subcollection(title)
-          file = @session.drive.files.insert.request_schema.new({
-              "title" => title,
-              "mimeType" => "application/vnd.google-apps.folder",
-              "parents" => [{"id" => self.id}],
-          })
-          api_result = @session.execute!(
-              :api_method => @session.drive.files.insert,
-              :body_object => file)
-          return @session.wrap_api_file(api_result.data)
-        end
+    # Adds the given GoogleDrive::File to the collection.
+    def add(file)
+      @session.drive.update_file(file.id, add_parents: self.id, fields: '')
+      nil
+    end
 
-        # Removes the given GoogleDrive::File from the collection.
-        def remove(file)
-          @session.execute!(
-              :api_method => @session.drive.children.delete,
-              :parameters => {
-                  "folderId" => self.id,
-                  "childId" => file.id,
-              })
-          return nil
-        end
+    # Removes the given GoogleDrive::File from the collection.
+    def remove(file)
+      @session.drive.update_file(file.id, remove_parents: self.id, fields: '')
+    end
 
-        # Returns true if this is a root collection
-        def root?
-          return self.api_file.parents.empty?
-        end
+    # Creates a sub-collection with given title. Returns GoogleDrive::Collection object.
+    def create_subcollection(title)
+      file_metadata = {
+        name: title,
+        mime_type: 'application/vnd.google-apps.folder',
+        parents: [self.id],
+      }
+      file = @session.drive.create_file(file_metadata, fields: '*')
+      @session.wrap_api_file(file)
+    end
 
-        # Returns all the files (including spreadsheets, documents, subcollections) in the collection.
-        #
-        # You can specify parameters documented at
-        # https://developers.google.com/drive/v2/reference/files/list
-        #
-        # e.g.
-        #
-        #   # Gets all the files in collection, including subcollections.
-        #   collection.files
-        #   # Gets only files with title "hoge".
-        #   collection.files("q" => "title = 'hoge'")
-        #   # Same as above with a placeholder.
-        #   collection.files("q" => ["title = ?", "hoge"])
-        #
-        # By default, it returns the first 100 files. See document of GoogleDrive::Session#files method
-        # for how to get all files.
-        def files(params = {}, &block)
-          return files_with_type(nil, params, &block)
-        end
+    # Returns true if this is a root collection
+    def root?
+      !api_file.parents || api_file.parents.empty?
+    end
 
-        alias contents files
+    # Returns all the files (including spreadsheets, documents, subcollections) in the collection.
+    #
+    # You can specify parameters documented at
+    # https://developers.google.com/drive/v2/reference/files/list
+    #
+    # e.g.
+    #
+    #   # Gets all the files in collection, including subcollections.
+    #   collection.files
+    #   # Gets only files with title "hoge".
+    #   collection.files("q" => "title = 'hoge'")
+    #   # Same as above with a placeholder.
+    #   collection.files("q" => ["title = ?", "hoge"])
+    #
+    # By default, it returns the first 100 files. See document of GoogleDrive::Session#files method
+    # for how to get all files.
+    def files(params = {}, &block)
+      files_with_type(nil, params, &block)
+    end
 
-        # Returns all the spreadsheets in the collection.
-        #
-        # By default, it returns the first 100 spreadsheets. See document of GoogleDrive::Session#files method
-        # for how to get all spreadsheets.
-        def spreadsheets(params = {}, &block)
-          return files_with_type("application/vnd.google-apps.spreadsheet", params, &block)
-        end
-        
-        # Returns all the Google Docs documents in the collection.
-        #
-        # By default, it returns the first 100 documents. See document of GoogleDrive::Session#files method
-        # for how to get all documents.
-        def documents(params = {}, &block)
-          return files_with_type("application/vnd.google-apps.document", params, &block)
-        end
-        
-        # Returns all its subcollections.
-        #
-        # By default, it returns the first 100 subcollections. See document of GoogleDrive::Session#files method
-        # for how to get all subcollections.
-        def subcollections(params = {}, &block)
-          return files_with_type("application/vnd.google-apps.folder", params, &block)
-        end
-        
-        # Returns a file (can be a spreadsheet, document, subcollection or other files) in the
-        # collection which exactly matches +title+ as GoogleDrive::File.
-        # Returns nil if not found. If multiple collections with the +title+ are found, returns
-        # one of them.
-        #
-        # If given an Array, does a recursive subcollection traversal.
-        def file_by_title(title)
-          return file_by_title_with_type(title, nil)
-        end
-        
-        # Returns its subcollection whose title exactly matches +title+ as GoogleDrive::Collection.
-        # Returns nil if not found. If multiple collections with the +title+ are found, returns
-        # one of them.
-        #
-        # If given an Array, does a recursive subcollection traversal.
-        def subcollection_by_title(title)
-          return file_by_title_with_type(title, "application/vnd.google-apps.folder")
-        end
+    alias_method :contents, :files
 
-        # Returns URL of the deprecated contents feed.
-        def contents_url
-          self.document_feed_url + "/contents"
-        end
-        
-      protected
-
-        def file_by_title_with_type(title, type)
-          if title.is_a?(Array)
-            rel_path = title
-            if rel_path.empty?
-              return self
-            else
-              parent = subcollection_by_title(rel_path[0...-1])
-              return parent && parent.file_by_title_with_type(rel_path[-1], type)
-            end
-          else
-            return files_with_type(type, "q" => ["title = ?", title], "maxResults" => 1)[0]
-          end
-        end
-        
-      private
-
-        def files_with_type(type, params = {}, &block)
-          params = convert_params(params)
-          query = construct_and_query([
-              ["? in parents", self.id],
-              type ? ["mimeType = ?", type] : nil,
-              params["q"],
-          ])
-          params = params.merge({"q" => query})
-          # This is faster than calling children.list and then files.get for each file.
-          return @session.files(params, &block)
+    # Returns all the spreadsheets in the collection.
+    #
+    # By default, it returns the first 100 spreadsheets. See document of GoogleDrive::Session#files method
+    # for how to get all spreadsheets.
+    def spreadsheets(params = {}, &block)
+      files_with_type('application/vnd.google-apps.spreadsheet', params, &block)
+    end
+
+    # Returns all the Google Docs documents in the collection.
+    #
+    # By default, it returns the first 100 documents. See document of GoogleDrive::Session#files method
+    # for how to get all documents.
+    def documents(params = {}, &block)
+      files_with_type('application/vnd.google-apps.document', params, &block)
+    end
+
+    # Returns all its subcollections.
+    #
+    # By default, it returns the first 100 subcollections. See document of GoogleDrive::Session#files method
+    # for how to get all subcollections.
+    def subcollections(params = {}, &block)
+      files_with_type('application/vnd.google-apps.folder', params, &block)
+    end
+
+    # Returns a file (can be a spreadsheet, document, subcollection or other files) in the
+    # collection which exactly matches +title+ as GoogleDrive::File.
+    # Returns nil if not found. If multiple collections with the +title+ are found, returns
+    # one of them.
+    #
+    # If given an Array, does a recursive subcollection traversal.
+    def file_by_title(title)
+      file_by_title_with_type(title, nil)
+    end
+
+    # Returns its subcollection whose title exactly matches +title+ as GoogleDrive::Collection.
+    # Returns nil if not found. If multiple collections with the +title+ are found, returns
+    # one of them.
+    #
+    # If given an Array, does a recursive subcollection traversal.
+    def subcollection_by_title(title)
+      file_by_title_with_type(title, 'application/vnd.google-apps.folder')
+    end
+
+    # Returns URL of the deprecated contents feed.
+    def contents_url
+      document_feed_url + '/contents'
+    end
+
+    protected
+
+    def file_by_title_with_type(title, type)
+      if title.is_a?(Array)
+        rel_path = title
+        if rel_path.empty?
+          return self
+        else
+          parent = subcollection_by_title(rel_path[0...-1])
+          return parent && parent.file_by_title_with_type(rel_path[-1], type)
         end
-        
+      else
+        files_with_type(type, q: ['name = ?', title], page_size: 1)[0]
+      end
+    end
+
+    private
+
+    def files_with_type(type, params = {}, &block)
+      params = convert_params(params)
+      query  = construct_and_query([
+        ['? in parents', id],
+        type ? ['mimeType = ?', type] : nil,
+        params[:q]
+      ])
+      params = params.merge(q: query)
+      # This is faster than calling children.list and then files.get for each file.
+      @session.files(params, &block)
     end
-    
+  end
 end