newsman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbdbadb8ae1727aa56b52deae928ceb16d0068d9b0190ac2672a75a98c669231
+  data.tar.gz: 5b0487e709dd265cfcfe39ffadab3ac1bff14fd0e94ad547fb49aa56567e317d
+SHA512:
+  metadata.gz: 749af2c2ce1a20006ad4ba4373c2d53f0f52c604c8f9801acb87f6f2cd6bd421d79690e643e46b5c97fad09a80a7ea75e41db8e6e4523da689c07025d0e0b059
+  data.tar.gz: 68e39b6efe454c926b8164e4c3c7e7fe6682c6086f80b0a579a84cc3116df2f424c2bad1f8572d2466bf07f8fc6c3b703c9325fa295eba028b229935c53535b9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Volodya Lombrozo 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Newsman 
+
+Newsman is a simple script that collects information about a developer's weekly activity on GitHub and creates a human-readable summary of the work done. To create the summary, Newsman asks ChatGPT to handle all the information about a developer's activity, including their pull requests and created issues.
+
+## How to Use
+
+To use newsman, you need to perfom several actions. 
+
+### Retrieve `GITHUB_TOKEN`
+
+First of all, you need to [retrieve your GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
+
+### Retrieve `OPENAI_TOKEN`
+
+Then, you need to [set up your OpenAI key](https://platform.openai.com/docs/quickstart?context=curl).
+
+## Run the script
+
+To run the newsman script you should pass `GITHUB_TOKEN` and `OPENAI_TOKEN` environment variables together with `name`, `username` and `repository` parameters.
+If you have some problems you can use `--help` option to get more info about newsman usage:
+```shell
+Usage: newsman [options]
+    -n, --name NAME                  Reporter name. Human readable name that will be used in a report
+    -u, --username USERNAME          GitHub username. For example, 'volodya-lombrozo'
+    -r, --repository REPOSITORIES    Specify which repositories to include in a report. You can specify several repositories using a comma separator, for example: '-r objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin'
+    -p, --position                   Reporter position in a company. Default value is a 'Software Developer'.
+```
+
+### Example
+
+You can download this repository and run the newsman script directly using the following command:
+```shell
+./bin/newsman --name "Vladimir Zakharov" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
+```
+
+Don't forget to set your own values for `name`, `username` and `repository` parameters.
+
+## How to build a gem from sources
+
+To create a newsman gem from sources first of all you need to build it:
+```shell
+gem build newsman.gemspec
+```
+Then, in the folder you might find a newly created gem file, e.g `newsman-0.1.0.gem`.
+To use it in any place of your system you need to install it:
+```shell
+gem install newsman-0.1.0.gem
+```
+To check that everythis is fine, just run the following command:
+```
+newsman --help
+```
+Annd you should see a welcome message from newsman.

data/bin/newsman

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/newsman.rb"
+
+generate

data/lib/newsman/pull_request.rb

@@ -0,0 +1,13 @@
+class PullRequest
+  attr_accessor :repository, :title, :description
+
+  def initialize(repository, title, description)
+    @repository = repository
+    @title = title
+    @description = description
+  end
+
+  def to_s
+    "title: ```#{@title}```\n, description: ```#{@description}```\n, repo: ```#{@repository}```\n"
+  end
+end

data/lib/newsman.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require 'octokit'
+require 'openai'
+require 'dotenv'
+require 'optparse'
+require_relative 'newsman/pull_request.rb'
+
+def generate
+  # Load all options required
+  # Pay attention that some of them have default values.
+  options = {}
+  OptionParser.new do |opts|
+    opts.banner = "Usage: newsman [options]"
+    opts.on("-n", "--name NAME", "Reporter name. Human readable name that will be used in a report") do |n|
+      options[:name] = n 
+    end
+    opts.on("-u", "--username USERNAME", "GitHub username. For example, 'volodya-lombrozo'") do |u|
+      options[:username] = u
+    end
+    opts.on("-r", "--repository REPOSITORIES", "Specify which repositories to include in a report. You can specify several repositories using a comma separator, for example: '-r objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin'") do |r|
+      options[:repositories] = r
+    end
+    opts.on("-p", "--position", "Reporter position in a company. Default value is a 'Software Developer'.") do |p|
+      options[:position] = p
+    end
+  end.parse!
+  # Custom method to raise exception with a human-readable message
+  def options.require_option(key, message)
+    raise OptionParser::MissingArgument, message if self[key].nil?
+  end
+
+  # Check for required options
+  options.require_option(:name, "Reporter name is required. Please specify using -n or --name.")
+  options.require_option(:username, "GitHub username is required. Please specify using -u or --username.")
+  options.require_option(:repositories, "GitHub repository is required. Please specify one or several repositories using -r or --repositories.")
+  options[:position] ||= "Software Developer"
+  all_params = options.map { |key, value| "#{key}: #{value}" }.join(", ")
+  puts "Parsed parameters: #{all_params}"
+
+  # Load all required environment variables
+  Dotenv.load
+  Dotenv.require_keys("GITHUB_TOKEN", "OPENAI_TOKEN")
+
+  # Init all required parameters
+  # Reporter Info
+  reporter = options[:name]
+  reporter_position = options[:position]
+  # GitHub 
+  github_username = options[:username]
+  github_repositories = options[:repositories].split(",").map { |repo| "repo:" + repo }.join(" ")
+  
+  # Your GitHub personal access token
+  # Make sure it has the 'repo' 
+  github_token = ENV['GITHUB_TOKEN']
+  # Your OpenAI personal access token
+  openai_token = ENV['OPENAI_TOKEN']
+  # Create a GitHub client instance with your access token
+  client = Octokit::Client.new(github_token: github_token)
+  # Calculate the date one week ago
+  report_date = Date.today
+  one_week_ago = date_one_week_ago(Date.today)
+  # Display pull request
+  query = "is:pr author:#{github_username} created:>=#{one_week_ago} #{github_repositories}"
+  puts "Searching pull requests for #{github_username}."
+  puts "Newsman uses the following request to GitHub to gather the required information about user activity: '#{query}'"
+  prs = []
+  pull_requests = client.search_issues(query)
+  pull_requests.items.each do |pr|
+    title = "#{pr.title}"
+    description = "#{pr.body}"
+    repository = pr.repository_url.split('/').last
+    puts "Found PR in #{repository}: #{title}"
+    # Create a new PullRequest object and add it to the list
+    pr = PullRequest.new(repository, title, description)
+    prs << pr
+  end
+  puts "\nNow lets test some aggregation using OpenAI\n\n"
+  openai_client = OpenAI::Client.new(access_token: openai_token)
+  example = "Last week achievements.
+  jeo-meven-plugin:
+  - Added 100 new files to the Dataset [#168]
+  - Fixed the deployment of XYZ [#169]
+  - Refined the requirements [#177]
+  opeo-maven-plugin
+  - Removed XYZ class [#57]
+  - Refactored http module [#69]
+
+  Next week plans:
+  jeo-maven-plugin:
+  - <leave empty>
+  opeo-maven-plugin:
+  - <leave empty>
+
+  Risks:
+jeo-maven-plugin:
+- <leave-empty>
+opeo-maven-plugin:
+- <leave-empty>
+
+Best regards,
+#{reporter}  
+#{reporter_position}  
+#{report_date}
+"
+
+response = openai_client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo",
+        messages: [
+          { role: "system", content: "You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor."},
+          { role: "user", content: "Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the PR. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example}. List of Pull Requests: [#{prs}]"}
+        ],
+        temperature: 0.3,
+    })
+puts response.dig("choices", 0, "message", "content")
+end
+
+
+def date_one_week_ago(today)
+  # Convert today to a Date object if it's not already
+  today = Date.parse(today) unless today.is_a?(Date)
+  # Subtract 7 days to get the date one week ago
+  one_week_ago = today - 7
+  # Format the date as "YYYY-MM-DD"
+  formatted_date = one_week_ago.strftime("%Y-%m-%d")
+  # Return the formatted date
+  return formatted_date
+end
+
+
+# Execute the function only if this script is run directly like `./newsman.rb`
+if __FILE__ == $0
+  generate()
+end
+

data/test/newsman/test_week_before.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2024 Volodya Lombrozo 
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../../lib/newsman/newsman.rb'
+
+class TestDateOneWeekAgo < Minitest::Test
+  def test_date_one_week_ago
+    assert_equal "2024-03-07", date_one_week_ago(Date.new(2024, 3, 14))
+    assert_equal "2024-02-29", date_one_week_ago(Date.new(2024, 3, 7))
+  end
+end
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: newsman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodya Lombrozo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A simple gem that gathers GitHub statistics and creates human-readable
+  report
+email:
+- volodya.lombrozo@gmail.com
+executables:
+- newsman
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/newsman
+- lib/newsman.rb
+- lib/newsman/pull_request.rb
+- test/newsman/test_week_before.rb
+homepage: https://github.com/volodya-lombrozo/newsman
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: GitHub user weekly news
+test_files: []