lazylead 0.1.0

data/lib/lazylead/system/synced.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+module Lazylead
+  # Thread-save ticketing system.
+  class Synced
+    def initialize(sys)
+      @mutex = Mutex.new
+      @sys = sys
+    end
+
+    # @todo #/DEV Unit tests for 'issues' function
+    #
+    def issues(jql)
+      @mutex.synchronize do
+        @sys.issues jql
+      end
+    end
+  end
+end

data/lib/lazylead/task/alert.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+require_relative "../log"
+require_relative "../email"
+require_relative "../version"
+require_relative "../postman"
+
+module Lazylead
+  #
+  # Email alerts about particular issue(s).
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  module Task
+    #
+    # Notify particular person about tickets based on pre-defined html template.
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - prepare email based on predefined template (*.erb)
+    #  - send the required notifications pre-defined "addressee".
+    class Alert
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        postman.send opts.merge(tickets: sys.issues(opts["sql"]))
+      end
+    end
+
+    #
+    # A task that sends notifications about issues to their assignees.
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - group all issues by assignee
+    #  - prepare email based on predefined template (*.erb)
+    #  - send the required notifications to each assignee
+    #
+    # The email message is sending to the assignee regarding all his/her issues,
+    #  not like one email per each issue.
+    class AssigneeAlert
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        sys.issues(opts["sql"])
+           .group_by(&:assignee)
+           .each do |a, t|
+          postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)
+        end
+      end
+    end
+
+    #
+    # A task that sends notifications about issues to their reporters.
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - group all issues by reporter
+    #  - prepare email based on predefined template (*.erb)
+    #  - send the required notifications to each reporter
+    #
+    # The email message is sending to the assignee regarding all his/her issues,
+    #  not like one email per each issue.
+    class ReporterAlert
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        sys.issues(opts["sql"])
+           .group_by(&:reporter)
+           .each do |a, t|
+          postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)
+        end
+      end
+    end
+  end
+end

data/lib/lazylead/task/confluence_ref.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+require "json"
+require "faraday"
+require_relative "../system/jira"
+require_relative "../log"
+require_relative "../confluence"
+
+module Lazylead
+  module Task
+    # The lazylead task which adds reference to Confluence page
+    #  in case if Confluence page was mentioned in issue comments.
+    # @todo #/DEV Support sub-task for link search. Potentially, the issue
+    #  might have sub-tasks where discussion ongoing.
+    class ConfluenceRef
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, _, opts)
+        confluences = confluences(opts)
+        return if confluences.empty?
+        sys.issues(opts["jql"])
+           .map { |i| Link.new(i, sys, confluences) }
+           .each(&:fetch_links)
+           .select(&:need_link?)
+           .each(&:add_link)
+      end
+
+      def confluences(opts)
+        return [] if opts["confluences"].nil? || opts["confluences"].blank?
+        JSON.parse(opts["confluences"], object_class: OpenStruct)
+            .map { |c| Confluence.new(c) }
+      end
+    end
+  end
+end

data/lib/lazylead/task/echo.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+module Lazylead
+  module Task
+    # Lazylead task which prints to STDOUT the current class name and team.
+    #
+    # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+    # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+    # License:: MIT
+    class Echo
+      def run(_, _, _)
+        self.class.to_s
+      end
+    end
+  end
+end

data/lib/lazylead/task/fix_version.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+require "date"
+require_relative "../system/jira"
+require_relative "../log"
+
+module Lazylead
+  module Task
+    # @todo #/DEV Each task should verify input arguments.
+    #  The common API should be provided for each task.
+    class FixVersion
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        allowed = opts["allowed"].split(",").map(&:strip).reject(&:blank?)
+        postman.send opts.merge(
+          versions: sys.issues(opts["jql"], expand: "changelog")
+                       .map { |i| Version.new(i, allowed) }
+                       .select(&:changed?)
+        )
+      end
+    end
+
+    # Instance of "Fix Version" field for the particular task.
+    class Version
+      attr_reader :issue
+
+      def initialize(issue, allowed)
+        @issue = issue
+        @allowed = allowed
+      end
+
+      # Gives true when last change of "Fix Version" field was done
+      #  by not authorized person.
+      def changed?
+        @allowed.none? do |a|
+          return false if last.nil?
+          a == last["author"]["name"]
+        end
+      end
+
+      # Detect details about last change of "Fix Version" to non-null value
+      def last
+        return @last if defined? @last
+        @last = issue.history
+                     .reverse
+                     .find do |h|
+          h["items"].any? do |i|
+            i["field"] == "Fix Version" && !i["to"].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lazylead/task/missing_comment.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+require_relative "../log"
+require_relative "../postman"
+
+module Lazylead
+  module Task
+    # A task which fetch issues by particular ticketing system query language
+    #  and find issues where comments has no expected text.
+    #
+    # Example:
+    #  you have a sub-task for demo session for your story;
+    #  demo session is recorded, placed to ftp;
+    #  nobody mentioned in comment the ftp location for recorded session.
+    # Such cases needs to be reported.
+    class MissingComment
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        opts["details"] = "text '#{opts['text']}'" if opts["details"].blank?
+        postman.send opts.merge(
+          comments: sys.issues(opts["jql"])
+                       .map { |i| Comments.new(i, sys) }
+                       .reject { |c| c.body? opts["text"] }
+        )
+      end
+    end
+  end
+end

data/lib/lazylead/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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.
+
+module Lazylead
+  VERSION = "0.1.0"
+end

data/lib/messages/due_date_expired.erb

@@ -0,0 +1,96 @@
+<html>
+<head>
+  <style>
+    /* CSS styles taken from https://github.com/yegor256/tacit */
+    th {
+      font-weight: 600
+    }
+
+    table tr {
+      border-bottom-width: 2.16px
+    }
+
+    table tr th {
+      border-bottom-width: 2.16px
+    }
+
+    table tr td, table tr th {
+      overflow: hidden;
+      padding: 5.4px 3.6px
+    }
+
+    a {
+      color: #275a90;
+      text-decoration: none
+    }
+
+    a:hover {
+      text-decoration: underline
+    }
+
+    * {
+      border: 0;
+      border-collapse: separate;
+      border-spacing: 0;
+      box-sizing: border-box;
+      margin: 0;
+      max-width: 100%;
+      padding: 0;
+      vertical-align: baseline;
+      font-family: system-ui, "Helvetica Neue", Helvetica, Arial, sans-serif;
+      font-size: 13px;
+      font-stretch: normal;
+      font-style: normal;
+      font-weight: 400;
+      line-height: 29.7px
+    }
+
+    html, body {
+      width: 100%
+    }
+
+    html {
+      height: 100%
+    }
+
+    body {
+      background: #fff;
+      color: #1a1919;
+      padding: 36px
+    }
+  </style>
+  <title>Expired due date</title>
+</head>
+<body>
+<p>Hi <%= addressee %>,</p>
+
+<p>The due date for these tasks is expired or seems to expire soon. Please plan
+  them accordingly or actualize the
+  <span style="font-weight:bold">"Due date"</span> field for the following
+  ticket(s):</p>
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Due date</th>
+    <th>Priority</th>
+    <th>Reporter</th>
+    <th>Summary</th>
+  </tr>
+  <% tickets.each do |ticket| %>
+    <tr>
+      <td><a href="<%= ticket.url %>"><%= ticket.key %></a></td>
+      <td><%= ticket.duedate %></td>
+      <td><%= ticket.priority %></td>
+      <td><%= ticket.reporter.name %></td>
+      <td><%= ticket.summary %></td>
+    </tr>
+  <% end %>
+</table>
+<p>In case you have no idea what date should be set - remove obsolete date or
+  ask your lead to fill it.</p>
+
+<p>Posted by
+  <a href="https://github.com/dgroup/lazylead">lazylead v<%= version %></a>.
+</p>
+</body>
+</html>