hyrum 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6af9ff6689127c74e41729fbd056dadf9a811ec19a74f14ccd6a61413d2b3c0b
-  data.tar.gz: 900a08d6f56ad8e8cdf70f60fcf5782859b78420c95c9afaf0c86f78815ab449
+  metadata.gz: b7177d332d4a6a3e7a9527a906e39d4f141af5444aedbb3acff837b07b93f619
+  data.tar.gz: 9b0d67445326a57b5aa4f1bc2926cf06455609f491c75c08e65889a8d019b481
 SHA512:
-  metadata.gz: 14adcecb5a38a2fe356e5c9eb27e5fc254d1ce45953bfe32d595ad909813a49ea5a641a99f9b64daae75f3322f09f0bfa8891d9885990f8b1159d7f6f40fbead
-  data.tar.gz: 19537c266190bcf175f8a340d8828fd354f974fbdb80639018e0d8862103a81bd792967b144afa4e2f5bc2cad78fd94e185bc30f7044cf8db62c1c004278cf55
+  metadata.gz: aa204a19e6e0080792381c09904cc0fcf013b05490875b4f793f4135b3cec0d605d544261266a6b00f54be2a30ddfef4d3fd44e2f8be17060f49924fabe528b3
+  data.tar.gz: 17ceb22c5ea1b7a3837ce9195cc4b0f8a9b4276d502e3a9b4f4450aec61f5bcb780eaf135f2d9ac92717c060a81cf1423af751ef34de54faf532850c67b024f0

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-12-16
+
+### Fixed
+
+- Minor bug fixes and spec updates
+- Option defaults added in help where appropriate
+
+### Added
+
+- New -n | --number option to specify number of messages to produce
+- New ScriptOption specs
+- New MessageGenerator specs
+- New FakeGenerator specs
+
+## [0.0.2] - 2024-12-06
+
+### Fixed
+
+- Minor bug fixes
+- Option defaults
+
+### Added
+
+- New OpenAI generator specs
+
+## [0.0.1] - 2024-12-01
+
+### Added
+
+- This CHANGELOG file
+- Initial version of the project

data/README.md

@@ -21,7 +21,8 @@ Also, we don't want to spend a lot of time writing variations of the same messag
 This is the use case Hyrum tries to solve. It uses an AI service (openai,
 ollama, etc.) to generate variations of a provided message. The generated
 variations are also formatted in the language/format of your choice (ruby,
-json, etc.).
+json, etc.). This code can then be used in your project to ensure messages are
+no longer static, improving your api design.
 
 ## Example
 
@@ -71,9 +72,6 @@ Usage: hyrum [options]
 ```
 
 ## Installation
-NOTE: This gem is not yet available on rubygems.org. You can install it from the
-repository with `bundle exec rake install`.  In the future, you can...
-
 Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add hyrum

data/lib/hyrum/generators/fake_generator.rb

@@ -40,7 +40,7 @@ module Hyrum
 
       def initialize(options)
         @options = options
-        @ai_service = options[:ai_service]
+        # @ai_service = options[:ai_service]
       end
 
       def generate

data/lib/hyrum/generators/message_generator.rb

@@ -18,9 +18,11 @@ module Hyrum
 
     class MessageGenerator
       def self.create(options)
-        generator_class = GENERATOR_CLASSES[options[:ai_service].to_sym]
+        unless GENERATOR_CLASSES.key?(options[:ai_service].to_sym)
+          raise ArgumentError, "Invalid AI service: #{options[:ai_service]}"
+        end
 
-        # Add error handling for invalid format
+        generator_class = GENERATOR_CLASSES[options[:ai_service].to_sym]
         generator_class.new(options)
       end
     end

data/lib/hyrum/generators/openai_generator.rb

@@ -11,17 +11,13 @@ module Hyrum
 
       def initialize(options)
         @options = options
-        configure
-        @client = OpenAI::Client.new
       end
 
       def generate
-        if options[:ai_model] == :fake
-          return JSON.parse(canned_content)
-        end
+        configure
 
-        response = get_response(prompt)
-        puts "Response: #{JSON.pretty_generate(response)}" if options[:verbose]
+        response = chat_response
+        puts "OpenAI response: #{JSON.pretty_generate(response)}" if options[:verbose]
         content = response.dig('choices', 0, 'message', 'content')
         JSON.parse(content)
       end
@@ -30,25 +26,19 @@ module Hyrum
 
       def prompt
         prompt = <<~PROMPT
-          Please provide 5 alternative status messages for the following message:
+          Please provide <%= number %> alternative status messages for the following message:
           `<%= message %>`. The messages should be unique and informative. The messages
           should be returned as json in the format: `{ "<%= key %>": ['list', 'of', 'messages']}`
           The key should be `"<%= key %>"` followed by the list of messages.
         PROMPT
-        erb_hash = { key: options[:key], message: options[:message] }
+        erb_hash = { key: options[:key], message: options[:message], number: options[:number] }
         template = ERB.new(prompt, trim_mode: '-')
         template.result_with_hash(erb_hash)
       end
 
-      def get_response(prompt)
-        @client.chat(
-          parameters: {
-            model: options[:ai_model],
-            response_format: { type: 'json_object' },
-            messages: [{ role: 'user', content: prompt}],
-            temperature: 0.7
-          }
-        )
+      def chat_response
+        client = OpenAI::Client.new
+        client.chat(parameters: chat_params)
       rescue OpenAI::Error => e
         puts "OpenAI::Error: #{e.message}"
         exit
@@ -58,6 +48,15 @@ module Hyrum
         exit
       end
 
+      def chat_params
+        {
+          model: options[:ai_model],
+          response_format: { type: 'json_object' },
+          messages: [{ role: 'user', content: prompt}],
+          temperature: 0.7
+        }
+      end
+
       def configure
         OpenAI.configure do |config|
           config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') if options[:ai_service] == :openai
@@ -73,10 +72,6 @@ module Hyrum
         puts "Please set the OPENAI_ACCESS_TOKEN environment variable."
         exit
       end
-
-      def canned_content
-        FakeGenerator::FAKE_MESSAGES
-      end
     end
   end
 end

data/lib/hyrum/script_options.rb

@@ -3,6 +3,8 @@
 require 'optparse'
 
 module Hyrum
+  class ScriptOptionsError < StandardError; end
+
   class ScriptOptions
     MANDATORY_OPTIONS = %i[message].freeze
 
@@ -19,22 +21,23 @@ module Hyrum
         parser.parse!(@args)
       end
       enforce_mandatory_options
+      set_dynamic_defaults
       options
     rescue OptionParser::InvalidOption => e
-      err = "Invalid option: #{e.message}"
+      raise ScriptOptionsError.new("Invalid option: #{e.message}")
     rescue OptionParser::MissingArgument => e
-      err = "Missing argument for option: #{e.message}"
+      raise ScriptOptionsError.new("Missing argument for option: #{e.message}")
     rescue OptionParser::InvalidArgument => e
-      err = "Invalid argument for option: #{e.message}"
-    ensure
-      if err
-        puts err
-        exit
-      end
+      raise ScriptOptionsError.new("Invalid argument for option: #{e.message}")
     end
 
     private
 
+    def set_dynamic_defaults
+      default_model = Generators::AI_MODEL_DEFAULTS[options[:ai_service]]
+      options[:ai_model] ||= default_model
+    end
+
     def enforce_mandatory_options
       missing = MANDATORY_OPTIONS.select { |param| options[param].nil? }
       return if missing.empty?
@@ -66,31 +69,37 @@ module Hyrum
     end
 
     def ai_service_options(parser)
-      description = "AI service: one of #{Generators::AI_SERVICES.join(', ')}"
+      options[:ai_service] = :fake
+
+      description = "AI service: one of #{Generators::AI_SERVICES.join(', ')} (default: fake)"
       parser.on('-s SERVICE', '--service SERVICE', Generators::AI_SERVICES, description) do |service|
         options[:ai_service] = service.to_sym
       end
-      options[:ai_service] ||= :fake
 
-      default_model = Generators::AI_MODEL_DEFAULTS[options[:ai_service]]
       description = 'AI model: must be a valid model for the selected service'
       parser.on('-d MODEL', '--model MODEL', description) do |model|
         options[:ai_model] = model.to_sym
       end
-      options[:ai_model] ||= default_model
     end
 
     def message_key_options(parser)
-      parser.on('-k KEY', '--key KEY', 'Message key') do |key|
-        options[:key] = key
+      options[:key] = :status
+
+      parser.on('-k KEY', '--key KEY', 'Message key (default: status)') do |key|
+        options[:key] = key.to_sym
       end
-      options[:key] ||= 'status'
     end
 
     def message_options(parser)
-      parser.on('-m MESSAGE', '--message MESSAGE', 'Status message') do |message|
+      parser.on('-m MESSAGE', '--message MESSAGE', 'Status message (required)') do |message|
         options[:message] = message
       end
+
+      options[:number] = 5
+
+      parser.on('-n NUMBER', '--number NUMBER', Integer, 'Number of messages to generate (default: 5)',) do |number|
+        options[:number] = number.to_i
+      end
     end
 
     def verbosity_options(parser)
@@ -100,13 +109,14 @@ module Hyrum
     end
 
     def format_options(parser)
+      options[:format] = :text
+
       formats = Formats::FORMATS
       description = 'Output format. Supported formats are:'
       supported   = formats.join(', ')
-      parser.on('-f FORMAT', '--format FORMAT', formats, description, supported) do |format|
+      parser.on('-f FORMAT', '--format FORMAT', formats, description, supported, "(default: text)") do |format|
         options[:format] = format
       end
-      options[:format] ||= :text
     end
   end
 end

data/lib/hyrum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hyrum
-  VERSION = '0.0.1'
-end
+  VERSION = '0.1.0'
+end

data/lib/hyrum.rb

@@ -8,7 +8,7 @@ loader.setup
 module Hyrum
   def self.run(args)
     options = ScriptOptions.new(args).parse
-    generator_opts = options.slice(:message, :key, :ai_service, :ai_model, :verbose)
+    generator_opts = options.slice(:message, :key, :ai_service, :ai_model, :number, :verbose)
     formatter_opts = options.slice(:format, :verbose)
 
     puts "Options: #{options.inspect}" if options[:verbose]
@@ -17,6 +17,9 @@ module Hyrum
     messages = message_generator.generate
     output = formatter.format(messages)
     puts output
+  rescue ScriptOptionsError => e
+    puts e.message
+    exit
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyrum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tracy Atteberry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -46,7 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 files:
+- CHANGELOG.md
 - README.md
 - bin/console
 - bin/hyrum
@@ -85,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="