fastlane-plugin-jira_fetch_tickets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 527b5e571224926a0340d61568456d9bc7d4952e9192a8cc788077ceeef19350
+  data.tar.gz: ddfef4f47585103f70034b47bbffa6968678b0a7f48e724d62e9abfe87c32fcf
+SHA512:
+  metadata.gz: 307121a63096d8163fc166d540d6165fc5a3561530615a9aa0800565f31627acfc35e3748713d6f0da685a8da79e57a4d637c7767515d9e6e227aa25853e3fa0
+  data.tar.gz: 9952e9cf8094bbdc2489c1404eb76c98f00b6abeacb271190404d83e961e284f488c774fca176918b3f71c69e34b7b3374d7c71f0c2376ce1c26a7cf716ee24a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Luca Tagliabue <lu.tagliabue@reply.it>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# jira_fetch_tickets plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_fetch_tickets)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_fetch_tickets`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_fetch_tickets
+```
+
+## About jira_fetch_tickets
+
+Fetch ticekts on jira project using jql query
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/jira_fetch_tickets/actions/jira_fetch_tickets_action.rb

@@ -0,0 +1,274 @@
+require 'fastlane/action'
+require 'fastlane_core'
+require_relative '../helper/jira_fetch_tickets_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      JIRA_FETCH_TICKETS_RESULT = :JIRA_FETCH_TICKETS_RESULT
+    end
+
+    class JiraFetchTicketsAction < Action
+      # rubocop:disable Metrics/PerceivedComplexity
+      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
+        )
+
+        projects = params[:projects]
+        project = params[:project]
+        statuses = params[:statuses]
+        status = params[:status]
+        labels = params[:labels]
+        label = params[:label]
+        sprints = params[:sprints]
+        sprint = params[:sprint]
+        custom_jql = params[:custom_jql]
+
+        jql = ""
+
+        unless projects.instance_of?(NilClass)
+          options = { key: "project", values: projects }
+          jql = jql_from_array?(options)
+        end
+
+        if jql.empty? && !project.instance_of?(NilClass)
+          options = { key: "project", value: project }
+          jql = jql_from_string?(options)
+        end
+
+        added = false
+        unless statuses.instance_of?(NilClass)
+          options = { key: "status", values: statuses, jql: jql }
+          jql = append_jql_from_array?(options)
+          added = true
+        end
+
+        if !added && !status.instance_of?(NilClass)
+          options = { key: "status", value: status, jql: jql }
+          jql = append_jql_from_string?(options)
+        end
+
+        added = false
+        unless labels.instance_of?(NilClass)
+          options = { key: "labels", values: labels, jql: jql }
+          jql = append_jql_from_array?(options)
+          added = true
+        end
+
+        if !added && !label.instance_of?(NilClass)
+          options = { key: "labels", value: label, jql: jql }
+          jql = append_jql_from_string?(options)
+        end
+
+        added = false
+        unless sprints.instance_of?(NilClass)
+          options = { key: "Sprint", values: sprints, jql: jql }
+          jql = append_jql_from_array?(options)
+          added = true
+        end
+
+        if !added && !sprint.instance_of?(NilClass)
+          options = { key: "Sprint", value: sprint, jql: jql }
+          jql = append_jql_from_string?(options)
+        end
+
+        if custom_jql
+          options = { jql: jql, new_value: custom_jql }
+          jql = append_jql?(options)
+        end
+
+        UI.message("JQL query is '#{jql}'")
+
+        issues = client.Issue.jql(jql)
+
+        issues = issues.map do |issue|
+          { key: issue.key, issue: issue.attrs }
+        end
+
+        Actions.lane_context[SharedValues::JIRA_FETCH_TICKETS_RESULT] = issues
+
+        UI.success('Successfully fetched JIRA tickets!')
+        issues
+      end
+
+      def self.jql_from_array?(options)
+        values = options[:values]
+        values = values.map { |string| "\"#{string}\"" }
+        "#{options[:key]} in (#{values.join(', ')})"
+      end
+
+      def self.append_jql_from_array?(options)
+        jql = options[:jql]
+        options = { key: options[:key], values: options[:values] }
+        to_append = jql_from_array?(options)
+        options = { jql: jql, new_value: to_append }
+        append_jql?(options)
+      end
+
+      def self.jql_from_string?(options)
+        "#{options[:key]} = \"#{options[:value]}\""
+      end
+
+      def self.append_jql_from_string?(options)
+        jql = options[:jql]
+        options = { key: options[:key], value: options[:value] }
+        to_append = jql_from_string?(options)
+        options = { jql: jql, new_value: to_append }
+        append_jql?(options)
+      end
+
+      def self.append_jql?(options)
+        jql = options[:jql]
+        new_value = options[:new_value]
+
+        appended = ""
+        if jql.empty?
+          appended = new_value
+        else
+          appended = "#{jql} AND #{new_value}"
+        end
+
+        appended
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def self.description
+        "Fetch ticekts on jira project using jql query"
+      end
+
+      def self.authors
+        ["Luca Tagliabue"]
+      end
+
+      def self.return_value
+        "Hash object of key and issue."
+      end
+
+      def self.output
+        [
+          ['JIRA_FETCH_TICKETS_RESULT', 'Hash object of key and issue.']
+        ]
+      end
+
+      def self.details
+        "Fetch ticekts on jira project using jql query"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_JIRA_SITE",
+                                       description: "URL for Jira instance",
+                                       sensitive: true,
+                                       type: String,
+                                       verify_block: ->(value) { verify_option(key: 'url', value: value) }),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for Jira instance",
+                                       sensitive: true,
+                                       type: String,
+                                       verify_block: ->(value) { verify_option(key: 'username', value: value) }),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password or api token for Jira",
+                                       sensitive: true,
+                                       type: String,
+                                       verify_block: ->(value) { verify_option(key: 'password', value: value) }),
+          FastlaneCore::ConfigItem.new(key: :projects,
+                                       env_name: "FL_JIRA_FETCH_JQL_PROJECTS",
+                                       description: "Array of Jira projects",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :project,
+                                       env_name: "FL_JIRA_FETCH_JQL_PROJECT",
+                                       description: "Jira project",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:projects],
+                                       conflict_block: proc do |other|
+                                                         UI.message("Ignoring :project in favor of :projects")
+                                                       end),
+          FastlaneCore::ConfigItem.new(key: :statuses,
+                                       env_name: "FL_JIRA_FETCH_JQL_STATUSES",
+                                       description: "Array of Jira status",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :status,
+                                       env_name: "FL_JIRA_FETCH_JQL_STATUS",
+                                       description: "Jira status",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:statuses],
+                                       conflict_block: proc do |other|
+                                                         UI.message("Ignoring :status in favor of :statuses")
+                                                       end),
+          FastlaneCore::ConfigItem.new(key: :labels,
+                                       env_name: "FL_JIRA_FETCH_JQL_LABELS",
+                                       description: "Array of Jira labels",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :label,
+                                       env_name: "FL_JIRA_FETCH_JQL_LABEL",
+                                       description: "Jira label",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:labels],
+                                       conflict_block: proc do |other|
+                                                         UI.message("Ignoring :label in favor of :labels")
+                                                       end),
+          FastlaneCore::ConfigItem.new(key: :sprints,
+                                       env_name: "FL_JIRA_FETCH_JQL_SPRINTS",
+                                       description: "Jira sprints",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :sprint,
+                                       env_name: "FL_JIRA_FETCH_JQL_SPRINT",
+                                       description: "Jira sprint",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:sprints],
+                                       conflict_block: proc do |other|
+                                                         UI.message("Ignoring :sprint in favor of :sprints")
+                                                       end),
+          FastlaneCore::ConfigItem.new(key: :custom_jql,
+                                       env_name: "FL_JIRA_FETCH_JQL_CUSTOM",
+                                       description: "Jira custom jql",
+                                       type: String,
+                                       optional: true)
+        ]
+      end
+
+      def self.verify_option(options)
+        UI.user_error!("No value found for '#{options[:key]}'") if options[:value].to_s.empty?
+      end
+
+      def self.example_code
+        [
+          'jira_fetch_tickets(
+              url: "YOUR_URL_HERE",
+              username: "YOUR_USERNAME_HERE",
+              password: "YOUR_PASSWORD_HERE",
+              project: "YOUR_PROJECT_HERE",
+              status: "STATUS_HERE",
+              label: "LABEL_HERE",
+              sprint: "SPRINT_HERE",
+              custom_jql: "CUSTOM_JQL_HERE"
+          )'
+        ]
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_fetch_tickets/helper/jira_fetch_tickets_helper.rb

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

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

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

data/lib/fastlane/plugin/jira_fetch_tickets.rb

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

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_fetch_tickets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luca Tagliabue
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-19 00:00:00.000000000 Z
+dependencies: []
+description:
+email: homobonus-luca@hotmail.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_fetch_tickets.rb
+- lib/fastlane/plugin/jira_fetch_tickets/actions/jira_fetch_tickets_action.rb
+- lib/fastlane/plugin/jira_fetch_tickets/helper/jira_fetch_tickets_helper.rb
+- lib/fastlane/plugin/jira_fetch_tickets/version.rb
+homepage: https://github.com/lukluca/fastlane-plugin-jira_fetch_tickets
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Fetch ticekts on jira project using jql query
+test_files: []