hyrum 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6af9ff6689127c74e41729fbd056dadf9a811ec19a74f14ccd6a61413d2b3c0b
-  data.tar.gz: 900a08d6f56ad8e8cdf70f60fcf5782859b78420c95c9afaf0c86f78815ab449
+  metadata.gz: 2c973fd6cbfc5ee63d43e581024c7fc9720501d6e544aa90f524fc6ce8e3b641
+  data.tar.gz: a080770b267980f238d35e0d7ea86613ad37b306075a887d8ec83eaf52cd19db
 SHA512:
-  metadata.gz: 14adcecb5a38a2fe356e5c9eb27e5fc254d1ce45953bfe32d595ad909813a49ea5a641a99f9b64daae75f3322f09f0bfa8891d9885990f8b1159d7f6f40fbead
-  data.tar.gz: 19537c266190bcf175f8a340d8828fd354f974fbdb80639018e0d8862103a81bd792967b144afa4e2f5bc2cad78fd94e185bc30f7044cf8db62c1c004278cf55
+  metadata.gz: 95833489cffa0a13282d7c294e43346d6aff1aa762629f03a49b2b65dc663f3e9ec722861d4f2b5325fb5351ee3ad7444995f3981a43ee541fb9583f003579a8
+  data.tar.gz: 7b198b8dce4536f38f1e37b07fa7dad5c83bbcd4121e5a9ff76d16029aba45f5b60ba012b8cb153b3c5e9601834b6853daf6beee109321a4c67a6efeb41ffde2

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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.0.1] - 2024-12-01
+
+### Added
+
+- This CHANGELOG file
+- Initial version of the project
+
+## [0.0.2] - 2024-12-06
+
+### Fixed
+
+- Minor bug fixes
+- Option defaults
+
+### Added
+
+- New OpenAI generator specs

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/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
@@ -40,15 +36,9 @@ module Hyrum
         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

@@ -19,6 +19,7 @@ module Hyrum
         parser.parse!(@args)
       end
       enforce_mandatory_options
+      set_dynamic_defaults
       options
     rescue OptionParser::InvalidOption => e
       err = "Invalid option: #{e.message}"
@@ -35,6 +36,11 @@ module Hyrum
 
     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,25 +72,25 @@ module Hyrum
     end
 
     def ai_service_options(parser)
+      options[:ai_service] = :fake
+
       description = "AI service: one of #{Generators::AI_SERVICES.join(', ')}"
       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)
+      options[:key] = :status
+
       parser.on('-k KEY', '--key KEY', 'Message key') do |key|
-        options[:key] = key
+        options[:key] = key.to_sym
       end
-      options[:key] ||= 'status'
     end
 
     def message_options(parser)
@@ -100,13 +106,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|
         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'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyrum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tracy Atteberry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-07 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:
   - - ">="