fastlane-plugin-rooster 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0884cfc7aded76d4b2f582b9a34f3f73d991b5f6499589c5bbfcb91e839ecd71'
-  data.tar.gz: 766976696518e674f2a3e2c4e29249c8184bde75b39a2f3dfc569d51b81f3f51
+  metadata.gz: f2bf10f44077348260a73b870ddde68cbfe4496656470f7d49a1b96d49a6676d
+  data.tar.gz: 055ad6a5a639979abc2d9ad512f0d99c32107e25be2ae156f410efafe571ba1d
 SHA512:
-  metadata.gz: 907d02d8ccb22b27fa10f0a95b321e711b5703035ce4a1da3337c8c7fcfd6e1fff5307f900118dcd40b8f1787d49705dbcbf756f357545f40b59cb54c982a89c
-  data.tar.gz: a2cf1b2186e50b8a3db7736f9a354d9b113062fb531659528b5c4d12761bdd0310d9780fa295bc65fd08ff889e478b910f57796b9410aa2e98067fc557a333ff
+  metadata.gz: 3522e7fae717a366ac58ec7e167987ea1f6c1a674768c8a6a38e686a9e250854bc6f32cbbedaef1feed8f040c41736380f2cc50449a81240cec6135fa42203ef
+  data.tar.gz: e859bcf76d0b80839c6ad84877f9c28f092ee1f3165fab9a1cb2b684d5ef8c4e25686f3f236038198701230e939067db00392a4db08513b44eb8fc8c7e83c8b0

data/README.md

@@ -1,6 +1,8 @@
 # rooster plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-rooster)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/tbetmen/fastlane-plugin-rooster/blob/main/LICENSE)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-rooster.svg)](https://rubygems.org/gems/fastlane-plugin-rooster)
 
 ## Getting Started
 
@@ -10,17 +12,81 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin rooster
 ```
 
-## About rooster
+## About Rooster
 
-Send gitlab merge requests reminder 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.
+Rooster is fastlane action to send Gitlab merge request to Slack using webhook, for now only has one action `rooster_merge_request`.
 
 ## 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`.
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use `rooster_merge_request` action. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test_env`.
+
+There are also some example files that used in `rooster_merge_request` action:
+1. Sample uses `.env` in [example `.env.example`](example/.env.example) for setting all action parameters or just private variable like Gitlab Api Token. 
+2. [example `slack_message_format.json`](example/slack_message_format.json) used for slack message format to replace default value given in action.
+3. [example `slack_users.csv`](example/slack_users.csv) slack users and gitlab users mapping format.
+
+Slack message preview has opened merge request
+
+![has merge request](./screenshots/sample%20merge%20request.png)
+
+Slack message preview merge request empty
+
+![has merge request](./screenshots/sample%20merge%20request%20empty.png)
+
+## Parameters
+
+The action parameters `gitlab_token` and others can also be omitted when their values are [set as environment variables](https://docs.fastlane.tools/advanced/#environment-variables).
 
-**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)
+Here is the list of all existing parameters for `rooster_merge_request` action:
+
+| Key | Env Var               | Default                                                                       | Optional | Description                                                                                               |
+|-----|-----------------------|-------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------|
+| `gitlab_token` | `ROOSTER_GITLAB_ACCESS_TOKEN` | -                                                                             | false    | API Token for Gitlab [find out here](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) |
+| `gitlab_project_id` | `ROOSTER_GITLAB_PROJECT_ID` | -                                                                             | false    | Gitlab project id, you can find in Project Overview menu located below project name.                                                                                                                                                                  |
+| `slack_webhook_url` | `ROOSTER_SLACK_WEBHOOK_URL` | -                                                                             | false    | Slack webhook url, check this link for more detail [Slack Webhooks](https://api.slack.com/messaging/webhooks)                                                                                                                                         |
+| `gitlab_milestones_path` | `ROOSTER_GITLAB_MILESTONES_PATH` | -                                                                             | true     | Gitlab group or project milestones with given format either `groups/:group_id` or `projects/:project_id`. You can find `group id` similar with project id in Group Overview. [Gitlab Milestones](https://docs.gitlab.com/ee/user/project/milestones/) |
+| `gitlab_merge_request_total` | `ROOSTER_GITLAB_MERGE_REQUEST_TOTAL` | 10                                                                            | true     | Maximum merge request when fetching data from gitlab, uses in query param `per_page`                      |
+| `slack_users_file` | `ROOSTER_SLACK_USERS_FILE` | -                                                                             | true     | Comma separate file that contains mapping user of gitlab and slack using id                               |
+| `slack_message_format_file` | `ROOSTER_SLACK_MESSAGE_FORMAT_FILE` | Check in this [file](lib/fastlane/plugin/rooster/helper/slack_file_client.rb) | true     | Slack message format in json format contains `text`, `header`, `mr_item`, `footer`, and `empty_mr_text`.  |
+
+## Replace word in `slack_message_format`
+
+In slack message format json has word replacement, check this table to see all possibility:
+
+| Key | Availability | Description                                     |
+|-----|--------------|-------------------------------------------------|
+| `MR_TOTAL`  | header       | Total merge request to be shown in slack        |
+| `MR_MILESTONE`  | header, empty_mr_text     | Current active milestone                        |
+| `MR_TITLE`  | mr_item             | Title of merge request                          |
+| `MR_TIME`  | mr_item             | Time relative to current date like `3 days ago` |
+| `MR_ASSIGNEE_SINGLE`  | mr_item             | Merge request assignee just one user            |
+| `MR_ASSIGNEES`  | mr_item             | All assignee users in merge request             |
+| `MR_REVIEWERS`  | mr_item             | All reviewer users in merge request             |
+| `MR_LABELS`  | mr_item             | Merge request labels                            |
+| `MR_LINK`  | mr_item             | Merge request link                              |
+
+### Example usage
+
+before
+```json
+{
+    "text": "Hello, its beautiful day!",
+    "header": "Hi there, Just wanted to let you know that we have MR_TOTAL merge requests that need your attention.",
+    "mr_item": "<MR_LINK|MR_TITLE> MR_ASSIGNEE_SINGLE",
+    "footer": "Thank you",
+    "empty_mr_text": "Congratulation there is no merge request anymore, keep the good works"
+}
+```
+after
+```json
+{
+    "text": "Hello, its beautiful day!",
+    "header": "Hi there, Just wanted to let you know that we have 10 merge requests that need your attention.",
+    "mr_item": "<https://gitlab.com/nnn/merge_requests/1|feat: Add new feature mobile prepaid> @Bruce Wayne",
+    "footer": "Thank you",
+    "empty_mr_text": "Congratulation there is no merge request anymore, keep the good works"
+}
+```
 
 ## Run tests for this plugin
 
@@ -37,7 +103,7 @@ rubocop -a
 
 ## Issues and Feedback
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+For any other issues and feedback about this plugin, please submit new [Github Issue](https://github.com/tbetmen/fastlane-plugin-rooster/issues).
 
 ## Troubleshooting
 

data/lib/fastlane/plugin/rooster/actions/rooster_merge_request_action.rb

@@ -0,0 +1,148 @@
+require 'fastlane/action'
+require_relative '../helper/gitlab_api_client'
+require_relative '../helper/gitlab_merge_request_transformer'
+require_relative '../helper/slack_file_client'
+require_relative '../helper/slack_message_client'
+
+module Fastlane
+  module Actions
+    class RoosterMergeRequestAction < Action
+      def self.run(params)
+        # get params or envs
+        users_file = params[:slack_users_file] || ENV['ROOSTER_SLACK_USERS_FILE']
+        gitlab_project_id = params[:gitlab_project_id] || ENV['ROOSTER_GITLAB_PROJECT_ID']
+        slack_webhook_url = params[:slack_webhook_url] || ENV['ROOSTER_SLACK_WEBHOOK_URL']
+        slack_message_format_file = params[:slack_message_format_file] || ENV['ROOSTER_SLACK_MESSAGE_FORMAT_FILE']
+        gitlab_mr_total = params[:gitlab_merge_request_total] || ENV['ROOSTER_GITLAB_MERGE_REQUEST_TOTAL']
+        gitlab_milestones_path = params[:gitlab_milestones_path] || ENV['ROOSTER_GITLAB_MILESTONES_PATH']
+        gitlab_token = params[:gitlab_token] || ENV['ROOSTER_GITLAB_ACCESS_TOKEN']
+
+        # load slack files
+        slack_file_client = Helper::SlackFileClient.new
+        slack_message_format = slack_file_client.message_format(slack_message_format_file)
+        slack_users = slack_file_client.users(users_file)
+
+        # get gitlab merge request
+        gitlab_api = Helper::GitlabApiClient.new(gitlab_token)
+        current_milestone = gitlab_api.current_milestone(gitlab_milestones_path)
+        mr_resp_json = gitlab_api.merge_requests(gitlab_project_id, gitlab_mr_total, current_milestone)
+
+        # transform merge request
+        gitlab_mr_transformer = Helper::GitlabMergeRequestTransformer.new(slack_users, mr_resp_json)
+        merge_request_formatted = gitlab_mr_transformer.transform
+
+        # post merge request into slack
+        slack_message_client = Helper::SlackMessageClient.new(
+          slack_users,
+          slack_message_format,
+          merge_request_formatted,
+          current_milestone
+        )
+        slack_message_client.post_message(
+          slack_webhook_url,
+          slack_message_client.payload
+        )
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_token,
+            env_name: 'ROOSTER_GITLAB_ACCESS_TOKEN',
+            description: 'Gitlab access token',
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!('No gitlab access token given') unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_project_id,
+            env_name: 'ROOSTER_GITLAB_PROJECT_ID',
+            description: 'Gitlab project id',
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!('No gitlab project id given') unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :slack_webhook_url,
+            env_name: 'ROOSTER_SLACK_WEBHOOK_URL',
+            description: 'Slack webhook url',
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!('No slack webhook url given') unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_milestones_path,
+            env_name: 'ROOSTER_GITLAB_MILESTONES_PATH',
+            description: 'Gitlab group or project milestones with given format either `groups/:group_id` or `projects/:project_id`',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_merge_request_total,
+            env_name: 'ROOSTER_GITLAB_MERGE_REQUEST_TOTAL',
+            default_value: 10,
+            type: Integer,
+            description: 'Maximum merge request when fetching data from gitlab, uses in query param `per_page`',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :slack_users_file,
+            env_name: 'ROOSTER_SLACK_USERS_FILE',
+            description: 'Comma separate file that contains mapping user of gitlab and slack using id',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :slack_message_format_file,
+            env_name: 'ROOSTER_SLACK_MESSAGE_FORMAT_FILE',
+            default_value: Helper::SlackFileClient::SLACK_MESSAGE_FORMAT_DEFAULT,
+            description: 'Slack message format in json format contains `text`, `header`, `mr_item`, `footer`, and `empty_mr_text`'\
+                          '| In `header` you can use use `MR_TOTAL` and `MR_MILESTONE`'\
+                          '| In `mr_item` you can use use `MR_TITLE`, `MR_TIME`, `MR_ASSIGNEE_SINGLE`, `MR_ASSIGNEES`, `MR_REVIEWERS`  `MR_LABELS`, and `MR_LINK`'\
+                          '| In `empty_mr_text` you can use `MR_MILESTONE`',
+            optional: true
+          )
+        ]
+      end
+
+      def self.example_code
+        [
+          'rooster_merge_request',
+          'rooster_merge_request(
+            gitlab_token: "xyx",
+            gitlab_project_id: "123456",
+            gitlab_milestones_path: "projects/12345678"
+            gitlab_merge_request_total: 20,
+            slack_users_file: "/User/documents/slack_users.csv",
+            slack_webhook_url: "https://hooks.slack.com/000/000",
+            slack_message_format_file: "/User/documents/slack_message_format.json",
+          )'
+        ]
+      end
+
+      def self.is_supported?(_)
+        true
+      end
+
+      def self.author
+        'tbetmen (muhammadmmunir24@gmail.com)'
+      end
+
+      def self.description
+        'Send gitlab merge requests reminder to slack.'
+      end
+
+      def self.details
+        [
+          'This action is reminder system of gitlab merge request, ',
+          'fetching merge requests using Gitlab REST API and send to Slack using webhook url.'
+        ].join('')
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/api_request.rb

@@ -0,0 +1,42 @@
+require 'fastlane_core/ui/ui'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Fastlane
+  module Helper
+    module ApiRequest
+      def api_get_response_json(url, header)
+        uri = URI(url)
+
+        UI.message "Get Request from url: #{url}"
+        response = Net::HTTP.get_response(uri, header)
+
+        if response.is_a?(Net::HTTPSuccess)
+          UI.success "Successfully get request with code: #{response.code}"
+          JSON.parse(response.body)
+        else
+          UI.error "Failed to get request code: #{response.code} message: #{response.message}"
+          nil
+        end
+      end
+
+      def api_post(url, body, header)
+        uri = URI(url)
+        request = Net::HTTP::Post.new(uri, header)
+        request.body = JSON(body)
+
+        UI.message "Post Request to url: #{url}"
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |https|
+          https.request(request)
+        end
+
+        if response.is_a?(Net::HTTPSuccess)
+          UI.success "Successfully post request to with code: #{response.code}"
+        else
+          UI.error "Failed to post request code: #{response&.code} message: #{response&.message}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/file_loader.rb

@@ -0,0 +1,45 @@
+require 'fastlane_core/ui/ui'
+require 'csv'
+require 'json'
+
+module Fastlane
+  module Helper
+    module FileLoader
+      def valid_extension(filepath, ext)
+        File.file?(filepath.to_s) && [ext.to_s].include?(File.extname(filepath.to_s))
+      end
+
+      def load_json(filepath, default_value)
+        UI.message "Load json filepath #{filepath}"
+
+        if valid_extension(filepath, '.json')
+          UI.success 'Successfully loaded json file'
+          JSON.parse(File.read(filepath))
+        else
+          UI.success 'Successfully return default value because given file is missing or invalid json format'
+          default_value
+        end
+      end
+
+      def load_csv_to_hash(filepath, header_id, header_one, header_two, header_one_key, header_two_key)
+        UI.message "Load csv filepath #{filepath}"
+
+        unless valid_extension(filepath, '.csv')
+          UI.message 'The given file is missing or invalid csv format'
+          return nil
+        end
+
+        hash_value = {}
+        CSV.foreach(filepath, headers: true) do |user|
+          hash_value[user[header_id.to_s]] = {
+            header_one_key.to_s => user[header_one.to_s],
+            header_two_key.to_s => user[header_two.to_s]
+          }
+        end
+
+        UI.success 'Successfully loaded csv file into hash'
+        hash_value
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/gitlab_api_client.rb

@@ -0,0 +1,72 @@
+require 'date'
+require 'fastlane_core/ui/ui'
+require_relative './api_request'
+
+module Fastlane
+  module Helper
+    class GitlabApiClient
+      include Helper::ApiRequest
+
+      BASE_URL = 'https://gitlab.com/api/v4/'.freeze
+
+      def initialize(private_token)
+        @header = { 'PRIVATE-TOKEN': private_token }
+      end
+
+      #####################################################
+      # @!group MILESTONE
+      #####################################################
+      def current_milestone(milestones_path)
+        UI.message 'Fetching current milestone'
+        milestones_url = milestones_url(milestones_path)
+
+        if milestones_url.nil? || milestones_url.empty?
+          UI.success 'Return empty milestone because invalid milestone url'
+          ''
+        else
+          milestones_json = api_get_response_json(milestones_url, @header)
+          value = milestone_title(milestones_json)
+          UI.success "Successfully fetched current milestone #{value}" unless value.empty?
+          value
+        end
+      end
+
+      # `path` available option ['groups/:group_id', 'projects/:project_id']
+      def milestones_url(path)
+        path.nil? || path.empty? ? '' : "#{BASE_URL}#{path}/milestones?state=active"
+      end
+
+      def milestone_title(milestone_resp_json)
+        return '' if milestone_resp_json.nil?
+
+        current_milestone = milestone_resp_json.find do |value|
+          due_date = DateTime.strptime(value['due_date'], '%Y-%m-%d')
+          DateTime.now.to_time.to_i <= due_date.to_time.to_i
+        end
+
+        current_milestone.nil? ? '' : current_milestone['title']
+      end
+
+      #####################################################
+      # @!group MERGE REQUEST
+      #####################################################
+      def merge_requests(project_id, per_page = 10, current_milestone = '')
+        UI.message 'Fetching merge requests'
+        url = merge_request_url(project_id, per_page, current_milestone)
+        resp = api_get_response_json(url, @header)
+
+        if resp.nil?
+          UI.user_error! 'Failed to fetch gitlab merge request'
+        else
+          UI.success "Successfully fetched #{resp.length} merge requests"
+          resp
+        end
+      end
+
+      def merge_request_url(project_id, per_page, current_milestone)
+        url = "#{BASE_URL}projects/#{project_id}/merge_requests?state=opened&order_by=created_at&sort=asc&per_page=#{per_page}"
+        current_milestone.nil? || current_milestone.empty? ? url : url + "&milestone=#{current_milestone}"
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/gitlab_merge_request_transformer.rb

@@ -0,0 +1,60 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  module Helper
+    # Transform merge request json to new format by adding slack users id if `slack_users` parameter not nil or empty.
+    # And ignoring merge request when title has prefix `draft` and `wip`.
+    class GitlabMergeRequestTransformer
+      def initialize(slack_users, gitlab_mr_json)
+        @slack_users = slack_users
+        @gitlab_mr_json = gitlab_mr_json
+      end
+
+      def transform
+        UI.message 'Transform gitlab merge request into new format'
+
+        mr_filtered = remove_draft_merge_request(@gitlab_mr_json)
+        mr_transformed = compose_gitlab_merge_request(mr_filtered)
+        UI.success 'Successfully transformed into new format'
+
+        mr_transformed
+      end
+
+      def get_slack_user_id(gitlab_user_id, gitlab_username)
+        if !@slack_users.nil? && @slack_users.key?(gitlab_user_id.to_s)
+          "<@#{@slack_users[gitlab_user_id.to_s]['slack_id']}>"
+        else
+          "@#{gitlab_username}"
+        end
+      end
+
+      def get_slack_user_ids(gitlab_mr_json, key)
+        gitlab_mr_json[key.to_s]&.map do |v|
+          get_slack_user_id(v['id'], v['username'])
+        end
+      end
+
+      def remove_draft_merge_request(gitlab_mr_json)
+        gitlab_mr_json&.select do |value|
+          title = value['title']
+          !(title.downcase.start_with? 'draft') && !(title.downcase.start_with? 'wip')
+        end
+      end
+
+      def compose_gitlab_merge_request(gitlab_mr_json)
+        gitlab_mr_json&.map do |value|
+          {
+            title: value['title'],
+            created_at: value['created_at'],
+            link: value['web_url'],
+            assignee: get_slack_user_id(value.dig('assignee', 'id'), value.dig('assignee', 'username')),
+            assignees: get_slack_user_ids(value, 'assignees'),
+            reviewers: get_slack_user_ids(value, 'reviewers'),
+            labels: value['labels']&.map { |label| label },
+            milestone_title: value.dig('milestone', 'title')
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/slack_file_client.rb

@@ -0,0 +1,39 @@
+require 'fastlane_core/ui/ui'
+require_relative './file_loader'
+
+module Fastlane
+  module Helper
+    class SlackFileClient
+      include Helper::FileLoader
+
+      SLACK_MESSAGE_FORMAT_DEFAULT = {
+        'text' => 'Hello, its beautiful day!',
+        'header' => 'Hi there, Just wanted to let you know that we have MR_TOTAL merge requests that need your attention.',
+        'mr_item' => '<MR_LINK|MR_TITLE> MR_ASSIGNEE_SINGLE',
+        'footer' => 'Thank you',
+        'empty_mr_text' => 'Congratulation there is no merge request anymore, keep the good works'
+      }.freeze
+
+      def message_format(filepath)
+        UI.message 'Load slack message format'
+        load_json(filepath, SLACK_MESSAGE_FORMAT_DEFAULT)
+      end
+
+      def users(filepath)
+        UI.message 'Load slack users'
+        slack_users = load_csv_to_hash(
+          filepath,
+          'Gitlab User ID',
+          'Name',
+          'Slack ID',
+          'name',
+          'slack_id'
+        )
+
+        UI.success 'Slack users nil, skipped using tag user `@user` in when posting message reminder in slack' if slack_users.nil?
+
+        slack_users
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/slack_message_client.rb

@@ -0,0 +1,99 @@
+require 'fastlane_core/ui/ui'
+require_relative './api_request'
+require_relative './time_format'
+
+module Fastlane
+  module Helper
+    class SlackMessageClient
+      include Helper::ApiRequest
+      include Helper::TimeFormat
+
+      def initialize(slack_users, slack_message_format, merge_requests, current_milestone)
+        @slack_users = slack_users
+        @slack_message_format = slack_message_format
+        @merge_requests = merge_requests
+        @current_milestone = current_milestone
+      end
+
+      def post_message(slack_webhook_url, payload)
+        UI.message 'Posting slack message'
+        api_post(
+          slack_webhook_url,
+          payload,
+          { "Content-Type": 'application/json' }
+        )
+      end
+
+      def markdown_section(text)
+        {
+          type: 'section',
+          text: {
+            type: 'mrkdwn',
+            text: text
+          }
+        }
+      end
+
+      def format_users_string(users)
+        users.empty? ? '-' : users.join(' ')
+      end
+
+      def merge_request_numbering
+        @merge_requests.map.with_index do |mr, index|
+          time = format_relative_date_time(mr[:created_at])
+          assignees = format_users_string(mr[:assignees])
+          reviewers = format_users_string(mr[:reviewers])
+          text = @slack_message_format['mr_item'].to_s
+                                                 .gsub('MR_TITLE', mr[:title].to_s)
+                                                 .gsub('MR_TIME', time.to_s)
+                                                 .gsub('MR_ASSIGNEE_SINGLE', mr[:assignee].to_s)
+                                                 .gsub('MR_ASSIGNEES', assignees.to_s)
+                                                 .gsub('MR_REVIEWERS', reviewers.to_s)
+                                                 .gsub('MR_LABELS', mr[:labels].join(','))
+                                                 .gsub('MR_LINK', mr[:link].to_s)
+          "#{index + 1}. #{text}"
+        end
+      end
+
+      def merge_request_section
+        mr_numbering = merge_request_numbering
+        mr_numbering = mr_numbering.join("\n") if mr_numbering.length > 1
+
+        markdown_section(mr_numbering)
+      end
+
+      def payload
+        UI.message 'Composing slack payload'
+        merge_request_size = @merge_requests.nil? ? 0 : @merge_requests.length
+
+        unless merge_request_size.positive?
+          UI.success 'Successfully composed slack payload but has empty merge request'
+          return {
+            text: @slack_message_format['text'],
+            blocks: [
+              markdown_section(
+                @slack_message_format['empty_mr_text'].gsub('MR_MILESTONE', @current_milestone)
+              )
+            ]
+          }
+        end
+
+        header_section = markdown_section(
+          @slack_message_format['header'].gsub('MR_TOTAL', merge_request_size.to_s)
+                                         .gsub('MR_MILESTONE', @current_milestone)
+        )
+        footer_section = markdown_section(@slack_message_format['footer'])
+
+        UI.success "Successfully composed slack payload with total #{merge_request_size} merge request"
+        {
+          text: @slack_message_format['text'],
+          blocks: [
+            header_section,
+            merge_request_section,
+            footer_section
+          ]
+        }
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rooster/helper/time_format.rb

@@ -0,0 +1,66 @@
+require 'date'
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  module Helper
+    # source: https://stackoverflow.com/a/63106647
+    module TimeFormat
+      TIME_UNIT_TO_SECS = {
+        SECONDS: 1,
+        MINUTES: 60,
+        HOURS: 3600,
+        DAYS: 24 * 3600,
+        WEEKS: 7 * 24 * 3600,
+        MONTHS: 30 * 24 * 3600,
+        YEARS: 365 * 24 * 3600
+      }.freeze
+      TIME_UNIT_LABELS = {
+        SECONDS: 'seconds',
+        MINUTES: 'minutes',
+        HOURS: 'hours',
+        DAYS: 'days',
+        WEEKS: 'weeks',
+        MONTHS: 'months',
+        YEARS: 'years'
+      }.freeze
+
+      def format_relative_date_time(date_string, date_format = '%Y-%m-%dT%H:%M:%S.%L%Z')
+        created_at = DateTime.strptime(date_string, date_format)
+        now = DateTime.now
+        diff = now.to_time.to_i - created_at.to_time.to_i
+
+        if diff.negative?
+          UI.message '`date` cannot be in the future'
+          return 'in future'
+        end
+
+        time_unit = if diff < TIME_UNIT_TO_SECS[:MINUTES]
+                      :SECONDS
+                    elsif diff < TIME_UNIT_TO_SECS[:HOURS]
+                      :MINUTES
+                    elsif diff < TIME_UNIT_TO_SECS[:DAYS]
+                      :HOURS
+                    elsif diff < TIME_UNIT_TO_SECS[:WEEKS]
+                      :DAYS
+                    elsif diff < TIME_UNIT_TO_SECS[:MONTHS]
+                      :WEEKS
+                    elsif diff < TIME_UNIT_TO_SECS[:YEARS]
+                      :MONTHS
+                    else
+                      :YEARS
+                    end
+
+        time_relative = case time_unit
+                        when :SECONDS, :MINUTES, :HOURS, :DAYS, :WEEKS
+                          diff / TIME_UNIT_TO_SECS[time_unit]
+                        when :MONTHS
+                          0.step.find { |n| (created_at >> n) > now } - 1
+                        else
+                          0.step.find { |n| (created_at >> 12 * n) > now } - 1
+                        end
+
+        "#{time_relative} #{TIME_UNIT_LABELS[time_unit]} ago"
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Rooster
-    VERSION = "0.2.0"
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-rooster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Muhammad M Munir
+- Muhammad M. Munir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,8 +159,14 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/rooster.rb
-- lib/fastlane/plugin/rooster/actions/rooster_action.rb
-- lib/fastlane/plugin/rooster/helper/rooster_helper.rb
+- lib/fastlane/plugin/rooster/actions/rooster_merge_request_action.rb
+- lib/fastlane/plugin/rooster/helper/api_request.rb
+- lib/fastlane/plugin/rooster/helper/file_loader.rb
+- lib/fastlane/plugin/rooster/helper/gitlab_api_client.rb
+- lib/fastlane/plugin/rooster/helper/gitlab_merge_request_transformer.rb
+- lib/fastlane/plugin/rooster/helper/slack_file_client.rb
+- lib/fastlane/plugin/rooster/helper/slack_message_client.rb
+- lib/fastlane/plugin/rooster/helper/time_format.rb
 - lib/fastlane/plugin/rooster/version.rb
 homepage: https://github.com/tbetmen/fastlane-plugin-rooster
 licenses:

data/lib/fastlane/plugin/rooster/actions/rooster_action.rb

@@ -1,420 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'json'
-require 'csv'
-require 'date'
-
-require 'fastlane/action'
-require_relative '../helper/rooster_helper'
-
-module Fastlane
-  module Actions
-    class RoosterAction < Action
-      def self.run(params)
-        members_file = params[:members_file] || ENV['GITLAB_SLACK_MEMBERS_FILE']
-        gitlab_project_id = params[:gitlab_project_id] || ENV['GITLAB_PROJECT_ID']
-        slack_webhook_url = params[:slack_webhook_url] || ENV['SLACK_WEBHOOK_URL']
-        slack_message_format_file = params[:slack_message_format_file] || ENV['SLACK_MESSAGE_FORMAT_FILE']
-        gitlab_mr_total = params[:gitlab_merge_request_total] || ENV['GITLAB_MERGE_REQUEST_TOTAL']
-        gitlab_milestones_path = params[:gitlab_milestones_path] || ENV['GITLAB_MILESTONES_PATH']
-
-        @gitlab_token = params[:gitlab_token] || ENV['GITLAB_ACCESS_TOKEN']
-        @gitlab_api_base_url = 'https://gitlab.com/api/v4/'
-        @slack_message_format = get_slack_message_format(slack_message_format_file)
-        @members = get_members(members_file)
-        @current_milestone = get_current_milestone(gitlab_milestones_path)
-
-        mr_url = compose_merge_request_url(gitlab_project_id, gitlab_mr_total, @current_milestone)
-        mr_resp_json = get_response_json(mr_url)
-        merge_requests = compose_gitlab_merge_requests(mr_resp_json)
-        slack_payload = compose_slack_payload(merge_requests)
-
-        # UI.message slack_payload.to_json
-        post_request(
-          slack_webhook_url,
-          slack_payload,
-          { "Content-Type": "application/json" }
-        )
-      end
-
-      #####################################################
-      # @!group API REQUEST
-      #####################################################
-
-      def self.get_response_json(url)
-        uri = URI(url)
-        header = { 'PRIVATE-TOKEN' => @gitlab_token }
-        response = Net::HTTP.get_response(uri, header)
-
-        if response.is_a?(Net::HTTPSuccess)
-          JSON.parse(response.body)
-        else
-          UI.error "Failed to get request from #{url} code #{response.code} message #{response.message}"
-        end
-      end
-
-      def self.post_request(url, body, header)
-        uri = URI(url)
-        request = Net::HTTP::Post.new(uri, header)
-        request.body = JSON(body)
-
-        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |https|
-          https.request(request)
-        end
-
-        if response.is_a?(Net::HTTPSuccess)
-          UI.success "Successfully post request to #{url}"
-        else
-          UI.error "Failed to post request to #{url} code #{response.code} message #{response.message}"
-        end
-      end
-
-      #####################################################
-      # @!group MILESTONE
-      #####################################################
-
-      def self.compose_milestones_url(milestones_path)
-        return nil unless !milestones_path.nil?
-
-        "#{@gitlab_api_base_url}#{milestones_path}/milestones?state=active"
-      end
-
-      def self.extract_current_milestone_title(milestone_resp_json)
-        current_milestone = milestone_resp_json.find do |value|
-          due_date = DateTime.strptime(value.dig('due_date'), '%Y-%m-%d')
-          DateTime.now.to_time.to_i <= due_date.to_time.to_i
-        end
-
-        return "" unless !current_milestone.nil?
-
-        current_milestone.dig('title')
-      end
-
-      def self.get_current_milestone(milestones_path)
-        milestones_url = compose_milestones_url(milestones_path)
-        return "" unless !milestones_url.nil?
-
-        milestones_json = get_response_json(milestones_url)
-        extract_current_milestone_title(milestones_json)
-      end
-
-      #####################################################
-      # @!group SLACK MESSAGE FORMAT
-      #####################################################
-
-      def self.get_slack_message_format(slack_message_format_file)
-        unless !slack_message_format_file.is_a?(Hash)
-          return slack_message_format_file
-        end
-
-        JSON.parse(File.read(slack_message_format_file))
-      end
-
-      #####################################################
-      # @!group MEMBERS
-      #####################################################
-
-      def self.get_members(members_file)
-        return nil unless !members_file.nil? && !members_file.empty?
-
-        members = {}
-        CSV.foreach(members_file, headers: true) do |member|
-          members[member['Gitlab User ID']] = {
-            :name => member['Name'],
-            :slack_id => member['Slack ID']
-          }
-        end
-
-        members
-      end
-
-      #####################################################
-      # @!group MERGE REQUEST
-      #####################################################
-
-      def self.compose_merge_request_url(project_id, per_page, current_milestone)
-        "#{@gitlab_api_base_url}projects/#{project_id}/merge_requests?state=opened&order_by=created_at&sort=asc&per_page=#{per_page}&milestone=#{current_milestone}"
-      end
-
-      def self.get_slack_member_id(gitlab_member_id, gitlab_member_username)
-        if !@members.nil? && @members.key?(gitlab_member_id.to_s)
-          @members[gitlab_member_id.to_s][:slack_id]
-        else
-          "@#{gitlab_member_username}"
-        end
-      end
-
-      def self.get_slack_member_ids(gitlab_mr_json, key)
-        gitlab_mr_json.dig("#{key}")&.map do |v|
-          get_slack_member_id(v.dig('id'), v.dig('username'))
-        end
-      end
-
-      def self.compose_gitlab_merge_requests(gitlab_mr_json)
-        gitlab_mr_json = gitlab_mr_json.select do |value|
-          title = value.dig('title')
-          !(title.downcase.start_with? 'draft') && !(title.downcase.start_with? 'wip')
-        end
-
-        gitlab_mr_json.map do |value|
-          {
-            :title => value.dig('title'),
-            :created_at => value.dig('created_at'),
-            :link => value.dig('web_url'),
-            :assignee => get_slack_member_id(value.dig('assignee', 'id'), value.dig('assignee', 'username')),
-            :assignees => get_slack_member_ids(value, 'assignees'),
-            :reviewers => get_slack_member_ids(value, 'reviewers'),
-            :labels => value.dig('labels')&.map { |label| label },
-            :milestone_title => value.dig('milestone', 'title')
-          }
-        end
-      end
-
-      #####################################################
-      # @!group TIME FORMAT
-      # source: https://stackoverflow.com/a/63106647
-      #####################################################
-
-      def self.format_relative_date_time(date_string)
-        time_unit_to_secs = {
-          SECONDS: 1,
-          MINUTES: 60,
-          HOURS: 3600,
-          DAYS: 24 * 3600,
-          WEEKS: 7 * 24 * 3600,
-          MONTHS: 30 * 24 * 3600,
-          YEARS: 365 * 24 * 3600
-        }
-        time_unit_labels = {
-          SECONDS: 'seconds',
-          MINUTES: 'minutes',
-          HOURS: 'hours',
-          DAYS: 'days',
-          WEEKS: 'weeks',
-          MONTHS: 'months',
-          YEARS: 'years'
-        }
-
-        created_at = DateTime.strptime(date_string, '%Y-%m-%dT%H:%M:%S.%L%Z')
-        diff = DateTime.now.to_time.to_i - created_at.to_time.to_i
-
-        UI.error("'date_time' cannot be in the future") if diff.negative?
-
-        time_unit = if diff < time_unit_to_secs[:MINUTES]
-                      :SECONDS
-                    elsif diff < time_unit_to_secs[:HOURS]
-                      :MINUTES
-                    elsif diff < time_unit_to_secs[:DAYS]
-                      :HOURS
-                    elsif diff < time_unit_to_secs[:WEEKS]
-                      :DAYS
-                    elsif diff < time_unit_to_secs[:MONTHS]
-                      :WEEKS
-                    elsif diff < time_unit_to_secs[:YEARS]
-                      :MONTHS
-                    else
-                      :YEARS
-                    end
-
-        time_relative = case time_unit
-                        when :SECONDS, :MINUTES, :HOURS, :DAYS, :WEEKS
-                          diff / time_unit_to_secs[time_unit]
-                        when :MONTHS
-                          0.step.find { |n| (created_at >> n) > now } - 1
-                        else
-                          0.step.find { |n| (created_at >> 12 * n) > now } - 1
-                        end
-
-        "#{time_relative} #{time_unit_labels[time_unit]} ago"
-      end
-
-      #####################################################
-      # @!group SLACK
-      #####################################################
-
-      def self.format_users_string(users)
-        return '-' if users.empty?
-
-        users.join(' ')
-      end
-
-      def self.compose_merge_request_list_message(merge_requests)
-        merge_requests_formatted = merge_requests.map.with_index do |mr, index|
-          time = format_relative_date_time(mr[:created_at])
-          assignees = format_users_string(mr[:assignees])
-          reviewers = format_users_string(mr[:reviewers])
-          text = @slack_message_format['mr_item'].to_s
-                                      .gsub('MR_TITLE', mr[:title].to_s)
-                                      .gsub('MR_TIME', time.to_s)
-                                      .gsub('MR_ASSIGNEE_SINGLE', mr[:assignee].to_s)
-                                      .gsub('MR_ASSIGNEES', assignees.to_s)
-                                      .gsub('MR_REVIEWERS', reviewers.to_s)
-                                       .gsub('MR_LABELS', mr[:labels].join(','))
-                                      .gsub('MR_LINK', mr[:link].to_s)
-          "#{index+1}. #{text}"
-        end
-
-        if merge_requests_formatted.length > 1
-          merge_requests_formatted = merge_requests_formatted.join("\n")
-        end
-
-        {
-          "type": 'section',
-          "text": {
-            "type": 'mrkdwn',
-            "text": merge_requests_formatted
-          }
-        }
-      end
-
-      def self.compose_slack_payload(merge_requests)
-        unless merge_requests.length > 0
-          return {
-            :text => @slack_message_format['text'],
-            :blocks => [
-              {
-                "type": 'section',
-                "text": {
-                  "type": 'mrkdwn',
-                  "text": @slack_message_format['empty_mr_text'].gsub('MR_MILESTONE', @current_milestone)
-                }
-              }
-            ]
-          }
-        end
-
-        header_text = @slack_message_format['header'].gsub('MR_TOTAL', merge_requests.length.to_s)
-                                                     .gsub('MR_MILESTONE', @current_milestone)
-        header_section = {
-          :type => 'section',
-          :text => {
-            :type => 'mrkdwn',
-            :text => header_text
-          }
-        }
-        mr_section = compose_merge_request_list_message(merge_requests)
-        footer_section = {
-          :type => 'section',
-          :text => {
-            :type => 'mrkdwn',
-            :text => @slack_message_format['footer']
-          }
-        }
-
-        {
-          :text => @slack_message_format['text'],
-          :blocks => [header_section, mr_section, footer_section]
-        }
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.available_options # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        [
-          FastlaneCore::ConfigItem.new(
-            key: :gitlab_token,
-            env_name: 'GITLAB_ACCESS_TOKEN',
-            description: 'Gitlab access token',
-            optional: false,
-            verify_block: proc do |value|
-              UI.user_error!('No gitlab access token given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :gitlab_project_id,
-            env_name: 'GITLAB_PROJECT_ID',
-            description: 'Gitlab project id',
-            optional: false,
-            verify_block: proc do |value|
-              UI.user_error!('No gitlab mr url given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :gitlab_milestones_path,
-            env_name: 'GITLAB_MILESTONES_PATH',
-            description: 'Gitlab group or project milestones with given format either `groups/:group_id` or `projects/:project_id`',
-            optional: true,
-            verify_block: proc do |value|
-              UI.user_error!('No gitlab milestones path given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :gitlab_merge_request_total,
-            env_name: 'GITLAB_MERGE_REQUEST_TOTAL',
-            default_value: '10',
-            description: 'Total merge request to be shown in reminder, default value is `10`',
-            optional: true,
-            verify_block: proc do |value|
-              UI.user_error!('No gitlab merge request total given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :members_file,
-            env_name: 'GITLAB_SLACK_MEMBERS_FILE',
-            description: 'Gitlab members filepath in csv format',
-            optional: true,
-            verify_block: proc do |value|
-              UI.user_error!('No members file given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :slack_webhook_url,
-            env_name: 'SLACK_WEBHOOK_URL',
-            description: 'Slack webhook url',
-            optional: false,
-            verify_block: proc do |value|
-              UI.user_error!('No slack webhook url given') unless value and !value.empty?
-            end
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :slack_message_format_file,
-            env_name: 'SLACK_MESSAGE_FORMAT_FILE',
-            default_value: {
-              'text' => 'Hello, beautiful day!',
-              'header' =>'Hi there, Just wanted to let you know that we have MR_TOTAL merge requests that need your attention.',
-              'mr_item' => '<MR_LINK|MR_TITLE> MR_ASSIGNEE_SINGLE',
-              'footer' => 'Thank you',
-              'empty_mr_text' => 'Congratulation there is no merge request anymore, keep the good works'
-            },
-            description: "Slack message format in json format contains `text`, `header`, `mr_item`, `footer`, and `empty_mr_text`"\
-                          "| In `header` you can use use `MR_TOTAL` and `MR_MILESTONE`"\
-                          "| In `mr_item` you can use use `MR_TITLE`, `MR_TIME`, `MR_ASSIGNEE_SINGLE`, `MR_ASSIGNEES`, `MR_REVIEWERS`  `MR_LABELS`, and `MR_LINK`"\
-                          "| In `empty_mr_text` you can use `MR_MILESTONE`",
-            optional: true
-          )
-        ]
-      end
-
-      def self.example_code
-        [
-          'gitlab_mr_reminder()',
-          'gitlab_mr_reminder(
-            gitlab_members_file: "/User/documents/fe_members.csv",
-            gitlab_token: "XXXX",
-            gitlab_project_id: "https://gitlab.com/...",
-            slack_webhook_url: "ttps://hooks.slack.com/...",
-            slack_message_format_file: "/User/documents/slack_format.csv", # optional
-          )'
-        ]
-      end
-
-      def self.is_supported?(platform)
-        true
-      end
-
-      def self.author
-        'tbetmen'
-      end
-
-      def self.description
-        'Send gitlab merge requests reminder to slack.'
-      end
-
-      def self.details
-        "This action is reminder system of gitlab merge request, fetching merge requests using Gitlab REST API and send to Slack using webhook url."
-      end
-    end
-  end
-end

data/lib/fastlane/plugin/rooster/helper/rooster_helper.rb

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