fastlane-plugin-google_drive 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69b7bc30ac28e0475fb4ee43332ee5dccb610401afa983c0b51149d361846b5
-  data.tar.gz: 85267e5222259dce3f093bdf680edbbe6f0ad0dfcdb52e8e53fc71a36794dcc1
+  metadata.gz: 25c7b2e3b658ca2ab433146073bfd0da8f5acdc865b1d8ab5a7981927e087c13
+  data.tar.gz: 42cce7a465a1955e902c9522c754694733309f9aaff5d5797e76a4a142c3d03a
 SHA512:
-  metadata.gz: 11a321c10bb1f5627caffa9d939c7993368c35358a48eb21ad18c64ca25538e858676a1436d65cd3dba8ee06e84ca1c9eec5754e6b8d1d1a34a177342977d838
-  data.tar.gz: 440c4b18e80b521e6e99f3d3c6b4869dc7bef61adcb1a389ab1a6ae96bf41c52f2495f677b97a3f28aba9513ae7789312db7d27fcb14ce86c7ab1915362190e2
+  metadata.gz: 4f694a5b1e75ca345133e4759598ec7b93f8cab3bef73f60ca2c2cfa76451ade3404ae845535d5240dd46f7927a16b17bd94cfd2e907875cdd58d89c146c4594
+  data.tar.gz: 036e78a81ee5d63dc0cacc106be9c6e472befb71addfd45564993b5d9c3d04258735155edbd8d6c1691c378c9680ab426ae9fb6a1b03a0795ba012808c427347

data/README.md

@@ -1,6 +1,8 @@
-# google_drive plugin
+# google_drive `fastlane` plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-google_drive)
+[![Gem Version Badge](https://badge.fury.io/rb/fastlane-plugin-google_drive.svg)](https://badge.fury.io/rb/fastlane-plugin-google_drive)
+[![Build Status](https://travis-ci.org/bskim45/fastlane-plugin-google_drive.svg?branch=master)](https://travis-ci.org/bskim45/fastlane-plugin-google_drive)
 
 ## Getting Started
 
@@ -12,26 +14,44 @@ fastlane add_plugin google_drive
 
 ## About google_drive
 
-Upload files to Google Drive
+```ruby
+upload_google_drive(
+  drive_keyfile: 'drive_key.json',
+  service_account: true,
+  folder_id: 'folder_id',
+  upload_files: ['file_to_upload', 'another_file_to_upload']
+)
+```
+
+Upload files to Google Drive folder.
+
+```ruby
+create_google_drive_folder(
+  drive_keyfile: 'drive_key.json',
+  folder_id: '#{folder_id}',
+  folder_title: 'new_folder'
+)
+```
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+Create new Google Drive folder
+
+Download feature is not implemented yet. PR is always welcome.
 
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
 
-```
+```bash
 rake
 ```
 
 To automatically fix many of the styling issues, use
-```
+
+```bash
 rubocop -a
 ```
 
@@ -50,3 +70,9 @@ For more information about how the `fastlane` plugin system works, check out the
 ## About _fastlane_
 
 _fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2018 Bumsoo Kim (<https://bsk.im>)

data/lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb

@@ -0,0 +1,103 @@
+require 'fastlane/action'
+require_relative '../helper/google_drive_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GDRIVE_CREATED_FOLDER_ID = :GDRIVE_CREATED_FOLDER_ID
+      GDRIVE_CREATED_FOLDER_URL = :GDRIVE_CREATED_FOLDER_URL
+    end
+    class CreateGoogleDriveFolderAction < Action
+      def self.run(params)
+        UI.message("Using config file: #{params[:drive_keyfile]}")
+
+        session = Helper::GoogleDriveHelper.setup(
+          keyfile: params[:drive_keyfile],
+          service_account: params[:service_account]
+        )
+
+        folder = Helper::GoogleDriveHelper.file_by_id(
+          session: session, fid: params[:folder_id]
+        )
+
+        title = params[:folder_title]
+        UI.message('------------------')
+        UI.important("Creating #{title}")
+        new_folder = Helper::GoogleDriveHelper.create_subcollection(root_folder: folder, title: title)
+        UI.success('Success')
+        UI.message('------------------')
+
+        folder_id = new_folder.resource_id.split(':').last
+        Actions.lane_context[SharedValues::GDRIVE_CREATED_FOLDER_ID] = folder_id
+        Actions.lane_context[SharedValues::GDRIVE_CREATED_FOLDER_URL] = new_folder.human_url
+
+        new_folder
+      end
+
+      def self.description
+        'Create new folder on Google Drive'
+      end
+
+      def self.details
+        [
+          'Create new folder on Google Drive',
+          'See https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md to get a keyfile'
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :drive_keyfile,
+                                       env_name: 'GDRIVE_KEY_FILE',
+                                       description: 'Json config file',
+                                       type: String,
+                                       default_value: 'drive_key.json',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find config keyfile at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :service_account,
+                                       env_name: 'GDRIVE_SERVICE_ACCOUNT',
+                                       description: 'Credential is service account',
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :folder_id,
+                                       env_name: "GDRIVE_UPLOAD_FOLDER_ID",
+                                       description: "Upload target folder id",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No target folder id given, pass using `folder_id: 'some_id'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :folder_title,
+                                       env_name: "GDRIVE_FOLDER_NAME",
+                                       description: "Folder title of new one",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No folder title given") if value.nil? || value.empty?
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['GDRIVE_CREATED_FOLDER_ID', 'ID of the created folder'],
+          ['GDRIVE_CREATED_FOLDER_URL', 'Link to the created folder']
+        ]
+      end
+
+      def self.return_value
+        '`GoogleDrive::Collection` object which indicates the created folder.'
+      end
+
+      def self.authors
+        ['Kohki Miki (@giginet)']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_drive/actions/google_drive_upload_action.rb

@@ -105,6 +105,15 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.category
+        :deprecated
+      end
+
+      def self.deprecated_notes
+        "`google_drive_upload(...)` is renamed to `upload_google_drive(...)`\n" \
+        "It will be removed in next release."
+      end
     end
   end
 end

data/lib/fastlane/plugin/google_drive/actions/upload_google_drive_action.rb

@@ -0,0 +1,110 @@
+require 'fastlane/action'
+require_relative '../helper/google_drive_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GDRIVE_UPLOADED_FILE_NAMES = :GDRIVE_UPLOADED_FILE_NAMES
+      GDRIVE_UPLOADED_FILE_URLS = :GDRIVE_UPLOADED_FILE_URLS
+    end
+    class UploadGoogleDriveAction < Action
+      def self.run(params)
+        UI.message("Using config file: #{params[:drive_keyfile]}")
+
+        session = Helper::GoogleDriveHelper.setup(
+          keyfile: params[:drive_keyfile],
+          service_account: params[:service_account]
+        )
+
+        folder = Helper::GoogleDriveHelper.file_by_id(
+          session: session, fid: params[:folder_id]
+        )
+
+        uploaded_files = []
+        assets = params[:upload_files]
+
+        UI.abort_with_message!("No files to upload") if assets.nil? or assets.empty?
+
+        assets.each do |asset|
+          UI.message('------------------')
+          UI.important("Uploading #{asset}")
+          uploaded_files.push(Helper::GoogleDriveHelper.upload_file(file: folder, file_name: asset))
+          UI.success('Success')
+          UI.message('------------------')
+        end
+
+        Actions.lane_context[SharedValues::GDRIVE_UPLOADED_FILE_NAMES] = uploaded_files.map(&:title)
+        Actions.lane_context[SharedValues::GDRIVE_UPLOADED_FILE_URLS] = uploaded_files.map(&:human_url)
+      end
+
+      def self.description
+        'Upload files to Google Drive'
+      end
+
+      def self.details
+        [
+          'Upload files to Google Drive',
+          'See https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md to get a keyfile'
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :drive_keyfile,
+                                      env_name: 'GDRIVE_KEY_FILE',
+                                      description: 'Json config file',
+                                      type: String,
+                                      default_value: 'drive_key.json',
+                                      verify_block: proc do |value|
+                                        UI.user_error!("Couldn't find config keyfile at path '#{value}'") unless File.exist?(value)
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :service_account,
+                                      env_name: 'GDRIVE_SERVICE_ACCOUNT',
+                                      description: 'Credential is service account',
+                                      optional: true,
+                                      is_string: false,
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :folder_id,
+                                      env_name: "GDRIVE_UPLOAD_FOLDER_ID",
+                                      description: "Upload target folder id",
+                                      optional: false,
+                                      type: String,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("No target folder id given, pass using `folder_id: 'some_id'`") unless value and !value.empty?
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :upload_files,
+                                      env_name: "GDRIVE_UPLOAD_FILES",
+                                      description: "Path to files to be uploaded",
+                                      optional: false,
+                                      is_string: false,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("upload_files must be an Array of paths to files") unless value.kind_of?(Array)
+                                        UI.user_error!("No upload file is given, pass using `upload_files: ['a', 'b']`") unless value and !value.empty?
+                                        value.each do |path|
+                                          UI.user_error!("Couldn't find upload file at path '#{path}'") unless File.exist?(path)
+                                        end
+                                      end)
+        ]
+      end
+
+      def self.output
+        [
+          ['GDRIVE_UPLOADED_FILE_NAMES', 'The array of names of uploaded files'],
+          ['GDRIVE_UPLOADED_FILE_URLS', 'The array of links to uploaded files']
+        ]
+      end
+
+      def self.return_value
+        # nothing
+      end
+
+      def self.authors
+        ['Bumsoo Kim (@bskim45)']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_drive/helper/google_drive_helper.rb

@@ -1,6 +1,5 @@
 require 'fastlane_core/ui/ui'
 require 'google_drive'
-
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
 
@@ -36,6 +35,13 @@ module Fastlane
           UI.user_error!("Upload '#{file_name}' failed")
         end
       end
+
+      def self.create_subcollection(root_folder:, title:)
+        root_folder.create_subcollection(title)
+      rescue Exception => e
+        UI.error(e.message)
+        UI.user_error!("Create '#{title}' failed")
+      end
     end
   end
 end

data/lib/fastlane/plugin/google_drive/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module GoogleDrive
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bumsoo Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -159,7 +159,9 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/google_drive.rb
+- lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb
 - lib/fastlane/plugin/google_drive/actions/google_drive_upload_action.rb
+- lib/fastlane/plugin/google_drive/actions/upload_google_drive_action.rb
 - lib/fastlane/plugin/google_drive/helper/google_drive_helper.rb
 - lib/fastlane/plugin/google_drive/version.rb
 homepage: https://github.com/bskim45/fastlane-plugin-google_drive
@@ -182,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Upload files to Google Drive