fastlane-plugin-jira_update 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be1047099dbcbed94ee376b1e981940dfb9a4a8aba74ba4c62b71e8b62834148
+  data.tar.gz: fcd75278ef5b42c71c1872810fc53f11501bfa8555cc9723631bb5f1e140b5cb
+SHA512:
+  metadata.gz: df28f102280045b2cabf9dff1003803f4c8267acc74e20284fd69b91be9ffcab603e2f1675450936cc3e10cd58219cf00747c0f819665492024142515d581175
+  data.tar.gz: 213c796acdce2254a258dcc7ec3812897e1c18fa297231d12eaef39e37aa720391730712b199158c3cdd9d58041714d60a4eb8a340ab4ad09b0a100f94103e84

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Flop Butylkin <flop@hackerspace.by>
+
+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,80 @@
+# jira_update plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_update)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_update`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_update
+```
+
+## About jira_update
+
+Update JIRA tickets status
+
+
+## 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`.
+
+```ruby
+lane :notes do
+  result = jira_move_tickets(
+    username: "me",
+    password: "123", # password or api token
+    url:      "https://jira.example.com",
+    ticket: "APP-123",
+    target: "ready"
+  )
+  puts result
+end
+```
+
+## Options
+
+```
+fastlane action jira_move_tickets
+```
+
+[How to generate an API Access Token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)
+
+Key | Description | Env Var | Default
+----|-------------|---------|--------
+url | URL for Jira instance | FL_JIRA_SITE |
+username | Username for Jira instance | FL_JIRA_USERNAME |
+password | Password for Jira or api token | FL_JIRA_PASSWORD |
+ticket | Jira ticket to move String | FL_JIRA_TICKET |
+tickets | Jira tickets to move Array of Strings | FL_JIRA_TICKETS |
+target | Jira status move to | FL_JIRA_TARGET |
+
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/jira_update/actions/jira_comment_update_action.rb

@@ -0,0 +1,169 @@
+module Fastlane
+  module Actions
+    class JiraCommentUpdateAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        client = JIRA::Client.new(
+          username:     params[:username],
+          password:     params[:password],
+          site:         params[:url],
+          context_path: '',
+          auth_type:    :basic
+        )
+
+        ticket = params[:ticket]
+        search = params[:comment_search]
+        username = params[:username]
+        comment = params[:comment_text]
+        update_comment = params[:update_comment] || false
+        fail_if_not_found = params[:fail_if_not_found] || false
+
+
+        UI.message("JIRA ticket to update: '#{ticket}'")
+
+
+        begin
+          issue = client.Issue.find(ticket)
+          
+          UI.message("JIRA ticket: '#{issue.id}'")
+
+          if search
+            # search comment
+            UI.message("Searching for comment: '#{search}'")
+            comment_obj = issue.comments.find { |comment| 
+              comment.body.include?(search) && comment.author['displayName'] == username
+            }
+
+            UI.error!("Comment not found") if fail_if_not_found && !comment_obj
+            UI.message("Comment found: '#{comment_obj.body}'") if comment_obj
+
+            if comment_obj && update_comment
+              comment_obj.save({ 'body' => comment })
+              UI.message("Comment updated: '#{comment_obj.body}'")
+            elsif comment_obj
+              comment_obj.delete
+              UI.message("Comment deleted: '#{comment_obj.body}'")
+            end
+            
+            if !update_comment
+              new_comment = issue.comments.build
+              new_comment.save({ 'body' => comment })
+              UI.message("Comment added: '#{new_comment.body}'")
+            end
+
+          else 
+            UI.message("No search provided, will add new comment")
+            new_comment = issue.comments.build
+            new_comment.save({ 'body' => comment })
+            UI.message("Comment added: '#{new_comment.body}'")
+          end
+
+        rescue StandardError => e
+          UI.important("Failed to fetch issue #{ticket}: #{e.message}")
+          UI.error!("Failed to fetch issue #{ticket}: #{e.message}") if fail_if_not_found
+          result = "Ticket not found"
+        end
+
+        UI.success("JIRA ticket updated: '#{issue.id}'")
+
+        return issue
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Jira ticket comment replace action"
+      end
+
+      def self.details
+        "Replace Jira ticket comment"
+      end
+
+      def self.return_value
+        "Hash where keys are Jira ticket IDs and values results of the action"
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_JIRA_SITE",
+                                       description: "URL for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No url for Jira given") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password or api token for Jira",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ticket,
+                                       env_name: "FL_JIRA_TICKET",
+                                       description: "Jira ticket id",
+                                       type: String,
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :comment_search,
+                                       description: "Jira comment text to find",
+                                       type: String,
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :comment_text,
+                                       description: "Jira comment text to add",
+                                       type: String,
+                                       default_value: "comment"),
+          FastlaneCore::ConfigItem.new(key: :fail_if_not_found,
+                                       description: "Fail if Issue or comment not found",
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :update_comment,
+                                       description: "Update comment if found otherwise will delete and add new comment",
+                                       type: Boolean,
+                                       default_value: false)
+        ]
+      end
+
+      def self.authors
+        ["Flop Butylkin"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          '
+          gym
+          slack(message: "Done")
+          jira_comment_update(
+            ticket: "APP-132",
+            search: "Test comment",
+            comment: "Test comment updated",
+            update_comment: true
+          )
+          '
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_update/actions/jira_get_ticket.rb

@@ -0,0 +1,118 @@
+module Fastlane
+  module Actions
+    class JiraGetTicketAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        client = JIRA::Client.new(
+          username:     params[:username],
+          password:     params[:password],
+          site:         params[:url],
+          context_path: '',
+          auth_type:    :basic
+        )
+
+        ticket = params[:ticket]
+        UI.message("JIRA ticket id: '#{ticket}'")
+
+        begin
+          issue = client.Issue.find(ticket)
+          
+        rescue StandardError => e
+          UI.important("Failed to fetch issue #{ticket}: #{e.message}")
+          UI.error!("Failed to fetch issue #{ticket}: #{e.message}") if fail_if_not_found
+          result = "Ticket not found"
+        end
+
+        # Convert the issue to a hash only with the fields we need
+        issue_hash = {
+          id: issue.id,
+          key: issue.key,
+          summary: issue.summary,
+          description: issue.description,
+          status: issue.status.name,
+          assignee: issue.assignee.displayName,
+          reporter: issue.reporter.displayName,
+          created: issue.created,
+          updated: issue.updated
+        }
+
+        UI.message("JIRA ticket found: '#{issue_hash[:key]}'")
+        return issue_hash
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Jira ticket comment replace action"
+      end
+
+      def self.details
+        "Replace Jira ticket comment"
+      end
+
+      def self.return_value
+        "Hash where keys are Jira ticket IDs and values results of the action"
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_JIRA_SITE",
+                                       description: "URL for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No url for Jira given") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password or api token for Jira",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ticket,
+                                       env_name: "FL_JIRA_TICKET",
+                                       description: "Jira ticket id",
+                                       type: String,
+                                       optional: true,
+                                       default_value: nil)
+        ]
+      end
+
+      def self.authors
+        ["Flop Butylkin"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          '
+          jira_get_ticket(
+            ticket: "APP-132",
+          )
+          '
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_update/actions/jira_move_tickets_action.rb

@@ -0,0 +1,144 @@
+module Fastlane
+  module Actions
+    class JiraMoveTicketsAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        client = JIRA::Client.new(
+          username:     params[:username],
+          password:     params[:password],
+          site:         params[:url],
+          context_path: '',
+          auth_type:    :basic
+        )
+
+        issues = {}
+        issues[params[:ticket]] = "" if params[:ticket]
+        params[:tickets].each { |ticket| issues[ticket] = "" } if params[:tickets]
+        target = params[:target]
+
+        UI.message("JIRA tickets to move: '#{issues.keys}' to '#{target}'")
+
+
+        issues.each_key do |ticket|
+          # puts "Moving ticket #{ticket}"
+          result = ""
+          begin
+            issue = client.Issue.find(ticket)
+            
+            transition = issue.transitions.build
+            available_transitions = issue.transitions.all.map { |t| { id: t.id, name: t.name } }
+            # puts "Available transitions: #{available_transitions}"
+            target_transition = available_transitions.find { |t| t[:name].casecmp(target).zero? }
+            if target_transition
+              transition.save!("transition" => { "id" => target_transition[:id] })
+              result = "Success '#{target}'"
+            else
+              result = "Can't move to '#{target}'"
+            end
+        
+          rescue StandardError => e
+            UI.important("Failed to fetch issue #{ticket}: #{e.message}")
+            result = "Ticket not found"
+          end
+          issues[ticket] = result
+        end
+
+        
+        UI.message("JIRA tickets updated: '#{issues}'")
+
+        return issues
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Jira update actions"
+      end
+
+      def self.details
+        "Update Jira tickets"
+      end
+
+      def self.return_value
+        "Hash where keys are Jira ticket IDs and values results of the action"
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_JIRA_SITE",
+                                       description: "URL for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No url for Jira given") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password or api token for Jira",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ticket,
+                                       env_name: "FL_JIRA_TICKET",
+                                       description: "Jira ticket id",
+                                       type: String,
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :tickets,
+                                       env_name: "FL_JIRA_TICKETS",
+                                       description: "Jira tickets ids array",
+                                       type: Array,
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                       env_name: "FL_JIRA_TARGET",
+                                       description: "Target status for Jira tickets",
+                                       type: String,
+                                       default_value: "Closed")
+        ]
+      end
+
+      def self.authors
+        ["Flop Butylkin"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          '
+          gym
+          slack(message: "Done")
+          jira_move_tickets(
+            url: "https://jira.yourdomain.com",
+            username: "Username",
+            password: "Password",
+            ticket: "ABC-123",
+            target: "Done"
+          )
+          '
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_update/helper/jira_move_tickets_helper.rb

@@ -0,0 +1,8 @@
+module Fastlane
+  module Helper
+    class JiraMoveTicketsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JiraMoveTicketsHelper.your_method`
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/jira_update.rb

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

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_update
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Flop Butylkin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.49.0
+description:
+email: flopspm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_update.rb
+- lib/fastlane/plugin/jira_update/actions/jira_comment_update_action.rb
+- lib/fastlane/plugin/jira_update/actions/jira_get_ticket.rb
+- lib/fastlane/plugin/jira_update/actions/jira_move_tickets_action.rb
+- lib/fastlane/plugin/jira_update/helper/jira_move_tickets_helper.rb
+- lib/fastlane/plugin/jira_update/version.rb
+homepage: https://github.com/
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: JIRA update actions
+test_files: []