apadmi_grout 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38dac1846b90f9d3ade4bec465d4a8518f3e469977dc1ac51fd02aa238037a99
+  data.tar.gz: e1eda0e1ab3dfa4ed76c19f1b629ee8fc0dd29f308c3090145557b3aa0e99cc2
+SHA512:
+  metadata.gz: 03ad8c9bfdaafcb3fd25bfb8d4599a8889410bd3b28620ef91417cd43b1ac55599d74f5578cf6747eeb78a52e54f6acf65fed6661c6948e9ed849e0d584e920b
+  data.tar.gz: cac7a75e0e4991f4d5a20f714a293b627281d55f993c41a12a157d44c2f73e4b2ee4421f15855543418fb2ad72edea4573e2cee2d32e3c1ed1e561baed83f908

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Fastlane Plugin Changelog
+
+## [Unreleased]
+
+## [0.1.0] - 2022-01-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at samdc@apadmi.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Apadmi Ltd
+
+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,3 @@
+# Apadmi::Grout
+
+See documentation here: https://apadmi-grout.web.app/

data/lib/apadmi/grout/di.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Convenience class for initializing and accessing the various actions
+    class DependencyInjector
+      attr_reader :move_jira_tickets_action, :find_tickets_to_move_action, :generate_release_notes_action, :issues_from_changelog_action
+
+      # @param [String] username
+      # @param [String] token
+      # @param [String] base_url
+      # @param [String] context_path
+      # @param [String] project
+      # @param [Logger] logger
+      def initialize(username, token, base_url, context_path, project, logger)
+        @jira_wrapper = Apadmi::Grout::JiraWrapper.new(username, token, base_url, context_path, project)
+
+        @move_jira_tickets_action = Apadmi::Grout::MoveJiraTicketsAction.new(@jira_wrapper, logger)
+        @find_tickets_to_move_action = Apadmi::Grout::FindTicketsToMoveAction.new(@jira_wrapper, logger)
+        @generate_release_notes_action = Apadmi::Grout::GenerateReleaseNotesAction.new(base_url)
+        @issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(@jira_wrapper, logger)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/jira/actions/find_tickets_to_move_action.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Finds and returns a list of all the issues that are ready to be moved
+    # Any tickets found that have the given status but *don't* appear ready to be moved will
+    # be flagged.
+    class FindTicketsToMoveAction
+      # @param [Apadmi::Grout::JiraWrapper]
+      # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
+      def initialize(jira_wrapper, logger)
+        @jira_wrapper = jira_wrapper
+        @logger = logger
+      end
+
+      # @param component [String] Only include tickets tagged with this component
+      # @param status [String] The status of tickets to be moved (Usually "Awaiting QA Release")
+      # @param excluded_ticket_keys [Array<String>] ticket keys to be excluded from consideration
+      # @param custom_flag_messages [FlagMessages]
+      # @return [Array<JIRA::Resource::Issue>] the issues ready to move
+      def run(
+        component,
+        status,
+        excluded_ticket_keys,
+        custom_flag_messages = FlagMessages.new(
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no PRs connected to it. CI still moved it",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs and at least one OPEN PR",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has only DECLINED PRs",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs"
+        )
+      )
+        issues = @jira_wrapper.search_unblocked_issues(component, status).reject do |issue|
+          puts issue.key
+          excluded_ticket_keys.include? issue.key
+        end
+
+        @logger.message("Found issues to consider #{issues.map(&:key).join(", ")}")
+        final_list = issues.filter do |issue|
+          # Decide whether to include this ticket based on PRs
+          process_prs(issue, custom_flag_messages)
+        end
+        @logger.message("Final list:  #{final_list.map(&:key).join(", ")}")
+        final_list
+      end
+
+      private
+
+      # @param issue [JIRA::Resource::Issue]
+      # @param custom_flag_messages [FlagMessages]
+      # @return [Boolean] whether or not this ticket can be moved
+      def process_prs(issue, custom_flag_messages)
+        prs = @jira_wrapper.get_ticket_prs(issue)
+
+        if prs.empty?
+          @logger.message("#{issue.key} has no PRs. Flagging it: STILL MOVABLE")
+          @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.no_prs_flag_msg)
+          return true
+        elsif prs.all?(&:open)
+          @logger.message("#{issue.key} has only open PRs. Flagging it: NOT MOVABLE")
+          @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.open_prs_flag_msg)
+          return false
+        elsif prs.all?(&:declined)
+          @logger.message("#{issue.key} has only declined PRs. Flagging it: NOT MOVABLE")
+          @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.declined_prs_flag_msg)
+          return false
+        elsif prs.none?(&:merged)
+          @logger.message("#{issue.key} has no merged PRs. Flagging it: NOT MOVABLE")
+          @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.no_merged_prs_flag_msg)
+          return false
+        end
+
+        true # At least one merged PR, so it's included
+      end
+    end
+  end
+end

data/lib/apadmi/grout/jira/actions/move_jira_tickets_action.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Moves all given jira tickets to a given status and assigns fix versions
+    class MoveJiraTicketsAction
+      # @param [Apadmi::Grout::JiraWrapper]
+      # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
+      def initialize(jira_wrapper, logger)
+        @jira_wrapper = jira_wrapper
+        @logger = logger
+      end
+
+      # @param [Array<String>] version_strings
+      # @param [Array<JIRA::Resource::Issue>] issues
+      # @param [String] new_status
+      def run(version_strings, issues, new_status)
+        if issues.empty?
+          @logger.error("No issues found, aborting")
+          return
+        end
+
+        @logger.message("Creating versions #{version_strings}")
+        versions = create_or_get_versions(version_strings)
+
+        @logger.message("Transitioning issues: #{issues.map(&:key).join(", ")}")
+        issues.each { |issue| move_issue(issue, new_status, versions) }
+
+        @logger.success("Issues transitioned successfully :D")
+      end
+
+      # @param [Array<String>] version_strings
+      # @return [Array<JIRA::Resource::Version>]
+      def create_or_get_versions(version_strings)
+        all_versions = @jira_wrapper.all_versions
+        version_strings.map do |version|
+          existing_version = all_versions.find { |v| v.name == version }
+          if !existing_version.nil?
+            existing_version
+          else
+            date = Time.now.strftime("%Y-%m-%d")
+            @jira_wrapper.create_version(date, version)
+          end
+        end
+      end
+
+      # @param [JIRA::Resource::Issue] issue
+      # @param [String] new_status
+      # @param [Array<JIRA::Resource::Version>] versions
+      def move_issue(issue, new_status, versions)
+        @jira_wrapper.transition_issue(issue, new_status)
+        @jira_wrapper.assign_fixversions(issue.id, versions)
+      end
+
+      private :create_or_get_versions, :move_issue
+    end
+  end
+end

data/lib/apadmi/grout/jira/models/flag_messages.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FlagMessages = Struct.new(
+  :no_prs_flag_msg,
+  :open_prs_flag_msg,
+  :declined_prs_flag_msg,
+  :no_merged_prs_flag_msg
+)

data/lib/apadmi/grout/jira/models/pull_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Represents a pull request object derived from the Jira REST API response.
+    class PullRequest
+      # @return [String]
+      attr_reader :id
+      # @return [String]
+      attr_reader :name
+      # @return [bool]
+      attr_reader :merged
+      # @return [bool]
+      attr_reader :declined
+      # @return [bool]
+      attr_reader :open
+
+      # @param [String] id
+      # @param [String] name
+      # @param [bool] merged
+      # @param [bool] declined
+      def initialize(id, name, merged, declined)
+        @id = id
+        @name = name
+        @merged = merged
+        @declined = declined
+        @open = (!merged and !declined)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/jira/models/version.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Represents a version object derived from the Jira REST API response.
+    class Version
+      attr_reader :self, :id, :description, :name, :archived, :released, :release_date, :overdue, :user_release_date, :project_id
+
+      def initialize(json)
+        @self = json["self"]
+        @id = json["id"]
+        @description = json["description"]
+        @name = json["name"]
+        @archived = json["archived"]
+        @released = json["released"]
+        @release_date = json["release_date"]
+        @overdue = json["overdue"]
+        @user_release_date = json["user_release_date"]
+        @project_id = json["project_id"]
+      end
+    end
+  end
+end

data/lib/apadmi/grout/jira/wrapper/jira_wrapper.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+# Build tools
+require "jira-ruby"
+require "faraday"
+
+module Apadmi
+  module Grout
+    # Provides a layer of abstraction on top of the Jira api
+    class JiraWrapper
+      APPLICATION_JSON = "application/json"
+      CONTENT_TYPE = "Content-Type"
+      private_constant :CONTENT_TYPE, :APPLICATION_JSON
+
+      # @param [String] username
+      # @param [String] token
+      # @param [String] base_url
+      # @param [String] context_path
+      # @param [String] project
+      def initialize(username, token, base_url, context_path, project)
+        @options = {
+          username: username,
+          password: token,
+          site: base_url,
+          context_path: context_path,
+          auth_type: :basic
+        }
+        @project = project
+        @jira_client = JIRA::Client.new(@options)
+      end
+
+      # @return returns the ticket prefix for the given project
+      def issue_id_prefix
+        @project
+      end
+
+      # @param [String[]] keys
+      # @return [Array<JIRA::Resource::Issue>]
+      def find_issues_by_keys(keys)
+        return [] if keys.length <= 0
+
+        jql_search = "project = '#{@project}' AND issue IN (#{keys.join(", ")})"
+        @jira_client.Issue.jql(jql_search, { max_results: 1000 }).uniq
+      end
+
+      # @param [String] component
+      # @param [String] status
+      # @param [String[]] ticket_types
+      # @return [Array<JIRA::Resource::Issue>]
+      def search_unblocked_issues(component, status, ticket_types = [])
+        component_filter = (" AND component = '#{component}' " unless component.empty?) || ""
+        status_filter = (" AND status = '#{status}' " unless status.empty?) || ""
+        type_filter = ("AND (#{ticket_types.map { |type| "type = #{type}" }.join("OR ")})" unless ticket_types.empty?) || ""
+
+        jql_search = %{
+          project = '#{@project}'
+          #{status_filter} #{component_filter} #{type_filter}
+          AND sprint in openSprints() AND (labels not in(Blocked) or labels is EMPTY) AND Flagged is EMPTY
+        }
+
+        @jira_client.Issue.jql(jql_search, { max_results: 1000 }).uniq
+      end
+
+      # @param [String] key
+      # @param [String] comment
+      def flag_ticket(key, comment)
+        payload = "{\"flag\":true,\"issueKeys\":[\"#{key}\"],\"commentVisibility\":\"\",\"comment\":\"#{comment}\"}"
+        do_post("#{@options[:site]}/rest/greenhopper/1.0/xboard/issue/flag/flag.json", payload)
+      end
+
+      # @param [String] key
+      def un_flag_ticket(key)
+        payload = "{\"flag\":false,\"issueKeys\":[\"#{key}\"],\"commentVisibility\":\"\",\"comment\":\"Unflagged by CI\"}"
+        do_post("#{@options[:site]}/rest/greenhopper/1.0/xboard/issue/flag/flag.json", payload)
+      end
+
+      # @param [String] key
+      # @return bool
+      def flagged?(key)
+        jql_search = "project = '#{@project}' AND issue IN (#{key}) AND Flagged is not EMPTY"
+        response = @jira_client.Issue.jql(jql_search, { max_results: 1 }).uniq
+        response != []
+      end
+
+      # @param [String] key
+      # @param [String] comment
+      def add_comment(key, comment)
+        payload = "{\"issueKeys\":[\"#{key}\"],\"commentVisibility\":\"\",\"comment\":\"#{comment}\"}"
+        do_post("#{@options[:site]}/rest/greenhopper/1.0/xboard/issue/flag/flag.json", payload)
+      end
+
+      # @param [String] key
+      # @return [JIRA::Resource::Comment]
+      def get_top_comment(key)
+        jql_search = "project = '#{@project}' AND issue IN (#{key})"
+        response = @jira_client.Issue.jql(jql_search, { fields: ["comment"], max_results: 1000 }).uniq
+        comments = response[0].comments.reverse
+        !comments.empty? ? comments[0] : nil
+      end
+
+      # @param [String] key
+      # @param [String] comment_id
+      def remove_comment(key, comment_id)
+        do_delete("#{@options[:site]}/rest/api/2/issue/#{key}/comment/#{comment_id}")
+      end
+
+      # @param [String] component_key
+      # @return [Array<JIRA::Resource::Issue>]
+      def get_tickets_by_component(component_key)
+        jql_search = "project = '#{@project}' AND component IN ('#{component_key}')"
+        @jira_client.Issue.jql(jql_search, { max_results: 1000 }).uniq
+      end
+
+      # @param [String] key
+      def get_transitions(key)
+        issue = @jira_client.Issue.find(key)
+        @jira_client.Transition.all(issue: issue)
+      end
+
+      # @param [String] ticket
+      # @param [String] state_name
+      def transition_ticket(ticket, state_name)
+        issue = @jira_client.Issue.find(ticket)
+        transition_issue(issue, state_name)
+      end
+
+      # @param [JIRA::Resource::Issue] issue
+      # @param [String] state_name
+      def transition_issue(issue, state_name)
+        transitions = @jira_client.Transition.all(issue: issue)
+        transition = transitions.find { |elem| elem.name == state_name }
+
+        trans = issue.transitions.build
+        trans.save!("transition" => { "id" => transition.id })
+      end
+
+      # @param [String] key
+      def get_ticket_status(key)
+        issue = @jira_client.Issue.find(key)
+        issue.status
+      end
+
+      # @param [JIRA::Resource::Issue] issue
+      # @return [Array<PullRequest>]
+      def get_ticket_prs(issue)
+        response = do_get("#{@options[:site]}/rest/dev-status/latest/issue/details?issueId=#{issue.id}&applicationType=bitbucket&dataType=pullrequest")
+
+        return [] if JSON.parse(response.body)["detail"].empty?
+
+        JSON.parse(response.body)["detail"][0]["pullRequests"].map do |pr|
+          PullRequest.new(pr["id"], pr["name"], pr["status"].to_s == "MERGED", pr["status"].to_s == "DECLINED")
+        end
+      end
+
+      # @param [String] keys
+      # @param [String] component
+      # @return [Array<JIRA::Resource::Issue>]
+      def get_ticket_subtask(keys, component = nil)
+        jql_search = "project = '#{@project}' AND parent IN #{keys.to_s.gsub("[", "(").gsub("]", ")")}"\
+                      + (component.nil? ? "" : " AND component IN ('#{component}')")
+        @jira_client.Issue.jql(jql_search, { max_results: 1000 }).uniq
+      end
+
+      # @param [String] release_date
+      # @param [String] name
+      # @return [JIRA::Resource::Version]
+      def create_version(release_date, name)
+        version = @jira_client.Version.build
+        version.save!({
+                        "project": @project,
+                        "name": name,
+                        "releaseDate": release_date
+                      })
+        version
+      end
+
+      # @param [int] version_id
+      # @param [int] move_version_id
+      def delete_version(version_id, move_version_id)
+        payload = "{\"moveFixIssuesTo\": #{move_version_id}, \"moveAffectedIssuesTo\": #{move_version_id}, "\
+                  "\"customFieldReplacementList\": []}"
+        do_post("#{@options[:site]}/rest/api/2/version/#{version_id}/removeAndSwap", payload)
+      end
+
+      # @return [Array<JIRA::Resource::Version>]
+      def all_versions
+        @jira_client.Project.find(@project).versions
+      end
+
+      # @param [String] ticket
+      # @param [Array<JIRA::Resource::Version>] versions
+      def assign_fixversions(ticket, versions)
+        fixversions = versions.map { |v| "{\"id\": \"#{v.id}\"}" }.join(", ")
+        payload = "{\"fields\" : {\"fixVersions\": [#{fixversions}] }}"
+        do_put("#{@options[:site]}/rest/api/2/issue/#{ticket}", payload)
+      end
+
+      # @param [String] ticket
+      # @return [Array<Version>]
+      def get_ticket_fixversions(ticket)
+        response = do_get("#{@options[:site]}/rest/api/2/issue/#{ticket}")
+        JSON.parse(response.body)["fields"]["fixVersions"].map do |version|
+          Version.new(version)
+        end
+      end
+
+      # @param [Faraday::Response] response
+      def throw_if_error(response)
+        raise "Network call failed #{response.status} #{response.body}" unless (200..210).include?(response.status)
+      end
+
+      # @param [String] uri
+      # @return [Faraday::Response]
+      def do_get(uri)
+        conn = setup_con
+        response = conn.get(uri, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] uri
+      # @param [String] payload
+      # @return [Faraday::Response]
+      def do_put(uri, payload)
+        conn = setup_con
+        response = conn.put(uri, payload, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] uri
+      # @param [String] payload
+      # @return [Faraday::Response]
+      def do_post(uri, payload)
+        conn = setup_con
+        response = conn.post(uri, payload, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] uri
+      # @return [Faraday::Response]
+      def do_delete(uri)
+        conn = setup_con
+        response = conn.delete(uri, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @return [Faraday::Connection]
+      def setup_con
+        auth_str = "#{@options[:username]}:#{@options[:password]}"
+        conn = Faraday.new # create a new Connection with base URL
+        conn.headers["Authorization"] = "Basic #{Base64.strict_encode64(auth_str)}"
+        conn
+      end
+
+      private :setup_con, :do_delete, :do_get, :do_post, :do_put
+    end
+  end
+end

data/lib/apadmi/grout/release_notes/actions/generate_release_notes_action.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "mustache"
+
+module Apadmi
+  module Grout
+    # Finds and returns a list of all the issues who's ids exist in the given changelog
+    class GenerateReleaseNotesAction
+      # @param jira_base_url [String] Jira base url
+      def initialize(jira_base_url)
+        @jira_base_url = jira_base_url
+      end
+
+      # @param config [Apadmi::Grout::ReleaseNotesConfig]
+      def run(config)
+        base_url = "#{@jira_base_url}/browse/"
+
+        Mustache.render(
+          config.templates.document_template,
+          config: config,
+          rendered_moved_issues: render_classified_issues(config.templates.list_template, base_url, config.classified_moved_issues),
+          rendered_release_issues: render_classified_issues(config.templates.list_template, base_url, config.classified_release_issues)
+        ).strip
+      end
+
+      private
+
+      def render_classified_issues(template, base_url, classified_issues)
+        return if classified_issues.empty
+
+        Mustache.render(
+          template,
+          classified_issues: classified_issues,
+          base_url: base_url
+        )
+      end
+    end
+  end
+end

data/lib/apadmi/grout/release_notes/actions/issues_from_changelog_action.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Finds and returns a list of all the issues who's ids exist in the given changelog
+    class IssuesFromChangelogAction
+      # @param [Apadmi::Grout::JiraWrapper]
+      # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
+      def initialize(jira_wrapper, logger)
+        @jira_wrapper = jira_wrapper
+        @logger = logger
+      end
+
+      # @param changelog [String] raw git changelog
+      # @return [Array<JIRA::Resource::Issue>] list of issues from changelog
+      def run(changelog)
+        ids = issue_ids_from_changelog(changelog)
+
+        @logger.message("Found issue ids: #{ids.join(", ")}")
+        @jira_wrapper.find_issues_by_keys(ids)
+      end
+
+      private
+
+      # @param changelog [String] raw git changelog
+      # @return [Array<String>] list of issue ids from changelog
+      def issue_ids_from_changelog(changelog)
+        changelog.scan(/(#{@jira_wrapper.issue_id_prefix}-\d+)/).flatten.uniq
+      end
+    end
+  end
+end

data/lib/apadmi/grout/release_notes/models/release_notes_config.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # @param tasks [Array<JIRA::Resource::Issue>]
+    # @param features [Array<JIRA::Resource::Issue>] aka stories
+    # @param improvements [Array<JIRA::Resource::Issue>]
+    # @param defects [Array<JIRA::Resource::Issue>] aka bugs
+    # @param others [Array<JIRA::Resource::Issue>] any other non-standard issue types
+    ClassifiedIssues = Struct.new(
+      :tasks,
+      :features,
+      :improvements,
+      :defects,
+      :others
+    ) do
+      # @return returns true if all categories are empty
+      def empty
+        tasks.empty? && features.empty? &&
+          improvements.empty? && defects.empty? && others.empty?
+      end
+    end
+
+    # @param title [String] The title of the document
+    # @param app_version [String] The app version pertaining to this release
+    # @param min_os_version [String] The min supported os version of this release
+    # @param date [String] Today's date
+    # @param moved_issues [Array<JIRA::Resource::Issue>] Issues moved to a new state by this build job
+    # @param release_issues [Array<JIRA::Resource::Issue>] Issues considered part of this release
+    # @param commit_hash [String] Commit hash from which release was built
+    # @param ci_build_number [String] CI build number which built the release
+    # @param ci_build_url [String] Link to CI build job
+    # @param templates [Apadmi::Grout::Templates] Mustache templates to use to generate the document
+    ReleaseNotesConfig = Struct.new(
+      :title,
+      :app_version,
+      :min_os_version,
+      :date,
+      :moved_issues,
+      :release_issues,
+      :commit_hash,
+      :ci_build_number,
+      :ci_build_url,
+      :templates
+    ) do
+      def classified_moved_issues
+        classify_issues(moved_issues)
+      end
+
+      def classified_release_issues
+        classify_issues(release_issues)
+      end
+
+      private
+
+      def classify_issues(issues)
+        ClassifiedIssues.new(
+          filter_issues_by_type(%w[Task], issues),
+          filter_issues_by_type(%w[Story Debt], issues),
+          filter_issues_by_type(%w[Improvement Rework], issues),
+          filter_issues_by_type(%w[Bug], issues),
+          issues - filter_issues_by_type(%w[Task Story Debt Improvement Rework Bug], issues)
+        )
+      end
+
+      # @param types [Array<String>] List of types to match on
+      # @param issues [Array<JIRA::Resource::Issue>]
+      # @return [Array<JIRA::Resource::Issue>]
+      def filter_issues_by_type(types, issues)
+        issues.find_all { |issue| types.include?(issue.issuetype.name) }
+      end
+    end
+  end
+end

data/lib/apadmi/grout/release_notes/models/release_notes_templates.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Default baked in templates for generating release notes
+    class DefaultTemplates
+      def default_document_template
+        %{# {{config.title}}
+
+### Version
+{{config.app_version}}
+{{config.hello}}
+### Release date
+{{config.date}}
+
+### Minimum Supported OS
+{{config.min_os_version}}
+
+### Build Details
+Commit Hash: {{config.commit_hash}}
+[CI/CD build \#{{config.ci_build_number}}]({{config.ci_build_url}})
+
+## Jira Tickets Moved By This Build
+{{ rendered_moved_issues }}
+## Jira Sprint Release notes
+{{ rendered_release_issues }} }
+      end
+
+      def default_list_template
+        %{### New functionality
+{{# classified_issues.features.first}}
+{{# classified_issues.features}}
+* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+{{/ classified_issues.features}}
+
+{{/ classified_issues.features.first}}
+{{# classified_issues.improvements.first}}
+### Improvements
+  {{# classified_issues.improvements}}
+* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+  {{/ classified_issues.improvements}}
+
+{{/ classified_issues.improvements.first}}
+{{# classified_issues.tasks.first}}
+### Completed Tasks
+  {{# classified_issues.tasks}}
+* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+  {{/ classified_issues.tasks}}
+
+{{/ classified_issues.tasks.first}}
+{{# classified_issues.defects.first}}
+### Fixed defects
+  {{# classified_issues.defects}}
+* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+  {{/ classified_issues.defects}}
+
+{{/ classified_issues.defects.first}}
+{{# classified_issues.others.first}}
+### Other issue types
+  {{# classified_issues.others}}
+* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+  {{/ classified_issues.others}}
+
+{{/ classified_issues.others.first}}}
+      end
+    end
+
+    # @param document_template [String] the template for the entire document
+    # @param list_template [String] the template for the repeated subsection listing issues
+    Templates = Struct.new(
+      :document_template,
+      :list_template
+    ) do
+      # @return returns the default hardcoded templates
+      def self.default
+        defaults = DefaultTemplates.new
+        Templates.new(defaults.default_document_template, defaults.default_list_template)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/utils/logger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # A basic logger to be used in various places. To be replaced by version injected from fastlane in real use
+    class DefaultLogger
+      def error(msg)
+        puts "ERROR: #{msg}"
+      end
+
+      def success(msg)
+        puts "SUCCESS: #{msg}"
+      end
+
+      def message(msg)
+        puts "MESSAGE: #{msg}"
+      end
+    end
+  end
+end

data/lib/apadmi/grout/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    VERSION = "0.0.3"
+  end
+end

data/lib/apadmi_grout.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "apadmi/grout/version"
+require_relative "apadmi/grout/di"
+
+require_relative "apadmi/grout/release_notes/actions/issues_from_changelog_action"
+require_relative "apadmi/grout/release_notes/actions/generate_release_notes_action"
+require_relative "apadmi/grout/release_notes/models/release_notes_config"
+require_relative "apadmi/grout/release_notes/models/release_notes_templates"
+
+require_relative "apadmi/grout/jira/actions/move_jira_tickets_action"
+require_relative "apadmi/grout/jira/actions/find_tickets_to_move_action"
+
+require_relative "apadmi/grout/jira/wrapper/jira_wrapper"
+
+require_relative "apadmi/grout/jira/models/pull_request"
+require_relative "apadmi/grout/jira/models/version"
+require_relative "apadmi/grout/jira/models/flag_messages"
+
+require_relative "apadmi/grout/utils/logger"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: apadmi_grout
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Apadmi build tool utils for use through Fastlane on Android and iOS.
+email:
+- samdc@apadmi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/apadmi/grout/di.rb
+- lib/apadmi/grout/jira/actions/find_tickets_to_move_action.rb
+- lib/apadmi/grout/jira/actions/move_jira_tickets_action.rb
+- lib/apadmi/grout/jira/models/flag_messages.rb
+- lib/apadmi/grout/jira/models/pull_request.rb
+- lib/apadmi/grout/jira/models/version.rb
+- lib/apadmi/grout/jira/wrapper/jira_wrapper.rb
+- lib/apadmi/grout/release_notes/actions/generate_release_notes_action.rb
+- lib/apadmi/grout/release_notes/actions/issues_from_changelog_action.rb
+- lib/apadmi/grout/release_notes/models/release_notes_config.rb
+- lib/apadmi/grout/release_notes/models/release_notes_templates.rb
+- lib/apadmi/grout/utils/logger.rb
+- lib/apadmi/grout/version.rb
+- lib/apadmi_grout.rb
+homepage: https://bitbucket.org/apadmi/apadmi-grout-ruby/
+licenses: []
+metadata:
+  homepage_uri: https://bitbucket.org/apadmi/apadmi-grout-ruby/
+  documentation_uri: https://apadmi-grout.web.app/
+  source_code_uri: https://bitbucket.org/apadmi/apadmi-grout-ruby/
+  changelog_uri: https://bitbucket.org/apadmi/apadmi-grout-ruby/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Apadmi build tool utils for use through Fastlane on Android and iOS.
+test_files: []