bns 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f27d7368a358fcf6dea96e51922690ff399670b5582387b70f56db0d5b25feb
-  data.tar.gz: a46adf0a088dd65740c85aadc5d3005654f3654e2f12cecf345700be7f44f2b1
+  metadata.gz: f45452ff8e3569ad4ffed2d32d8cc7801cd5a4379205ca70d7d401814abb7d50
+  data.tar.gz: 64cd26aaa2269270f77f50ec5b1d4371272d4f53d280bed5b0ccd727b0e628b7
 SHA512:
-  metadata.gz: bfa9c1394d5fe161f90fe86e29a44acace8b2a7809ee8bd233ee12d0be082b11a0081e3fb98efefcdfe22c64a50f27335a95ac24f9c8baeec10c5a9f8d381754
-  data.tar.gz: a13978067c0c9ad5a96c8abc8ae2f7781674a0f4b3accc9b2229a11dde525f706a52ee448effad8570c34b2141a5e9c3ad0a3457f29dea2f5d60d42c6ba7bd4e
+  metadata.gz: a61ce154f73bcf97b76828f437cf4cbd0af1809458532de9ec232343e9a92c85ec118d336a5f13b4eb95cb8e792e2b10bd941c90c79c720c2ae7b4fd5272543f
+  data.tar.gz: '088fc7b072e971ebc37259cc2e017bcc22aa69d9c8d2f035958bb33b578108235686f889c1faccdb6a6566e39b44cddacc6a356c737a81924cebd10d6379d057'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.0 (19.03.2024)
+- [Add Component - Email fetcher](https://github.com/kommitters/bns/issues/40)
+- [Use case - Email based notifications](https://github.com/kommitters/bns/issues/45)
+- [Dynamic WIP limit value](https://github.com/kommitters/bns/issues/48)
+
 ## 0.2.0 (29.02.2024)
 - [Add a Postgres fetcher component](https://github.com/kommitters/bns/issues/28)
 - [Use case - PTO's Postgres-Slack implementation](https://github.com/kommitters/bns/issues/30)

data/Gemfile

@@ -7,6 +7,8 @@ gemspec
 
 gem "rake", "~> 13.0"
 
+gem "net-imap", "~> 0.4.10"
+gem "net-smtp", "~> 0.4.0.1"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "simplecov", require: false, group: :test
@@ -18,3 +20,5 @@ gem "webmock"
 gem "httparty"
 
 gem "pg", "~> 1.5", ">= 1.5.4"
+
+gem "gmail_xoauth"

data/lib/bns/domain/email.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Domain
+  ##
+  # The Domain::Email class provides a domain-specific representation of an Email object.
+  # It encapsulates information about an email, including the subject, the sender, and the date.
+  #
+  class Email
+    attr_reader :subject, :sender
+    attr_accessor :date
+
+    ATTRIBUTES = %w[subject sender date].freeze
+
+    # Initializes a Domain::Email instance with the specified subject, sender, and date.
+    #
+    # <br>
+    # <b>Params:</b>
+    # * <tt>String</tt> email subject.
+    # * <tt>String</tt> Email of the sender.
+    # * <tt>String</tt> Reception date
+    #
+    def initialize(subject, sender, date)
+      @subject = subject
+      @sender = sender
+      @date = parse_to_datetime(date)
+    end
+
+    private
+
+    def parse_to_datetime(date)
+      DateTime.parse(date).to_time
+    end
+  end
+end

data/lib/bns/domain/work_items_limit.rb

@@ -3,37 +3,23 @@
 module Domain
   ##
   # The Domain::WorkItemsLimit class provides a domain-specific representation of a Work Item object.
-  # It encapsulates information about a work items limit, including the domain, total, and wip_limit.
+  # It encapsulates information about a work items limit, including the domain and total.
   #
   class WorkItemsLimit
-    attr_reader :domain, :total, :wip_limit
+    attr_reader :domain, :total
 
-    ATTRIBUTES = %w[domain total wip_limit].freeze
+    ATTRIBUTES = %w[domain total].freeze
 
-    # Initializes a Domain::WorkItemsLimit instance with the specified domain, total and wip_limit.
+    # Initializes a Domain::WorkItemsLimit instance with the specified domain and total.
     #
     # <br>
     # <b>Params:</b>
     # * <tt>String</tt> 'domain' responsible domain of the work items.
     # * <tt>String</tt> 'total' total 'in progress' work items.
-    # * <tt>String</tt> 'wip_limit' maximum 'in progress' work items for the domain
     #
     def initialize(domain, total)
       @domain = domain
       @total = total
-      @wip_limit = domain_wip_limit(domain)
-    end
-
-    private
-
-    def domain_wip_limit(domain)
-      case domain
-      when "kommit.ops" then 5
-      when "kommit.sales" then 3
-      when "kommit.marketing" then 4
-      when "kommit.engineering" then 12
-      else 6
-      end
     end
   end
 end

data/lib/bns/fetcher/imap/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "net/imap"
+require "gmail_xoauth"
+
+require_relative "../base"
+require_relative "./types/response"
+
+module Fetcher
+  module Imap
+    ##
+    # This class is an implementation of the Fetcher::Base interface, specifically designed
+    # for fetching data from an IMAP server.
+    #
+    class Base < Fetcher::Base
+      protected
+
+      # Implements the data fetching logic for emails data from an IMAP server.
+      # It connects to an IMAP server inbox, request emails base on a filter,
+      # and returns a validated response.
+      #
+      def execute(email_domain, email_port, token_uri, query)
+        access_token = refresh_token(token_uri)
+
+        imap_fetch(email_domain, email_port, query, access_token)
+
+        Fetcher::Imap::Types::Response.new(@emails)
+      end
+
+      private
+
+      def imap_fetch(email_domain, email_port, query, access_token)
+        imap = Net::IMAP.new(email_domain, port: email_port, ssl: true)
+
+        imap.authenticate("XOAUTH2", config[:user], access_token)
+
+        imap.examine(config[:inbox])
+
+        @emails = fetch_emails(imap, query)
+
+        imap.logout
+        imap.disconnect
+      end
+
+      def fetch_emails(imap, query)
+        imap.search(query).map do |message_id|
+          imap.fetch(message_id, "ENVELOPE")[0].attr["ENVELOPE"]
+        end
+      end
+
+      def refresh_token(token_uri)
+        uri = URI.parse(token_uri)
+
+        response = Net::HTTP.post_form(uri, params)
+        token_data = JSON.parse(response.body)
+
+        token_data["access_token"]
+      end
+
+      def params
+        {
+          "grant_type" => "refresh_token",
+          "refresh_token" => config[:refresh_token],
+          "client_id" => config[:client_id],
+          "client_secret" => config[:client_secret]
+        }
+      end
+    end
+  end
+end

data/lib/bns/fetcher/imap/types/response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Fetcher
+  module Imap
+    module Types
+      ##
+      # Represents a response received from the Imap client. It encapsulates essential
+      # information about the response, providing a structured way to handle and analyze
+      # it's responses.
+      class Response
+        attr_reader :status_code, :message, :results
+
+        def initialize(response)
+          if response.empty?
+            @status_code = 404
+            @message = "no result were found"
+            @results = []
+          else
+            @status_code = 200
+            @message = "success"
+            @results = response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bns/fetcher/imap/use_case/support_emails.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Fetcher
+  module Imap
+    ##
+    # This class is an implementation of the Fetcher::Imap::Base interface, specifically designed
+    # for fetching support email from a Google Gmail account.
+    #
+    class SupportEmails < Imap::Base
+      TOKEN_URI = "https://oauth2.googleapis.com/token"
+      EMAIL_DOMAIN = "imap.gmail.com"
+      EMAIL_PORT = 993
+
+      # Implements the data fetching filter for support emails from Google Gmail.
+      #
+      def fetch
+        yesterday = (Time.now - (60 * 60 * 24)).strftime("%e-%b-%Y")
+        query = ["TO", config[:search_email], "SINCE", yesterday]
+
+        execute(EMAIL_DOMAIN, EMAIL_PORT, TOKEN_URI, query)
+      end
+    end
+  end
+end

data/lib/bns/formatter/pto.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "date"
+
 require_relative "../domain/pto"
 require_relative "./exceptions/invalid_data"
 require_relative "./base"
@@ -9,13 +11,15 @@ module Formatter
   # This class implements methods from the Formatter::Base module, tailored to format the
   # Domain::Pto structure for a dispatcher.
   class Pto < Base
+    DEFAULT_TIME_ZONE = "+00:00"
+
     # Initializes the Slack formatter with essential configuration parameters.
     #
     # <b>timezone</b> : expect an string with the time difference relative to the UTC. Example: "-05:00"
     def initialize(config = {})
       super(config)
 
-      @timezone = config[:timezone]
+      @timezone = config[:timezone] || DEFAULT_TIME_ZONE
     end
 
     # Implements the logic for building a formatted payload with the given template for PTO's.
@@ -64,7 +68,9 @@ module Formatter
     end
 
     def format_timezone(date)
-      @timezone.nil? ? Time.new(date) : Time.new(date, in: @timezone)
+      date_time = build_date(date)
+
+      Time.at(date_time, in: @timezone)
     end
 
     def today?(date)
@@ -72,5 +78,11 @@ module Formatter
 
       date == format_timezone(time_now).strftime("%F")
     end
+
+    def build_date(date)
+      date_time = date.include?("T") ? date : "#{date}T00:00:00.000#{@timezone}"
+
+      DateTime.parse(date_time).to_time
+    end
   end
 end

data/lib/bns/formatter/support_emails.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "../domain/email"
+require_relative "./exceptions/invalid_data"
+require_relative "./base"
+
+module Formatter
+  ##
+  # This class implements methods from the Formatter::Base module, tailored to format the
+  # Domain::Email structure for a dispatcher.
+  class SupportEmails < Base
+    DEFAULT_TIME_ZONE = "+00:00"
+
+    # Initializes the formatter with essential configuration parameters.
+    #
+    # <b>timezone</b> : expect an string with the time difference relative to the UTC. Example: "-05:00"
+    def initialize(config = {})
+      super(config)
+
+      @timezone = config[:timezone] || DEFAULT_TIME_ZONE
+      @frecuency = config[:frecuency]
+    end
+
+    # Implements the logic for building a formatted payload with the given template for support emails.
+    #
+    # <br>
+    # <b>Params:</b>
+    # * <tt>List<Domain::Email></tt> support_emails_list: list of support emails.
+    #
+    # <br>
+    # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
+    #
+    # <br>
+    # <b>returns</b> <tt>String</tt> payload: formatted payload suitable for a Dispatcher.
+    #
+    def format(support_emails_list)
+      raise Formatter::Exceptions::InvalidData unless support_emails_list.all? do |support_email|
+        support_email.is_a?(Domain::Email)
+      end
+
+      process_emails(support_emails_list).reduce("") do |payload, support_email|
+        payload + build_template(Domain::Email::ATTRIBUTES, support_email)
+      end
+    end
+
+    private
+
+    def process_emails(emails)
+      emails.each { |email| email.date = at_timezone(email.date) }
+      emails.filter! { |email| email.date > time_window } unless @frecuency.nil?
+
+      format_timestamp(emails)
+    end
+
+    def format_timestamp(emails)
+      emails.each { |email| email.date = email.date.strftime("%F %r") }
+    end
+
+    def time_window
+      date_time = Time.now - (60 * 60 * @frecuency)
+
+      at_timezone(date_time)
+    end
+
+    def at_timezone(date)
+      Time.at(date, in: @timezone)
+    end
+  end
+end

data/lib/bns/formatter/work_items_limit.rb

@@ -9,7 +9,16 @@ module Formatter
   # This class implements methods from the Formatter::Base module, tailored to format the
   # Domain::WorkItemsLimit structure for a dispatcher.
   class WorkItemsLimit < Base
-    attr_reader :limit
+    DEFAULT_DOMAIN_LIMIT = 6
+
+    # Initializes the formatter with essential configuration parameters.
+    #
+    # <b>limits</b> : expect a map with the wip limits by domain. Example: { "ops": 5 }
+    def initialize(config = {})
+      super(config)
+
+      @limits = config[:limits]
+    end
 
     # Implements the logic for building a formatted payload with the given template for wip limits.
     #
@@ -30,14 +39,26 @@ module Formatter
       end
 
       exceeded_domains(work_items_list).reduce("") do |payload, work_items_limit|
-        payload + build_template(Domain::WorkItemsLimit::ATTRIBUTES, work_items_limit)
+        built_template = build_template(Domain::WorkItemsLimit::ATTRIBUTES, work_items_limit)
+        payload + format_message_by_case(built_template.gsub("\n", ""), work_items_limit)
       end
     end
 
     private
 
+    def format_message_by_case(template, work_items_limit)
+      total_items = work_items_limit.total
+      limit = domain_limit(work_items_limit.domain)
+
+      template + ", #{total_items} of #{limit}\n"
+    end
+
     def exceeded_domains(work_items_list)
-      work_items_list.filter { |work_item| work_item.total > work_item.wip_limit }
+      work_items_list.filter { |work_item| work_item.total > domain_limit(work_item.domain) }
+    end
+
+    def domain_limit(domain)
+      @limits[domain.to_sym] || DEFAULT_DOMAIN_LIMIT
     end
   end
 end

data/lib/bns/mapper/imap/support_emails.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "../../domain/email"
+require_relative "../base"
+
+module Mapper
+  module Imap
+    ##
+    # This class implementats the methods of the Mapper::Base module, specifically designed for
+    # preparing or shaping support emails data coming from a Fetcher::Base implementation.
+    class SupportEmails
+      include Base
+
+      # Implements the logic for shaping the results from a fetcher response.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Fetcher::Imap::Types::Response</tt> imap_response: Array of imap emails data.
+      #
+      # <br>
+      # <b>return</b> <tt>List<Domain::Email></tt> support_emails_list, mapped support emails to be used by a
+      # Formatter::Base implementation.
+      #
+      def map(imap_response)
+        return [] if imap_response.results.empty?
+
+        normalized_email_data = normalize_response(imap_response.results)
+
+        normalized_email_data.map do |email|
+          Domain::Email.new(email["subject"], email["sender"], email["date"])
+        end
+      end
+
+      private
+
+      def normalize_response(results)
+        return [] if results.nil?
+
+        results.map do |value|
+          {
+            "sender" => extract_sender(value),
+            "date" => value.date,
+            "subject" => value.subject
+          }
+        end
+      end
+
+      def extract_sender(value)
+        mailbox = value.sender[0]["mailbox"]
+        host = value.sender[0]["host"]
+
+        "#{mailbox}@#{host}"
+      end
+    end
+  end
+end

data/lib/bns/use_cases/use_cases.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
+# fetcher
 require_relative "../fetcher/notion/use_case/birthday_today"
 require_relative "../fetcher/notion/use_case/birthday_next_week"
 require_relative "../fetcher/notion/use_case/pto_today"
 require_relative "../fetcher/notion/use_case/pto_next_week"
 require_relative "../fetcher/notion/use_case/work_items_limit"
 require_relative "../fetcher/postgres/use_case/pto_today"
+require_relative "../fetcher/imap/use_case/support_emails"
 
+# mapper
 require_relative "../mapper/notion/birthday_today"
 require_relative "../mapper/notion/pto_today"
 require_relative "../mapper/notion/work_items_limit"
 require_relative "../mapper/postgres/pto_today"
+require_relative "../mapper/imap/support_emails"
 
+# formatter
 require_relative "../formatter/birthday"
 require_relative "../formatter/pto"
 require_relative "../formatter/work_items_limit"
+require_relative "../formatter/support_emails"
 
+# dispatcher
 require_relative "../dispatcher/discord/implementation"
 require_relative "../dispatcher/slack/implementation"
 
@@ -325,4 +332,46 @@ module UseCases
 
     UseCases::UseCase.new(use_case_config)
   end
+
+  # Provides an instance of the support emails from an google IMAP server to Discord use case implementation.
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     fetch_options: {
+  #       user: 'info@email.co',
+  #       refresh_token: REFRESH_TOKEN,
+  #       client_id: CLIENT_ID,
+  #       client_secret: CLIENT_SECRET,
+  #       inbox: 'INBOX',
+  #       search_email: 'support@email.co'
+  #     },
+  #     dispatch_options: {
+  #       webhook: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
+  #       name: "emailSupport"
+  #     }
+  #   }
+  #
+  #   use_case = UseCases.notify_support_email_from_imap_to_discord(options)
+  #   use_case.perform
+  #
+  #   #################################################################################
+  #
+  #   Requirements:
+  #   * A google gmail account with IMAP support activated.
+  #   * A set of authorization parameters like a client_id, client_secret, and a resfresh_token. To
+  #     generate them, follow this instructions: https://developers.google.com/identity/protocols/oauth2
+  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
+  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
+  #
+  def self.notify_support_email_from_imap_to_discord(options)
+    fetcher = Fetcher::Imap::SupportEmails.new(options[:fetch_options])
+    mapper = Mapper::Imap::SupportEmails.new
+    formatter = Formatter::SupportEmails.new(options[:format_options])
+    dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    UseCases::UseCase.new(use_case_config)
+  end
 end

data/lib/bns/version.rb

@@ -2,5 +2,5 @@
 
 module Bns
   # Gem version
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-03-20 00:00:00.000000000 Z
 dependencies: []
 description: A versatile business notification system offering key components for
   building various use cases.     It provides an easy-to-use tool for implementing
@@ -39,10 +39,14 @@ files:
 - lib/bns/dispatcher/slack/implementation.rb
 - lib/bns/dispatcher/slack/types/response.rb
 - lib/bns/domain/birthday.rb
+- lib/bns/domain/email.rb
 - lib/bns/domain/exceptions/function_not_implemented.rb
 - lib/bns/domain/pto.rb
 - lib/bns/domain/work_items_limit.rb
 - lib/bns/fetcher/base.rb
+- lib/bns/fetcher/imap/base.rb
+- lib/bns/fetcher/imap/types/response.rb
+- lib/bns/fetcher/imap/use_case/support_emails.rb
 - lib/bns/fetcher/notion/base.rb
 - lib/bns/fetcher/notion/exceptions/invalid_api_key.rb
 - lib/bns/fetcher/notion/exceptions/invalid_database_id.rb
@@ -61,8 +65,10 @@ files:
 - lib/bns/formatter/birthday.rb
 - lib/bns/formatter/exceptions/invalid_data.rb
 - lib/bns/formatter/pto.rb
+- lib/bns/formatter/support_emails.rb
 - lib/bns/formatter/work_items_limit.rb
 - lib/bns/mapper/base.rb
+- lib/bns/mapper/imap/support_emails.rb
 - lib/bns/mapper/notion/birthday_today.rb
 - lib/bns/mapper/notion/pto_today.rb
 - lib/bns/mapper/notion/work_items_limit.rb