bns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a422fa03f80a83a9c8ba021d998a00b90ee7381a5167d96e23562c67cc6d73d1
-  data.tar.gz: 168f81ac480dc71796c2123c24ad27a5b04cbd1a9543388c1010425a037ad08f
+  metadata.gz: 7f27d7368a358fcf6dea96e51922690ff399670b5582387b70f56db0d5b25feb
+  data.tar.gz: a46adf0a088dd65740c85aadc5d3005654f3654e2f12cecf345700be7f44f2b1
 SHA512:
-  metadata.gz: 28919c76616533281768cd65bb00e4e2d0d7c0e22c480ffe38bf75d23e5d46a3b768f3e1e99bc68e55b3d822eb01fd598731e12e35351f8b29a15b60f80bee3d
-  data.tar.gz: d88313f8d80abce0480c63a4e35d8b5ccfa0151c2afb13205b2ae31a755974d72f2be87fdd726ac573b6b80ac4f1fcd133899936b04728af70e95d3be4a358e7
+  metadata.gz: bfa9c1394d5fe161f90fe86e29a44acace8b2a7809ee8bd233ee12d0be082b11a0081e3fb98efefcdfe22c64a50f27335a95ac24f9c8baeec10c5a9f8d381754
+  data.tar.gz: a13978067c0c9ad5a96c8abc8ae2f7781674a0f4b3accc9b2229a11dde525f706a52ee448effad8570c34b2141a5e9c3ad0a3457f29dea2f5d60d42c6ba7bd4e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 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)
+
 ## 0.1.0 (06.02.2024)
 
 - [Build initial codebase](https://github.com/kommitters/bns/issues/6)

data/Gemfile

@@ -16,3 +16,5 @@ gem "vcr"
 gem "webmock"
 
 gem "httparty"
+
+gem "pg", "~> 1.5", ">= 1.5.4"

data/README.md

@@ -1,11 +1,16 @@
 # 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)
 ![Build Badge](https://img.shields.io/github/actions/workflow/status/kommitters/bns/ci.yml?branch=project-opensource-config&style=for-the-badge)
 [![Coverage Status](https://img.shields.io/coveralls/github/kommitters/bns?style=for-the-badge)](https://coveralls.io/github/kommitters/bns?branch=main)
-[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/bns?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/bns)
 ![GitHub License](https://img.shields.io/github/license/kommitters/bns?style=for-the-badge)
+[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/bns?label=openssf%20scorecard&style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/bns)
+[![OpenSSF Best Practices](https://img.shields.io/cii/summary/8383?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/8383)
 
 ## Installation
 
@@ -147,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/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Reporting Security Issues
+
+To report a security issue, you can either:
+- Privately report a vulnerability through repository's Security tab by clicking "Report a vulnerability".
+- Email us at [oss@kommit.co](mailto:oss@kommit.co).
+
+Please, make sure to provide a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue.
+
+## Responsible Disclosure
+
+If the issue is confirmed as a vulnerability, we will open a Security Advisory and acknowledge your contributions as part of it.

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/birthday.rb

@@ -8,6 +8,8 @@ module Domain
   class Birthday
     attr_reader :individual_name, :birth_date
 
+    ATTRIBUTES = %w[individual_name birth_date].freeze
+
     # Initializes a Domain::Birthday instance with the specified individual name, and date of birth.
     #
     # <br>

data/lib/bns/domain/pto.rb

@@ -9,6 +9,8 @@ module Domain
   class Pto
     attr_reader :individual_name, :start_date, :end_date
 
+    ATTRIBUTES = %w[individual_name start_date end_date].freeze
+
     # Initializes a Domain::Pto instance with the specified individual name, start date, and end date.
     #
     # <br>

data/lib/bns/domain/work_items_limit.rb

@@ -0,0 +1,39 @@
+# 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, total, and wip_limit.
+  #
+  class WorkItemsLimit
+    attr_reader :domain, :total, :wip_limit
+
+    ATTRIBUTES = %w[domain total wip_limit].freeze
+
+    # Initializes a Domain::WorkItemsLimit instance with the specified domain, total and wip_limit.
+    #
+    # <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/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/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

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

@@ -0,0 +1,71 @@
+# 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 Paid Time Off (PTO) data from Notion.
+    #
+    class PtoNextWeek < Notion::Base
+      # Implements the data fetching filter for next week PTO's data from Notion.
+      #
+      def fetch
+        filter = build_filter
+
+        execute(filter)
+      end
+
+      private
+
+      def next_week_dates
+        monday = next_week_monday
+        sunday = monday + 6
+
+        [monday, sunday]
+      end
+
+      def next_week_monday
+        today = Date.today
+        week_day = today.wday
+
+        days = week_day.zero? ? 1 : 8 - week_day
+
+        today + days
+      end
+
+      def build_filter
+        monday, sunday = next_week_dates
+
+        {
+          filter: {
+            or: [
+              belong_next_week("Desde?", monday, sunday),
+              belong_next_week("Hasta?", monday, sunday),
+              cover_next_week(monday, sunday)
+            ]
+          }
+        }
+      end
+
+      def belong_next_week(property, after_day, before_day)
+        {
+          and: [
+            { property: property, date: { on_or_after: after_day } },
+            { property: property, date: { on_or_before: before_day } }
+          ]
+        }
+      end
+
+      def cover_next_week(monday, sunday)
+        {
+          and: [
+            { property: "Hasta?", date: { on_or_after: sunday } },
+            { property: "Desde?", date: { on_or_before: monday } }
+          ]
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# 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 Paid Time Off (PTO) data from Notion.
+    #
+    class PtoToday < Notion::Base
+      # Implements the data fetching filter for todays PTO's data from Notion.
+      #
+      def fetch
+        today = Time.now.utc.strftime("%F").to_s
+
+        filter = {
+          filter: {
+            "and": [
+              { property: "Desde?", date: { on_or_before: today } },
+              { property: "Hasta?", date: { on_or_after: today } }
+            ]
+          }
+        }
+
+        execute(filter)
+      end
+    end
+  end
+end