fastlane-plugin-dropbox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ea3802e7d6f6303249be04205d0c152474e3bae
-  data.tar.gz: bd7e8e8c9c76db3d960dc32c4105019b2a97a434
+  metadata.gz: 9c56b82a82ac14332f51d316963e2d754f953d5f
+  data.tar.gz: 2e6873044edb0257de75a9f8c43ff6d9f01888ea
 SHA512:
-  metadata.gz: cb02b5404cbdb428649712c5a1fafc48ddfe79578b9870c1e97e9068d084d389e0e331d095e80cd7caf520c343b0014f8241bee8ab6d815672b9292cbb3b2c04
-  data.tar.gz: 3ed6e4330e586e25897d545a7d41ef4f341d8b76b93d23011696f92b6a7453c67025c40d72511e80b7be00c8d3cef8c512dfa818fc5897ca61d6cef8e19f3862
+  metadata.gz: 1ad412c087e911833ff72a285e3814b79802243ff06aa277d8866a3a44859408691d3f3723ea1719884488e9969cdb48424a862e2ecdd471fa5025137ce7276b
+  data.tar.gz: e370924eccc4c93bb911bcb33786a5088d379d38a83bdb474c361aa092eccb03063eb5ed49af6dc382647d4ee072d2b5abbc7d1f5d5df2bf82341550f587b5db

data/README.md

@@ -1,6 +1,6 @@
-# dropbox plugin
+# Fastlane Dropbox plugin
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-dropbox)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-dropbox) [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-dropbox.svg)](https://badge.fury.io/rb/fastlane-plugin-dropbox)
 
 ## Getting Started
 
@@ -29,6 +29,8 @@ In order to register a Dropbox app you need to go to [Dropbox Developers](https:
     dropbox(
         file_path: '/some/local-path/to/file.txt',
         dropbox_path: '/path/to/Dropbox/destination/folder',
+        write_mode: "update",
+        update_rev: "file-revision-to-update",
         app_key: 'your-dropbox-app-key',
         app_secret: 'your-dropbox-app-secret'
     )

data/lib/fastlane/plugin/dropbox/actions/dropbox_action.rb

@@ -13,6 +13,22 @@ module Fastlane
 
         params[:keychain] ||= default_keychain
 
+        write_mode =
+          if params[:write_mode].nil?
+            'add'
+          elsif params[:write_mode].eql? 'update'
+            if params[:update_rev].nil?
+              UI.user_error! 'You need to specify `update_rev` when using `update` write_mode.'
+            else
+              DropboxApi::Metadata::WriteMode.new({
+                  '.tag' => 'update',
+                  'update' => params[:update_rev]
+                })
+            end
+          else
+            params[:write_mode]
+          end
+
         access_token = get_token_from_keychain(params[:keychain], params[:keychain_password])
         unless access_token
           access_token = request_token(params[:app_key], params[:app_secret])
@@ -23,36 +39,52 @@ module Fastlane
 
         client = DropboxApi::Client.new(access_token)
 
-        output_file_name = nil
+        output_file = nil
 
         chunk_size = 157_286_400 # 150 megabytes
 
         if File.size(params[:file_path]) < chunk_size
-          file = client.upload destination_path(params), File.read(params[:file_path])
-          output_file_name = file.name
+          output_file = upload(client, params[:file_path], destination_path(params), write_mode)
         else
-          parts = chunker params[:file_path], './part', chunk_size
+          output_file = upload_chunked(client, chunk_size, params[:file_path], destination_path(params), write_mode)
+        end
 
-          UI.message ''
-          UI.important "The archive is a big file so we're uploading it in 150MB chunks"
-          UI.message ''
+        if output_file.name != File.basename(params[:file_path])
+          UI.user_error! 'Failed to upload file to Dropbox'
+        else
+          UI.success "File revision: '#{output_file.rev}'"
+          UI.success "Successfully uploaded file to Dropbox at '#{destination_path(params)}'"
+        end
+      end
+
+      def self.upload(client, file_path, destination_path, write_mode)
+        begin
+          client.upload destination_path, File.read(file_path), mode: write_mode
+        rescue DropboxApi::Errors::UploadWriteFailedError => e
+          UI.user_error! "Failed to upload file to Dropbox. Error message returned by Dropbox API: \"#{e.message}\""
+        end
+      end
+
+      def self.upload_chunked(client, chunk_size, file_path, destination_path, write_mode)
+        parts = chunker file_path, './part', chunk_size
+        UI.message ''
+        UI.important "The archive is a big file so we're uploading it in 150MB chunks"
+        UI.message ''
 
+        begin
           UI.message "Uploading part #1 (#{File.size(parts[0])} bytes)..."
           cursor = client.upload_session_start File.read(parts[0])
           parts[1..parts.size].each_with_index do |part, index|
             UI.message "Uploading part ##{index + 2} (#{File.size(part)} bytes)..."
             client.upload_session_append_v2 cursor, File.read(part)
           end
-          file = client.upload_session_finish cursor, DropboxApi::Metadata::CommitInfo.new('path' => destination_path(params),
-                                                                                           'mode' => :add)
-          output_file_name = file.name
-          parts.each { |part| File.delete(part) }
-        end
 
-        if output_file_name != File.basename(params[:file_path])
-          UI.user_error! 'Failed to upload archive to Dropbox'
-        else
-          UI.success "Successfully uploaded archive to Dropbox at '#{destination_path(params)}'"
+          client.upload_session_finish cursor, DropboxApi::Metadata::CommitInfo.new('path' => destination_path,
+                                                                                    'mode' => write_mode)
+        rescue DropboxApi::Errors::UploadWriteFailedError => e
+          UI.user_error! "Error uploading file to Dropbox: \"#{e.message}\""
+        ensure
+          parts.each { |part| File.delete(part) }
         end
       end
 
@@ -148,6 +180,22 @@ module Fastlane
                                        description: 'Path to the destination Dropbox folder',
                                        type: String,
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :write_mode,
+                                       env_name: 'DROPBOX_WRITE_MODE',
+                                       description: 'Determines uploaded file write mode. Supports `add`, `overwrite` and `update`',
+                                       type: String,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.command_output("write_mode '#{value}' not recognized. Defaulting to `add`.") unless value =~ /(add|overwrite|update)/
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :update_rev,
+                                       env_name: 'DROPBOX_UPDATE_REV',
+                                       description: 'Revision of the file uploaded in `update` write_mode',
+                                       type: String,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Revision no. must be at least 9 hexadecimal characters ([0-9a-f]).") unless value =~ /[0-9a-f]{9,}/
+                                       end),
           FastlaneCore::ConfigItem.new(key: :app_key,
                                        env_name: 'DROPBOX_APP_KEY',
                                        description: 'App Key of your Dropbox app',
@@ -195,6 +243,8 @@ module Fastlane
           'dropbox(
             file_path: "./path/to/file.txt",
             dropbox_path: "/My Dropbox Folder/Text files",
+            write_mode: "add/overwrite/update",
+            update_rev: "a1c10ce0dd78",
             app_key: "dropbox-app-key",
             app_secret: "dropbox-app-secret"
           )'

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Dropbox
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-dropbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Kapusta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox_api