summarize-meeting 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e3eaa4b04f7b2d9ccb00632ab021a85b87dd8a6798a72319d84ec3c905fa4f
-  data.tar.gz: 200e57a22c74d4c7c418f2b34ec4fbec6f53119ca1e381266ce16d53ac680e36
+  metadata.gz: f46de38135486b2bb4c89b9f3a5bbd205685f6dbb3cba5b9927acdbf0490dc56
+  data.tar.gz: 14c08f5210e5752e7c6581f047d83a52b8cc4a1d487b802c0aa928895e06f01e
 SHA512:
-  metadata.gz: a201d18bd409b281bf8e2e7610d4f98a37cc29dfff8f1a6b1c631d61fe88c00b43977b076bfa887e3f074bc64a6fa03951e2459cdc5baad738e47f5d0255d414
-  data.tar.gz: d3ea73f7bfbc3f756324d2e72c49ff9cd67694ef7da7647b9e8b0dc08805f745d9d265a906e49ff49c55b08e406b5ddb8b8887d45be0399962a1efd7b1707964
+  metadata.gz: 2a6eea93e686093632a577d1a090e2036b91ae96b230e7fe1e37da928ec5b08730d8f6ab82954c88b98f277b791f8180f69456ccbd06d2df8ca7582de2cdabfb
+  data.tar.gz: 06a7efc7fa8c1eb400f2ac2671589829179f2abaf8c0c4741b4577926a15938cf98f71db01593996dc98c5c097583d3c67a5d07d0374a391468eaeb6b5d4e6ba

data/README.md

@@ -18,79 +18,79 @@ Input a meeting transcript and output a summary.
 
 #### Options
 
-`-o, --output-file FILE` - Path to the output file. By default, it will be the `${input-file}-summary.txt`  
-`-k, --openai-key KEY` - The OpenAI API Key. Can also be set via `ENV["OPENAI_KEY"]`.  
-`-g, --openai-org ORG` - The OpenAI org id. It can also be set via `ENV["OPENAI_ORG"]` .  
+`-o, --output-file FILE` - Path to the output file. By default, it will be the `${input-file}-summary.txt`
+`-k, --openai-key KEY` - The OpenAI API Key. Can also be set via `ENV["OPEN_AI_API_KEY"]`.
+`-g, --openai-org ORG` - The OpenAI org id (optional). It can also be set via `ENV["OPEN_AI_ORGANIZATION_ID"]` .
 
 ## Example
 
 This is an example summary from a 3,700 word transcript from a 30 minute meeting.
 
 > Summary of the Meeting:
-> 
+>
 > The meeting started with discussions focusing on individual progress reports, where Sean shared updates on profit-related work, consolidating estimates, and improving Hey Kayla by creating a new JSON structure for Chat GPT messages API. Colenso reported finding a bug in the JavaScript Google Maps API and not making progress on push notifications. Meanwhile, Pankaj worked on bulk assign form handling, retaining time zone, and Benjamin faced some issues regarding database connection but eventually resolved the casting and integration issues.
-> 
+>
 > In the open discussion session, the team discussed the confusion over parameters and importing across different branches. Benjamin shared about an open discussion necessary for a feature related to job production plans at ACME. Shirish discussed fixing the cycle time summary query, which used to take up to 6-7 seconds and now takes less than 1 second. Anish added a business unit filter feature to the time card and will work on page titles.
-> 
+>
 > The meeting concluded with Sean hoping to have success with profit stuff before Monday's call.
-> 
+>
 > Attendees:
-> 
+>
 > - Sean
 > - Colenso
 > - Pankaj
 > - Benjamin
 > - Shirish
 > - Anish
-> 
+>
 > Action Items:
-> 
+>
 > - Sean to continue working on profit-related things before the next call.
 > - Colenso to continue working on resolving the bug in the Google Maps API and push notifications.
 > - Pankaj to continue working on bulk assign form handling and to keep the time zone option.
 > - Benjamin to finalize the release notes for the open discussion at  and to continue working on resolving the database connection issues.
 > - Shirish to further improve the query for cycle time summary and reduce the processing time.
-> - Anish to improve page titles and add filters for the time card. 
-> 
+> - Anish to improve page titles and add filters for the time card.
+>
 > Detailed notes:
-> 
+>
 > Sean:
-> 
+>
 > - Reported progress on Prophet-related things
 > - Worked on consolidating all effective estimates
 > - Worked on improving Hey Kayla by creating a new JSON structure for Chat GPT messages API
-> 
+>
 > Colenso:
-> 
+>
 > - Found a bug in the JavaScript Google Maps API
 > - Has not made progress on push notifications yet
-> 
+>
 > Pankaj:
-> 
+>
 > - Worked on bulk assign form handling
 > - Allowed the option to retain the time zone
-> 
+>
 > Benjamin:
-> 
+>
 > - Faced difficulty regarding database connection issues in Heroku
 > - Resolved casting issues by switching to a different cash store
 > - Listed an interesting issue regarding split loads with more than one material transaction during the same trip
 > - Mentioned an integration issue with ACME
 > - Shared that there is an open discussion at ACME and he needs assistance with the release notes for a feature related to job production plans
-> 
+>
 > Open Discussion:
-> 
+>
 > - The team discussed the confusion over parameters and importing across different branches.
-> 
+>
 > Shirish:
-> 
+>
 > - Discussed fixing the cycle time summary query, which used to take up to 6-7 seconds and now takes less than 1 second
-> 
+>
 > Anish:
-> 
+>
 > - Added a business unit filter feature to the time card
 > - Will work on improving page titles
 
 ## Credits
 
-This gem was created by XBE.
+This gem was created by XBE.

data/bin/summarize-meeting

@@ -18,16 +18,16 @@ def main
       options[:output_file] = file
     end
 
-    if ENV["OPENAI_API_KEY"]
-      options[:openai_key] = ENV["OPENAI_API_KEY"]
+    if ENV["OPEN_AI_API_KEY"]
+      options[:openai_key] = ENV["OPEN_AI_API_KEY"]
     end
 
     opts.on("-k", "--openai-key KEY", "The OpenAI API key to use") do |key|
       options[:openai_key] = key
     end
 
-    if ENV["OPENAI_ORG"]
-      options[:openai_org] = ENV["OPENAI_ORG"]
+    if ENV["OPEN_AI_ORGANIZATION_ID"]
+      options[:openai_org] = ENV["OPEN_AI_ORGANIZATION_ID"]
     end
 
     opts.on("-g", "--openai-org ORG", "The OpenAI organization ID to use") do |org|

data/lib/summarize-meeting/ai.rb

@@ -1,56 +1,155 @@
+# frozen_string_literal: true
+
+require "openai"
+
 module SummarizeMeeting
   module Ai
-    class OpenAiError < StandardError; end
+    module OpenAIException; end
+    class OpenAIError < StandardError
+      include OpenAIException
+    end
+    class OpenAiResponseFailure < OpenAIError; end
+    class OpenAiNoResponseError < OpenAIError; end
+    class OpenAiRetryableError < OpenAIError; end
+    extend self
+
     MAX_TOTAL_TOKENS = 8000
     WORDS_PER_TOKEN = 0.75
 
-    @@access_token = ENV["OPENAI_KEY"]
-    @@organization_id = ENV["OPENAI_ORG"]
-
-    def self.client
+    def client
       @client ||= new_client(access_token: access_token, organization_id: organization_id)
     end
 
-    def self.new_client(access_token:, organization_id:)
+    def new_client(access_token:, organization_id:)
       OpenAI::Client.new(access_token: access_token, organization_id: organization_id)
     end
 
-    def self.access_token
-      @@access_token
+    def access_token
+      return @access_token if defined?(@access_token)
+      @access_token = ENV.fetch("OPEN_AI_API_KEY") do
+        fail KeyError, "Set OPEN_AI_API_KEY in the the ENV or set access_token directly"
+      end
     end
 
-    def self.organization_id
-      @@organization_id
+    def organization_id
+      return @organization_id if defined?(@organization_id)
+      @organization_id = ENV.fetch("OPEN_AI_ORGANIZATION_ID", nil)
     end
 
-    def self.access_token=(token)
-      @@access_token = token
+    def access_token=(token)
+      @access_token = token
     end
 
-    def self.organization_id=(id)
-      @@organization_id = id
+    def organization_id=(id)
+      @organization_id = id
     end
 
-    def self.calculate_token_word_count(token_count)
+    def calculate_token_word_count(token_count)
       (token_count * WORDS_PER_TOKEN.to_f).ceil
     end
 
-    def self.calculate_word_token_count(word_count)
+    def calculate_word_token_count(word_count)
       (word_count / WORDS_PER_TOKEN.to_f).ceil
     end
 
-    def self.chat(messages, client: self.client)
+    # @raise on response error or no expected response content
+    def chat(messages, client: self.client)
       parameters = {
         model: "gpt-4",
         messages: messages,
       }
-      response = client.chat(parameters: parameters)
-      content = response.dig("choices", 0, "message", "content")
-      if !content
-        raise OpenAiError, "No response from OpenAI"
+      response = nil
+      begin
+        response = client.chat(parameters: parameters)
+      rescue => exception
+        handle_request_error(exception)
       else
-        content
+        is_failure = !response.success?
+        if is_failure
+          log_response_failure(response)
+          raise OpenAiResponseFailure, "Failed response from OpenAI"
+        else
+          content = response.dig("choices", 0, "message", "content")
+          if !content
+            raise OpenAiNoResponseError, "No response from OpenAI in #{response.body}"
+          else
+            content
+          end
+        end
+      end
+    end
+
+    def notify_error(exception, message, **options)
+      if exception_notifier
+        exception_notifier.call(exception, message, **options)
+      else
+        warn "#{exception.inspect}: #{message}. options=#{options.inspect}"
+      end
+    end
+
+    # responds to call(exception, message, **options)
+    def exception_notifier=(exception_notifier)
+      @exception_notifier = exception_notifier
+    end
+
+    def exception_notifier
+      return @exception_notifier if defined?(@exception_notifier)
+      nil
+    end
+
+    def handle_request_error(exception)
+      is_openai_error =
+        case exception.inspect
+        when /Connection refused/i then true
+        when /Connection reset/i then true
+        when /Connection timed out/i then true
+        when /Could not connect/i then true
+        when /EOFError/i then true
+        when /Errno::ECONNREFUSED/i then true
+        when /Errno::ECONNRESET/i then true
+        when /Net::OpenTimeout/i then true
+        when /Net::ReadTimeout/i then true
+        when /OpenSSL::SSL::SSLError/i then false
+        when /Server is unavailable or does not exist/i then true
+        when /Unable to connect/i then true
+        when /closed stream/i then true
+        when /connect timed out/i then true
+        when /end of file reached/i then true
+        when /execution expired/i then true
+        else false
+        end
+      if is_openai_error
+        exception.extend OpenAIException
+      end
+      raise
+    end
+
+    def log_response_failure(response)
+      response_details = {
+        # https://github.com/jnunemaker/httparty/blob/v0.21.0/lib/httparty/response.rb#L53-L56
+        response: response.to_s,
+      }
+      if response.class.name.match?(/HTTParty::Response/)
+        response_details.merge!(
+          raw_request: response.request.inspect,
+          raw_response: response.response.inspect,
+          response_body: response.body,
+          response_code: response.code,
+          response_headers: response.headers,
+          # marshal_dump_base_64: Base64.encode64(response._dump(1)), # so it can be encoded as JSON
+        )
       end
+      notify_error(
+        nil, # there's no exception object
+        "Logging OpenAI Error",
+        **response_details
+      )
+    rescue => exception
+      notify_error(
+        exception,
+        "Unhandled error in #{name}##{__callee__}",
+        response: response.inspect,
+      )
     end
   end
-end
+end

data/lib/summarize-meeting/version.rb

@@ -1,3 +1,3 @@
 module SummarizeMeeting
-  VERSION = "1.4.0"
-end
+  VERSION = "1.5.1"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: summarize-meeting
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Sean Devine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -151,11 +151,11 @@ files:
 - lib/summarize-meeting/ai.rb
 - lib/summarize-meeting/meeting.rb
 - lib/summarize-meeting/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A command line utility that summarizes a meeting
 test_files: []