newsman 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b217b1d0fee448151ff8a04b2099a6e311275e781112144a87f62a4e2a49e03
-  data.tar.gz: 78de209a3631b3e1589caab3b1bb336925009bcd52861e570e53b589d3ed8a65
+  metadata.gz: 3c6eaa01ebc8b603b13a1bb158e8a491ed2c51df32d973d56e9e99d959db7d4a
+  data.tar.gz: be86c2c47cc64f2da87a04127cf879a8ccabfff8fa9557730e6f3031a225efdb
 SHA512:
-  metadata.gz: 317b520b605b309c9ce5aeed0ac3ba385afb6865a8469a3547189232f248011920a67c3a3cc9bb40470e1f0f0ec0b7014f667f106275e56e9df48469d810f757
-  data.tar.gz: 65eacb6e1debdcb1581af1d40c0b043d641825fc70780b01471f496c0bf5a336fbc8d13a43eab89ea0dacd39890b7ec38f684c842472d9be970508de20a46f70
+  metadata.gz: b2b8972c04260e5c588015270b0e192c47bc39cc72c52124b200b5150b16be0e0d149ebb85d890ebcf2e21d98168b220c49953e769b852a62f6d9e18af627a5c
+  data.tar.gz: 12b435a44fb9687e9904f436f8b7203927856be57d1933045ca5fefbbe9d076346869962abd884c71e9bd6c2674daa1f9334186a90a84a79d2baa9b0c47d02a8

data/README.md

@@ -6,6 +6,32 @@
 
 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 it Works
+
+`newsman` sends multiple requests to GitHub to retrieve the following data:
+
+1. **Recently Closed Pull Requests by the Author**  
+   The tool fetches pull requests that were closed recently and were created by the specified author.  
+   Example query:  
+
+```
+is:pr author:volodya-lombrozo created:>=2024-11-29 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin
+```
+
+2. **Open Issues Assigned to the Author with the `soon` Label**  
+The tool retrieves issues that:  
+- Were opened in the last year  
+- Are currently open  
+- Are assigned to the specified author  
+- Have the label `soon`  
+
+Example query:  
+```
+is:issue is:open assignee:volodya-lombrozo created:>=2023-12-06 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin label:soon
+```
+
+Once the data is retrieved, the script analyzes it using the model specified with the `--model` option.
+
 ## Install
 
 To install [newsman](https://rubygems.org/gems/newsman) from RubyGems.org use the following command:
@@ -53,6 +79,8 @@ Also you can download this repository and run the newsman script directly using
 ./bin/newsman --name "Vladimir Lombrozo" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
 ```
 
+Actually, this command is also useful during development process.
+
 ## How to build a gem from sources
 
 To create a newsman gem from sources first of all you need to build it:

data/lib/newsman/assistant.rb

@@ -25,11 +25,6 @@ require 'openai'
 # This class mimics a robot that can analyse a developer activity.
 # The assistant uses OpenAI API to analyze.
 class Assistant
-  CONTEXT = '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.'
-
   def initialize(token, model: 'gpt-3.5-turbo', temperature: 0.3)
     @token = token
     @model = model
@@ -117,18 +112,32 @@ class Assistant
     send(prompt)
   end
 
+  # rubocop:disable Metrics/MethodLength
   def send(request)
-    @client.chat(
-      parameters: {
-        model: @model,
-        messages: [
-          { role: 'system', content: CONTEXT },
-          { role: 'user', content: request.to_s }
-        ],
-        temperature: @temperature
-      }
-    ).dig('choices', 0, 'message', 'content')
+    if @model == 'o1-preview'
+      @client.chat(
+        parameters: {
+          model: @model,
+          messages: [{ role: 'user', content: request.to_s }]
+        }
+      ).dig('choices', 0, 'message', 'content')
+    else
+      @client.chat(
+        parameters: {
+          model: @model,
+          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: request.to_s }
+          ],
+          temperature: @temperature
+        }
+      ).dig('choices', 0, 'message', 'content')
+    end
   end
+  # rubocop:enable Metrics/MethodLength
 
   def deprecated(method)
     warn "Warning! '#{method}' is deprecated and will be removed in future versions."

data/lib/newsman/github.rb

@@ -40,8 +40,8 @@ class Github
 
   def issues(username, repositories)
     one_year_ago = Date.today.prev_year.strftime('%Y-%m-%d')
-    query = "is:issue is:open author:#{username}"\
-      " author:0pdd created:>=#{one_year_ago} #{repositories}"
+    query = "is:issue is:open assignee:#{username}"\
+      " created:>=#{one_year_ago} #{repositories} label:#{IMPORTANT_ISSUE}"
     puts "Searching issues using the following query: '#{query}'"
     @client.search_issues(query).items.map do |issue|
       parse_issue(issue)

data/lib/newsman/issues.rb

@@ -23,6 +23,8 @@
 require 'net/http'
 require 'json'
 
+IMPORTANT_ISSUE = 'soon'
+
 # This class represents a GitHub Issue abstraction created by a user.
 class Issue
   attr_accessor :title, :body, :repo, :number
@@ -69,7 +71,7 @@ class Issue
   end
 
   def important?
-    labels.include? 'soon'
+    labels.include? IMPORTANT_ISSUE
   end
 end
 
@@ -124,7 +126,7 @@ class PddIssue
   end
 
   def important?
-    labels.include? 'soon'
+    labels.include? IMPORTANT_ISSUE
   end
 
   def url

data/lib/newsman.rb

@@ -129,15 +129,15 @@ def generate
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
   if output_mode.eql? 'txt'
-    puts 'Print result to txy file'
+    puts 'Print result to a txt file'
     output = Txtout.new('.')
     output.print(full_answer, github_username)
   elsif output_mode.eql? 'html'
-    puts 'Print result to html file'
+    puts 'Print result to a html file'
     output = Htmlout.new('.')
     output.print(full_answer, github_username, options[:model])
   else
-    puts 'Print result to stdout'
+    puts 'Print result to a stdout'
     output = Stdout.new
     output.print(full_answer)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Volodya Lombrozo
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -198,7 +198,7 @@ homepage: https://github.com/volodya-lombrozo/newsman
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: GitHub user weekly news
 test_files: []