speedflow-plugin-jira 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e86db3144dfa9255cb647663724cb8e12ec86e76
+  data.tar.gz: 9ea700d99decf1955e7d1df581514fc8bc14ffb2
+SHA512:
+  metadata.gz: 04539b08a4ba7828d1a910d44b800187f71b0e1b8efa7d255f1f5fa647fd90567c258b30afb6fc4e2cde46b198d754dc628310d361ee581f2295eb8a386fc3b6
+  data.tar.gz: d115c35351527e4d2554c2f7581b9daff00c14d0c17d82cd98337f5ed53b38366637e9d4dbda072757f26525e32adfb2bf13da48e83bf6dd034bad229a304f7f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Speedflow
+
+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,98 @@
+# Speedflow Plugin Jira
+
+[![Build Status](https://travis-ci.org/speedflow/speedflow-plugin-jira.svg?branch=master)](https://travis-ci.org/speedflow/speedflow-plugin-jira)
+[![Gem Version](https://badge.fury.io/rb/speedflow-plugin-jira.svg)](https://badge.fury.io/rb/speedflow-plugin-jira)
+[![Code Climate](https://codeclimate.com/github/speedflow/speedflow-plugin-jira/badges/gpa.svg)](https://codeclimate.com/github/speedflow/speedflow-plugin-jira)
+[![Test Coverage](https://codeclimate.com/github/speedflow/speedflow-plugin-jira/badges/coverage.svg)](https://codeclimate.com/github/speedflow/speedflow-plugin-jira/coverage)
+[![Inline docs](http://inch-ci.org/github/speedflow/speedflow-plugin-jira.svg?branch=master)](http://inch-ci.org/github/speedflow/speedflow-plugin-jira)
+
+:package: A Speedflow plugin to work with Jira.
+
+## How to install?
+
+`gem install speedflow-plugin-jira`
+
+## How to configure?
+
+`.speedflow.yml` :
+```yml
+---
+plugins:
+  - jira
+
+# ...
+
+jira:
+  site: "{JIRA_SITE}"
+  username: "{JIRA_USERNAME}"
+  password: "{JIRA_PASSWORD}"
+```
+
+`~/.zshrc` or `~/.bashrc` :
+```sh
+# Jira
+export JIRA_SITE="https://xxx.atlassian.net/"
+export JIRA_USERNAME="..."
+export JIRA_PASSWORD="..."
+```
+
+### How to use in my flow?
+
+#### Search an issue
+
+`.speedflow.yml` :
+```yml
+#...
+
+flow:
+  test:
+    - plugin: jira
+      action: search_issue
+```
+
+#### Create an issue (beta)
+
+`.speedflow.yml` :
+```yml
+#...
+
+flow:
+  test:
+    - plugin: jira
+      action: create_issue
+      arguments:
+        title: ~
+        project:
+          default: TEST
+```
+
+#### Change issue assignee
+
+`.speedflow.yml` :
+```yml
+#...
+
+flow:
+  test:
+    - plugin: jira
+      action: change_issue_assignee
+      arguments:
+        assignee:
+          default: "{JIRA_USERNAME}"
+        issue: ~
+```
+
+#### Change issue transition
+
+`.speedflow.yml` :
+```yml
+#...
+
+flow:
+  test:
+    - plugin: jira
+      action: change_issue_transition
+      arguments:
+        transition: ~
+        issue: ~
+```

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'speedflow/plugin/jira'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/speedflow-plugin-jira.rb

@@ -0,0 +1 @@
+require 'speedflow/plugin/jira'

data/lib/speedflow/plugin/jira.rb

@@ -0,0 +1,47 @@
+require 'speedflow/plugin/jira/version'
+require 'speedflow/plugin/jira/formatter/issue_formatter'
+require 'speedflow/plugin/jira/plugin_core'
+require 'speedflow/plugin/jira/prompt'
+require 'speedflow/plugin/jira/configuration'
+require 'speedflow/plugin/jira/client'
+
+# Speedflow GEM, help you to boost your flow and keep your time.
+module Speedflow
+  module Plugin
+    # Jira Speedflow plugin.
+    module Jira
+      # TODO: Move this system in the core Utils
+      class << self
+        ACTIONS = [
+          :action_create_issue,
+          :action_search_issue,
+          :action_change_issue_assignee,
+          :action_change_issue_transition
+        ].freeze
+
+        # @return [Speedflow::Plugin::Jira.PluginCore] Plugin.
+        attr_writer :plugin
+
+        # Public: Magic method to route to action
+        #
+        # args - Some arguments :)
+        #
+        # Returns nothing.
+        def method_missing(*args)
+          action = args.first
+
+          raise NoMethodError, action unless ACTIONS.include? action
+
+          plugin.new(args.last).send(action)
+        end
+
+        # Public: Plugin.
+        #
+        # Returns Speedflow::Plugin::Jira.PluginCore instance.
+        def plugin
+          @plugin ||= PluginCore
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/jira/client.rb

@@ -0,0 +1,154 @@
+require 'jira'
+require 'json'
+
+module Speedflow
+  module Plugin
+    module Jira
+      # Jira Client
+      class Client
+        include ::Speedflow::Plugin::Jira::Formatter
+
+        # @return [Prompt] Prompt.
+        attr_writer :prompt
+
+        # @return [JIRA::Client] JIRA Client.
+        attr_writer :jira_client
+
+        # Initialize.
+        #
+        # config - Speedflow::Plugin::Jira::Configuration instance.
+        # prompt - Speedflow::Plugin::Jira::Prompt instance.
+        #
+        # Examples
+        #
+        #    Client.new({}, Speedflow::Plugin::Jira::Prompt.new)
+        #    # => <Speedflow::Plugin::Jira::Client>
+        #
+        # Returns nothing.
+        def initialize(config, prompt)
+          @config = config
+          @prompt = prompt
+        end
+
+        # Public: Search issue.
+        #
+        # project - Project name.
+        # title   - Issue title.
+        #
+        # Returns Hash of issue.
+        def search_issue(project, title)
+          safe do
+            jira_client
+              .Issue.jql("PROJECT = \"#{project}\" AND text ~ \"#{title}\"")
+          end
+        end
+
+        # Public: Create issue.
+        #
+        # project_key   - Project key.
+        # title         - Title (summary).
+        # issue_type_id - Issue type (Fixnum).
+        #
+        # Returns Hash of issue.
+        def create_issue(project_key, title, issue_type_id)
+          safe do
+            issue = jira_client.Issue.build
+            data = IssueFormatter.to_create(project_key, title, issue_type_id)
+            issue.save!(data)
+            issue.fetch
+          end
+        end
+
+        # Public: Update issue.
+        #
+        # issue_key     - Key of issue.
+        # assignee_name - Assignee name.
+        #
+        # Returns Hash of issue.
+        def update_issue_assignee(issue_key, assignee_name)
+          safe do
+            issue = jira_client.Issue.find(issue_key)
+            data = IssueFormatter.to_assignee(assignee_name)
+            issue.save!(data)
+          end
+        end
+
+        # Public: Update issue transition.
+        #
+        # issue_key     - Key of issue.
+        # transition_id - Transition ID.
+        #
+        # Returns Hash of issue.
+        def update_issue_transition(issue_key, transition_id)
+          safe do
+            issue = jira_client.Issue.find(issue_key)
+            issue.transitions.build.save!(transition: transition_id)
+          end
+        end
+
+        # Public: Jira project.
+        #
+        # project_key - Project key.
+        #
+        # Returns JIRA::Resource.Project.
+        def project(project_key)
+          safe { jira_client.Project.find(project_key) }
+        end
+
+        # Public: Jira projects.
+        #
+        # Returns Hash of projects.
+        def projects
+          safe { jira_client.Project.all }
+        end
+
+        # Public: Jira issue transitions.
+        #
+        # issue_key - Issue key.
+        #
+        # Returns Hash of transitions.
+        def issue_trans(issue_key)
+          safe do
+            issue = jira_client.Issue.find(issue_key, expand: 'transitions')
+            issue.transitions
+          end
+        end
+
+        # Public: Jira issue types.
+        #
+        # Returns Hash of issue types.
+        def issue_types
+          safe { jira_client.Issuetype.all }
+        end
+
+        # Public: Safe process JIRA action.
+        #
+        # Returns nothing.
+        def safe
+          yield
+        rescue ::JIRA::HTTPError => exception
+          prompt.error 'Jira errors'
+          prompt.errors exception
+          abort
+        rescue ::URI::InvalidURIError
+          prompt.error 'Invalid URL'
+          abort
+        end
+
+        # Public: Jira client.
+        #
+        # Returns JIRA::Client instance.
+        def jira_client
+          @jira_client ||= ::JIRA::Client.new(@config.auth)
+        end
+
+        # Public: Prompt.
+        #
+        # Returns ::Speedflow::Plugin::Jira::Prompt instance.
+        def prompt
+          @prompt ||= ::Speedflow::Plugin::Jira::Prompt.new
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/jira/configuration.rb

@@ -0,0 +1,84 @@
+module Speedflow
+  module Plugin
+    module Jira
+      # Jira Configuration
+      class Configuration
+        CONFIG_KEY = '_config'.freeze
+        PLUGIN_KEY = 'jira'.freeze
+
+        # Initialize.
+        #
+        # arguments - Hash of arguments.
+        #
+        # Examples
+        #
+        #    Configuration.new({})
+        #    # => <Speedflow::Plugin::Jira::Configuration>
+        #
+        # Returns nothing.
+        def initialize(arguments)
+          @arguments = arguments
+        end
+
+        # Public: Auth configuration.
+        #
+        # Returns Hash of auth configuration.
+        def auth
+          {
+            username:     by_config('username'),
+            password:     by_config('password'),
+            site:         by_config('site'),
+            context_path: by_config('context_path', '/'),
+            auth_type:    by_config('auth_type', :basic),
+            read_timeout: by_config('read_timeout', 120)
+          }
+        end
+
+        # Public: Get a specific config.
+        #
+        # key           - Key of config.
+        # default_value - Default value.
+        #
+        # Returns value of config key.
+        def by_config(key, default_value = '')
+          if @arguments.key?(CONFIG_KEY) &&
+             @arguments[CONFIG_KEY].key?(PLUGIN_KEY)
+            config = @arguments[CONFIG_KEY][PLUGIN_KEY]
+          end
+          config.key?(key) ? config[key] : default_value
+        end
+
+        # Public: Get an input config by key.
+        #
+        # key           - Key of config.
+        # default_value - Default value.
+        #
+        # Returns value of input config key.
+        def by_input(key, default_value = '')
+          if @arguments.key?(key)
+            @arguments[key]['value'].to_s
+          else
+            default_value
+          end
+        end
+
+        # Public: Get an input config by key but required.
+        #
+        # key           - Key of config.
+        # default_value - Default value.
+        #
+        # Returns value of input config key or Exception.
+        def by_required_input(key, default_value = '')
+          value = by_input(key, default_value)
+
+          # TODO: Improve communication with core for errors
+          if by_input(key).empty?
+            raise Exception, "Required value for '#{key}'."
+          end
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/jira/formatter/issue_formatter.rb

@@ -0,0 +1,43 @@
+module Speedflow
+  module Plugin
+    module Jira
+      # Formatter
+      module Formatter
+        # Issue formatter
+        module IssueFormatter
+          # Public: To create issue.
+          #
+          # project_key   - Project Key.
+          # title         - Issue title.
+          # issue_type_id - Issue type ID.
+          #
+          # Returns Hash of fields.
+          def self.to_create(project_key, title, issue_type_id)
+            {
+              'fields' => {
+                'project'   => { 'key' => project_key.to_s },
+                'summary'   => title.to_s,
+                'issuetype' => { 'id' => issue_type_id.to_s }
+              }
+            }
+          end
+
+          # Public: To assignee.
+          #
+          # assignee_name - Assignee name.
+          #
+          # Returns Hash of fields.
+          def self.to_assignee(assignee_name)
+            {
+              'fields' => {
+                'assignee' => {
+                  'name' => assignee_name.to_s
+                }
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end