ai-chat 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96adef3af8e7871b999d82885b74b35ed59da4fa91c90640fe8089fd63d87ca5
-  data.tar.gz: 1becad90a613aff2c57b91b8d90700f6c7e48faf621ae0ffdc9a3f3e49870227
+  metadata.gz: '080a6986c9471fac9120a46be24abb034238d88093c63ec700b9f3e9e3a6b4fd'
+  data.tar.gz: 2bd5ce414fb2323a897594810802e61bf4d0918de8d050210e643458bca8d83c
 SHA512:
-  metadata.gz: b3f703478eaf415e5b0e3976d86c9f8e773756b9a0a292f6f73a41da4d479b013366726da5335ba40b105981cc558d04f10b44d2d9f78dc513b10da039507a7c
-  data.tar.gz: 903e3772c07a351f2435d990bb1bbb02f6223d982e76025afc5e97477f64cc9d356eca153d31e5a39031c4f21f381d3aab6c8e53da48a8d29f31843fa195a801
+  metadata.gz: 3dfa680c1d64dfab65bdfa0470a0bb48fc7301645dc102723af40d562ba4b3707a65c9cd0fccd5db824a470bb801675dcef1957c541fdf43d651fbdafa793a45
+  data.tar.gz: ad1c8453fd0b15e7abca23082b14b224ec1a41d4708da43a3cd520208386c09df2d9e939b3031a111933b955382c392abd240ea93af9a942d456a9dc686c207b

data/.config/rubocop/config.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  caliber: config/all.yml

data/.reek.yml

@@ -0,0 +1,7 @@
+exclude_paths:
+  - tmp
+  - vendor
+
+detectors:
+  LongParameterList:
+    enabled: false

data/.rspec_status

@@ -0,0 +1,16 @@
+example_id                                    | status | run_time        |
+--------------------------------------------- | ------ | --------------- |
+./spec/ai/chat/image_support_spec.rb[1:1:1:1] | passed | 0.00007 seconds |
+./spec/ai/chat/image_support_spec.rb[1:1:2:1] | passed | 0.0001 seconds  |
+./spec/ai/chat/image_support_spec.rb[1:1:3:1] | passed | 0.00012 seconds |
+./spec/ai/chat/image_support_spec.rb[1:1:3:2] | passed | 0.00018 seconds |
+./spec/ai/chat/image_support_spec.rb[1:2:1:1] | passed | 0.0016 seconds  |
+./spec/ai/chat/image_support_spec.rb[1:2:1:2] | passed | 0.0001 seconds  |
+./spec/ai/chat/image_support_spec.rb[1:2:2:1] | passed | 0.00011 seconds |
+./spec/ai/chat/image_support_spec.rb[1:2:3:1] | passed | 0.00007 seconds |
+./spec/ai/chat/image_support_spec.rb[1:2:3:2] | passed | 0.00013 seconds |
+./spec/ai/chat/image_support_spec.rb[1:3:1]   | passed | 0.00005 seconds |
+./spec/ai/chat/image_support_spec.rb[1:3:2]   | passed | 0.00006 seconds |
+./spec/ai/chat/image_support_spec.rb[1:3:3]   | passed | 0.00008 seconds |
+./spec/ai/chat/image_support_spec.rb[1:3:4]   | passed | 0.00017 seconds |
+./spec/ai/chat/image_support_spec.rb[1:3:5]   | passed | 0.00074 seconds |

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jelani@firstdraft.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in draft_chat.gemspec
+gemspec

data/README.md

@@ -1,13 +1,15 @@
 # AI::Chat
 
-This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Chat Completions endpoint.
+This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use cutting-edge Large Language Models.
 
 ## Installation
 
+### Gemfile way (preferred)
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "ai-chat"
+gem "ai-chat", "< 1.0.0"
 ```
 
 And then, at a command prompt:
@@ -16,37 +18,60 @@ And then, at a command prompt:
 bundle install
 ```
 
+### Direct way
+
 Or, install it directly with:
 
 ```
 gem install ai-chat
 ```
 
-## Configuration
-
-- By default, the gem checks for an environment variable called `AI_TOKEN`, then falls back to `OPENAI_TOKEN` if available. You can also provide your token directly when instantiating a chat:
-
-    ```ruby
-    x = AI::Chat.new(api_token: "your-token-goes-here")
-    ```
-- By default, the gem uses the `gpt-4o` model. If you want something else, you can set it:
-
-    ```ruby
-    x.model = "o3-mini"
-    ```
-
 ## Simplest usage
 
+In your Ruby program:
+
 ```ruby
+require "ai-chat"
+
+# Create an instance of AI::Chat
 x = AI::Chat.new
+
+# Add system-level instructions
 x.system("You are a helpful assistant that speaks like Shakespeare.")
+
+# Add a user message to the chat
 x.user("Hi there!")
+
+# Get the next message from the model
 x.assistant!
 # => "Greetings, good sir or madam! How dost thou fare on this fine day? Pray, tell me how I may be of service to thee."
 
+# Rinse and repeat
 x.user("What's the best pizza in Chicago?")
 x.assistant!
-# => "Ah, the fair and bustling city of Chicago, renowned for its deep-dish delight that hath captured hearts and stomachs aplenty. Amongst the many offerings of this great city, 'tis often said that Lou Malnati's and Giordano's art the titans of the deep-dish realm. Lou Malnati's crust is praised for its buttery crispness, whilst Giordano's doth boast a stuffed creation that is nigh unto legendary. Yet, I encourage thee to embark upon thine own quest and savor the offerings of these famed establishments, for in the tasting lies the truth of which thy palate prefers. Enjoy the gastronomic adventure, my friend."
+# => "Ah, the fair and bustling city of Chicago, renowned for its deep-dish delight that hath captured hearts and stomachs aplenty. Amongst the many offerings of this great city, 'tis often said that Lou Malnati's and Giordano's...."
+```
+
+## Configuration
+
+By default, the gem uses OpenAI's `gpt-4.1-mini` model. If you want to use a different model, you can set it:
+
+```ruby
+x.model = "o3"
+```
+
+The gem by default looks for an environment variable called `OPENAI_API_KEY` and uses that if it finds it.
+
+You can specify a different environment variable name:
+
+```ruby
+x = AI::Chat.new(api_key_env_var: "OPENAI_TOKEN")
+```
+
+Or, you can pass an API key in directly:
+
+```ruby
+x = AI::Chat.new(api_key: "your-api-key-goes-here")
 ```
 
 ## Structured Output
@@ -55,9 +80,13 @@ Get back Structured Output by setting the `schema` attribute (I suggest using [O
 
 ```ruby
 x = AI::Chat.new
+
 x.system("You are an expert nutritionist. The user will describe a meal. Estimate the calories, carbs, fat, and protein.")
+
 x.schema = '{"name": "nutrition_values","strict": true,"schema": {"type": "object","properties": {  "fat": {    "type": "number",    "description": "The amount of fat in grams."  },  "protein": {    "type": "number",    "description": "The amount of protein in grams."  },  "carbs": {    "type": "number",    "description": "The amount of carbohydrates in grams."  },  "total_calories": {    "type": "number",    "description": "The total calories calculated based on fat, protein, and carbohydrates."  }},"required": [  "fat",  "protein",  "carbs",  "total_calories"],"additionalProperties": false}}'
+
 x.user("1 slice of pizza")
+
 x.assistant!
 # => {"fat"=>15, "protein"=>5, "carbs"=>50, "total_calories"=>350}
 ```
@@ -142,4 +171,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the AI Chat project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/firstdraft/ai-chat/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the AI Chat project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/firstdraft/ai-chat/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run standardrb and rspec tests"
+task default: [:standard, :spec]

data/ai_chat.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/ai/chat/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ai-chat"
+  spec.version = AI::Chat::VERSION
+  spec.authors = ["Raghu Betina", "Jelani Woods"]
+  spec.email = ["raghu@firstdraft.com", "jelani@firstdraft.com"]
+
+  spec.summary = "This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Chat Completions endpoint."
+  spec.description = "This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Chat Completions endpoint. Supports Structured Output."
+  spec.homepage = "https://github.com/firstdraft/ai-chat"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/firstdraft/ai-chat"
+  spec.metadata["changelog_uri"] = "https://github.com/firstdraft/ai-chat/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Register dependencies of the gem
+  spec.add_runtime_dependency "mime-types", "~> 3.0"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "factory_bot", "~> 6.2"
+  spec.add_development_dependency "webmock", "~> 3.18"
+  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "standard", "~> 1.32"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ai/chat/version.rb

@@ -2,6 +2,6 @@
 
 module AI
   class Chat
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/ai/chat.rb

@@ -6,10 +6,10 @@ module AI
   class Chat
     attr_accessor :messages, :schema, :model
 
-    def initialize(api_token: nil)
-      @api_token = api_token || ENV.fetch("AI_TOKEN", ENV.fetch("OPENAI_TOKEN", nil))
+    def initialize(api_key: nil)
+      @api_key = api_key || ENV.fetch("OPENAI_API_KEY")
       @messages = []
-      @model = "gpt-4o"
+      @model = "gpt-4.1-mini"
     end
 
     def system(content)
@@ -96,7 +96,7 @@ module AI
 
     def assistant!
       request_headers_hash = {
-        "Authorization" => "Bearer #{@api_token}",
+        "Authorization" => "Bearer #{@api_key}",
         "content-type" => "application/json"
       }
 

data/test_program/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "dotenv"
+gem "ai-chat", path: ".."

data/test_program/test_ai_chat.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "ai-chat"
+
+puts "Testing AI::Chat gem with examples from README"
+puts "=============================================="
+
+# Simplest usage example
+puts "\nSimplest Usage Test:"
+puts "-------------------"
+x = AI::Chat.new
+
+# Add system-level instructions
+x.system("You are a helpful assistant that speaks like Shakespeare.")
+
+# Add a user message to the chat
+x.user("Hi there!")
+
+# Get the next message from the model
+begin
+  response = x.assistant!
+  puts "Assistant response: #{response}"
+rescue => e
+  puts "Error: #{e.message}"
+  puts "API response: #{e.backtrace.first(3).join("\n")}"
+end
+
+# Follow-up question
+x.user("What's the best pizza in Chicago?")
+response = x.assistant!
+puts "Assistant response: #{response}"
+
+# Configuration example
+puts "\nConfiguration Test:"
+puts "-------------------"
+# Using a different model
+y = AI::Chat.new
+y.model = "gpt-4o-mini" # Using a model that should be available
+y.system("You are a helpful assistant.")
+y.user("Write a haiku about programming.")
+response = y.assistant!
+puts "Response with model #{y.model}: #{response}"
+
+# Structured Output example
+puts "\nStructured Output Test:"
+puts "-----------------------"
+z = AI::Chat.new
+
+z.system("You are an expert nutritionist. The user will describe a meal. Estimate the calories, carbs, fat, and protein.")
+
+z.schema = '{"name": "nutrition_values","strict": true,"schema": {"type": "object","properties": {  "fat": {    "type": "number",    "description": "The amount of fat in grams."  },  "protein": {    "type": "number",    "description": "The amount of protein in grams."  },  "carbs": {    "type": "number",    "description": "The amount of carbohydrates in grams."  },  "total_calories": {    "type": "number",    "description": "The total calories calculated based on fat, protein, and carbohydrates."  }},"required": [  "fat",  "protein",  "carbs",  "total_calories"],"additionalProperties": false}}'
+
+z.user("1 slice of pizza")
+response = z.assistant!
+puts "Nutrition values: #{response.inspect}"
+
+# Test with an image (using the fixture image from the spec directory)
+puts "\nImage Support Test:"
+puts "------------------"
+begin
+  img_path = File.expand_path("../../spec/fixtures/test_image.jpg", __FILE__)
+  if File.exist?(img_path)
+    i = AI::Chat.new
+    i.user("What's in this image?", image: img_path)
+    response = i.assistant!
+    puts "Image description: #{response}"
+  else
+    puts "Test image not found at #{img_path}"
+  end
+rescue => e
+  puts "Image test error: #{e.message}"
+  puts "#{response}"
+end
+
+# Get messages example
+puts "\nMessages Test:"
+puts "--------------"
+m = AI::Chat.new
+m.system("You are a helpful assistant.")
+m.user("Hello world!")
+m.assistant!
+puts "Messages: #{m.messages.inspect}"
+
+# Manual assistant message example
+puts "\nManual Assistant Message Test:"
+puts "-----------------------------"
+a = AI::Chat.new
+a.system("You are a helpful assistant.")
+a.assistant("Greetings! How can I assist you today?")
+a.user("Tell me a joke.")
+response = a.assistant!
+puts "Assistant response after manual message: #{response}"
+
+puts "\nTests completed!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Raghu Betina
 - Jelani Woods
 bindir: exe
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 2025-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -118,12 +118,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/rubocop/config.yml"
+- ".reek.yml"
+- ".rspec_status"
+- ".ruby-version"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
+- ai_chat.gemspec
 - lib/ai-chat.rb
 - lib/ai/chat.rb
 - lib/ai/chat/version.rb
+- test_program/Gemfile
+- test_program/test_ai_chat.rb
 homepage: https://github.com/firstdraft/ai-chat
 licenses:
 - MIT