lazylead 0.4.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5d4e1e8d89064bfa868e1c088166d3a42b4c155fde98246979a262854d15b0
-  data.tar.gz: fa0d3aefc186740945b1da68318aebe1d597d7b88f70b079644058f5e201126b
+  metadata.gz: 847a338ce12f9cd01529f1e6a66d810e68cde504e2a0873ecb41b869adcda7cc
+  data.tar.gz: 8ca65bb46faced2b89f07f1b65002b2890ecf2c78d4d53e74d017a712133d0f4
 SHA512:
-  metadata.gz: 7b018d644048900e19d03bbf8b24847a0b617ba74721f213743687b90d1cc2078ca84f35af29c2660b73207e5fc5b86d4b9e45d3394d9c095645198400602dfe
-  data.tar.gz: 842cf53e33f2376891d80dcd7f7802f2a27a37bf26ea42a55c88d4b53925b6a161b3962cbc7df0467c2c1049532db8029977c78776340e938cc20f757f5d89b3
+  metadata.gz: f527721696b9f7215efc7628ea39c6cbf18c3145908d715ef5e698de57fcb5b6b28af8d0fe167b54b5418c9f15915071d0ff7ff2c7df3315f107f0d49c4c95d9
+  data.tar.gz: 1a71de8819ce9aa81fd0e11c4d0248e8b44d846d17f71adb0be18c6a74c9fe58d2ad257fd639f263c29546898cea0725dd6850dbdb417de6e03f541009fbebe0

data/.docs/accuracy.md

@@ -66,7 +66,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
     insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
                values ('Post ticket score and accuracy to the tickets', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::Accuracy',
@@ -82,7 +82,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                         }
                        ');
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.docs/duedate_expired.md

@@ -68,16 +68,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Expired due dates', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::AssigneeAlert',
                        '{"sql":"filter=222", "cc":"<youremail.com>", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.docs/propagate_down.md

@@ -58,16 +58,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Propagate customfield_1 (External ID) to sub-tasks', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::PropagateDown',
                        '{"jql":"filter=222", "propagate":"customfield_1"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.gitattributes

@@ -7,3 +7,4 @@
 *.xml ident
 *.png binary
 *.pdf binary
+*.db binary

data/Rakefile

@@ -26,7 +26,7 @@ require "rubygems"
 require "rake"
 require "date"
 require "rdoc"
-require "rainbow"
+require "colorize"
 require "rake/clean"
 
 # @todo #/DEV Investigate the possibility of using migrations from active_record
@@ -112,9 +112,10 @@ task :sqlint do
     total += violations.count { |lint| lint.type == :error }
   end
   if total.positive?
-    abort "#{Rainbow(total).red} SQL violations found."
+    abort "#{total.colorize(:red)} SQL violations found."
   else
-    puts "#{src.size} files inspected, #{Rainbow('no offenses').green} detected"
+    puts "#{src.size} files inspected, #{'no offenses'.colorize(:green)} " \
+          "detected"
   end
 end
 
@@ -127,4 +128,6 @@ task :docker do
   system "docker-compose -f .docker/docker-compose.yml build "\
           " --build-arg release_tags='latest 1.0'"\
           " --build-arg version=1.0"
+  system "docker-compose -f .docker/docker-compose.yml rm --force -s lazylead"
+  system "docker-compose -f .docker/docker-compose.yml up"
 end

data/bin/lazylead

@@ -29,7 +29,7 @@ STDOUT.sync = true
 
 require "slop"
 require "sqlite3"
-require "rainbow"
+require "colorize"
 require "logging"
 require "backtrace"
 require "memory_profiler"
@@ -77,12 +77,13 @@ Available options:"
     exit
   end
 end
-log.debug("Version: #{Lazylead::VERSION}")
-log.debug("Memory footprint at start is #{Lazylead::Allocated.new}")
+log.debug "Version: #{Lazylead::VERSION.colorize(:green)}"
+log.debug "Memory footprint at start is " \
+          "#{Lazylead::Allocated.new.to_s.colorize(:light_blue)}."
 cmd = lambda do
   Lazylead::CLI::App.new(
     log,
-    Lazylead::Schedule.new(log),
+    Lazylead::Schedule.new(log: log),
     Lazylead::Smtp.new(
       log, Lazylead::Salt.new("smtp_salt"),
       smtp_host: ENV["smtp_host"],
@@ -103,5 +104,6 @@ if opts["memory-dump"]
 else
   code = cmd.call
 end
-log.debug("Memory footprint at the end is #{Lazylead::Allocated.new}")
+log.debug "Memory footprint at the end is " \
+          "#{Lazylead::Allocated.new.to_s.colorize(:light_blue)}."
 exit(code) unless code.zero?

data/lazylead.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.2"
   s.required_ruby_version = ">=2.6.5"
   s.name = "lazylead"
-  s.version = "0.4.3"
+  s.version = "0.6.1"
   s.license = "MIT"
   s.summary = "Eliminate the annoying work within bug-trackers."
   s.description = "Ticketing systems (Github, Jira, etc.) are strongly
@@ -45,7 +45,7 @@ tasks instead of solving technical problems."
   s.authors = ["Yurii Dubinka"]
   s.email = "yurii.dubinka@gmail.com"
   s.homepage = "http://github.com/dgroup/lazylead"
-  s.post_install_message = "Thanks for installing Lazylead v0.4.3!
+  s.post_install_message = "Thanks for installing Lazylead v0.6.1!
   Read our blog posts: https://lazylead.org
   Stay in touch with the community in Telegram: https://t.me/lazylead
   Follow us on Twitter: https://twitter.com/lazylead
@@ -57,6 +57,7 @@ tasks instead of solving technical problems."
   s.extra_rdoc_files = %w[readme.md license.txt]
   s.add_runtime_dependency "activerecord", "6.0.3"
   s.add_runtime_dependency "backtrace", "0.3"
+  s.add_runtime_dependency "colorize", "0.8.1"
   s.add_runtime_dependency "faraday", "1.0.1"
   s.add_runtime_dependency "get_process_mem", "0.2.5"
   s.add_runtime_dependency "jira-ruby", "1.7.1"
@@ -65,11 +66,11 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "mail", "2.7.1"
   s.add_runtime_dependency "memory_profiler", "0.9.13"
   s.add_runtime_dependency "openssl", "2.1.2"
-  s.add_runtime_dependency "rainbow", "3.0.0"
   s.add_runtime_dependency "require_all", "3.0.0"
   s.add_runtime_dependency "rufus-scheduler", "3.6.0"
   s.add_runtime_dependency "slop", "4.4"
   s.add_runtime_dependency "sqlite3", "1.4.2"
+  s.add_runtime_dependency "tempfile", "0.1.0"
   s.add_runtime_dependency "tilt", "2.0.10"
   s.add_runtime_dependency "tzinfo", "1.1"
   s.add_runtime_dependency "tzinfo-data", "1.2019.3"

data/lib/lazylead/cli/app.rb

@@ -22,6 +22,7 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
+require "colorize"
 require "vcs4sql/sqlite/migration"
 require_relative "../smtp"
 require_relative "../schedule"
@@ -58,9 +59,11 @@ module Lazylead
       def apply_vcs_migration(opts)
         @db = File.expand_path(opts[:home]) + "/" + opts[:sqlite]
         vcs = File.expand_path(opts[:home]) + "/" + opts[:vcs4sql]
-        @log.debug "Database: '#{@db}', sql migration dir: '#{vcs}'"
+        @log.debug "Database: '#{@db.colorize(:light_blue)}', "\
+                   "sql migration dir: '#{vcs.colorize(:light_blue)}'"
         Vcs4sql::Sqlite::Migration.new(@db).upgrade vcs, opts[:testdata]
-        @log.debug "Migration applied to #{@db} from #{vcs}"
+        @log.debug "Migration applied to '#{@db.colorize(:light_blue)}' from " \
+                   "'#{vcs.colorize(:light_blue)}'"
       end
 
       def enable_active_record(opts)
@@ -78,7 +81,12 @@ module Lazylead
           @log.warn "ll-001: No tasks found."
         else
           todo.find_each do |task|
-            @schedule.register task
+            if task.to_h?
+              @schedule.register task
+            else
+              @log.warn "ll-011: Scheduling skipped due to configuration " \
+                        "mistake in #{task}"
+            end
           end
           @schedule.join
         end

data/lib/lazylead/exchange.rb

@@ -54,19 +54,25 @@ module Lazylead
     def send(opts)
       to = opts["to"] || opts[:to]
       to = [to] unless to.is_a? Array
-      html = make_body(opts)
-      msg = {
-        subject: opts["subject"],
-        body: html,
-        body_type: "HTML",
-        to_recipients: to
-      }
+      if to.reject { |e| e.nil? || e.blank? }.empty?
+        @log.warn "Email can't be sent to '#{to}, more: '#{opts}'"
+        return
+      end
+      msg = make_msg(to, opts)
       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}"
+      @log.debug "#{__FILE__} sent '#{opts['subject']}' to '#{to}'."
+    end
+
+    def make_msg(to, opts)
+      {
+        subject: opts["subject"],
+        body: make_body(opts),
+        body_type: "HTML",
+        to_recipients: to
+      }
     end
 
     def add_attachments(msg, opts)

data/lib/lazylead/log.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "logging"
+require "colorize"
 require "forwardable"
 
 module Lazylead
@@ -68,7 +69,7 @@ module Lazylead
     Logging.appenders.stdout(
       "stdout",
       layout: Logging.layouts.pattern(
-        pattern: "[%d] %-5l [%X{tid}] %m\n",
+        pattern: "[%d] %-5l #{'[%X{tid}]'.colorize(:light_green)} %m\n",
         color_scheme: "bright"
       )
     )

data/lib/lazylead/model.rb

@@ -80,6 +80,13 @@ module Lazylead
       JSON.parse(properties).to_h
     end
 
+    def to_h?
+      return true unless to_hash.nil?
+      false
+    rescue StandardError => _e
+      false
+    end
+
     def to_s
       attributes.map { |k, v| "#{k}='#{v}'" }.join(", ")
     end
@@ -94,6 +101,7 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
+      # Execute task
       def exec
         sys = system.connect
         opts = props
@@ -101,6 +109,25 @@ module Lazylead
         action.constantize.new.run(sys, postman, opts)
       end
 
+      # Scheduling type.
+      # Current implementation is based on 'rufus-scheduler' gem and supports
+      #  the following types: 'cron', 'interval', 'in', 'at', 'every'
+      def type
+        trigger.first
+      end
+
+      # Scheduling unit.
+      # Current implementation is based on 'rufus-scheduler' gem thus each
+      # scheduling type has own arguments:
+      #  1. Scheduling type 'cron' has 'unit' = '00 09 * * *'
+      #  2. Scheduling type 'interval' has 'unit' = '2h'
+      #  3. Scheduling type 'every' has 'unit' = '3h'
+      #  4. Scheduling type 'in' has 'unit' = '10d'
+      #  5. Scheduling type 'at' has 'unit' = '2014/12/24 2000'
+      def unit
+        trigger.last
+      end
+
       def detect_cc(sys)
         opts = props
         opts["cc"] = CC.new.detect(opts["cc"], sys)
@@ -125,13 +152,27 @@ module Lazylead
           Postman.new
         end
       end
+
+      private
+
+      # Parse scheduling #type and #unit
+      def trigger
+        @trigger ||= begin
+                       trg = schedule.split(":")
+                       unless trg.size == 2
+                         raise "ll-007: illegal schedule format '#{schedule}'"
+                       end
+                       trg.map(&:strip).map(&:chomp)
+                     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_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type,
+                     :unit
 
       def initialize(orig, log = Log.new)
         @orig = orig

data/lib/lazylead/opts.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "forwardable"
+require_relative "salt"
 
 module Lazylead
   #
@@ -41,6 +42,7 @@ module Lazylead
 
     # Split text value by delimiter, trim all spaces and reject blank items
     def slice(key, delim)
+      return [] unless to_h.key? key
       to_h[key].split(delim).map(&:chomp).map(&:strip).reject(&:blank?)
     end
 
@@ -64,5 +66,16 @@ module Lazylead
     def jira_fields
       to_h.fetch("fields", "").split(",").map(&:to_sym)
     end
+
+    # Decrypt particular option using cryptography salt
+    # @param key option to be decrypted
+    # @param sid the name of the salt to be used for the description
+    # @see Lazylead::Salt
+    def decrypt(key, sid)
+      text = to_h[key]
+      return text if text.blank? || text.nil?
+      return Salt.new(sid).decrypt(text) if ENV.key? sid
+      text
+    end
   end
 end

data/lib/lazylead/postman.rb

@@ -53,26 +53,32 @@ module Lazylead
     # Send an email.
     # :opts   :: the mail configuration like to, from, cc, subject, template.
     def send(opts)
-      html = make_body(opts)
+      mail = make_email(opts)
+      mail.deliver
+      @log.debug "#{__FILE__} sent '#{mail.subject}' to '#{mail.to}'."
+    end
+
+    # Construct an email based on input arguments
+    def make_email(opts)
       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"]
+      html = make_body(opts)
       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}"
+      mail
     end
 
     def add_attachments(mail, opts)
-      return unless opts.key? "attachments"
-      opts["attachments"].select { |a| File.file? a }
-                         .each { |a| mail.add_file a }
+      return unless opts.key?("attachments") || opts.key?(:attachments)
+      attach = opts["attachments"] || opts[:attachments]
+      return if attach.nil?
+      attach.select { |a| File.file? a }.each { |a| mail.add_file a }
     end
   end
 end

data/lib/lazylead/schedule.rb

@@ -34,23 +34,18 @@ module Lazylead
   # 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.new, cling = true)
+    def initialize(log: Log.new, cling: true, trigger: Rufus::Scheduler.new)
       @log = log
       @cling = cling
-      @trigger = Rufus::Scheduler.new
+      @trigger = trigger
     end
 
-    # @todo #/DEV error code is required for reach 'raise' statement within the
-    #  application.
+    # @todo #/DEV error code is required for each 'raise' statement within the
+    #  application. Align the naming of existing one, the error code should be
+    #  like ll-xxx.
     def register(task)
       raise "ll-002: task can't be a null" if task.nil?
-      @trigger.cron task.cron do
+      @trigger.method(task.type).call(task.unit) do
         ActiveRecord::Base.connection_pool.with_connection do
           ORM::VerboseTask.new(task, @log).exec
         end
@@ -60,7 +55,9 @@ module Lazylead
 
     # @todo #/DEV inspect the current execution status. This method should
     #  support several format for output, by default is `json`.
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
     def join
       @trigger.join if @cling
@@ -80,11 +77,15 @@ module Lazylead
     end
 
     def register(task)
-      @log.debug("Task registered: #{task}")
+      @log.debug "Task registered: #{task}"
     end
 
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
-    def join; end
+    def join
+      @log.debug "#{self}#join"
+    end
   end
 end