lazylead 0.1.1 → 0.4.0

data/lib/lazylead/cli/app.rb

@@ -48,7 +48,7 @@ module Lazylead
 
       def run(opts)
         apply_vcs_migration opts
-        enable_active_record
+        enable_active_record opts
         @smtp.enable
         schedule_tasks
       end
@@ -63,10 +63,11 @@ module Lazylead
         @log.debug "Migration applied to #{@db} from #{vcs}"
       end
 
-      def enable_active_record
+      def enable_active_record(opts)
         ActiveRecord::Base.establish_connection(
           adapter: "sqlite3",
-          database: @db
+          database: @db,
+          pool: opts[:max_connections]
         )
         @log.debug "Database connection established"
       end

data/lib/lazylead/exchange.rb

@@ -42,7 +42,7 @@ module Lazylead
     include Emailing
 
     def initialize(
-      log = Log::NOTHING, salt = Salt.new("exchange_salt"), opts = ENV.to_h
+      log = Log.new, salt = Salt.new("exchange_salt"), opts = ENV.to_h
     )
       @log = log
       @salt = salt
@@ -61,12 +61,25 @@ module Lazylead
         body_type: "HTML",
         to_recipients: to
       }
-      msg.update(cc_recipients: split("cc", opts)) if opts.key? "cc"
+      msg.update(cc_recipients: opts["cc"]) if opts.key? "cc"
+      add_attachments(msg, opts)
       cli.send_message msg
+      close_attachments msg
       @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
                  "Here is the body: #{html}"
     end
 
+    def add_attachments(msg, opts)
+      return unless opts.key? "attachments"
+      files = split("attachments", opts).map { |f| File.open(f, "r") }
+      msg[:file_attachments] = files
+    end
+
+    def close_attachments(msg)
+      return if msg[:file_attachments].nil? || msg[:file_attachments].empty?
+      msg[:file_attachments].each(&:close)
+    end
+
     private
 
     def cli

data/lib/lazylead/home.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.
+
+require "logging"
+
+module Lazylead
+  # Home directory for lazylead
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Home
+    def dir
+      ENV["LL_HOME"].nil? ? Dir.pwd : ENV["LL_HOME"]
+    end
+  end
+end

data/lib/lazylead/log.rb

@@ -23,16 +23,38 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "logging"
+require "forwardable"
 
 module Lazylead
-  # Loggers.
+  # The main application logger
+  class Log
+    extend Forwardable
+    def_delegators :@log, :debug, :info, :warn, :error
+
+    def initialize(log = Lazylead::Level::ERRORS)
+      @log = log
+      @log = Lazylead::Level::DEBUG if ARGV.include? "--trace"
+    end
+
+    def nothing
+      @log = Lazylead::Level::NOTHING
+      self
+    end
+
+    def verbose
+      @log = Lazylead::Level::DEBUG
+      self
+    end
+  end
+
+  # Predefined logging levels.
   #
   # There are 3 colored loggers so far:
   #  NOTHING - for cases when logging isn't required
   #  VERBOSE - all logging levels including debug
   #  ERRORS - for errors only which are critical for app.
   #
-  module Log
+  module Level
     # Coloring configuration for appender(s).
     Logging.color_scheme("bright",
                          levels: {
@@ -46,7 +68,7 @@ module Lazylead
     Logging.appenders.stdout(
       "stdout",
       layout: Logging.layouts.pattern(
-        pattern: "[%d] %-5l %m\n",
+        pattern: "[%d] %-5l [%X{tid}] %m\n",
         color_scheme: "bright"
       )
     )
@@ -57,12 +79,12 @@ module Lazylead
     NOTHING.freeze
 
     # All levels including debug
-    VERBOSE = Logging.logger["verbose"]
-    VERBOSE.level = :debug
-    VERBOSE.add_appenders "stdout"
-    VERBOSE.freeze
+    DEBUG = Logging.logger["debug"]
+    DEBUG.level = :debug
+    DEBUG.add_appenders "stdout"
+    DEBUG.freeze
 
-    # Alerts
+    # Alerts/errors
     ERRORS = Logging.logger["errors"]
     ERRORS.level = :error
     ERRORS.add_appenders "stdout"

data/lib/lazylead/model.rb

@@ -22,11 +22,15 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-require "active_record"
+require "backtrace"
 require "require_all"
+require "forwardable"
+require "active_record"
 require_rel "task"
 require_rel "system"
+require_relative "cc"
 require_relative "log"
+require_relative "opts"
 require_relative "postman"
 require_relative "exchange"
 
@@ -64,7 +68,9 @@ module Lazylead
       opts.each_with_object({}) do |e, o|
         k = e[0]
         v = e[1]
-        v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        if v.respond_to? :start_with?
+          v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        end
         o[k] = v
       end
     end
@@ -88,35 +94,74 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
-      def exec(log = Log::NOTHING)
-        log.debug("Task ##{id} '#{name}' is started")
-        action.constantize
-              .new(log)
-              .run(system.connect(log), postman(log), props)
-        log.debug("Task ##{id} '#{name}' is completed")
+      def exec
+        sys = system.connect
+        opts = props
+        opts = detect_cc(sys) if opts.key? "cc"
+        action.constantize.new(log).run(sys, postman, opts)
+      end
+
+      def detect_cc(sys)
+        opts = props
+        opts["cc"] = CC.new.detect(opts["cc"], sys)
+        return opts.except "cc" if opts["cc"].is_a? EmptyCC
+        opts
       end
 
       def props
-        return @prop if defined? @prop
-        @prop = team.to_hash.merge(to_hash)
+        @props ||= begin
+                     if team.nil?
+                       Opts.new(env(to_hash))
+                     else
+                       Opts.new(env(team.to_hash.merge(to_hash)))
+                     end
+                   end
       end
 
-      def postman(log = Log::NOTHING)
+      def postman
         if props.key? "postman"
-          props["postman"].constantize.new(log)
+          props["postman"].constantize.new
         else
-          log.warn "No postman details provided, an local stub is used."
           Postman.new
         end
       end
     end
 
+    # A task with extended logging
+    # @see Lazylead::ORM::Task
+    class VerboseTask
+      extend Forwardable
+      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props
+
+      def initialize(orig, log = Log.new)
+        @orig = orig
+        @log = log
+      end
+
+      def exec
+        Logging.mdc["tid"] = "task #{id}"
+        @log.debug "'#{name}' is started."
+        @log.warn "No postman, stub is used." unless props.key? "postman"
+        @log.warn "No team." if team.nil?
+        @orig.exec @log
+        @log.debug "'#{name}' is completed"
+      rescue StandardError => e
+        msg = <<~MSG
+          ll-006: Task ##{id} #{e} (#{e.class}) at #{self}
+          #{Backtrace.new(e) if ARGV.include? '--trace'}"
+        MSG
+        @log.error msg
+      ensure
+        Logging.mdc["tid"] = ""
+      end
+    end
+
     # Ticketing systems to monitor.
     class System < ActiveRecord::Base
       include ORM
 
       # Make an instance of ticketing system for future interaction.
-      def connect(log = Log::NOTHING)
+      def connect(log = Log.new)
         opts = to_hash
         if opts["type"].empty?
           log.warn "No task system details provided, an empty stub is used."
@@ -124,8 +169,7 @@ module Lazylead
         else
           opts["type"].constantize.new(
             env(opts.except("type", "salt")),
-            opts["salt"].blank? ? NoSalt.new : Salt.new(opts["salt"]),
-            log
+            opts["salt"].blank? ? NoSalt.new : Salt.new(opts["salt"])
           )
         end
       end

data/lib/lazylead/opts.rb

@@ -0,0 +1,68 @@
+# 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 "forwardable"
+
+module Lazylead
+  #
+  # Default options for all lazylead tasks.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Opts
+    extend Forwardable
+    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge
+
+    def initialize(origin = {})
+      @origin = origin
+    end
+
+    # Split text value by delimiter, trim all spaces and reject blank items
+    def slice(key, delim)
+      to_h[key].split(delim).map(&:chomp).map(&:strip).reject(&:blank?)
+    end
+
+    def blank?(key)
+      to_h[key].nil? || @origin[key].blank?
+    end
+
+    def to_h
+      @origin
+    end
+
+    # Default Jira options to use during search for all Jira-based tasks.
+    def jira_defaults
+      {
+        max_results: fetch("max_results", 50),
+        fields: jira_fields
+      }
+    end
+
+    # Default fields which to fetch within the Jira issue
+    def jira_fields
+      to_h.fetch("fields", "").split(",").map(&:to_sym)
+    end
+  end
+end

data/lib/lazylead/postman.rb

@@ -46,7 +46,7 @@ module Lazylead
   class Postman
     include Emailing
 
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 
@@ -54,25 +54,25 @@ module Lazylead
     # :opts   :: the mail configuration like to, from, cc, subject, template.
     def send(opts)
       html = make_body(opts)
-      cc = detect_cc(opts)
-      Mail.deliver do
-        to opts[:to] || opts["to"]
-        from opts["from"]
-        cc cc if opts.key? "cc"
-        subject opts["subject"]
-        html_part do
-          content_type "text/html; charset=UTF-8"
-          body html
-        end
+      mail = Mail.new
+      mail.to opts[:to] || opts["to"]
+      mail.from opts["from"]
+      mail.cc opts["cc"] if opts.key? "cc"
+      mail.subject opts["subject"]
+      mail.html_part do
+        content_type "text/html; charset=UTF-8"
+        body html
       end
+      add_attachments mail, opts
+      mail.deliver
       @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
                  "Here is the body: #{html}"
     end
 
-    def detect_cc(opts)
-      cc = opts["cc"]
-      cc = split("cc", opts) if !cc.nil? && cc.include?(",")
-      cc
+    def add_attachments(mail, opts)
+      return unless opts.key? "attachments"
+      opts["attachments"].select { |a| File.file? a }
+                         .each { |a| mail.add_file a }
     end
   end
 end

data/lib/lazylead/schedule.rb

@@ -22,7 +22,7 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-require "json"
+require "active_support"
 require "rufus-scheduler"
 require_relative "log"
 require_relative "model"
@@ -40,7 +40,7 @@ module Lazylead
     #  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)
+    def initialize(log = Log.new, cling = true)
       @log = log
       @cling = cling
       @trigger = Rufus::Scheduler.new
@@ -51,7 +51,9 @@ module Lazylead
     def register(task)
       raise "ll-002: task can't be a null" if task.nil?
       @trigger.cron task.cron do
-        task.exec @log
+        ActiveRecord::Base.connection_pool.with_connection do
+          ORM::VerboseTask.new(task, @log).exec
+        end
       end
       @log.debug "Task scheduled: #{task}"
     end
@@ -73,7 +75,7 @@ module Lazylead
 
   # Fake application schedule for unit testing purposes
   class NoSchedule
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 

data/lib/lazylead/smtp.rb

@@ -34,7 +34,7 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Smtp
-    def initialize(log = Log::NOTHING, salt = NoSalt.new, opts = {})
+    def initialize(log = Log.new, salt = NoSalt.new, opts = {})
       @log = log
       @salt = salt
       @opts = opts