fastlane-plugin-report 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6a4b9ac144d068e16ff3cf3bd27b5d810464026
+  data.tar.gz: 80f74a8e65e66ac2e3f03df6abcec84625dea0d1
+SHA512:
+  metadata.gz: a799aa213fd5d51a086ca78c2888f09cbfea9a8593852546999e43a1ad804beacdaa78e971a87ec0bd047d6642e64089e8744e7f303f3eeef5086774df443f06
+  data.tar.gz: b37439f6091f8d26f3e231a1a78f1bdf862211cfd72c7fea62532b66016c53f57d1688729a77231176d9e7c4918ccf2c7822101db26cad687a119772a73ca5b0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bruno Miguêns <bruno.miguens@olx.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,52 @@
+# report plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-report)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-report`, add it to your project by running:
+
+```bash
+fastlane add_plugin report
+```
+
+## About report
+
+This action is responsible to send a report file of what you want to slack (ex. send a scan report to slack).
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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
+
+```
+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/report.rb

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

data/lib/fastlane/plugin/report/actions/report_action.rb

@@ -0,0 +1,126 @@
+module Fastlane
+  module Actions
+    class ReportAction < Action
+      def self.run(options)
+        require 'slack-ruby-client'
+
+        token = options[:slack_api_token]
+        if token.nil?
+          UI.user_error!("Is mandatory to provide a 'Slack API Token'.")
+        else
+
+          Slack.configure do |config|
+            config.token = token
+          end
+
+          channel = options[:channel] ||= '#channel'
+          title = options[:title] ||= 'Report!'
+          message = options[:message] ||= 'This is your report.'
+          as_user = options[:as_user] ||= false
+
+          path = options[:path]
+          path_type = options[:path_type]
+          file_name = options[:file_name]
+
+          client = Slack::Web::Client.new
+          client.files_upload(
+            channels: channel,
+            as_user: as_user,
+            file: Faraday::UploadIO.new(path, path_type),
+            title: title,
+            filename: file_name,
+            initial_comment: message
+          )
+
+          UI.success("Report successfully uploaded and sent to Slack channel '" + channel + "'.")
+          UI.success("Title: " + title + " and messsage: " + options[:message])
+
+        end
+
+      end
+
+      def self.description
+        "This plugin is responsible to send a report file of what you want to slack."
+      end
+
+      def self.authors
+        ["Bruno Miguêns"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :slack_api_token,
+                                  env_name: "REPORT_SLACK_API_TOKEN",
+                               description: "Token of slack rest api. Need to be generated at 'https://api.slack.com'",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                         UI.user_error!("You need to provide a 'slack_api_token' parameter") if value.to_s.length == 0
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :path,
+                                  env_name: "REPORT_PATH",
+                               description: "Relative path to report file (ex. .../report/20170603140211.html)",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                         UI.user_error!("You need to provide a 'path' parameter") if value.to_s.length == 0
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :path_type,
+                                  env_name: "REPORT_PATH_TYPE",
+                               description: "Multipart type of your report file (ex. text/html)",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                         UI.user_error!("You need to provide a 'path_type' parameter") if value.to_s.length == 0
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :file_name,
+                                  env_name: "REPORT_FILE_NAME",
+                               description: "Name of your file (ex. 20170603140211.html)",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                         UI.user_error!("You need to provide a 'file_name' parameter") if value.to_s.length == 0
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :channels,
+                                  env_name: "REPORT_CHANNELS",
+                               description: "Selected channels to upload and post your report (default: '#channel')",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :as_user,
+                                  env_name: "REPORT_AS_USER",
+                               description: "Report will be post as 'Slack API' if false or the user that created the token (default: 'false')",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :title,
+                                  env_name: "REPORT_TITLE",
+                               description: "Title that will be shown on Slack (default: 'Report!')",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :message,
+                                  env_name: "REPORT_MESSAGE",
+                               description: "Message that will be shown on Slack (default: 'This is your report.')",
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+
+      def self.is_supported?(platform)
+      end
+
+      def self.example_code
+        ['']
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/report/helper/report_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Report
+    VERSION = "0.1.3"
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-report
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Bruno Miguêns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+  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.19.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.19.2
+- !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'
+description: 
+email: brunomiguens@outlook.pt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/report.rb
+- lib/fastlane/plugin/report/actions/report_action.rb
+- lib/fastlane/plugin/report/helper/report_helper.rb
+- lib/fastlane/plugin/report/version.rb
+homepage: 
+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.6.8
+signing_key: 
+specification_version: 4
+summary: This action is responsible to send a report file of what you want to slack
+  (ex. send a scan report to slack).
+test_files: []