bas 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d8ff973fc126ff9d0af5adf9200417f302a9a86cc50be3d3ef090a8979a22b1
-  data.tar.gz: 846dfe3cd6d719aa0a7cc17ce2219a0dee54a5d89043a475ec93b4786fd688d2
+  metadata.gz: 97cc25416cff1a50cad38e85bbc1e7389693ccf2f4004a1c5fb8d5049162b407
+  data.tar.gz: efef410e0d776c8808655dbd20cb7500c81bcf53c16f072a7103d5827def9e58
 SHA512:
-  metadata.gz: 14ea01f630b4a296fa94a352d14bc00111833d2f5b1867861280c5aa32abca445bdc7ec888c83a4a673109aba2c5e3239fdccc48cc7315477a3b579d200b649c
-  data.tar.gz: 3b73cf8b1dc7d931c3cd428141f2a3806c1b90c23bb1c0ac2dc755bf16278b679f42405f4d504b5cfbd6d1f09787d065f34fe3a06cee15ed9d684a93d2249971
+  metadata.gz: f7d915c41461667d858750e117e63468fba9cdea4fac59dfd80b0dcf1a7c4ce749b773378b06a81e2cdfafbefce92a61a2ee8415a80edd6a1e1a61380c5bdda9
+  data.tar.gz: fa174b7e86b013055efabe32b7dc7c2f213bd8dd18600c35e655d4c7512ce8e8f7ed4e104c091ca5b4def7180d4499a1c37f3dd5f4ad5e0a936ac79d716f03b1

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
 
+## 0.2.0 (04.04.2024)
+- [Add a GitHub fetcher component](https://github.com/kommitters/bas/issues/6)
+- [Allow daily hours pto for more than one day pto](https://github.com/kommitters/bas/issues/8)
+
 ## 0.1.0 (26.03.2024)
 - [Add the BNS gem code](https://github.com/kommitters/bas/issues/1)

data/Gemfile

@@ -5,10 +5,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bas.gemspec
 gemspec
 
+gem "jwt", "~> 2.8.1"
+
 gem "rake", "~> 13.0"
 
 gem "net-imap", "~> 0.4.10"
 gem "net-smtp", "~> 0.4.0.1"
+
+gem "octokit", "~> 8.1.0"
+gem "openssl", "~> 3.2"
+
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "simplecov", require: false, group: :test

data/README.md

@@ -6,11 +6,11 @@ The underlying idea is to develop generic components that can serve a wide range
 
 ![Gem Version](https://img.shields.io/gem/v/bas?style=for-the-badge)
 ![Gem Total Downloads](https://img.shields.io/gem/dt/bas?style=for-the-badge)
-![Build Badge](https://img.shields.io/github/actions/workflow/status/kommitters/bas/ci.yml?branch=project-opensource-config&style=for-the-badge)
+![Build Badge](https://img.shields.io/github/actions/workflow/status/kommitters/bas/ci.yml?style=for-the-badge)
 [![Coverage Status](https://img.shields.io/coveralls/github/kommitters/bas?style=for-the-badge)](https://coveralls.io/github/kommitters/bas?branch=main)
 ![GitHub License](https://img.shields.io/github/license/kommitters/bas?style=for-the-badge)
 [![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/bas?label=openssf%20scorecard&style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/bas)
-[![OpenSSF Best Practices](https://img.shields.io/cii/summary/8383?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/8383)
+[![OpenSSF Best Practices](https://img.shields.io/cii/summary/8713?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/8713)
 
 ## Installation
 

data/lib/bas/domain/issue.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Domain
+  ##
+  # The Domain::Issue class provides a domain-specific representation of a Github issue object.
+  # It encapsulates information about a repository issue, including the title, state, assignees,
+  # description, and the repository url.
+  #
+  class Issue
+    attr_reader :title, :state, :assignees, :description, :url
+
+    ATTRIBUTES = %w[title state assignees description url].freeze
+
+    def initialize(title, state, assignees, body, url)
+      @title = title
+      @state = state
+      @assignees = assignees
+      @description = body
+      @url = url
+    end
+  end
+end

data/lib/bas/domain/pto.rb

@@ -7,9 +7,9 @@ module Domain
   # the start date, and the end date of the time off period.
   #
   class Pto
-    attr_reader :individual_name, :start_date, :end_date
+    attr_reader :individual_name, :start_date_from, :start_date_to, :end_date_from, :end_date_to
 
-    ATTRIBUTES = %w[individual_name start_date end_date].freeze
+    ATTRIBUTES = %w[individual_name start_date_from start_date_to end_date_from end_date_to].freeze
 
     # Initializes a Domain::Pto instance with the specified individual name, start date, and end date.
     #
@@ -21,8 +21,49 @@ module Domain
     #
     def initialize(individual_name, start_date, end_date)
       @individual_name = individual_name
-      @start_date = start_date
-      @end_date = end_date
+
+      @start_date_from = start_date[:from]
+      @start_date_to = start_date[:to]
+      @end_date_from = end_date[:from]
+      @end_date_to = end_date[:to]
+    end
+
+    def same_day?
+      start_date = extract_date(start_date_from)
+      end_date = extract_date(end_date_from)
+
+      start_date == end_date
+    end
+
+    def format_timezone(timezone)
+      @start_date_from = set_timezone(start_date_from, timezone)
+      @start_date_to = set_timezone(start_date_to, timezone)
+      @end_date_from = set_timezone(end_date_from, timezone)
+      @end_date_to = set_timezone(end_date_to, timezone)
+    end
+
+    private
+
+    def extract_date(date)
+      return if date.nil?
+
+      date.strftime("%F")
+    end
+
+    def build_date_time(date, timezone)
+      return if date.nil?
+
+      date_time = date.include?("T") ? date : "#{date}T00:00:00.000#{timezone}"
+
+      DateTime.parse(date_time).to_time
+    end
+
+    def set_timezone(date, timezone)
+      return if date.nil?
+
+      date_time = build_date_time(date, timezone)
+
+      Time.at(date_time, in: timezone)
     end
   end
 end

data/lib/bas/fetcher/github/base.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "octokit"
+require "openssl"
+require "jwt"
+
+require_relative "../base"
+require_relative "./types/response"
+
+module Fetcher
+  module Github
+    ##
+    # This class is an implementation of the Fetcher::Base interface, specifically designed
+    # for fetching data from a GitHub repository.
+    #
+    class Base < Fetcher::Base
+      protected
+
+      # Implements the data fetching logic to get data from a Github repository.
+      # It connects to Github using the octokit gem, authenticates with a github app,
+      # request the data and returns a validated response.
+      #
+      def execute(method, *filter)
+        octokit_response = octokit.public_send(method, *filter)
+
+        Fetcher::Github::Types::Response.new(octokit_response)
+      end
+
+      private
+
+      def octokit
+        Octokit::Client.new(bearer_token: access_token)
+      end
+
+      def access_token
+        app = Octokit::Client.new(client_id: config[:app_id], bearer_token: jwt)
+
+        app.create_app_installation_access_token(config[:installation_id])[:token]
+      end
+
+      def jwt
+        private_pem = File.read(config[:secret_path])
+        private_key = OpenSSL::PKey::RSA.new(private_pem)
+
+        JWT.encode(jwt_payload, private_key, "RS256")
+      end
+
+      def jwt_payload
+        {
+          iat: Time.now.to_i - 60,
+          exp: Time.now.to_i + (10 * 60),
+          iss: config[:app_id]
+        }
+      end
+    end
+  end
+end

data/lib/bas/fetcher/github/types/response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Fetcher
+  module Github
+    module Types
+      ##
+      # Represents a response received from the Octokit Github 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/bas/fetcher/github/use_case/repo_issues.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Fetcher
+  module Github
+    ##
+    # This class is an implementation of the Fetcher::Github::Base interface, specifically designed
+    # for fetching issues from a Github repository.
+    #
+    class RepoIssues < Github::Base
+      def fetch
+        execute("list_issues", config[:repo])
+      end
+    end
+  end
+end

data/lib/bas/formatter/pto.rb

@@ -38,6 +38,8 @@ module Formatter
     def format(ptos_list)
       raise Formatter::Exceptions::InvalidData unless ptos_list.all? { |pto| pto.is_a?(Domain::Pto) }
 
+      ptos_list.each { |pto| pto.format_timezone(@timezone) }
+
       ptos_list.reduce("") do |payload, pto|
         built_template = build_template(Domain::Pto::ATTRIBUTES, pto)
         payload + format_message_by_case(built_template.gsub("\n", ""), pto)
@@ -47,42 +49,37 @@ module Formatter
     private
 
     def format_message_by_case(built_template, pto)
-      date_start = format_timezone(pto.start_date).strftime("%F")
-      date_end = format_timezone(pto.end_date).strftime("%F")
-
-      if date_start == date_end
+      if pto.same_day?
         interval = same_day_interval(pto)
-        day_message = today?(date_start) ? "today" : "the day #{date_start}"
+        day_message = today?(pto.start_date_from) ? "today" : "the day #{pto.start_date_from.strftime("%F")}"
 
         "#{built_template} #{day_message} #{interval}\n"
       else
-        "#{built_template} from #{date_start} to #{date_end}\n"
+        start_date_interval = day_interval(pto.start_date_from, pto.start_date_to)
+        end_date_interval = day_interval(pto.end_date_from, pto.end_date_to)
+
+        "#{built_template} from #{start_date_interval} to #{end_date_interval}\n"
       end
     end
 
-    def same_day_interval(pto)
-      time_start = format_timezone(pto.start_date).strftime("%I:%M %P")
-      time_end = format_timezone(pto.end_date).strftime("%I:%M %P")
-
-      time_start == time_end ? "all day" : "from #{time_start} to #{time_end}"
-    end
+    def day_interval(start_date, end_date)
+      return start_date.strftime("%F") if end_date.nil?
 
-    def format_timezone(date)
-      date_time = build_date(date)
+      time_start = start_date.strftime("%I:%M %P")
+      time_end = end_date.strftime("%I:%M %P")
 
-      Time.at(date_time, in: @timezone)
+      "#{start_date.strftime("%F")} (#{time_start} - #{time_end})"
     end
 
-    def today?(date)
-      time_now = Time.now.strftime("%F")
+    def same_day_interval(pto)
+      time_start = pto.start_date_from.strftime("%I:%M %P")
+      time_end = pto.end_date_from.strftime("%I:%M %P")
 
-      date == format_timezone(time_now).strftime("%F")
+      time_start == time_end ? "all day" : "from #{time_start} to #{time_end}"
     end
 
-    def build_date(date)
-      date_time = date.include?("T") ? date : "#{date}T00:00:00.000#{@timezone}"
-
-      DateTime.parse(date_time).to_time
+    def today?(date)
+      date == Time.now(in: @timezone).strftime("%F")
     end
   end
 end

data/lib/bas/mapper/github/issues.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../domain/issue"
+require_relative "../base"
+
+module Mapper
+  module Github
+    ##
+    # This class implementats the methods of the Mapper::Base module, specifically designed for
+    # preparing or shaping Github issues data coming from a Fetcher::Base implementation.
+    class Issues
+      include Base
+
+      # Implements the logic for shaping the results from a fetcher response.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Fetcher::Github::Types::Response</tt> github_response: Array of github issues data.
+      #
+      # <br>
+      # <b>return</b> <tt>List<Domain::Issue></tt> mapped github issues to be used by a
+      # Formatter::Base implementation.
+      #
+      def map(github_response)
+        return [] if github_response.results.empty?
+
+        normalized_github_data = normalize_response(github_response.results)
+
+        normalized_github_data.map do |issue|
+          Domain::Issue.new(
+            issue["title"], issue["state"], issue["assignees"], issue["body"], issue["url"]
+          )
+        end
+      end
+
+      private
+
+      def normalize_response(results)
+        return [] if results.nil?
+
+        results.map do |value|
+          {
+            "title" => value[:title],
+            "state" => value[:state],
+            "assignees" => extract_assignees(value[:assignees]),
+            "body" => value[:body],
+            "url" => value[:url]
+          }
+        end
+      end
+
+      def extract_assignees(assignees)
+        assignees.map { |assignee| assignee[:login] }
+      end
+    end
+  end
+end

data/lib/bas/mapper/notion/pto_today.rb

@@ -42,19 +42,11 @@ module Mapper
         response.map do |value|
           pto_fields = value["properties"].slice(*PTO_PARAMS)
 
-          pto_fields.each do |field, pto_value|
-            pto_fields[field] = extract_pto_value(field, pto_value)
-          end
-
-          pto_fields
-        end
-      end
-
-      def extract_pto_value(field, value)
-        case field
-        when "Person" then extract_person_field_value(value)
-        when "Desde?" then extract_date_field_value(value)
-        when "Hasta?" then extract_date_field_value(value)
+          {
+            "Person" => extract_person_field_value(pto_fields["Person"]),
+            "Desde?" => extract_date_field_value(pto_fields["Desde?"]),
+            "Hasta?" => extract_date_field_value(pto_fields["Hasta?"])
+          }
         end
       end
 
@@ -62,9 +54,20 @@ module Mapper
         data["people"][0]["name"]
       end
 
-      def extract_date_field_value(data)
+      def extract_date_field_value(date)
+        {
+          from: extract_start_date(date),
+          to: extract_end_date(date)
+        }
+      end
+
+      def extract_start_date(data)
         data["date"]["start"]
       end
+
+      def extract_end_date(data)
+        data["date"]["end"]
+      end
     end
   end
 end

data/lib/bas/mapper/postgres/pto_today.rb

@@ -27,8 +27,8 @@ module Mapper
 
         ptos.map do |pto|
           name = pto["name"]
-          start_date = pto["start_date"]
-          end_date = pto["end_date"]
+          start_date = { from: pto["start_date"], to: nil }
+          end_date = { from: pto["end_date"], to: nil }
 
           Domain::Pto.new(name, start_date, end_date)
         end

data/lib/bas/use_cases/use_cases.rb

@@ -8,6 +8,7 @@ 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"
+require_relative "../fetcher/github/use_case/repo_issues"
 
 # mapper
 require_relative "../mapper/notion/birthday_today"
@@ -15,6 +16,7 @@ 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"
+require_relative "../mapper/github/issues"
 
 # formatter
 require_relative "../formatter/birthday"

data/lib/bas/version.rb

@@ -2,5 +2,5 @@
 
 module Bas
   # Gem version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies: []
 description: A versatile business automation system offering key components for building
   various use cases.     It provides an easy-to-use tool for implementing automation
@@ -41,9 +41,13 @@ files:
 - lib/bas/domain/birthday.rb
 - lib/bas/domain/email.rb
 - lib/bas/domain/exceptions/function_not_implemented.rb
+- lib/bas/domain/issue.rb
 - lib/bas/domain/pto.rb
 - lib/bas/domain/work_items_limit.rb
 - lib/bas/fetcher/base.rb
+- lib/bas/fetcher/github/base.rb
+- lib/bas/fetcher/github/types/response.rb
+- lib/bas/fetcher/github/use_case/repo_issues.rb
 - lib/bas/fetcher/imap/base.rb
 - lib/bas/fetcher/imap/types/response.rb
 - lib/bas/fetcher/imap/use_case/support_emails.rb
@@ -68,6 +72,7 @@ files:
 - lib/bas/formatter/support_emails.rb
 - lib/bas/formatter/work_items_limit.rb
 - lib/bas/mapper/base.rb
+- lib/bas/mapper/github/issues.rb
 - lib/bas/mapper/imap/support_emails.rb
 - lib/bas/mapper/notion/birthday_today.rb
 - lib/bas/mapper/notion/pto_today.rb