lazylead 0.1.0

data/lib/lazylead/salt.rb

@@ -0,0 +1,91 @@
+# 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 "active_support"
+
+module Lazylead
+  #
+  # A cryptography salt defined in environment variables.
+  #
+  # Salt is random data that is used as an additional input to a one-way
+  # function that hashes data, a password or passphrase. Salts are used to
+  # safeguard passwords in storage. Historically a password was stored in
+  # plaintext on a system, but over time additional safeguards developed to
+  # protect a user's password against being read from the system. A salt is one
+  # of those methods.
+  #
+  # Read more: https://en.wikipedia.org/wiki/Salt_(cryptography).
+  #
+  class Salt
+    attr_reader :id
+    #
+    # Each salt should be defined as a environment variable with id, like
+    #  salt1=E1F53135E559C253
+    #  salt2=84B03D034B409D4E
+    #  ...
+    #  saltN=xxxxxxxxx
+    #
+    def initialize(id, env = ENV.to_h)
+      @id = id
+      @env = env
+    end
+
+    def encrypt(password)
+      ActiveSupport::MessageEncryptor.new(@env[@id]).encrypt_and_sign password
+    end
+
+    def decrypt(password)
+      ActiveSupport::MessageEncryptor.new(@env[@id]).decrypt_and_verify password
+    end
+
+    def specified?
+      @env.key?(@id) && !@env[@id].blank?
+    end
+  end
+
+  #
+  # No cryptography salt defined within environment variables.
+  #
+  class NoSalt
+    def id
+      "No salt"
+    end
+
+    def encrypt(_)
+      raise "ll-003: Unsupported operation: 'encrypt'"
+    end
+
+    def decrypt(_)
+      raise "ll-004: Unsupported operation: 'decrypt'"
+    end
+
+    def specified?
+      false
+    end
+
+    def key
+      raise "ll-005: Unsupported operation: 'key'"
+    end
+  end
+end

data/lib/lazylead/schedule.rb

@@ -0,0 +1,88 @@
+# 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 "rufus-scheduler"
+require_relative "log"
+require_relative "model"
+
+module Lazylead
+  # The tasks schedule
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Schedule
+    # @todo #/DEV New scheduling types like 'at', 'once' is required.
+    #  The minimum time period for cron is 1 minute and it's not suitable for
+    #  unit testing, thus its better to introduce new types which allows to
+    #  schedule some task once or at particular time period like in next 200ms).
+    #  For cron expressions we should define separate test suite which will test
+    #  in parallel without blocking main CI process.
+    def initialize(log = Log::NOTHING, cling = true)
+      @log = log
+      @cling = cling
+      @trigger = Rufus::Scheduler.new
+    end
+
+    # @todo #/DEV error code is required for reach 'raise' statement within the
+    #  application.
+    def register(task)
+      raise "ll-002: task can't be a null" if task.nil?
+      @trigger.cron task.cron do
+        task.exec @log
+      end
+      @log.debug "Task scheduled: #{task}"
+    end
+
+    # @todo #/DEV inspect the current execution status. This method should
+    #  support several format for output, by default is `json`.
+    def ps; end
+
+    def join
+      @trigger.join if @cling
+    end
+
+    # @todo #/DEV stop the execution of current jobs (shutdown?).
+    #  The test is required.
+    def stop
+      @trigger.shutdown(:kill)
+    end
+  end
+
+  # Fake application schedule for unit testing purposes
+  class NoSchedule
+    def initialize(log = Log::NOTHING)
+      @log = log
+    end
+
+    def register(task)
+      @log.debug("Task registered: #{task}")
+    end
+
+    def ps; end
+
+    def join; end
+  end
+end

data/lib/lazylead/smtp.rb

@@ -0,0 +1,82 @@
+# 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 "mail"
+require_relative "log"
+require_relative "salt"
+
+module Lazylead
+  #
+  # The emails configuration over SMTP protocol.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Smtp
+    def initialize(log = Log::NOTHING, salt = NoSalt.new, opts = {})
+      @log = log
+      @salt = salt
+      @opts = opts
+    end
+
+    def enable
+      if @opts.empty? || @opts[:test_mode] || @opts[:smtp_host].blank?
+        Mail.defaults do
+          delivery_method :test
+        end
+        @log.warn "SMTP connection enabled in test mode."
+      else
+        setup_smtp
+      end
+    end
+
+    private
+
+    def setup_smtp
+      host = @opts[:smtp_host]
+      port = @opts[:smtp_port]
+      user = decrypted(:smtp_user)
+      pass = decrypted(:smtp_pass)
+      Mail.defaults do
+        delivery_method :smtp,
+                        address: host,
+                        port: port,
+                        user_name: user,
+                        password: pass,
+                        authentication: "plain",
+                        enable_starttls_auto: true
+      end
+      @log.debug "SMTP connection established with #{host} as #{user}."
+    end
+
+    # Decrypt the value of configuration property using cryptography salt.
+    def decrypted(key)
+      if @salt.specified?
+        @salt.decrypt(@opts[key])
+      else
+        @opts[key]
+      end
+    end
+  end
+end

data/lib/lazylead/system/empty.rb

@@ -0,0 +1,36 @@
+# 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
+  #
+  # A empty ticketing system
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Empty
+    def issues(_)
+      []
+    end
+  end
+end

data/lib/lazylead/system/fake.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
+  #
+  # A fake ticketing system
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Fake
+    def initialize(issues = [])
+      @issues = issues
+    end
+
+    def issues(_)
+      @issues
+    end
+  end
+end

data/lib/lazylead/system/jira.rb

@@ -0,0 +1,249 @@
+# 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 "jira-ruby"
+require_relative "../salt"
+
+module Lazylead
+  # Jira system for manipulation with issues.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Jira
+    # @todo #57/DEV The debug method should be moved outside of ctor.
+    #  This was moved here from 'client' method because Rubocop failed the build
+    #  due to 'Metrics/AbcSize' violation.
+    def initialize(opts, salt = NoSalt.new, log = Log::NOTHING)
+      @opts = opts
+      @salt = salt
+      @log = log
+      @log.debug "Initiate a Jira client using following opts: " \
+                 "#{@opts.except 'password', :password} " \
+                 " and salt #{@salt.id} (found=#{@salt.specified?})"
+    end
+
+    def issues(jql, opts = {})
+      raw do |jira|
+        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i) }
+      end
+    end
+
+    # Execute request to the ticketing system using raw client.
+    # For Jira the raw client is 'jira-ruby' gem.
+    def raw
+      raise "ll-06: No block given to method" unless block_given?
+      yield client
+    end
+
+    private
+
+    def client
+      return @client if defined? @client
+      @opts[:auth_type] = :basic if @opts[:auth_type].nil?
+      @opts["username"] = @salt.decrypt(@opts["username"]) if @salt.specified?
+      @opts["password"] = @salt.decrypt(@opts["password"]) if @salt.specified?
+      cp("site", :site)
+      cp("username", :username)
+      cp("password", :password)
+      cp("context_path", :context_path)
+      @client = JIRA::Client.new(@opts)
+    end
+
+    # Copy the required/mandatory parameter(s) for Jira client which can't
+    #  be specified/defined at database level.
+    #
+    # @todo #/DEV Jira.cp - find a way how to avoid this method.
+    #  Potentially, hash with indifferent access might be used.
+    #  http://jocellyn.cz/2014/05/03/hash-with-indifferent-access.html
+    #  key.kind_of?(Symbol) ? key.to_s : key
+    def cp(act, exp)
+      @opts[exp] = @opts[act] if @opts.key? act
+    end
+  end
+
+  #
+  # An user from Jira which might be reporter, assignee, etc.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class User
+    def initialize(usr)
+      @usr = usr
+    end
+
+    def id
+      @usr["name"]
+    end
+
+    def name
+      @usr["displayName"]
+    end
+
+    def email
+      @usr["emailAddress"]
+    end
+
+    def ==(other)
+      if other.respond_to?(:id)
+        other.id == id
+      else
+        false
+      end
+    end
+
+    alias eql? ==
+
+    def hash
+      id.hash
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#{@opts['site']} (#{@opts['username']})"
+    end
+  end
+
+  #
+  # An issue from Jira
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Issue
+    def initialize(issue)
+      @issue = issue
+    end
+
+    def id
+      @issue.id
+    end
+
+    def key
+      @issue.key
+    end
+
+    def summary
+      fields["summary"]
+    end
+
+    def url
+      @issue.attrs["self"].split("/rest/api/").first + "/browse/" + key
+    end
+
+    def duedate
+      @issue.fields["duedate"]
+    end
+
+    def priority
+      fields["priority"]["name"]
+    end
+
+    def reporter
+      Lazylead::User.new(fields["reporter"])
+    end
+
+    def assignee
+      Lazylead::User.new(@issue.assignee.attrs)
+    end
+
+    def fields
+      @issue.fields
+    end
+
+    def history
+      return [] unless @issue.respond_to? :changelog
+      return [] if @issue.changelog == nil? || @issue.changelog.empty?
+      @issue.changelog["histories"]
+    end
+
+    def comments
+      @issue.comments
+    end
+
+    def to_s
+      "#{key} #{summary}"
+    end
+
+    def inspect
+      to_s
+    end
+  end
+
+  # The jira issue comments
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Comments
+    attr_reader :issue
+
+    def initialize(issue, sys)
+      @issue = issue
+      @sys = sys
+    end
+
+    def body?(text)
+      comments.any? { |c| c.attrs["body"].include? text }
+    end
+
+    def comments
+      @comments ||= @sys.raw do |conn|
+        conn.Issue.find(@issue.id, expand: "comments,changelog", fields: "")
+            .comments
+      end
+    end
+
+    def last(quantity)
+      comments.last(quantity).map { |c| c.attrs["body"] }
+    end
+  end
+
+  # Jira instance without authentication in order to access public filters
+  #  or dashboards.
+  class NoAuthJira
+    def initialize(url, log = Log::NOTHING)
+      @jira = Jira.new(
+        { username: nil, password: nil, site: url, context_path: "" },
+        NoSalt.new,
+        log
+      )
+    end
+
+    def issues(jql, opts = {})
+      @jira.issues(jql, opts)
+    end
+
+    # Execute request to the ticketing system using raw client.
+    # For Jira the raw client is 'jira-ruby' gem.
+    def raw(&block)
+      raise "ll-07: No block given to method" unless block_given?
+      @jira.raw(&block)
+    end
+  end
+end