fastlane-plugin-jira_issue_details 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c593c03b31741d49f1c77b778fc9e9092ad1539
+  data.tar.gz: 985a286d908052bba6a57fd4deae1697d3dc5cd2
+SHA512:
+  metadata.gz: 7414de5d77f9321fbc1e7cc5238e55f24d2c7bec8d8f54dc0ae2dfdef99db8fa116f79b49c4a3b7b6bea3b376fc25e31b9fe76e5a3a4f319ea56a6ef0ad2b9cf
+  data.tar.gz: 37b631d0467f15b9a1605647288d44f19545ca2afdaabdd11970ae9e6102af252e282ad97463697061b2fefa8dba6cf870892bfd0f6d71050fdc38f8118bd092

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zaim Ramlan <zaimramlan@gmail.com>
+
+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,57 @@
+# 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)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_issue_details`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_issue_details
+```
+
+## About This Plugin
+
+Get the details for the given jira issue key.
+
+It utilises the [jira-ruby gem](https://github.com/sumoheavy/jira-ruby) to communicate with Jira and get the details of the Jira issue for the given key. If the key does not exists, it will just return `nil`.
+
+(Currently only supports basic `auth_type` login)
+
+## Actions
+
+### get_jira_issue
+
+Get the jira issue by passing the `username`, `api_token`, `site` and `issue_key` parameters. You can later get the details that you need by accessing the string keys. The reference to all the keys can be found [here](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-issue-issueIdOrKey-get), just scroll to the `responses` section.
+
+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.
+```
+
+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`.
+
+## 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_issue_details.rb

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

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

@@ -0,0 +1,89 @@
+require 'jira-ruby'
+require 'fastlane/action'
+require_relative '../helper/jira_issue_details_helper'
+
+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)
+
+        begin
+          return client.Issue.find(issue_key).attrs
+        rescue
+          return nil
+        end
+      end
+
+      def self.description
+        "Get the details for the given jira issue key."
+      end
+
+      def self.authors
+        ["Zaim Ramlan"]
+      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."
+      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)"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                  env_name: "JIRA_ISSUE_DETAILS_USERNAME",
+                               description: "Your Jira Username",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                  env_name: "JIRA_ISSUE_DETAILS_API_TOKEN",
+                               description: "Your Jira API Token",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :site,
+                                  env_name: "JIRA_ISSUE_DETAILS_SITE",
+                               description: "Your Jira Site ('http://yourdomain.atlassian.net')",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :issue_key,
+                                  env_name: "JIRA_ISSUE_DETAILS_ISSUE_KEY",
+                               description: "Your Jira Issue Key",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_issue_details/helper/jira_issue_details_helper.rb

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

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_issue_details
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zaim Ramlan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-25 00:00:00.000000000 Z
+dependencies:
+- !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: rspec_junit_formatter
+  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.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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.108.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.108.0
+description: 
+email: zaimramlan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_issue_details.rb
+- lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb
+- lib/fastlane/plugin/jira_issue_details/helper/jira_issue_details_helper.rb
+- lib/fastlane/plugin/jira_issue_details/version.rb
+homepage: https://github.com/zaimramlan/fastlane-plugin-jira-issue
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Get the details for the given jira issue key
+test_files: []