fastlane-plugin-jira_issue_details 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c593c03b31741d49f1c77b778fc9e9092ad1539
-  data.tar.gz: 985a286d908052bba6a57fd4deae1697d3dc5cd2
+  metadata.gz: f8e4e65b0e2830cb2cd5529f0684100505cd46ed
+  data.tar.gz: 8ec1259b484de24c4e2da3158ec0c0f7cb4632e4
 SHA512:
-  metadata.gz: 7414de5d77f9321fbc1e7cc5238e55f24d2c7bec8d8f54dc0ae2dfdef99db8fa116f79b49c4a3b7b6bea3b376fc25e31b9fe76e5a3a4f319ea56a6ef0ad2b9cf
-  data.tar.gz: 37b631d0467f15b9a1605647288d44f19545ca2afdaabdd11970ae9e6102af252e282ad97463697061b2fefa8dba6cf870892bfd0f6d71050fdc38f8118bd092
+  metadata.gz: 446fc9d66a571582a1b9464dae93e7e4267b2c5c5798467172d3c5d94f73466bbe92e0ed7a73510eb0fcb3fdd390752b2bdbdb706abecbc98ed4bafd7ec75ee2
+  data.tar.gz: 6283b7eff344c8b3a69428a82e8f3443ac1c38b15eb0638dabaf614650c8e9b3e579fc02a57f99341b9d5d646db6e422f40fb8e8c48cc005a06c9f7cab50bdff

data/README.md

@@ -1,6 +1,6 @@
 # Jira Issue Details `fastlane` Plugin [![Build Status](https://app.bitrise.io/app/72df6f31dbaba55c/status.svg?token=eNywJtIKO1opSsI9PbEHVQ&branch=develop)](https://app.bitrise.io/app/72df6f31dbaba55c)
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_issue_details)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_issue_details) [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-jira_issue_details.svg)](https://badge.fury.io/rb/fastlane-plugin-jira_issue_details)
 
 ## Getting Started
 
@@ -26,17 +26,44 @@ Get the jira issue by passing the `username`, `api_token`, `site` and `issue_key
 
 Do note that all parameters are required, otherwise the action will return `nil`.
 
-```ruby
-issue = get_jira_issue(
-  username: 'you@domain.com',
-  api_token: 'yourapitoken',
-  site: 'https://your-domain.atlassian.net',
-  issue_key: 'TCK-123'
-)
-summary = issue['fields']['summary']
-puts summary
-#=> Short summary for the ticket id: TCK-123.
-```
+1. Passing a single jira `issue_key`
+    
+    In return, you'll get a single hash, or `nil` if the issue for the given key was not found.
+
+    ```ruby
+    issue = get_jira_issue(
+      username: 'you@domain.com',
+      api_token: 'yourapitoken',
+      site: 'https://your-domain.atlassian.net',
+      issue_key: 'TKT-123'
+    )
+
+    summary = issue['fields']['summary']
+    puts summary
+    #=> Short summary for the ticket id TKT-123
+    ```
+
+1. Passing multiple jira `issue_key`s (Do note that you should **only** separate the keys using a single space ` `)
+
+    In return, you'll get a hash of `key-hash` pair, or `key-nil` pair if the issue was not found.
+
+    ```ruby
+    issue = get_jira_issue(
+      username: 'you@domain.com',
+      api_token: 'yourapitoken',
+      site: 'https://your-domain.atlassian.net',
+      issue_key: 'TKT-123 TKT-456'
+    )
+
+    summary = issue['TKT-123']['fields']['summary']
+    puts summary
+    #=> Short summary for the ticket id: TKT-123
+
+    # assuming TKT-456 doesn't exist
+    summary = issue['TKT-456']
+    puts summary
+    #=> nil
+    ```    
 
 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`.
 

data/lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb

@@ -6,39 +6,16 @@ module Fastlane
   module Actions
     class GetJiraIssueAction < Action
       def self.run(params)
-        site = ENV['JIRA_ISSUE_DETAILS_SITE'] 
-        username = ENV['JIRA_ISSUE_DETAILS_USERNAME'] 
-        api_token = ENV['JIRA_ISSUE_DETAILS_API_TOKEN']
-        issue_key = ENV['JIRA_ISSUE_DETAILS_ISSUE_KEY']
-
-        if params && params[:site] && params[:username] && params[:api_token] && params[:issue_key]
-          site = params[:site]
-          username = params[:username]
-          api_token = params[:api_token]
-          issue_key = params[:issue_key]
-        end
-
-        return nil if site.nil? && username.nil? && api_token.nil? && issue_key.nil?
-
-        options = {
-          username: username,
-          password: api_token,
-          context_path: "",
-          auth_type: :basic,
-          site: "#{site}:443/",
-          rest_base_path: "/rest/api/3"
-        }
-        client = JIRA::Client.new(options)
+        input = get_input_from_env
+        input = get_input_from(params) if is_exists?(params)
+        return nil if is_nil_any(input)
 
-        begin
-          return client.Issue.find(issue_key).attrs
-        rescue
-          return nil
-        end
+        client = JIRA::Client.new(options_for_jira_client(input))
+        return get_issues_from(client, input)
       end
 
       def self.description
-        "Get the details for the given jira issue key."
+        "Get the details for the given jira issue key(s)."
       end
 
       def self.authors
@@ -46,11 +23,14 @@ module Fastlane
       end
 
       def self.return_value
-        "Return a `Hash` containing the details of the jira issue for the given key, or `nil` if the issue key does not exists."
+        single_key = "it returns a `Hash` containing the details of the jira issue for the given key, or `nil` if the issue key does not exists."
+        multiple_key = "it returns a `Hash` of `key-Hash` pairs containing the details of the jira issue key, or `key-nil` pair if the issue key does not exists."
+
+        "For single jira issue key, #{single_key} For multiple jira issue keys, #{multiple_key}"
       end
 
       def self.details
-        "It utilises the `jira-ruby` gem to communicate with Jira and get the details of the Jira issue for the given key.\n\n(Currently only supports basic auth_type login)"
+        "It utilises the `jira-ruby` gem to communicate with Jira and get the details of the Jira issue for the given key.\n\n(Currently only supports basic auth_type login)."
       end
 
       def self.available_options
@@ -75,7 +55,7 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :issue_key,
                                   env_name: "JIRA_ISSUE_DETAILS_ISSUE_KEY",
-                               description: "Your Jira Issue Key",
+                               description: "Your Jira Issue Key(s). Separate with a single space ` ` to add more keys",
                                   optional: false,
                                       type: String)
         ]
@@ -84,6 +64,62 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      private 
+
+      def self.get_input_from_env
+        {
+          site: ENV['JIRA_ISSUE_DETAILS_SITE'],
+          username: ENV['JIRA_ISSUE_DETAILS_USERNAME'],
+          api_token: ENV['JIRA_ISSUE_DETAILS_API_TOKEN'],
+          issue_key: ENV['JIRA_ISSUE_DETAILS_ISSUE_KEY']
+        }
+      end
+
+      def self.is_exists?(params)
+        params && params[:site] && params[:username] && params[:api_token] && params[:issue_key]        
+      end
+
+      def self.get_input_from(params)
+        {
+          site: params[:site],
+          username: params[:username],
+          api_token: params[:api_token],
+          issue_key: params[:issue_key]
+        }
+      end
+
+      def self.is_nil_any(input)
+        input[:site].nil? || input[:username].nil? || input[:api_token].nil? || input[:issue_key].nil?
+      end
+
+      def self.options_for_jira_client(input)
+        {
+          username: input[:username],
+          password: input[:api_token],
+          context_path: "",
+          auth_type: :basic,
+          site: "#{input[:site]}:443/",
+          rest_base_path: "/rest/api/3"
+        }
+      end
+
+      def self.get_issues_from(client, input)
+        issues = {}
+        keys = input[:issue_key].split(" ")
+        keys.each {|key| issues[key] = fetch_issue(key, client) }
+        
+        return issues[keys.first] if keys.count == 1
+        return issues
+      end
+
+      def self.fetch_issue(key, client)
+        begin
+          return client.Issue.find(key).attrs
+        rescue
+          return nil
+        end        
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module JiraIssueDetails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-jira_issue_details
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zaim Ramlan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-25 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.108.0
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 description: 
 email: zaimramlan@gmail.com
 executables: []
@@ -171,5 +199,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Get the details for the given jira issue key
+summary: Get the details for the given jira issue key(s)
 test_files: []