fastlane-plugin-dropbox 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb75b24901139d6abc08c1ff3d6ea563f17084ce23bd308dbe96f24c856c1c5
-  data.tar.gz: 86d25e5494a6043a63bb322aec67f930da9737145f057a6a2a16f54ebf0c9c41
+  metadata.gz: e65e3a99db618fd4d50bf04788b28295ce94a5a02a2cb6e86dc590bf5c749cc4
+  data.tar.gz: e1c5c12d9ae53366fcfd9743a910ab153bce84afe3decdaef966eea9718e9675
 SHA512:
-  metadata.gz: 7ce42363dac0fb171e17286a15bee1fa3b57102c6303224461c1577c3426a2a37aa0a55344f327e5ddc39e762463773499be3322f9b8f5dd35d1b345a00a06ad
-  data.tar.gz: c49d606532c5a64a6e27a3183fdb82f85a10ccb81bb517ac7a9ceefae6b0344333b989b68d5dca5283417090c5791c96aa6c8bbd52fea309ca0184c73371b53d
+  metadata.gz: df8ded885066405e344f956b9ee83af2067ecef9aae4ffe21729c0b7b1e52525cda4dab2f6493bc3a3aafda71e6226127fa77dd6b2abad42b27c70e730175d63
+  data.tar.gz: 93f173625125689f8d35fa119db0a110aaa7b5a5f64cba7ffcabdde344eb6231d8d66721969db757845c8581149a3ab2ff5735c6c3755dfe7832a6d9aff65a39

data/README.md

@@ -25,7 +25,9 @@ This plugin relies on MacOS keychain (for storing your Dropbox access token), he
 
 In order to register a Dropbox app you need to go to [Dropbox Developers](https://www.dropbox.com/developers/apps) site and create your own app. 
 
-1. For Fastlane you only need the app key and app secret. You'll also have to come up with some name for the app, but this is not used by Fastlane in any way.
+### Using access token
+
+1. For Fastlane you only need the access token (or the app key and app secret). You'll also have to come up with some name for the app, but this is not used by Fastlane in any way.
 1. You also don't need to apply for production state of your app, and keep it in development phase unless you make heavy use of it. Even Dropbox themselves encourage staying in development state when the app is used as an internal tool. Read more [here](https://www.dropbox.com/developers/reference/developer-guide#production-approval).
 1. You start with access for one user only, but in development state you can request access for up to 500 users, which should cover most of the use cases for Fastlane integration.
 
@@ -33,6 +35,16 @@ In order to register a Dropbox app you need to go to [Dropbox Developers](https:
 
 ### Basic usage
 
+Using access token:
+
+    dropbox(
+        file_path: '/some/local-path/to/file.txt',
+        dropbox_path: '/path/to/Dropbox/destination/folder',
+        access_token: 'your-dropbox-access-token'
+    )
+
+Using app key and app secret:
+
     dropbox(
         file_path: '/some/local-path/to/file.txt',
         dropbox_path: '/path/to/Dropbox/destination/folder',
@@ -50,8 +62,7 @@ The default `write_mode` is `add`, which means that plugin will raise an error i
         file_path: '/some/local-path/to/file.txt',
         dropbox_path: '/path/to/Dropbox/destination/folder',
         write_mode: 'overwrite',
-        app_key: 'your-dropbox-app-key',
-        app_secret: 'your-dropbox-app-secret'
+        access_token: 'your-dropbox-access-token'
     )
 
 For the more fine-grained overwriting you can set the `update` write mode, and pass the current file revision to update:
@@ -61,8 +72,7 @@ For the more fine-grained overwriting you can set the `update` write mode, and p
         dropbox_path: '/path/to/Dropbox/destination/folder',
         write_mode: 'update',
         update_rev: 'filerevisiontoupdate',
-        app_key: 'your-dropbox-app-key',
-        app_secret: 'your-dropbox-app-secret'
+        access_token: 'your-dropbox-access-token'
     )
 
 The `update_rev` parameter is required for `update` write mode and ignored in other cases. Currently, if the current file revision on Dropbox doesn't match the provided revision, the plugin will fail (Dropbox API won't allow for the update).

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

@@ -7,12 +7,12 @@ module Fastlane
       KEYCHAIN_SERVICE_NAME = 'fastlane-plugin-dropbox'.freeze
 
       def self.run(params)
+        validate_params(params)
+
         UI.message ''
         UI.message "Starting upload of #{params[:file_path]} to Dropbox"
         UI.message ''
 
-        params[:keychain] ||= default_keychain
-
         write_mode =
           if params[:write_mode].nil?
             'add'
@@ -29,7 +29,7 @@ module Fastlane
             params[:write_mode]
           end
 
-        access_token = get_token_from_keychain(params[:keychain], params[:keychain_password])
+        access_token = params[:access_token] || get_token_from_keychain(params[:keychain] ||= default_keychain, params[:keychain_password])
         unless access_token
           access_token = request_token(params[:app_key], params[:app_secret])
           unless save_token_to_keychain(params[:keychain], access_token)
@@ -152,6 +152,13 @@ module Fastlane
         end
       end
 
+      def self.validate_params(params)
+        return if params[:access_token] && !params[:access_token].empty?
+
+        UI.user_error!("App Key not specified for Dropbox app. Provide your app's App Key or create a new app at https://www.dropbox.com/developers if you don't have an app yet.") unless params[:app_key] && !params[:app_key].empty?
+        UI.user_error!("App Secret not specified for Dropbox app. Provide your app's App Secret or create a new app at https://www.dropbox.com/developers if you don't have an app yet.") unless params[:app_secret] && !params[:app_secret].empty?
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################
@@ -161,7 +168,7 @@ module Fastlane
       end
 
       def self.details
-        'You have to authorize the action before using it. The access token is stored in your default keychain'
+        'You have to authorize the action before using it. The access token is stored in your default keychain or passed in'
       end
 
       def self.available_options
@@ -200,18 +207,12 @@ module Fastlane
                                        env_name: 'DROPBOX_APP_KEY',
                                        description: 'App Key of your Dropbox app',
                                        type: String,
-                                       optional: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("App Key not specified for Dropbox app. Provide your app's App Key or create a new app at https://www.dropbox.com/developers if you don't have an app yet.") unless value && !value.empty?
-                                       end),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :app_secret,
                                        env_name: 'DROPBOX_APP_SECRET',
                                        description: 'App Secret of your Dropbox app',
                                        type: String,
-                                       optional: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("App Secret not specified for Dropbox app. Provide your app's App Secret or create a new app at https://www.dropbox.com/developers if you don't have an app yet.") unless value && !value.empty?
-                                       end),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :keychain,
                                        env_name: 'DROPBOX_KEYCHAIN',
                                        description: 'Path to keychain where the access token would be stored. Will use default keychain if no value is provided',
@@ -222,7 +223,12 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :keychain_password,
                                        env_name: 'DROPBOX_KEYCHAIN_PASSWORD',
-                                       description: 'Password to unlock keychain. If not provided, the plugin would ask for password',
+                                       description: 'Password to unlock keychain. If not provided, the plugin will ask for password',
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :access_token,
+                                       env_name: 'DROPBOX_ACCESS_TOKEN',
+                                       description: 'Access Token to authenticate with the Dropbox API',
                                        type: String,
                                        optional: true)
         ]

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Dropbox
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-dropbox
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Dominik Kapusta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox_api