bns 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a422fa03f80a83a9c8ba021d998a00b90ee7381a5167d96e23562c67cc6d73d1
-  data.tar.gz: 168f81ac480dc71796c2123c24ad27a5b04cbd1a9543388c1010425a037ad08f
+  metadata.gz: '088295440471344d853d850bf071e7fb885fa824a49bfcd182fe5d6a6de03b6c'
+  data.tar.gz: 909cec977526aaf735599e1b6dcbf8a0144eeb0dc8f02a37e371a4f90fb62405
 SHA512:
-  metadata.gz: 28919c76616533281768cd65bb00e4e2d0d7c0e22c480ffe38bf75d23e5d46a3b768f3e1e99bc68e55b3d822eb01fd598731e12e35351f8b29a15b60f80bee3d
-  data.tar.gz: d88313f8d80abce0480c63a4e35d8b5ccfa0151c2afb13205b2ae31a755974d72f2be87fdd726ac573b6b80ac4f1fcd133899936b04728af70e95d3be4a358e7
+  metadata.gz: 473e834fb819c4f8b36a053643b883b2cf5704c89aa470f9a58c063e148fbdfa7c8f78ac745b85f9ef193066f4e00e4b084f2add8385a58f892759297a23fa1f
+  data.tar.gz: bc15074b2628619f25786b8da2edcd5a0ec20eb5154df50027450886bc7e2f3c6cceba8897081ef78d0ac9770d19c2ca349ff799c64842bdef8ef4736a6b6fe6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 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/README.md

@@ -2,10 +2,13 @@
 
 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.
 
+![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
 

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/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/formatter/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../domain/exceptions/function_not_implemented"
+require "erb"
 
 module Formatter
   ##
@@ -8,7 +9,7 @@ module Formatter
   # within the Formatter module. Defines essential methods, that provide a blueprint for creating custom
   # formatters tailored to different use cases.
   #
-  module Base
+  class Base
     # A method meant to give an specified format depending on the implementation to the data coming from an
     # implementation of the Mapper::Base interface.
     # Must be overridden by subclasses, with specific logic based on the use case.
@@ -22,8 +23,28 @@ module Formatter
     #
     # <b>returns</b> <tt>String</tt> Formatted payload suitable for a Dispatcher::Base implementation.
     #
+    attr_reader :template
+
+    def initialize(config = {})
+      @template = config[:template]
+    end
+
     def format(_domain_data)
       raise Domain::Exceptions::FunctionNotImplemented
     end
+
+    protected
+
+    def build_template(attributes, instance)
+      formated_template = format_template(attributes, instance)
+
+      "#{ERB.new(formated_template).result(binding)}\n"
+    end
+
+    def format_template(attributes, _instance)
+      attributes.reduce(template) do |formated_template, attribute|
+        formated_template.gsub(attribute, "<%= instance.#{attribute} %>")
+      end
+    end
   end
 end

data/lib/bns/formatter/discord/birthday.rb

@@ -9,9 +9,7 @@ module Formatter
     ##
     # This class implementats the methods of the Formatter::Base module, specifically designed for formatting birthday
     # data in a way suitable for Discord messages.
-    class Birthday
-      include Base
-
+    class Birthday < Base
       # Implements the logic for building a formatted payload with the given template for birthdays.
       #
       # <br>
@@ -29,14 +27,9 @@ module Formatter
                                                                    brithday.is_a?(Domain::Birthday)
                                                                  end
 
-        template = "NAME, Wishing you a very happy birthday! Enjoy your special day! :birthday: :gift:"
-        payload = ""
-
-        birthdays_list.each do |birthday|
-          payload += "#{template.gsub("NAME", birthday.individual_name)}\n"
+        birthdays_list.reduce("") do |payload, birthday|
+          payload + build_template(Domain::Birthday::ATTRIBUTES, birthday)
         end
-
-        payload
       end
     end
   end

data/lib/bns/formatter/discord/pto.rb

@@ -8,9 +8,7 @@ module Formatter
     ##
     # This class is an implementation of the Formatter::Base interface, specifically designed for formatting PTO
     # data in a way suitable for Discord messages.
-    class Pto
-      include Base
-
+    class Pto < Base
       # Implements the logic for building a formatted payload with the given template for PTO's.
       #
       # <br>
@@ -23,28 +21,27 @@ module Formatter
       # <br>
       # <b>returns</b> <tt>String</tt> payload, formatted payload suitable for a Discord message.
       #
+
       def format(ptos_list)
         raise Formatter::Discord::Exceptions::InvalidData unless ptos_list.all? { |pto| pto.is_a?(Domain::Pto) }
 
-        template = ":beach: NAME is on PTO"
-        payload = ""
-
-        ptos_list.each do |pto|
-          payload += "#{template.gsub("NAME", pto.individual_name)} #{build_pto_message(pto)}\n"
+        ptos_list.reduce("") do |payload, pto|
+          built_template = build_template(Domain::Pto::ATTRIBUTES, pto)
+          payload + format_message_by_case(built_template.gsub("\n", ""), pto)
         end
-
-        payload
       end
 
       private
 
-      def build_pto_message(pto)
+      def format_message_by_case(built_template, pto)
         if pto.start_date.include?("|")
           start_time = pto.start_date.split("|")
           end_time = pto.end_date.split("|")
-          "#{start_time[1]} - #{end_time[1]}"
+          "#{built_template} #{start_time[1]} - #{end_time[1]}\n"
+        elsif pto.start_date == pto.end_date
+          "#{built_template} all day\n"
         else
-          "all day"
+          "#{built_template} #{pto.start_date} - #{pto.end_date}\n"
         end
       end
     end

data/lib/bns/use_cases/use_cases.rb

@@ -73,7 +73,7 @@ module UseCases
   def self.notify_birthday_from_notion_to_discord(options)
     fetcher = Fetcher::Notion::Birthday.new(options[:fetch_options])
     mapper = Mapper::Notion::Birthday.new
-    formatter = Formatter::Discord::Birthday.new
+    formatter = Formatter::Discord::Birthday.new(options[:format_options])
     dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
     use_case_cofig = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
 
@@ -141,7 +141,7 @@ module UseCases
   def self.notify_pto_from_notion_to_discord(options)
     fetcher = Fetcher::Notion::Pto.new(options[:fetch_options])
     mapper = Mapper::Notion::Pto.new
-    formatter = Formatter::Discord::Pto.new
+    formatter = Formatter::Discord::Pto.new(options[:format_options])
     dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
     use_case_cofig = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
 

data/lib/bns/version.rb

@@ -2,5 +2,5 @@
 
 module Bns
   # Gem version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:semverAllMonthly"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-08 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
@@ -25,10 +25,10 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
 - lib/bns.rb
 - lib/bns/dispatcher/base.rb
 - lib/bns/dispatcher/discord/exceptions/invalid_webhook_token.rb
@@ -55,6 +55,7 @@ files:
 - lib/bns/use_cases/use_case.rb
 - lib/bns/use_cases/use_cases.rb
 - lib/bns/version.rb
+- renovate.json
 - sig/business_notification_system.rbs
 homepage: https://github.com/kommitters/bns
 licenses:

data/Gemfile.lock

@@ -1,91 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bns (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    hashdiff (1.1.0)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    mini_mime (1.1.5)
-    multi_xml (0.6.0)
-    parallel (1.24.0)
-    parser (3.3.0.3)
-      ast (~> 2.4.1)
-      racc
-    public_suffix (5.0.4)
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.59.0)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.5.0)
-    vcr (6.2.0)
-    webmock (3.19.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  arm64-darwin-23
-  x86_64-linux
-
-DEPENDENCIES
-  bns!
-  httparty
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  simplecov
-  simplecov-lcov (~> 0.8.0)
-  vcr
-  webmock
-
-BUNDLED WITH
-   2.4.10