bns 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '088295440471344d853d850bf071e7fb885fa824a49bfcd182fe5d6a6de03b6c'
-  data.tar.gz: 909cec977526aaf735599e1b6dcbf8a0144eeb0dc8f02a37e371a4f90fb62405
+  metadata.gz: f45452ff8e3569ad4ffed2d32d8cc7801cd5a4379205ca70d7d401814abb7d50
+  data.tar.gz: 64cd26aaa2269270f77f50ec5b1d4371272d4f53d280bed5b0ccd727b0e628b7
 SHA512:
-  metadata.gz: 473e834fb819c4f8b36a053643b883b2cf5704c89aa470f9a58c063e148fbdfa7c8f78ac745b85f9ef193066f4e00e4b084f2add8385a58f892759297a23fa1f
-  data.tar.gz: bc15074b2628619f25786b8da2edcd5a0ec20eb5154df50027450886bc7e2f3c6cceba8897081ef78d0ac9770d19c2ca349ff799c64842bdef8ef4736a6b6fe6
+  metadata.gz: a61ce154f73bcf97b76828f437cf4cbd0af1809458532de9ec232343e9a92c85ec118d336a5f13b4eb95cb8e792e2b10bd941c90c79c720c2ae7b4fd5272543f
+  data.tar.gz: '088fc7b072e971ebc37259cc2e017bcc22aa69d9c8d2f035958bb33b578108235686f889c1faccdb6a6566e39b44cddacc6a356c737a81924cebd10d6379d057'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # 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)
+- [Slack dispatcher](https://github.com/kommitters/bns/issues/32)
+- [Refactor fetcher components](https://github.com/kommitters/bns/issues/34)
+- [Add Use Case - Boards WI alerts](https://github.com/kommitters/bns/issues/36)
+- [Add Use Case - Next Week Birthday](https://github.com/kommitters/bns/issues/38)
+- [Add Use Case - Next Week PTO's](https://github.com/kommitters/bns/issues/39)
+
 ## 0.1.1 (07.02.2024)
 - [Add custom templates option](https://github.com/kommitters/bns/issues/25)
 - [PTO's formatting use cases](https://github.com/kommitters/bns/issues/24)

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
@@ -16,3 +18,7 @@ gem "vcr"
 gem "webmock"
 
 gem "httparty"
+
+gem "pg", "~> 1.5", ">= 1.5.4"
+
+gem "gmail_xoauth"

data/README.md

@@ -1,6 +1,8 @@
 # BNS - Business Notification System
 
-The business notification system is designed to be a versatile platform, offering key components for building various use cases. It provides an easy-to-use tool for implementing notifications without excessive complexity.
+Many organizations and individuals rely on automatic notifications across various contexts in their daily operations. With BNS, we aim to provide an open-source platform that empowers users to create customized notification systems tailored to their unique requirements. BNS consists of a series of abstract components designed to facilitate the creation of diverse use cases, regardless of context.
+
+The underlying idea is to develop generic components that can serve a wide range of needs, this approach ensures that all members of the community can leverage the platform's evolving suite of components and use cases to their advantage.
 
 ![Gem Version](https://img.shields.io/gem/v/bns?style=for-the-badge)
 ![Gem Total Downloads](https://img.shields.io/gem/dt/bns?style=for-the-badge)
@@ -150,9 +152,163 @@ use_case.perform
 
 ```
 
-**Serverless**
+### Serverless
+We'll explain how to configure and deploy a use case with serverless, this example will cover the PTO's notifications use case.
+
+#### Configuring environment variables
+Create the environment variables configuration file.
+
+```bash
+cp env.yml.example env.yml
+```
 
-Examples of different use cases, and how to configure and deploy the lambdas can be found on: `https://github.com/kommitters/bns_serverless`
+And put the following env variables
+```
+dev:
+  NOTION_DATABASE_ID: NOTION_DATABASE_ID
+  NOTION_SECRET: NOTION_SECRET
+  DISCORD_WEBHOOK: DISCORD_WEBHOOK
+  DISCORD_BOT_NAME: DISCORD_BOT_NAME
+prod:
+  NOTION_DATABASE_ID: NOTION_DATABASE_ID
+  NOTION_SECRET: NOTION_SECRET
+  DISCORD_WEBHOOK: DISCORD_WEBHOOK
+  DISCORD_BOT_NAME: DISCORD_BOT_NAME
+
+```
+
+The variables should be defined either in the custom settings section within the `serverless.yml` file to ensure accessibility by all lambdas, or in the environment configuration option for each lambda respectively. For example:
+
+```bash
+# Accessible by all the lambdas
+custom:
+  settings:
+      api:
+        NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
+        NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
+
+# Accessible by the lambda
+functions:
+  lambdaName:
+    environment:
+      NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
+      NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
+```
+
+#### Schedule
+the schedule is configured using an environment variable containing the cron configuration. For example:
+```bash
+# env.yml file
+SCHEDULER: cron(0 13 ? * MON-FRI *)
+
+# serverless.yml
+functions:
+  lambdaName:
+    events:
+      - schedule:
+        rate: ${file(./env.yml):${env:STAGE}.SCHEDULER}
+```
+
+To learn how to modify the cron configuration follow this guide: [Schedule expressions using rate or cron](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents-expressions.html)
+
+#### Building your lambda
+On your serverless configuration, create your lambda function, on your serverless `/src` folder.
+
+```ruby
+# frozen_string_literal: true
+
+require 'bns'
+
+# Initialize the environment variables
+NOTION_BASE_URL = 'https://api.notion.com'
+NOTION_DATABASE_ID = ENV.fetch('PTO_NOTION_DATABASE_ID')
+NOTION_SECRET = ENV.fetch('PTO_NOTION_SECRET')
+DISCORD_WEBHOOK = ENV.fetch('PTO_DISCORD_WEBHOOK')
+DISCORD_BOT_NAME = ENV.fetch('PTO_DISCORD_BOT_NAME')
+
+module Notifier
+  # Service description
+  class UseCaseName
+    def self.notify(*)
+      options = { fetch_options:, dispatch_options: }
+
+      begin
+        use_case = UseCases.use_case_build_function(options)
+
+        use_case.perform
+      rescue StandardError => e
+        { body: { message: e.message } }
+      end
+    end
+
+    def self.fetch_options
+      {
+        base_url: NOTION_BASE_URL,
+        database_id: NOTION_DATABASE_ID,
+        secret: NOTION_SECRET,
+        filter: {
+          filter: { "and": fetch_filter }
+        }
+      }
+    end
+
+    def self.fetch_filter
+      today = Common::TimeZone.set_colombia_time_zone.strftime('%F').to_s
+
+      [
+        { property: 'Desde?', date: { on_or_before: today } },
+        { property: 'Hasta?', date: { on_or_after: today } }
+      ]
+    end
+
+    def self.dispatch_options
+      {
+        webhook: DISCORD_WEBHOOK,
+        name: DISCORD_BOT_NAME
+      }
+    end
+
+    def self.format_options
+      {
+        template: ':beach: individual_name is on PTO'
+      }
+    end
+  end
+end
+```
+
+#### Configure the lambda
+In the `serverless.yml` file, add a new instance in the `functions` block with this structure:
+
+```bash
+functions:
+  ptoNotification:
+    handler: src/lambdas/pto_notification.Notifier::PTO.notify
+    environment:
+      PTO_NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.PTO_NOTION_DATABASE_ID}
+      PTO_NOTION_SECRET: ${file(./env.yml):${env:STAGE}.PTO_NOTION_SECRET}
+      PTO_DISCORD_WEBHOOK: ${file(./env.yml):${env:STAGE}.PTO_DISCORD_WEBHOOK}
+      PTO_DISCORD_BOT_NAME: ${file(./env.yml):${env:STAGE}.DISCORD_BOT_NAME}
+    events:
+      - schedule:
+          name: pto-daily-notification
+          description: "Notify every 24 hours at 8:30 a.m (UTC-5) from monday to friday"
+          rate: cron(${file(./env.yml):${env:STAGE}.PTO_SCHEDULER})
+          enabled: true
+```
+
+#### Deploying
+
+Configure the AWS keys:
+
+```bash
+serverless config credentials --provider aws --key YOUR_KEY --secret YOUR_SECRET
+```
+
+Deploy the project:
+```bash
+STAGE=prod sls deploy --verbose
+```
 
 ## Development
 

data/lib/bns/dispatcher/discord/exceptions/invalid_webhook_token.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Dispatcher
-  module Exceptions
-    module Discord
+  module Discord
+    module Exceptions
       ##
       # Domain specific representation  when an invalid Discord webhook token is provided to Discord.
       #

data/lib/bns/dispatcher/discord/implementation.rb

@@ -41,7 +41,7 @@ module Dispatcher
       def validate_response(response)
         case response.code
         when 50_027
-          raise Exceptions::Discord::InvalidWebookToken, response.message
+          raise Discord::Exceptions::InvalidWebookToken, response.message
         else
           response
         end

data/lib/bns/dispatcher/slack/exceptions/invalid_webhook_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dispatcher
+  module Slack
+    module Exceptions
+      ##
+      # Domain specific representation when an invalid webhook token is provided to Slack.
+      #
+      class InvalidWebookToken < StandardError
+        def initialize(message = "The provided Webhook token is invalid.")
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/bns/dispatcher/slack/implementation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "./exceptions/invalid_webhook_token"
+require_relative "./types/response"
+
+module Dispatcher
+  module Slack
+    ##
+    # This class is an implementation of the Dispatcher::Base interface, specifically designed
+    # for dispatching messages to Slack.
+    #
+    class Implementation < Base
+      # Implements the dispatching logic for the Slack use case. It sends a POST request to
+      # the Slack webhook with the specified payload.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>String</tt> payload: Payload to be dispatched to slack.
+      # <br>
+      # <b>raises</b> <tt>Exceptions::Slack::InvalidWebookToken</tt> if the provided webhook token is invalid.
+      #
+      # <br>
+      # <b>returns</b> <tt>Dispatcher::Slack::Types::Response</tt>
+      #
+      def dispatch(payload)
+        body = {
+          username: name,
+          text: payload
+        }.to_json
+
+        response = HTTParty.post(webhook, { body: body, headers: { "Content-Type" => "application/json" } })
+
+        slack_response = Dispatcher::Discord::Types::Response.new(response)
+
+        validate_response(slack_response)
+      end
+
+      private
+
+      def validate_response(response)
+        case response.http_code
+        when 403
+          raise Dispatcher::Slack::Exceptions::InvalidWebookToken, response.message
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/bns/dispatcher/slack/types/response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dispatcher
+  module Slack
+    module Types
+      ##
+      # Represents a response received from Slack. It encapsulates essential information about the response,
+      # providing a structured way to handle and analyze Slack server responses.
+      #
+      class Response
+        attr_reader :body, :http_code, :message
+
+        def initialize(response)
+          @http_code = response.code
+          @message = response.message
+          @body = response.body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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 and total.
+  #
+  class WorkItemsLimit
+    attr_reader :domain, :total
+
+    ATTRIBUTES = %w[domain total].freeze
+
+    # 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.
+    #
+    def initialize(domain, total)
+      @domain = domain
+      @total = total
+    end
+  end
+end

data/lib/bns/fetcher/base.rb

@@ -26,5 +26,18 @@ module Fetcher
     def fetch
       raise Domain::Exceptions::FunctionNotImplemented
     end
+
+    protected
+
+    # A method meant to execute the fetch request, retrieven the required data
+    # from an specific filter configuration depending on the use case implementation.
+    # Must be overridden by subclasses, with specific logic based on the use case.
+    #
+    # <br>
+    # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
+    #
+    def execute
+      raise Domain::Exceptions::FunctionNotImplemented
+    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/fetcher/notion/{pto.rb → base.rb}

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
 require "httparty"
-require "date"
 
 require_relative "../base"
 require_relative "./exceptions/invalid_api_key"
 require_relative "./exceptions/invalid_database_id"
 require_relative "./types/response"
+require_relative "./helper"
 
 module Fetcher
   module Notion
     ##
     # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching Paid Time Off (PTO) data from Notion.
+    # for fetching data from Notion.
     #
-    class Pto < Base
-      # Implements the data fetching logic for PTO's data from Notion. It sends a POST
+    class Base < Fetcher::Base
+      NOTION_BASE_URL = "https://api.notion.com"
+
+      protected
+
+      # Implements the data fetching logic for data from Notion. It sends a POST
       # request to the Notion API to query the specified database and returns a validated response.
       #
       # <br>
@@ -24,10 +28,10 @@ module Fetcher
       # <b>raises</b> <tt>Exceptions::Notion::InvalidDatabaseId</tt> if the Database id provided is incorrect
       # or invalid.
       #
-      def fetch
-        url = "#{config[:base_url]}/v1/databases/#{config[:database_id]}/query"
+      def execute(filter)
+        url = "#{NOTION_BASE_URL}/v1/databases/#{config[:database_id]}/query"
 
-        httparty_response = HTTParty.post(url, { body: config[:filter].to_json, headers: headers })
+        httparty_response = HTTParty.post(url, { body: filter.to_json, headers: headers })
 
         notion_response = Fetcher::Notion::Types::Response.new(httparty_response)
 

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

@@ -13,7 +13,7 @@ module Fetcher
           if response["results"].nil?
             @status_code = response["status"]
             @message = response["message"]
-            @results = nil
+            @results = []
           else
             @status_code = 200
             @message = "success"

data/lib/bns/fetcher/notion/use_case/birthday_next_week.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Fetcher
+  module Notion
+    ##
+    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
+    # for fetching next week birthdays data from Notion.
+    #
+    class BirthdayNextWeek < Notion::Base
+      DAYS_BEFORE_NOTIFY = 8
+
+      # Implements the data fetching filter for next week Birthdays data from Notion.
+      #
+      def fetch
+        filter = {
+          filter: {
+            or: [
+              { property: "BD_this_year", date: { equals: eight_days_from_now } }
+            ]
+          }
+        }
+
+        execute(filter)
+      end
+
+      private
+
+      def eight_days_from_now
+        date = Time.now.utc + days_in_second(DAYS_BEFORE_NOTIFY)
+
+        date.utc.strftime("%F").to_s
+      end
+
+      def days_in_second(days)
+        days * 24 * 60 * 60
+      end
+    end
+  end
+end

data/lib/bns/fetcher/notion/use_case/birthday_today.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Fetcher
+  module Notion
+    ##
+    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
+    # for fetching birthday data from Notion.
+    #
+    class BirthdayToday < Notion::Base
+      # Implements the data fetching filter for todays Birthdays data from Notion.
+      #
+      def fetch
+        today = Time.now.utc.strftime("%F").to_s
+
+        filter = {
+          filter: {
+            or: [
+              { property: "BD_this_year", date: { equals: today } }
+            ]
+          }
+        }
+
+        execute(filter)
+      end
+    end
+  end
+end