fastlane-plugin-dropbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ea3802e7d6f6303249be04205d0c152474e3bae
+  data.tar.gz: bd7e8e8c9c76db3d960dc32c4105019b2a97a434
+SHA512:
+  metadata.gz: cb02b5404cbdb428649712c5a1fafc48ddfe79578b9870c1e97e9068d084d389e0e331d095e80cd7caf520c343b0014f8241bee8ab6d815672b9292cbb3b2c04
+  data.tar.gz: 3ed6e4330e586e25897d545a7d41ef4f341d8b76b93d23011696f92b6a7453c67025c40d72511e80b7be00c8d3cef8c512dfa818fc5897ca61d6cef8e19f3862

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dominik Kapusta <dominik@kapusta.cc>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# dropbox plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-dropbox)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-dropbox`, add it to your project by running:
+
+```bash
+fastlane add_plugin dropbox
+```
+
+## About
+
+This plugin allows for uploading files to Dropbox from Fastlane, using provided Dropbox client application.
+
+## Setting up
+
+**Note:** Dropbox allows accessing their API only for authorized applications, so in order to use this plugin you must register a Dropbox app.
+
+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.
+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.
+
+## Example
+
+    dropbox(
+        file_path: '/some/local-path/to/file.txt',
+        dropbox_path: '/path/to/Dropbox/destination/folder',
+        app_key: 'your-dropbox-app-key',
+        app_secret: 'your-dropbox-app-secret'
+    )
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## 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).

data/lib/fastlane/plugin/dropbox.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/dropbox/version'
+
+module Fastlane
+  module Dropbox
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Dropbox.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,209 @@
+require 'net/http'
+require 'dropbox_api'
+
+module Fastlane
+  module Actions
+    class DropboxAction < Action
+      KEYCHAIN_SERVICE_NAME = 'fastlane-plugin-dropbox'.freeze
+
+      def self.run(params)
+        UI.message ''
+        UI.message "Starting upload of #{params[:file_path]} to Dropbox"
+        UI.message ''
+
+        params[:keychain] ||= default_keychain
+
+        access_token = get_token_from_keychain(params[: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)
+            UI.user_error! 'Failed to store access token in the keychain'
+          end
+        end
+
+        client = DropboxApi::Client.new(access_token)
+
+        output_file_name = 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
+        else
+          parts = chunker params[: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 ''
+
+          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)}'"
+        end
+      end
+
+      def self.destination_path(params)
+        "#{params[:dropbox_path]}/#{File.basename(params[:file_path])}"
+      end
+
+      def self.default_keychain
+        `security default-keychain`.chomp.gsub(/.+"(.+)"/, '\\1')
+      end
+
+      def self.get_token_from_keychain(keychain, password)
+        other_action.unlock_keychain(
+          path: keychain,
+          password: password
+        )
+        token = `security find-generic-password -s #{KEYCHAIN_SERVICE_NAME} -w "#{keychain}" 2>/dev/null`.chomp
+        $CHILD_STATUS >> 8 == 0 ? token : nil
+      end
+
+      def self.save_token_to_keychain(keychain, access_token)
+        `security add-generic-password -a #{KEYCHAIN_SERVICE_NAME} -s #{KEYCHAIN_SERVICE_NAME} -w "#{access_token}" "#{keychain}"`
+        $CHILD_STATUS >> 8 == 0
+      end
+
+      def self.chunker(f_in, out_pref, chunksize)
+        parts = []
+        File.open(f_in, 'r') do |fh_in|
+          until fh_in.eof?
+            part = "#{out_pref}_#{format('%05d', (fh_in.pos / chunksize))}"
+            File.open(part, 'w') do |fh_out|
+              fh_out << fh_in.read(chunksize)
+            end
+            parts << part
+          end
+        end
+        parts
+      end
+
+      def self.request_token(app_key, app_secret)
+        sh("open 'https://www.dropbox.com/oauth2/authorize?response_type=code&require_role=work&client_id=#{app_key}'")
+        UI.message 'Please autorize fastlane Dropbox plugin to access your Dropbox account via your Dropbox app'
+        authorization_code = UI.input('Once authorized, please paste the authorization code here: ')
+
+        uri = URI('https://api.dropboxapi.com/oauth2/token')
+        req = Net::HTTP::Post.new(uri)
+        req.basic_auth app_key, app_secret
+        req.set_form_data(
+          'grant_type' => 'authorization_code',
+          'code' => authorization_code
+        )
+
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+
+        case res
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          json = JSON.parse(res.body)
+          access_token = json['access_token']
+          UI.success('Successfully authorized fastlane plugin to access Dropbox')
+          access_token
+        else
+          UI.user_error!("Error during authorization with Dropbox: #{res.code} - #{res.body}")
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Uploads files to Dropbox'
+      end
+
+      def self.details
+        'You have to authorize the action before using it. The access token is stored in your default keychain'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       env_name: 'DROPBOX_FILE_PATH',
+                                       description: 'Path to the uploaded file',
+                                       type: String,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No file path specified for upload to Dropbox, pass using `file_path: 'path_to_file'`") unless value && !value.empty?
+                                         UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dropbox_path,
+                                       env_name: 'DROPBOX_PATH',
+                                       description: 'Path to the destination Dropbox folder',
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :app_key,
+                                       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),
+          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),
+          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',
+                                       type: String,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find keychain at path '#{value}'") unless File.exist?(value)
+                                       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',
+                                       type: String,
+                                       optional: true)
+        ]
+      end
+
+      def self.output; end
+
+      def self.return_value
+        'nil or error message'
+      end
+
+      def self.authors
+        ['Dominik Kapusta']
+      end
+
+      def self.example_code
+        [
+          'dropbox(
+            file_path: "./path/to/file.txt",
+            dropbox_path: "/My Dropbox Folder/Text files",
+            app_key: "dropbox-app-key",
+            app_secret: "dropbox-app-secret"
+          )'
+        ]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/dropbox/helper/dropbox_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class DropboxHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DropboxHelper.your_method`
+      #
+      def self.show_message
+        UI.message('Hello from the dropbox plugin helper!')
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-dropbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominik Kapusta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dropbox_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.68.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.68.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dominik@kapusta.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/dropbox.rb
+- lib/fastlane/plugin/dropbox/actions/dropbox_action.rb
+- lib/fastlane/plugin/dropbox/helper/dropbox_helper.rb
+- lib/fastlane/plugin/dropbox/version.rb
+homepage: https://github.com/ayoy/fastlane-plugin-dropbox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Uploads files to Dropbox
+test_files: []