tumugi-plugin-google_drive 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6299d3432c8ea64f32980e96034eedd84ba7ccd9
-  data.tar.gz: 24be0abafa651a00fb408bb5efcd791ddedc4028
+  metadata.gz: 4bfeef127b61e1749d6d732d9dc67825a37d1143
+  data.tar.gz: 9691c71410622d8e0fc1c331fbcdd63ed67538c8
 SHA512:
-  metadata.gz: 4efc5aa4b66a9c81fb01b200290dacb44165e8a2b4390881678f10c8263b846de3733f82af1171cc39420c7a517cd3edfdd69c17ea3eb995784131176cdb517a
-  data.tar.gz: 02d61db00ff93d161899a39f5e53bf99fcc85561289b6e538976aa73d4b16f1ba8bedb68a81bd3c7a79723b1310fb9269fc41d96a9391dcf967f3cdf5e5c0eeb
+  metadata.gz: 22938993b7ba94e3382e11294d4780895cad57b6b393b8c8e8ca2337e64a0723097352ae65e30db2b276b9c45eff4c28c0d80d5f42419aacb02eb1051714b1e0
+  data.tar.gz: 18c0701d6077d0736d1450bcb39af8856e08d17028db709fdcde77a649fcb633c2b19c2e09ab978fb982fce17f962ae2246a907fa9c91253beb38a39df59050e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [v0.4.0](https://github.com/tumugi/tumugi-plugin-google_drive/tree/v0.4.0) (2016-08-29)
+[Full Changelog](https://github.com/tumugi/tumugi-plugin-google_drive/compare/v0.3.0...v0.4.0)
+
+**Implemented enhancements:**
+
+- Support convert a file to the corresponding Google Docs format [\#16](https://github.com/tumugi/tumugi-plugin-google_drive/issues/16)
+- Add method to get sharable link for Google Drive [\#13](https://github.com/tumugi/tumugi-plugin-google_drive/issues/13)
+
+**Merged pull requests:**
+
+- Support file type convert when import/export. [\#17](https://github.com/tumugi/tumugi-plugin-google_drive/pull/17) ([hakobera](https://github.com/hakobera))
+- Add url method to GoogleDriveFileTarget and GoogleDriveFolderTarget [\#15](https://github.com/tumugi/tumugi-plugin-google_drive/pull/15) ([hakobera](https://github.com/hakobera))
+
 ## [v0.3.0](https://github.com/tumugi/tumugi-plugin-google_drive/tree/v0.3.0) (2016-08-02)
 [Full Changelog](https://github.com/tumugi/tumugi-plugin-google_drive/compare/v0.2.0...v0.3.0)
 
@@ -7,6 +20,10 @@
 
 - \[Breaking Change\] Support match by name [\#12](https://github.com/tumugi/tumugi-plugin-google_drive/pull/12) ([hakobera](https://github.com/hakobera))
 
+**Merged pull requests:**
+
+- Prepare release for 0.3.0 [\#14](https://github.com/tumugi/tumugi-plugin-google_drive/pull/14) ([hakobera](https://github.com/hakobera))
+
 ## [v0.2.0](https://github.com/tumugi/tumugi-plugin-google_drive/tree/v0.2.0) (2016-07-18)
 [Full Changelog](https://github.com/tumugi/tumugi-plugin-google_drive/compare/v0.1.0...v0.2.0)
 

data/README.md

@@ -22,15 +22,18 @@ And then execute `bundle install`
 
 #### Parameters
 
-| name    | type                   | required? | default | description         |
-|---------|------------------------|-----------|---------|---------------------|
-| name    | string                 | required  |         | Filename            |
-| file_id | string                 | optional  |         | File ID             |
-| parents | string or string array | optional  |         | Parent folder ID(s) |
+| name      | type                   | required? | default | description         |
+|-----------|------------------------|-----------|---------|---------------------|
+| name      | string                 | required  |         | Filename            |
+| file_id   | string                 | optional  |         | File ID             |
+| parents   | string or string array | optional  |         | Parent folder ID(s) |
+| mime_type | string                 | optional  |         | MIME type of file |
+
+`mime_type` is specifiy default mime_type value for `GoogleDriveFileTarget#open(mode="r", mime_type: @mime_type, &block)` method.
 
 #### Examples
 
-Create Google Drive file in folder named `xyz`, which content is "done"
+##### Create Google Drive file in folder named `xyz`, which content is "done"
 
 ```rb
 task :task1 do
@@ -38,8 +41,8 @@ task :task1 do
 
   output do
     target(:google_drive_file,
-          name: "test_#{day.strftime('%Y%m%d')}.txt",
-          parents: "xyz")
+            name: "test_#{day.strftime('%Y%m%d')}.txt",
+            parents: "xyz")
   end
 
   run do
@@ -49,6 +52,27 @@ task :task1 do
 end
 ```
 
+##### Upload CSV file and convert it to Google Sheets file
+
+```rb
+task :task1 do
+  param :day, type: :time, auto_bind: true, required: true
+
+  output do
+    target(:google_drive_file,
+            name: "test_#{day.strftime('%Y%m%d')}.csv",
+            mime_type: "application/vnd.google-apps.spreadsheet")
+  end
+
+  run do
+    log "task1#run"
+    output.open("w") {|f| f.puts("header1,header2"); f.puts("value1,value2") }
+    # You can also specify mime_type by argument of open method.
+    # output.open("w", mime_type: "application/vnd.google-apps.spreadsheet") { ... }
+  end
+end
+```
+
 ### Tumugi::Plugin::GoogleDriveFolderTarget
 
 `GoogleDriveFolderTarget` represents folder on Googl Drive.

data/examples/example.rb

@@ -6,8 +6,8 @@ task :task1 do
 
   output do
     target(:google_drive_file,
-          name: "test_#{day.strftime('%Y%m%d%H%M')}_#{seed}.txt",
-          parents: input.folder_id)
+            name: "test_#{day.strftime('%Y%m%d%H%M')}_#{seed}.txt",
+            parents: input.folder_id)
   end
 
   run do

data/lib/tumugi/plugin/google_drive/atomic_file.rb

@@ -6,15 +6,24 @@ module Tumugi
       class AtomicFile < Tumugi::AtomicFile
         attr_reader :id
 
-        def initialize(path, fs, file_id: nil, parents: nil)
+        def initialize(path, fs, file_id: nil, parents: nil, mime_type: nil)
           super(path)
           @fs = fs
           @parents = parents
-          @id = (file_id.nil? ? @fs.generate_file_id : file_id)
+          @id = file_id.nil? ? fs.generate_file_id : file_id
+          @mime_type = mime_type
+
+          # https://developers.google.com/drive/v3/web/manage-uploads#uploading_using_a_pregenerated_id
+          # Pregenerated IDs are not supported for native Google Document creation,
+          # or uploads where conversion to native Google Document format is requested.
+          if fs.google_drive_document?(mime_type)
+            @id = nil
+          end
         end
 
         def move_to_final_destination(temp_file)
-          @fs.upload(temp_file, path, file_id: @id, parents: @parents)
+          file = @fs.upload(temp_file, path, file_id: @id, parents: @parents, mime_type: @mime_type)
+          @id = file.id unless @id
         end
       end
     end

data/lib/tumugi/plugin/google_drive/file_system.rb

@@ -1,4 +1,5 @@
 require 'google/apis/drive_v3'
+
 require 'tumugi/error'
 
 Tumugi::Config.register_section('google_drive', :project_id, :client_email, :private_key, :private_key_file)
@@ -7,7 +8,6 @@ module Tumugi
   module Plugin
     module GoogleDrive
       class FileSystem
-
         MIME_TYPE_FOLDER = 'application/vnd.google-apps.folder'
 
         def initialize(config)
@@ -15,7 +15,7 @@ module Tumugi
         end
 
         def exist?(file_id)
-          client.get_file(file_id, options: request_options)
+          get_file_metadata(file_id, fields: 'id')
           true
         rescue => e
           return false if e.respond_to?(:status_code) && e.status_code == 404
@@ -39,7 +39,7 @@ module Tumugi
             parents: parents,
             id: folder_id
           })
-          file = client.create_file(file_metadata, options: request_options)
+          file = client.create_file(file_metadata, fields: "*", options: request_options)
           wait_until { exist?(file.id) }
           file
         rescue
@@ -47,7 +47,7 @@ module Tumugi
         end
 
         def directory?(file_id)
-          file = client.get_file(file_id, options: request_options)
+          file = get_file_metadata(file_id)
           file.mime_type == MIME_TYPE_FOLDER
         rescue
           process_error($!)
@@ -72,14 +72,15 @@ module Tumugi
           process_error($!)
         end
 
-        def upload(media, name, content_type: nil, file_id: nil, parents: nil)
+        def upload(media, name, content_type: nil, file_id: nil, parents: nil, mime_type: nil)
           parents = [parents] if parents.is_a?(String)
           file_metadata = Google::Apis::DriveV3::File.new({
             id: file_id,
             name: name,
-            parents: parents
+            parents: parents,
+            mime_type: mime_type
           })
-          file = client.create_file(file_metadata, upload_source: media, content_type: content_type, options: request_options)
+          file = client.create_file(file_metadata, fields: "*", upload_source: media, content_type: content_type, options: request_options)
           wait_until { exist?(file.id) }
           file
         rescue
@@ -91,11 +92,29 @@ module Tumugi
           upload(media, name, content_type: content_type, file_id: file_id, parents: parents)
         end
 
-        def download(file_id, download_path: nil, mode: 'r', &block)
+        def download(file_id, download_path: nil, mode: 'r', mime_type: nil, &block)
+          if !exist?(file_id)
+            raise Tumugi::FileSystemError.new("#{file_id} does not exist")
+          end
+
           if download_path.nil?
             download_path = Tempfile.new('tumugi_google_drive_file_system').path
           end
-          client.get_file(file_id, download_dest: download_path, options: request_options)
+
+          file = get_file_metadata(file_id)
+          if google_drive_document?(file.mime_type)
+            # If file is Google Drive Document, use export_file
+            # https://developers.google.com/drive/v3/web/manage-downloads#downloading_google_documents
+            if mime_type.nil?
+              raise Tumugi::FileSystemError.new("mime_type is required because file #{file_id} is Google Drive Document")
+            end
+            client.export_file(file_id, mime_type, download_dest: download_path, options: request_options)
+          else
+            # If file is not Google Drive Document, use get_file
+            # https://developers.google.com/drive/v3/web/manage-downloads#downloading_a_file
+            client.get_file(file_id, download_dest: download_path, options: request_options)
+          end
+
           wait_until { File.exist?(download_path) }
 
           if block_given?
@@ -103,6 +122,7 @@ module Tumugi
           else
             File.open(download_path, mode)
           end
+          file
         rescue
           process_error($!)
         end
@@ -121,6 +141,14 @@ module Tumugi
           process_error($!)
         end
 
+        def get_file_metadata(file_id, fields: "*")
+          client.get_file(file_id, fields: fields, options: request_options)
+        end
+
+        def google_drive_document?(mime_type)
+          !!(mime_type && mime_type.start_with?("application/vnd.google-apps."))
+        end
+
         private
 
         def save_config(config)
@@ -173,16 +201,21 @@ module Tumugi
             begin
               if err.body.nil?
                 reason = err.status_code.to_s
-                errors = "HTTP Status: #{err.status_code}\nHeaders: #{err.header.inspect}"
+                errors = "HTTP Status: #{err.status_code}, Headers: #{err.header.inspect}"
               else
                 jobj = JSON.parse(err.body)
                 error = jobj["error"]
-                reason = error["errors"].map{|e| e["reason"]}.join(",")
-                errors = error["errors"].map{|e| e["message"] }.join("\n")
+                errors = "HTTP Status: #{err.status_code}, Headers: #{err.header.inspect}, Body: "
+                if error["errors"]
+                  reason = error["errors"].map{|e| e["reason"]}.join(",")
+                  errors += error["errors"].map{|e| e["message"] }.join(". ")
+                else
+                  errors += error["message"]
+                end
               end
             rescue JSON::ParserError
               reason = err.status_code.to_s
-              errors = "HTTP Status: #{err.status_code}\nHeaders: #{err.header.inspect}\nBody:\n#{err.body}"
+              errors = "HTTP Status: #{err.status_code}, Headers: #{err.header.inspect}, Body: #{err.body}"
             end
             raise Tumugi::FileSystemError.new(errors, reason)
           else

data/lib/tumugi/plugin/target/google_drive_file.rb

@@ -9,29 +9,31 @@ module Tumugi
     class GoogleDriveFileTarget < Tumugi::Plugin::FileSystemTarget
       Tumugi::Plugin.register_target('google_drive_file', self)
 
-      attr_reader :file_id, :name, :parents
+      attr_reader :file_id, :name, :parents, :mime_type
 
-      def initialize(file_id: nil, name:, parents: nil, fs: nil)
+      def initialize(file_id: nil, name:, parents: nil, mime_type: nil, fs: nil)
         @fs = fs unless fs.nil?
         @file_id = file_id
         @name = name
         @parents = parents
-        super(file_id)
+        @mime_type = mime_type
+
+        super(@file_id)
       end
 
       def fs
         @fs ||= Tumugi::Plugin::GoogleDrive::FileSystem.new(Tumugi.config.section('google_drive'))
       end
 
-      def open(mode="r", &block)
+      def open(mode="r", mime_type: @mime_type, &block)
         if mode.include? 'r'
           if file_id.nil?
             file = find_by_name(name)
             @file_id = file.id unless file.nil?
           end
-          fs.download(file_id, mode: mode, &block)
+          fs.download(file_id, mode: mode, mime_type: mime_type, &block)
         elsif mode.include? 'w'
-          file = Tumugi::Plugin::GoogleDrive::AtomicFile.new(name, fs, file_id: file_id, parents: @parents)
+          file = Tumugi::Plugin::GoogleDrive::AtomicFile.new(name, fs, file_id: file_id, parents: @parents, mime_type: mime_type)
           file.open(&block)
           @file_id = file.id
         else
@@ -53,6 +55,11 @@ module Tumugi
         s
       end
 
+      def url
+        file = fs.get_file_metadata(file_id)
+        file.web_view_link
+      end
+
       private
 
       def find_by_name(n)

data/lib/tumugi/plugin/target/google_drive_folder.rb

@@ -24,7 +24,7 @@ module Tumugi
         if folder_id
           fs.exist?(folder_id)
         else
-          !!find_by_name(name)
+          !find_by_name(name).nil?
         end
       end
 
@@ -40,6 +40,12 @@ module Tumugi
         s
       end
 
+      def url
+        return nil if folder_id.nil?
+        folder = fs.get_file_metadata(folder_id)
+        folder.web_view_link
+      end
+
       private
 
       def find_by_name(n)
@@ -51,7 +57,7 @@ module Tumugi
         if parents
           query += " and ("
           query += "#{ps.map{|p| "'#{p}' in parents"}.join(" or ")}"
-          query += ") and mime_type = '#{Tumugi::Plugin::GoogleDrive::FileSystem::MIME_TYPE_FOLDER}'"
+          query += ") and mime_type = '#{Tumugi::Plugin::GoogleDrive::MimeTypes::DRIVE_FOLDER}'"
         end
         files = fs.list_files(query: query, page_size: 2).files
         if files.size == 0

data/tumugi-plugin-google_drive.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "tumugi-plugin-google_drive"
-  spec.version       = "0.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["Kazuyuki Honda"]
   spec.email         = ["hakobera@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tumugi-plugin-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kazuyuki Honda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tumugi
@@ -136,7 +136,7 @@ files:
 - README.md
 - Rakefile
 - examples/example.rb
-- examples/tumgui_config_example.rb
+- examples/tumugi_config_example.rb
 - lib/tumugi/plugin/google_drive/atomic_file.rb
 - lib/tumugi/plugin/google_drive/file_system.rb
 - lib/tumugi/plugin/target/google_drive_file.rb