speedflow-plugin-jira 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2544df82452f45b75245c0cc92d952093f7c836
-  data.tar.gz: 3cfa5a29a39d3a2382981d1709c58bef1d1b2bd6
+  metadata.gz: 2ded6d3751a92f792b132a9b63939ac5d5d6a32e
+  data.tar.gz: 2e2cd3cf5c9b6a8653a75bcb2013f1398787488d
 SHA512:
-  metadata.gz: 673bebeb4cc4afdad00ee2639d51b9f04115e0d113d619c622f68e12e7bf1e6d69f28a00699c092439e4dcedc4b85bdeacc281658eb60b54df79e6c01a824ef9
-  data.tar.gz: 08f4c0fdad78d81b35244b6a47ef8a4cf30a16dbb10e07ea5d9331f5ea62f082d8174d31dd7eb02820f09239241e42cdcefcf9d3d385c08d945e678e51ac8a47
+  metadata.gz: aa25d85bbb3f7839c314fb26984e066d643677649f3e74e85db43b6d40a769c3f1d20f6ff2178d0589349771ef83557476ab3e56b5a20980e8e3d456d071c7f7
+  data.tar.gz: 689d420053f41dfc90300795cf95a427d82927e4d6d973d51240dbd3735f62f334fdae9a8048f1ef0dd4452c833cbfaca0aef17c43e54c655d8d58e70f8de46a

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

@@ -56,6 +56,7 @@ module Speedflow
             data = IssueFormatter.to_create(project_key, title, issue_type_id)
             issue.save!(data)
             issue.fetch
+            issue
           end
         end
 
@@ -121,6 +122,31 @@ module Speedflow
           safe { jira_client.Issuetype.all }
         end
 
+        # Public: Issue link.
+        #
+        # issue_key - Issue key.
+        #
+        # Returns issue link.
+        def issue_link(issue_key)
+          issue_link = @config.by_config('site')
+          issue_link << @config.by_config('context_path')
+          issue_link << '/browse/'
+          issue_link << issue_key
+          issue_link
+        end
+
+        # Public: Issue output formatter.
+        #
+        # issue - ::JIRA::Resource::Issue
+        #
+        # Returns Hash.
+        def issue_output_format(issue)
+          { 'issue' => {
+            'key'     => issue.key,
+            'summary' => issue.fields['summary'],
+            'url'     => issue_link(issue.key) } }
+        end
+
         # Public: Safe process JIRA action.
         #
         # Returns nothing.
@@ -137,16 +163,30 @@ module Speedflow
 
         # Public: Jira client.
         #
-        # Returns JIRA::Client instance.
+        # Returns <::JIRA::Client> instance.
         def jira_client
-          @jira_client ||= ::JIRA::Client.new(@config.auth)
+          @jira_client ||= ::JIRA::Client.new(auth)
+        end
+
+        # Public: Auth hash for JIRA.
+        #
+        # Returns hash of auth.
+        def auth
+          {
+            username:     @config.by_config('username'),
+            password:     @config.by_config('password'),
+            site:         @config.by_config('site'),
+            context_path: @config.by_config('context_path', ''),
+            auth_type:    @config.by_config('auth_type', :basic).to_sym,
+            read_timeout: @config.by_config('read_timeout', 120).to_i
+          }
         end
 
         # Public: Prompt.
         #
-        # Returns ::Speedflow::Plugin::Jira::Prompt instance.
+        # Returns <::Speedflow::Plugin::Prompt> instance.
         def prompt
-          @prompt ||= ::Speedflow::Plugin::Jira::Prompt.new
+          @prompt ||= ::Speedflow::Plugin::Prompt.new
         end
       end
     end

data/lib/speedflow/plugin/jira/{plugin_core.rb → plugin.rb}

@@ -1,85 +1,91 @@
 module Speedflow
   module Plugin
     module Jira
-      # Plugin core
-      class PluginCore
-        # @return [Prompt] Plugin prompt.
-        attr_writer :prompt
-
+      # JIRA Plugin
+      class Plugin < Speedflow::Plugin::Abstract
         # @return [Client] Plugin client.
         attr_writer :client
 
-        # @return [Config] Plugin config.
-        attr_writer :config
+        # @return [Prompt] Plugin prompt.
+        attr_writer :prompt
 
-        # Initialize.
+        # Public: Constructor
         #
-        # arguments - Hash of arguments.
+        # config - Speedflow::Plugin::Configuration object.
+        # prompt - Speedflow::Plugin::Prompt object.
         #
         # Examples
         #
-        #    Plugin.new({})
-        #    # => <Speedflow::Plugin::Jira::PluginCore>
+        #    Manager.new(
+        #      <Speedflow::Plugin::Configuration.new({})>,
+        #      <Speedflow::Plugin::Prompt.new>)
+        #    # => <Speedflow::Plugin::Abstract>
         #
         # Returns nothing.
-        def initialize(arguments)
-          @arguments = arguments
+        def initialize(config, _)
+          super(config, Prompt.new)
         end
 
         # Public: Create issue.
         #
         # Returns Hash of issue.
         def action_create_issue
-          title = config.by_required_input('title')
+          title = @config.by_required_input('title')
 
-          project_key = config.by_input('project')
-          project_key = prompt.project(client.projects) if project_key.empty?
+          project_key = @config.by_input('project')
+          project_key = @prompt.project(client.projects) if project_key.empty?
 
-          issue_type_id = config.by_input('type')
+          issue_type_id = @config.by_input('type')
           if issue_type_id.empty?
-            issue_type_id = prompt.issue_type(client.issue_types)
+            issue_type_id = @prompt.issue_type(client.issue_types)
           end
 
-          client.create_issue(project_key, title, issue_type_id)
+          issue = client.create_issue(project_key, title, issue_type_id)
+
+          client.issue_output_format(issue)
         end
 
         # Public: Search issue.
         #
-        # Returns Hash of issue.
+        # Returns Hash.
         def action_search_issue
           limit   = config.by_input('limit', 20)
           project = config.by_input('project')
           project = prompt.project(client.projects) if project.empty?
 
-          issue_id = prompt.issue do |title|
+          issue_key = prompt.issue do |title|
             client.search_issue(project, title).take(limit.to_i)
           end
 
-          issue_id
+          prompt.ok "[JIRA] Issue found: #{issue_key}"
+
+          { 'issue' => { 'key' => issue_key } }
         end
 
         # Public: Change issue assignee.
         #
-        # Returns Hash of assignee.
+        # Returns Hash.
         def action_change_issue_assignee
-          issue_key     = config.by_input('issue')
-          assignee_name = config.by_input('assignee')
+          issue_key     = @config.by_input('issue')
+          assignee_name = @config.by_input('assignee')
 
-          issue_key = action_search_issue if issue_key.empty?
+          issue_key = action_search_issue['issue']['key'] if issue_key.empty?
 
           client.update_issue_assignee(issue_key, assignee_name)
 
           prompt.ok "[JIRA] Issue assignee changed to: #{assignee_name}"
+
+          { 'issue' => { 'key' => issue_key, 'assignee' => assignee_name } }
         end
 
         # Public: Change issue transition.
         #
-        # Returns Hash of assignee.
+        # Returns Hash.
         def action_change_issue_transition
           issue_key     = config.by_input('issue')
           transition_id = config.by_input('transition')
 
-          issue_key = action_search_issue if issue_key.empty?
+          issue_key = action_search_issue['issue']['key'] if issue_key.empty?
 
           if transition_id.empty?
             transition_id = prompt.transition(client.issue_trans(issue_key))
@@ -88,13 +94,8 @@ module Speedflow
           client.update_issue_transition(issue_key, transition_id)
 
           prompt.ok "[JIRA] Issue transition changed to: #{transition_id}"
-        end
 
-        # Public: Plugin configuration.
-        #
-        # Returns Configuration instance.
-        def config
-          @config ||= Configuration.new(@arguments)
+          { 'issue' => { 'key' => issue_key, 'transition' => transition_id } }
         end
 
         # Public: Plugin client.
@@ -103,13 +104,6 @@ module Speedflow
         def client
           @client ||= Client.new(@config, @prompt)
         end
-
-        # Public: Plugin prompt.
-        #
-        # Returns Prompt instance.
-        def prompt
-          @prompt ||= Prompt.new
-        end
       end
     end
   end

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

@@ -5,8 +5,8 @@ module Speedflow
   module Plugin
     module Jira
       # Plugin prompt
-      class Prompt # < TTY::Prompt
-        # @return [TTY::Prompt] TTY::Prompt.
+      class Prompt
+        # @return [<::Speedflow::Plugin::Prompt>] Plugin prompt.
         attr_writer :prompt
 
         # Public: Prompt title.
@@ -69,8 +69,7 @@ module Speedflow
             end
           end
 
-          issue(&issues) if sel_issue == :retry
-          ok "[JIRA] Issue found: #{sel_issue}" unless sel_issue == :retry
+          sel_issue = issue(&issues) if sel_issue == :retry
 
           sel_issue
         end
@@ -99,11 +98,11 @@ module Speedflow
           prompt.send(method, *args, &block)
         end
 
-        # Public: TTY prompt.
+        # Public: Prompt.
         #
-        # Returns ::TTY::Prompt instance.
+        # Returns <::Speedflow::Plugin::Prompt> instance.
         def prompt
-          @prompt ||= ::TTY::Prompt.new
+          @prompt ||= ::Speedflow::Plugin::Prompt.new
         end
       end
     end

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

@@ -1,7 +1,7 @@
 module Speedflow
   module Plugin
     module Jira
-      VERSION = '0.2.2'.freeze
+      VERSION = '0.3.0'.freeze
     end
   end
 end

data/lib/speedflow/plugin/jira.rb

@@ -1,47 +1,6 @@
+require 'speedflow'
 require 'speedflow/plugin/jira/version'
 require 'speedflow/plugin/jira/formatter/issue_formatter'
-require 'speedflow/plugin/jira/plugin_core'
+require 'speedflow/plugin/jira/plugin'
 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/spec/speedflow/plugin/jira/client_spec.rb

@@ -1,13 +1,15 @@
 require 'spec_helper'
 
 describe Speedflow::Plugin::Jira::Client do
+  let(:config_site) { 'https://xxx.atlassian.net' }
   let(:args) do
     title    = { 'value' => 'test' }
     assignee = { 'default' => 'julien.breux' }
-    { 'title' => title, 'assignee' => assignee }
+    config   = { 'jira' => { 'site' => config_site } }
+    { 'title' => title, 'assignee' => assignee, '_config' => config }
   end
   let(:config) do
-    ::Speedflow::Plugin::Jira::Configuration.new(args)
+    ::Speedflow::Plugin::Configuration.new(args, 'jira')
   end
   let(:prompt) do
     prompt = ::Speedflow::Plugin::Jira::Prompt.new
@@ -87,6 +89,21 @@ describe Speedflow::Plugin::Jira::Client do
     client.issue_trans('T-1')
   end
 
+  it '.issue_link' do
+    expect(client.issue_link('T-1'))
+      .to eq config_site
+  end
+
+  it '.issue_output_format' do
+    issue = double(key: 'T-1', fields: { 'summary' => 'Test' })
+
+    expected_hash = {
+      'issue' => { 'key' => 'T-1', 'summary' => 'Test',
+                   'url' => "#{config_site}/browse/T-1" } }
+    expect(client.issue_output_format(issue))
+      .to eq expected_hash
+  end
+
   it '.safe' do
     allow(client.prompt)
       .to receive(:error).with('Invalid URL')
@@ -108,4 +125,18 @@ describe Speedflow::Plugin::Jira::Client do
     end
     e.to raise_error(SystemExit)
   end
+
+  it '.auth' do
+    expected_hash = {
+      auth_type:    :basic,
+      context_path: '',
+      password:     '',
+      read_timeout: 120,
+      site:         'https://xxx.atlassian.net',
+      username:     ''
+    }
+
+    expect(client.auth)
+      .to eq expected_hash
+  end
 end

data/spec/speedflow/plugin/jira/{plugin_core_spec.rb → plugin_spec.rb}

@@ -1,9 +1,8 @@
 require 'spec_helper'
 
-describe Speedflow::Plugin::Jira::PluginCore do
+describe Speedflow::Plugin::Jira::Plugin do
   let(:plugin) do
-    plugin = ::Speedflow::Plugin::Jira::PluginCore.new({})
-    plugin.config = double
+    plugin = ::Speedflow::Plugin::Jira::Plugin.new(double, double)
     plugin.prompt = double
     plugin.client = double
     plugin
@@ -32,11 +31,26 @@ describe Speedflow::Plugin::Jira::PluginCore do
       .with('3')
       .and_return('3')
 
+    allow(plugin.client)
+      .to receive(:issue_link)
+      .with('T-1')
+      .and_return('xxx')
+
+    return_object = double(key: 'T-1', fields: { 'summary' => 'Test' })
     allow(plugin.client)
       .to receive(:create_issue)
       .with('T', 'Test', '3')
+      .and_return(return_object)
 
-    plugin.action_create_issue
+    expected_hash = { 'foo' => 'bar' }
+
+    allow(plugin.client)
+      .to receive(:issue_output_format)
+      .with(return_object)
+      .and_return(expected_hash)
+
+    expect(plugin.action_create_issue)
+      .to eq expected_hash
   end
 
   it '.action_search_issue' do
@@ -53,12 +67,18 @@ describe Speedflow::Plugin::Jira::PluginCore do
       .to receive(:issue)
       .and_yield('test')
 
+    allow(plugin.prompt)
+      .to receive(:ok)
+      .with('[JIRA] Issue found: T-1')
+
     allow(plugin.client)
       .to receive(:search_issue)
       .with('T', 'test')
       .and_return(double(take: 'T-1'))
 
-    expect(plugin.action_search_issue).to eq 'T-1'
+    expected_hash = { 'issue' => { 'key' => 'T-1' } }
+    expect(plugin.action_search_issue)
+      .to eq expected_hash
   end
 
   it '.action_change_issue_assignee' do
@@ -80,7 +100,10 @@ describe Speedflow::Plugin::Jira::PluginCore do
       .with('T-1', 'julien.breux')
       .and_return(double(take: 'T-1'))
 
-    plugin.action_change_issue_assignee
+    expected_hash = {
+      'issue' => { 'key' => 'T-1', 'assignee' => 'julien.breux' } }
+    expect(plugin.action_change_issue_assignee)
+      .to eq expected_hash
   end
 
   it '.action_change_issue_transition' do
@@ -110,6 +133,8 @@ describe Speedflow::Plugin::Jira::PluginCore do
       .to receive(:ok)
       .with('[JIRA] Issue transition changed to: 1')
 
-    plugin.action_change_issue_transition
+    expected_hash = { 'issue' => { 'key' => 'T-1', 'transition' => '1' } }
+    expect(plugin.action_change_issue_transition)
+      .to eq expected_hash
   end
 end

data/spec/speedflow/plugin/jira_spec.rb

@@ -1,19 +1,7 @@
 require 'spec_helper'
 
 describe Speedflow::Plugin::Jira do
-  let(:plugin) do
-    double(new: double(action_create_issue: nil))
-  end
-
   it 'has a version number' do
     expect(Speedflow::Plugin::Jira::VERSION).not_to be nil
   end
-
-  it 'has an action catcher' do
-    expect { Speedflow::Plugin::Jira.action_lol }.to raise_error(NoMethodError)
-
-    Speedflow::Plugin::Jira.plugin = plugin
-
-    expect(Speedflow::Plugin::Jira.action_create_issue).to eq nil
-  end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: speedflow-plugin-jira
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Julien Breux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jira-ruby
+  name: speedflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: jira-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.17
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,16 +178,14 @@ files:
 - lib/speedflow-plugin-jira.rb
 - lib/speedflow/plugin/jira.rb
 - lib/speedflow/plugin/jira/client.rb
-- lib/speedflow/plugin/jira/configuration.rb
 - lib/speedflow/plugin/jira/formatter/issue_formatter.rb
-- lib/speedflow/plugin/jira/plugin_core.rb
+- lib/speedflow/plugin/jira/plugin.rb
 - lib/speedflow/plugin/jira/prompt.rb
 - lib/speedflow/plugin/jira/version.rb
 - spec/spec_helper.rb
 - spec/speedflow/plugin/jira/client_spec.rb
-- spec/speedflow/plugin/jira/configuration_spec.rb
 - spec/speedflow/plugin/jira/formatter/issue_formatter_spec.rb
-- spec/speedflow/plugin/jira/plugin_core_spec.rb
+- spec/speedflow/plugin/jira/plugin_spec.rb
 - spec/speedflow/plugin/jira/prompt_spec.rb
 - spec/speedflow/plugin/jira_spec.rb
 homepage: https://github.com/speedflow/speedflow-plugin-jira

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

@@ -1,84 +0,0 @@
-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/spec/speedflow/plugin/jira/configuration_spec.rb

@@ -1,53 +0,0 @@
-require 'spec_helper'
-
-describe Speedflow::Plugin::Jira::Configuration do
-  let(:config) do
-    title       = { 'value' => 'hello' }
-    num         = { 'value' => 3 }
-    jira_config = { 'username' => 'foo', 'password' => 'bar', 'site' => 'baz' }
-    config      = { 'jira' => jira_config }
-    args        = { 'num' => num, 'title' => title, '_config' => config }
-    Speedflow::Plugin::Jira::Configuration.new(args)
-  end
-
-  it '.by_config' do
-    expect(config.by_config('username', 'default'))
-      .to eq 'foo'
-  end
-
-  it '.by_input' do
-    expect(config.by_input('title', 'default'))
-      .to eq 'hello'
-
-    expect(config.by_input('num'))
-      .to eq '3'
-
-    expect(config.by_input('notitle', 'default'))
-      .to eq 'default'
-  end
-
-  it '.by_required_input' do
-    expect(config.by_required_input('title', 'default'))
-      .to eq 'hello'
-
-    expect { config.by_required_input('notitle') }
-      .to raise_error(Exception)
-
-    expect { config.by_required_input('nonotitle', 'default') }
-      .to raise_error(Exception)
-  end
-
-  it '.auth' do
-    returned_hash = {
-      auth_type:    :basic,
-      context_path: '/',
-      password:     'bar',
-      read_timeout: 120,
-      site:         'baz',
-      username:     'foo'
-    }
-
-    expect(config.auth)
-      .to eq returned_hash
-  end
-end