lazylead 0.1.0

data/lib/lazylead/email.rb

@@ -0,0 +1,74 @@
+# 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 "tilt"
+
+module Lazylead
+  # Email notifications utilities.
+  module Emailing
+    # Construct html document from template and binds.
+    def make_body(opts)
+      Email.new(
+        opts["template"],
+        opts.merge(version: Lazylead::VERSION)
+      ).render
+    end
+
+    # Split text with email addresses by ',' and trim all elements if needed.
+    def split(type, opts)
+      if opts[type].include? ","
+        opts[type].split(",").map(&:strip).reject(&:empty?)
+      else
+        [opts[type]]
+      end
+    end
+  end
+
+  # An email regarding tickets based on file with markup.
+  #
+  # The 'tilt' gem was used as a template engine.
+  # Read more about 'tilt':
+  #  - https://github.com/rtomayko/tilt
+  #  - https://github.com/rtomayko/tilt/blob/master/docs/TEMPLATES.md
+  #  - https://www.rubyguides.com/2018/11/ruby-erb-haml-slim/
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Email
+    # :file   :: the file with html template
+    # :binds  :: the template variables for substitution.
+    def initialize(file, binds)
+      @file = file
+      @binds = binds
+    end
+
+    # Construct the email body from html template based on variables (binds).
+    def render
+      Tilt.new(@file)
+          .render(OpenStruct.new(@binds))
+          .delete!("\n")
+    end
+  end
+end

data/lib/lazylead/exchange.rb

@@ -0,0 +1,83 @@
+# 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 "viewpoint"
+require_relative "log"
+require_relative "salt"
+require_relative "email"
+require_relative "version"
+
+module Lazylead
+  #
+  # A postman to send emails to the Microsoft Exchange server.
+  #
+  # @todo #/DEV Add support of symbols for options in order to use both
+  #  notations like opts[:endpoint] or opts["endpoint"].
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Exchange
+    include Emailing
+
+    def initialize(
+      log = Log::NOTHING, salt = Salt.new("exchange_salt"), opts = ENV.to_h
+    )
+      @log = log
+      @salt = salt
+      @opts = opts
+    end
+
+    # Send an email.
+    # :opts   :: the mail configuration like from, cc, subject, template.
+    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
+      }
+      msg.update(cc_recipients: split("cc", opts)) if opts.key? "cc"
+      cli.send_message msg
+      @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
+                 "Here is the body: #{html}"
+    end
+
+    private
+
+    def cli
+      return @cli if defined? @cli
+      url = @opts["exchange_url"]
+      usr = @opts["exchange_user"]
+      psw = @opts["exchange_password"]
+      usr = @salt.decrypt(usr) if @salt.specified?
+      psw = @salt.decrypt(psw) if @salt.specified?
+      @log.debug "Connect to MS Exchange server #{url} as '#{usr}'"
+      @cli = Viewpoint::EWSClient.new url, usr, psw
+    end
+  end
+end

data/lib/lazylead/log.rb

@@ -0,0 +1,71 @@
+# 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
+  # Loggers.
+  #
+  # 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
+    # Coloring configuration for appender(s).
+    Logging.color_scheme("bright",
+                         levels: {
+                           info: :green,
+                           warn: :yellow,
+                           error: :red,
+                           fatal: %i[white on_red]
+                         },
+                         date: :blue,
+                         logger: :cyan)
+    Logging.appenders.stdout(
+      "stdout",
+      layout: Logging.layouts.pattern(
+        pattern: "[%d] %-5l %m\n",
+        color_scheme: "bright"
+      )
+    )
+
+    # Nothing to log
+    NOTHING = Logging.logger["nothing"]
+    NOTHING.level = :off
+    NOTHING.freeze
+
+    # All levels including debug
+    VERBOSE = Logging.logger["verbose"]
+    VERBOSE.level = :debug
+    VERBOSE.add_appenders "stdout"
+    VERBOSE.freeze
+
+    # Alerts
+    ERRORS = Logging.logger["errors"]
+    ERRORS.level = :error
+    ERRORS.add_appenders "stdout"
+    ERRORS.freeze
+  end
+end

data/lib/lazylead/model.rb

@@ -0,0 +1,140 @@
+# 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_record"
+require "require_all"
+require_rel "task"
+require_rel "system"
+require_relative "log"
+require_relative "postman"
+require_relative "exchange"
+
+#
+# ORM domain model entities.
+#
+# Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+# License:: MIT
+module Lazylead
+  # ORM-related methods
+  module ORM
+    # Tables from database may have configuration in json column.
+    # Some of those properties might be configured/overridden by environment
+    # variable using macros "${...}"
+    #   {
+    #      ...
+    #      "user" = "${my_user}",
+    #      "pass" = "${my_pass}"
+    #      "url" = "https://url.com"
+    #      ...
+    #   }
+    # next, we need to configure following environment variables(ENV)
+    #   my_user=XXXXX
+    #   my_pass=YYYYY
+    # thus, the result of this method is
+    #   {
+    #      ...
+    #      "user" = "XXXXXX",
+    #      "pass" = "YYYYYY"
+    #      "url" = "https://url.com"
+    #      ...
+    #   }
+    def env(opts)
+      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? "${"
+        o[k] = v
+      end
+    end
+
+    # Convert json-based database column 'properties' to hash.
+    def to_hash
+      JSON.parse(properties).to_h
+    end
+
+    def to_s
+      attributes.map { |k, v| "#{k}='#{v}'" }.join(", ")
+    end
+
+    def inspect
+      to_s
+    end
+
+    # General lazylead task.
+    class Task < ActiveRecord::Base
+      include ORM
+      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")
+      end
+
+      def props
+        return @prop if defined? @prop
+        @prop = team.to_hash.merge(to_hash)
+      end
+
+      def postman(log = Log::NOTHING)
+        if props.key? "postman"
+          props["postman"].constantize.new(log)
+        else
+          log.warn "No postman details provided, an local stub is used."
+          Postman.new
+        end
+      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)
+        opts = to_hash
+        if opts["type"].empty?
+          log.warn "No task system details provided, an empty stub is used."
+          Empty.new
+        else
+          opts["type"].constantize.new(
+            env(opts.except("type", "salt")),
+            opts["salt"].blank? ? NoSalt.new : Salt.new(opts["salt"]),
+            log
+          )
+        end
+      end
+    end
+
+    # A team for lazylead task.
+    # Each team may have several tasks.
+    class Team < ActiveRecord::Base
+      include ORM
+    end
+  end
+end

data/lib/lazylead/postman.rb

@@ -0,0 +1,78 @@
+# 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"
+
+module Lazylead
+  #
+  # A postman to send emails.
+  #
+  # @todo #/DEV Merge Smtp and Postman objects. There might be different
+  #  postman's based on different mail servers, thus its better to keep together
+  #  the instantiation and sending. For each type of mail servers we should have
+  #  separate object.
+  #
+  # @todo #/DEV TestMail.deliveries -> store all emails to the files in
+  #  /test/resources/testmailer/*.html. Right now after each test with email
+  #  sending we taking the body and test it content. Quite ofter we need to
+  #  check visual style in mails, etc, thus its better to store them on disk.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Postman
+    include Emailing
+
+    def initialize(log = Log::NOTHING)
+      @log = log
+    end
+
+    # Send an email.
+    # :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
+      end
+      @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
+    end
+  end
+end