fastlane-plugin-rocket_chat 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ef717c02e6634f56cf7d28609e9157b9000e79f
+  data.tar.gz: e1a935a869bd90115da2cc5d0d431b7241791d18
+SHA512:
+  metadata.gz: 4c5a1305f71883b5cb25d2230358510287833096c483219c2a7eccea04bcab7666d1761e6bd4601e674b1402efb4cbd7cd44cb6a33601c762c8665da2e251833
+  data.tar.gz: d314f3500cda97c38846edc60e27071e30c1ab5d1a68dca7ebeb5fbc4ac693b7bc9b51b789e28a478ad265a0844a8be4bd6d8895ed0a6d1ef8e045bf3ece43a3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pavel Procházka <pprochazka72@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,72 @@
+# rocket_chat plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-rocket_chat)
+[![Build Status](https://travis-ci.org/thiagofelix/fastlane-plugin-rocket_chat.svg?branch=master)](https://travis-ci.org/thiagofelix/fastlane-plugin-rocket_chat)
+[![Code Climate](https://codeclimate.com/github/thiagofelix/fastlane-plugin-rocket_chat/badges/gpa.svg)](https://codeclimate.com/github/thiagofelix/fastlane-plugin-rocket_chat)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-rocket_chat`, add it to your project by running:
+
+```bash
+fastlane add_plugin rocket_chat
+```
+
+### About [RocketChat](http://rocket.chat)
+Create an Incoming WebHook and export this as `ROCKET_CHAT_URL`. Can send a message to **#channel** (by default), a direct message to **@username** or a message to a private group **group** with success (green) or failure (red) status.
+
+## Example
+```ruby
+rocket_chat(
+  message: "App successfully released!"
+)
+
+rocket_chat(
+  message: "App successfully released!",
+  channel: "#channel",  # Optional, by default will post to the default channel configured for the POST URL.
+  success: true,        # Optional, defaults to true.
+  payload: {            # Optional, lets you specify any number of your own Rocket.Chat attachments.
+    'Build Date' => Time.new.to_s,
+    'Built by' => 'Jenkins',
+  },
+  default_payloads: [:git_branch, :git_author], # Optional, lets you specify a whitelist of default payloads to include. Pass an empty array to suppress all the default payloads. Don't add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit_message`.
+  attachment_properties: { # Optional, lets you specify any other properties available for attachments. This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
+    thumb_url: 'http://example.com/path/to/thumb.png',
+    fields: [{
+      title: 'My Field',
+      value: 'My Value'
+    }]
+  }
+)
+```
+
+## 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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+Contributing
+------------
+
+If there is any thing you'd like to contribute or fix, please:
+
+- Fork the repo
+- Add tests for any new functionality
+- Make your changes
+- Verify all new & existing tests pass
+- Make a pull request
+
+License
+-------
+The rocket-chat-notifier gem is distributed under the MIT License.

data/lib/fastlane/plugin/rocket_chat.rb

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

data/lib/fastlane/plugin/rocket_chat/actions/rocket_chat.rb

@@ -0,0 +1,200 @@
+# rubocop:disable Style/CaseEquality
+# rubocop:disable Style/MultilineTernaryOperator
+# rubocop:disable Style/NestedTernaryOperator
+module Fastlane
+  module Actions
+    class RocketChatAction < Action
+      def self.is_supported?(platform)
+        true
+      end
+
+      # As there is a text limit in the notifications, we are
+      # usually interested in the last part of the message
+      # e.g. for tests
+      def self.trim_message(message)
+        # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
+        start_index = [message.length - 7000, 0].max
+        message = message[start_index..-1]
+        message
+      end
+
+      def self.run(options)
+        require 'rocket-chat-notifier'
+
+        options[:message] = self.trim_message(options[:message].to_s || '')
+
+        notifier = ::RocketChat::Notifier.new(options[:rocket_chat_url])
+
+        notifier.username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
+        icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+
+        if options[:channel].to_s.length > 0
+          notifier.channel = options[:channel]
+          notifier.channel = ('#' + notifier.channel) unless ['#', '@'].include?(notifier.channel[0]) # send message to channel by default
+        end
+
+        attachment = generate_attachments(options)
+
+        return [notifier, attachment] if Helper.is_test? # tests will verify the rocket chat attachments and other properties
+
+        result = notifier.ping '',
+                               icon_url: icon_url,
+                               attachments: [attachment]
+
+        if result.code.to_i == 200
+          UI.success('Successfully sent RocketChat notification')
+        else
+          UI.verbose(result)
+          UI.user_error!("Error pushing RocketChat message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile.")
+        end
+      end
+
+      def self.description
+        "Send a success/error message to your RocketChat group"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_ROCKET_CHAT_MESSAGE",
+                                       description: "The message that should be displayed on Rocket.Chat. This supports the standard Rocket.Chat markup language",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       env_name: "FL_ROCKET_CHAT_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :use_webhook_configured_username_and_icon,
+                                       env_name: "FL_ROCKET_CHAT_USE_WEBHOOK_CONFIGURED_USERNAME_AND_ICON",
+                                       description: "Use webook's default username and icon settings? (true/false)",
+                                       default_value: false,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :rocket_chat_url,
+                                       env_name: "ROCKET_CHAT_URL",
+                                       description: "Create an Incoming WebHook for your Rocket.Chat group"),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_ROCKET_CHAT_USERNAME",
+                                       description: "Overrides the webook's username property if use_webhook_configured_username_and_icon is false",
+                                       default_value: "fastlane",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :icon_url,
+                                       env_name: "FL_ROCKET_CHAT_ICON_URL",
+                                       description: "Overrides the webook's image property if use_webhook_configured_username_and_icon is false",
+                                       default_value: "https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :payload,
+                                       env_name: "FL_ROCKET_CHAT_PAYLOAD",
+                                       description: "Add additional information to this post. payload must be a hash containg any key with any value",
+                                       default_value: {},
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :default_payloads,
+                                       env_name: "FL_ROCKET_CHAT_DEFAULT_PAYLOADS",
+                                       description: "Remove some of the default payloads. More information about the available payloads on GitHub",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :attachment_properties,
+                                       env_name: "FL_ROCKET_CHAT_ATTACHMENT_PROPERTIES",
+                                       description: "Merge additional properties in the Rocket.Chat attachment",
+                                       default_value: {},
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :success,
+                                       env_name: "FL_ROCKET_CHAT_SUCCESS",
+                                       description: "Was this build successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false)
+        ]
+      end
+
+      def self.author
+        "thiagofelix"
+      end
+
+      #####################################################
+      # @!group Helper
+      #####################################################
+
+      def self.generate_attachments(options)
+        color = (options[:success] ? 'good' : 'danger')
+        should_add_payload = ->(payload_name) { options[:default_payloads].nil? || options[:default_payloads].include?(payload_name) }
+
+        attachment = {
+          fallback: options[:message],
+          text: options[:message],
+          color: color,
+          mrkdwn_in: ["pretext", "text", "fields", "message"],
+          fields: []
+        }
+
+        # custom user payloads
+        attachment[:fields] += options[:payload].map do |k, v|
+          {
+            title: k.to_s,
+            value: v.to_s
+          }
+        end
+
+        # Add the lane to the Rocket.Chat message
+        # This might be nil, if Rocket.Chat is called as "one-off" action
+        if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
+          attachment[:fields] << {
+            title: 'Lane',
+            value: Actions.lane_context[Actions::SharedValues::LANE_NAME]
+          }
+        end
+
+        # test_result
+        if should_add_payload[:test_result]
+          attachment[:fields] << {
+            title: 'Result',
+            value: (options[:success] ? 'Success' : 'Error')
+          }
+        end
+
+        # git branch
+        if Actions.git_branch && should_add_payload[:git_branch]
+          attachment[:fields] << {
+            title: 'Git Branch',
+            value: Actions.git_branch
+          }
+        end
+
+        # git_author
+        if Actions.git_author_email && should_add_payload[:git_author]
+          unless ENV['FASTLANE_ROCKET_CHAT_HIDE_AUTHOR_ON_SUCCESS'] && options[:success]
+            attachment[:fields] << {
+              title: 'Git Author',
+              value: Actions.git_author_email
+            }
+          end
+        end
+
+        # last_git_commit
+        if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
+          attachment[:fields] << {
+            title: 'Git Commit',
+            value: Actions.last_git_commit_message
+          }
+        end
+
+        # merge additional properties
+        deep_merge(attachment, options[:attachment_properties])
+      end
+
+      # Adapted from http://stackoverflow.com/a/30225093/158525
+      def self.deep_merge(a, b)
+        merger = proc do |key, v1, v2|
+          Hash === v1 && Hash === v2 ?
+                 v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
+                   v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
+        end
+        a.merge(b, &merger)
+      end
+    end
+  end
+end
+# rubocop:enable Style/CaseEquality
+# rubocop:enable Style/MultilineTernaryOperator
+# rubocop:enable Style/NestedTernaryOperator

data/lib/fastlane/plugin/rocket_chat/helper/rocket_chat_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RocketChat
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-rocket_chat
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Thiago Felix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rocket-chat-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.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: 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: 1.96.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.96.0
+description: 
+email: thiago@thiagofelix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/rocket_chat.rb
+- lib/fastlane/plugin/rocket_chat/actions/rocket_chat.rb
+- lib/fastlane/plugin/rocket_chat/helper/rocket_chat_helper.rb
+- lib/fastlane/plugin/rocket_chat/version.rb
+homepage: https://github.com/thiagofelix/fastlane-plugin-rocket_chat
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Send message to Rocket.Chat right from fastlane
+test_files: []
+has_rdoc: