terjira 0.1.0

data/lib/terjira.rb

@@ -0,0 +1,38 @@
+require 'pry'
+require_relative 'terjira/ext/jira_ruby'
+require_relative 'terjira/ext/tty_prompt'
+require 'terjira/version'
+require 'thor'
+
+Dir[File.dirname(__FILE__) + '/terjira/*_cli.rb'].each { |f| require f }
+
+ENV['PAGER'] ||= 'less'
+
+# http://willschenk.com/making-a-command-line-utility-with-gems-and-thor/
+module Terjira
+  # Main CLI
+  class CLI < Thor
+    desc 'login', 'login your Jira'
+    def login
+      Client::Base.expire_auth_options
+      Client::Base.build_auth_options
+    end
+
+    desc 'logout', 'logout your Jira'
+    def logout
+      Client::Base.expire_auth_options
+    end
+
+    desc 'project SUBCOMMAND ...ARGS', 'Manage proejcts'
+    subcommand 'project', ProjectCLI
+
+    desc 'board SUBCOMMAND ...ARGS', 'Manage boards'
+    subcommand 'board', BoardCLI
+
+    desc 'sprint SUBCOMMAND ...ARGS', 'Manage sprints'
+    subcommand 'sprint', SprintCLI
+
+    desc 'issue SUBCOMMAND ...ARGS', 'Manage issues'
+    subcommand 'issue', IssueCLI
+  end
+end

data/lib/terjira/base_cli.rb

@@ -0,0 +1,36 @@
+require 'thor'
+
+require_relative 'option_supportable'
+Dir[File.dirname(__FILE__) + "/presenters/*.rb"].each { |f| require f }
+
+module Terjira
+  module Client
+    %w[Base Field Project Board Sprint Issue User Status Resolution Priority RapidView Agile].each do |klass|
+      autoload klass, "terjira/client/#{klass.gsub(/(.)([A-Z](?=[a-z]))/,'\1_\2').downcase}"
+    end
+  end
+
+  class BaseCLI < Thor
+    include OptionSupportable
+
+    include CommonPresenter
+    include IssuePresenter
+    include ProjectPresenter
+    include BoardPresenter
+    include SprintPresenter
+
+    def self.banner(command, namespace = nil, subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
+
+    def self.subcommand_prefix
+      self.name.gsub(%r{.*::}, '').gsub("CLI", '').gsub(%r{^[A-Z]}) { |match| match[0].downcase }.gsub(%r{[A-Z]}) { |match| "-#{match[0].downcase}" }
+    end
+
+    no_commands do
+      def current_username
+        @current_username ||= Client::Base.username
+      end
+    end
+  end
+end

data/lib/terjira/board_cli.rb

@@ -0,0 +1,12 @@
+require_relative 'base_cli'
+
+module Terjira
+  class BoardCLI < BaseCLI
+    desc "list(ls)", "list all boards"
+    map ls: :list
+    def list
+      boards = Client::Board.all
+      render_boards_summary(boards.sort_by { |b| b.id })
+    end
+  end
+end

data/lib/terjira/client/agile.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class Agile < Base
+      class << self
+        delegate :all, :get_sprints, :backlog_issues, to: :resource
+
+        def project_by_board(board_id)
+          resp = agile_api_get("board/#{board_id}/project")
+        end
+
+        def boards
+          all["values"]
+        end
+
+        def sprints(board_id, options = {})
+          sprints = get_sprints(board_id)["values"]
+          sprints.sort_by do |sprint|
+            if sprint["state"] == 'active'
+              [0, sprint["id"]]
+            elsif sprint["state"] == 'future'
+              [1, sprint["id"]]
+            elsif sprint["state"] == 'closed'
+              [2, sprint["id"] * -1]
+            else
+              [3, 0]
+            end
+          end
+        end
+
+        def backlog_issues(board_id)
+          get_backlog_issues(board_id)
+        end
+
+        def sprint_issues(board_id)
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/auth_option_builder.rb

@@ -0,0 +1,42 @@
+require 'tty-prompt'
+require 'terjira/utils/file_cache'
+
+module Terjira
+  module Client
+    module AuthOptionBuilder
+      AUTH_CACHE_KEY = 'auth'.freeze
+
+      def build_auth_options(cache_key = AUTH_CACHE_KEY)
+        auth_file_cache.fetch cache_key do
+          build_auth_options_by_tty
+        end
+      end
+
+      def build_auth_options_by_cached(cache_key = AUTH_CACHE_KEY)
+        auth_file_cache.get(cache_key)
+      end
+
+      def expire_auth_options(cache_key = AUTH_CACHE_KEY)
+        auth_file_cache.delete(cache_key)
+      end
+
+      def build_auth_options_by_tty
+        puts 'Login will be required...'
+        prompt = TTY::Prompt.new
+
+        result = prompt.collect do
+          key(:site).ask('Site:', required: true)
+          key(:context_path).ask('Context path:', default: '')
+          key(:username).ask('Username:', required: true)
+          key(:password).mask('Password:', required: true)
+        end
+        result[:auth_type] = :basic
+        result
+      end
+
+      def auth_file_cache
+        @auth_file_cache ||= Terjira::FileCache.new('profile')
+      end
+    end
+  end
+end

data/lib/terjira/client/base.rb

@@ -0,0 +1,72 @@
+require_relative 'jql_query_builer'
+require_relative 'auth_option_builder'
+
+module Terjira
+  module Client
+    # Abstract class to delegate jira-ruby resource class
+    class Base
+      extend JQLQueryBuilder
+      extend AuthOptionBuilder
+
+      DEFAULT_CACHE_SEC = 60
+      DEFAULT_API_PATH = "/rest/api/2/"
+      AGILE_API_PATH = "/rest/agile/1.0/"
+
+      class << self
+
+        delegate :build, to: :resource
+
+        def client
+          @@client ||= JIRA::Client.new(build_auth_options)
+        end
+
+        def resource
+          client.send(class_name) if client.respond_to?(class_name)
+        end
+
+        def username
+          client.options[:username]
+        end
+
+        def class_name
+          self.to_s.split("::").last
+        end
+
+        def cache(options = {})
+          options[:expiry] ||= DEFAULT_CACHE_SEC
+          @cache ||= Terjira::FileCache.new(class_name, expiry)
+        end
+
+        # define `#api_get(post, put, delete)` and `#agile_api_get(post, put, delete)`
+        { DEFAULT_API_PATH => "api_",
+          AGILE_API_PATH => "agile_api_"
+        }.each do |url_prefix, method_prefix|
+
+          [:get, :delete].each do |http_method|
+            method_name = "#{method_prefix}#{http_method}"
+            define_method(method_name) do |path, params = {}, headers = {}|
+              url = url_prefix + path
+              if params.present?
+                params.reject! { |k, v| v.blank? }
+                url += "?#{URI.encode_www_form(params)}"
+              end
+              parse_body client.send(http_method, url, headers)
+            end
+          end
+
+          [:post, :put].each do |http_method|
+            method_name = "#{method_prefix}#{http_method}"
+            define_method(method_name) do |path, body = '', headers = {}|
+              url = url_prefix + path
+              parse_body client.send(http_method, url, body, headers)
+            end
+          end
+        end
+
+        def parse_body(response)
+          JSON.parse(response.body) if response.body.present?
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/board.rb

@@ -0,0 +1,20 @@
+module Terjira
+  module Client
+    class Board < Base
+      class << self
+        delegate :build, to: :resource
+
+        def all(options = {})
+          params = options.slice(:type)
+          resp = agile_api_get("board", params)
+          resp["values"].map { |value| build(value) }
+        end
+
+        def find(board_id)
+          resp = agile_api_get("board/#{board_id}")
+          self.build(resp)
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/field.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class Field < Base
+      class << self
+        def all
+          @all_fields ||= resource.all
+        end
+
+        def epic_name
+          all.find { |field| field.name == "Epic Name" }
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/issue.rb

@@ -0,0 +1,110 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class Issue < Base
+      class << self
+        delegate :build, :find, to: :resource
+        ISSUE_JQL_KEYS = [:sprint, :assignee, :reporter, :project, :issuetype, :priority, :status, :statusCategory]
+
+        def all(options = {})
+          opts = options.slice(*ISSUE_JQL_KEYS)
+          return resource.all if options.blank?
+          max_results = options.delete(:max_results) || 500
+          resource.jql(build_jql_query(opts), max_results: max_results)
+        end
+
+        def find(issue, options = {})
+          resp = api_get("issue/#{issue.key_value}", options)
+          build(resp)
+        end
+
+        def current_my_issues
+          jql("assignee = #{self.key_value} AND statusCategory != 'Done'")
+        end
+
+        def assign(issue, assignee)
+          body = { name: assignee.key_value }.to_json
+          api_put("issue/#{issue.key_value}/assignee", body)
+        end
+
+        def write_comment(issue, message)
+          resp = api_post("issue/#{issue.key_value}/comment", { body: message }.to_json)
+          find(issue)
+        end
+
+        def create(options = {})
+          params = extract_to_fields_params(options)
+          if transition_param = extract_to_transition_param(options)
+            params.merge!(transition_param)
+          end
+
+          resp = api_post "issue", params.to_json
+          result_id = resp["id"]
+          find(result_id)
+        end
+
+        def update(issue, options = {})
+          params = extract_to_fields_params(options)
+          api_put "issue/#{issue.key_value}", params.to_json
+          find(issue)
+        end
+
+        def trans(issue, options = {})
+          params = extract_to_transition_param(options)
+          params.merge!(extract_to_update_params(options))
+          params.merge!(extract_to_fields_params(options))
+          api_post "issue/#{issue.key_value}/transitions", params.to_json
+          find(issue)
+        end
+
+        private
+
+        def extract_to_update_params(options = {})
+          params = {}
+          if comment = options.delete(:comment)
+            params[:comment] = [{ add: { body: comment } }]
+          end
+          { update: params }
+        end
+
+        def extract_to_transition_param(options = {})
+          transition = options.delete(:status)
+          transition ||= options.delete(:transition)
+          return unless transition
+          { transition: convert_param_key_value_hash(transition) }
+        end
+
+        def extract_to_fields_params(options = {})
+          opts = options.dup
+          params = {}
+
+          custom_fields = options.keys.select { |k| k.to_s =~ /^customfield/ }
+          (custom_fields + [:summary, :description]).each do |k, v|
+            params[k] = opts.delete(k) if opts.key?(k)
+          end
+
+          if opts.key?(:project)
+            params[:project] = { key: opts.delete(:project).key_value }
+          end
+
+          opts.each do |k, v|
+            params[k] = convert_param_key_value_hash(v)
+          end
+          { fields: params }
+        end
+
+        def convert_param_key_value_hash(resource)
+          if resource.respond_to? :key_with_key_value
+            okey, ovalue = resource.key_with_key_value
+            { okey => ovalue }
+          elsif resource =~ /^\d+$/
+            { id: resource.key_value }
+          else
+            { name: resource.key_value }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/jql_query_builer.rb

@@ -0,0 +1,25 @@
+module Terjira
+  module Client
+    module JQLQueryBuilder
+      JQL_KEYS = %w(board sprint assignee issuetype priority project status statusCategory).freeze
+
+      def build_jql_query(options = {})
+        q_options = options.inject({}) do |memo,(k,v)|
+          memo[k.to_s] = v
+          memo
+        end.slice(*JQL_KEYS)
+
+        query = q_options.map do |key, value|
+          if value.is_a? Array
+            values = value.map { |v| "\"#{v.key_value}\""}.join(",")
+            "#{key} IN (#{values})"
+          else
+            "#{key}=#{value.key_value}"
+          end
+        end.reject(&:blank?).join(" AND ")
+
+        query
+      end
+    end
+  end
+end

data/lib/terjira/client/priority.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class Priority < Base
+      class << self
+        def all
+          resp = api_get "priority"
+          resp.map { |priority| build(priority) }
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/project.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    # Project Client Baseed on jira-ruby gem
+    class Project < Base
+      class << self
+        delegate :all, :find, :fetch, to: :resource
+
+        def all
+          expand = %w(description lead issueTypes url projectKeys)
+          resp = api_get 'project', expand: expand.join(',')
+          resp.map { |project| build(project) }
+        end
+
+        def all_by_board(board)
+          resp = agile_api_get "board/#{board.key_value}/project"
+          resp['values'].map do |project|
+            build(project)
+          end
+        end
+      end
+    end
+  end
+end