fastlane-plugin-slack_upload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98fa51f89907a53168f8c2a7f70b2fd96b3bce79a0db66953b9efbe5a14f7f0e
+  data.tar.gz: 7359277a1387186d6622483e075c96430e775c2b4c2b35acdec27385dcb4b98b
+SHA512:
+  metadata.gz: fec1ed1fc1db2e60ea8d85d779d8c15ef8fb364e25744cc3253e0e7d05cd48bb415906e6d26a9935a47146cef54bedcd2063848fbb5565a1b6da95949854bd55
+  data.tar.gz: 07ca1f726f73128c03f472d45cc91cd6a0005dc296415ea61688ae56681304d6c5cca3699073809f2a26f914215b6eb957bc0f555be3ed806da2dc37ef180ee2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dawid Cieslak <cieslakdawid@gmail.com>
+
+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,84 @@
+# slack_upload plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-slack_upload)
+
+
+This plugin simply uploads a given file to your Slack. 
+
+Sometimes as part of CI builds you want to generate some files from the project that might be valuable for your team. You can think about documentation or screenshots of the application on different devices. With `slack_uplaod` it's easy to send them to dedicated `Slack` channel or directly to your teammates. 
+
+Note: `Fastlane` comes with `slack` plugin by default, although it uses `slack-notifier` API that doesn't support uploading files.
+
+## Getting Started
+
+1. Generate `Slack token` for `Fastlane` bot
+    - From your Slack organization page, go to `Manage` -> `Custom Integrations`
+    - Open `Bots`
+    - Add Configuration
+    - Choose a name for your bot, e.g. `"fastlane"`
+    - Save `API Token`
+
+2. Add plugin to `fastlane`
+
+```bash
+fastlane add_plugin slack_upload
+```
+
+3. Add `slack_upload` to your lane in `Fastfile` whenever you want to upload the file
+
+In the following example we generate screenshots ([More info](https://docs.fastlane.tools/getting-started/ios/screenshots/)) and send them to `#general` channel
+
+```bash
+lane :screenshots_lane do
+
+    version = get_version_number
+
+    # Generate screenshots
+    capture_screenshots
+
+    # Zip screenshots folder
+    zip(
+      path: "./fastlane/screenshots",
+      output_path: "./fastlane/screenshots.zip"
+    )
+
+    # Upload to slack
+    slack_upload(
+            slack_api_token: "xyz", # Preferably configure as ENV['SLACK_API_TOKEN']
+            title: "New version #{version} is available ",
+            channel: "#general",
+            file_path: "./fastlane/screenshots.zip",
+            initial_comment: "Changelog goes here"
+    ) 
+  end
+```
+
+
+## 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/slack_upload.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/slack_upload/version'
+
+module Fastlane
+  module SlackUpload
+    # 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::SlackUpload.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/slack_upload/actions/slack_upload_action.rb

@@ -0,0 +1,111 @@
+
+module Fastlane
+  module Actions
+    class SlackUploadAction < Action
+      def self.run(params)
+        require 'slack-ruby-client'
+        
+        title = params[:title]
+        filepath = params[:file_path]
+        filename = params[:file_name]
+        initialComment = params[:initial_comment]
+
+        if params[:channel].to_s.length > 0 # From `slack` plugin implementation: https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/slack.rb
+          channel = params[:channel]
+          channel = ('#' + params[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+        end
+
+        if params[:file_type].to_s.empty?
+          filetype = File.extname(filepath)[1..-1] # Remove '.' from the file extension
+        else
+          filetype = params[:file_type]
+        end
+
+        Slack.configure do |config|
+          config.token = params[:slack_api_token]
+        end
+
+        client = Slack::Web::Client.new
+        
+        begin
+          results = client.files_upload(
+                    channels: channel,
+                    as_user: true,
+                    file: Faraday::UploadIO.new(filepath, filetype),
+                    title: title,
+                    filename: filename,
+                    initial_comment: initialComment
+                  )
+        rescue => exception
+          UI.error("Exception: #{exception}")
+        ensure
+          UI.success('Successfully sent file to Slack')
+        end
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :slack_api_token,
+                                       env_name: "SLACK_API_TOKEN",
+                                       sensitive: true,
+                                       description: "Slack API token"),
+          FastlaneCore::ConfigItem.new(key: :title,
+                                       env_name: "SLACK_UPLOAD_TITLE",
+                                       description: "Title of the file",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       env_name: "SLACK_UPLOAD_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       env_name: "SLACK_UPLOAD_FILE_PATH",
+                                       description: "Path to the file",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :file_type,
+                                       env_name: "SLACK_UPLOAD_FILE_TYPE",
+                                       description: "A file type identifier",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :file_name,
+                                       env_name: "SLACK_UPLOAD_FILE_NAME",
+                                       description: "Filename of file",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :initial_comment,
+                                       env_name: "SLACK_UPLOAD_INITIAL_COMMENT",
+                                       description: "Initial comment to add to file",
+                                       optional: true)                  
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.description
+        'Uploads given file to Slack'
+      end
+
+      def self.authors
+        ['Dawid Cieslak']
+      end
+
+      def self.example_code
+        [
+          'slack_upload(
+            title: "New version #{version} is available ",
+            channel: "#general",
+            file_path: "./screenshots.zip"
+          )',
+          'slack_upload(
+            slack_api_token: "xyz", 
+            title: "New version #{version} is available ",
+            channel: "#general",
+            file_path: "./screenshots.zip",
+            file_type: "zip",                        # Optional, type can be recognized from file path,
+            file_name: "screen_shots.zip",           # Optional, name can be recognized from file path,
+            initial_comment: "Enjoy!"                # Optional
+            )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/slack_upload/helper/slack_upload_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SlackUploadHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SlackUploadHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the slack_upload plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SlackUpload
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-slack_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dawid Cieslak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  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: 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: 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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.55'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.97.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.97.0
+description: 
+email: cieslakdawid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/slack_upload.rb
+- lib/fastlane/plugin/slack_upload/actions/slack_upload_action.rb
+- lib/fastlane/plugin/slack_upload/helper/slack_upload_helper.rb
+- lib/fastlane/plugin/slack_upload/version.rb
+homepage: https://github.com/cieslakdawid/fastlane-plugin-slack_upload
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Uploads specified file to Slack
+test_files: []