llm_gateway 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912c28c117bad46986f56b7571497ff276cb3ac5b9e39b442c7b29aeb50692e6
-  data.tar.gz: 2a087a8344992f50e0a4258d6aecbbeb7b5670cba62cfefed7c8fe054ed98c40
+  metadata.gz: 21b3998df57de474c78626d8267db572418f80426ddaf82730cf8738e181d96c
+  data.tar.gz: 9a37ff5a3907a8b0d48dbd0fc83be2e50cd5757a60cacd051e93ff1dc63d734e
 SHA512:
-  metadata.gz: 541fb18a405c58505913a7b5dc57fe109dacec72644224cdfb9746e5da290ca93cab2670731ae41f865cc79a20f28d6ee5dab3ea6690ab2161f82fe82b3c81f2
-  data.tar.gz: 2d6b3294fb5140e7e8b3754ae4c16bd983a133db5a3dcf61fd1adc0f07eed18003f4be724e2b90d98ca98f0aa78678d87648d434893836b52934e7da4fb7a979
+  metadata.gz: 1be591a45a6fbee0b89846c679e0a9709e3a5493757eac3196be8194f8e592615b177c15f20d6763cf6a444bf8dbf3d899cf6e9fd9b11de7e2f02845f53ab1ff
+  data.tar.gz: ed5a981d3e7ff311d26fe4924760e286e7370da598464e4b00ad004c940015432d873be73afae7067d5fa659adbe7af701b5b6f4163432c10cdf7f950532d690

data/CHANGELOG.md

@@ -1,5 +1,20 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2025-08-04
+## [Unreleased](https://github.com/Hyper-Unearthing/llm_gateway/tree/HEAD)
 
-- Initial release
+[Full Changelog](https://github.com/Hyper-Unearthing/llm_gateway/compare/v0.1.0...HEAD)
+
+**Merged pull requests:**
+
+- feat: add tool base class [\#4](https://github.com/Hyper-Unearthing/llm_gateway/pull/4) ([billybonks](https://github.com/billybonks))
+- feat: add prompt base class [\#3](https://github.com/Hyper-Unearthing/llm_gateway/pull/3) ([billybonks](https://github.com/billybonks))
+- lint files and add coverage [\#2](https://github.com/Hyper-Unearthing/llm_gateway/pull/2) ([billybonks](https://github.com/billybonks))
+- test: vcr lookup was not working when using different commands [\#1](https://github.com/Hyper-Unearthing/llm_gateway/pull/1) ([billybonks](https://github.com/billybonks))
+
+## [v0.1.0](https://github.com/Hyper-Unearthing/llm_gateway/tree/v0.1.0) (2025-08-04)
+
+[Full Changelog](https://github.com/Hyper-Unearthing/llm_gateway/compare/505c78116a2e778b23f319a380cd4bf6e300db89...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -43,10 +43,117 @@ result = LlmGateway::Client.chat(
 )
 ```
 
+### Prompt Class
+
+You can also create reusable prompt classes by subclassing `LlmGateway::Prompt`:
+
+```ruby
+# Simple text completion with prompt class
+class GeographyQuestionPrompt < LlmGateway::Prompt
+  def initialize(model, question)
+    super(model)
+    @question = question
+  end
+
+  def prompt
+    @question
+  end
+end
+
+# Usage
+geography_prompt = GeographyQuestionPrompt.new('claude-sonnet-4-20250514', 'What is the capital of France?')
+result = geography_prompt.run
+
+# With system message
+class GeographyTeacherPrompt < LlmGateway::Prompt
+  def initialize(model, question)
+    super(model)
+    @question = question
+  end
+
+  def prompt
+    @question
+  end
+
+  def system_prompt
+    'You are a helpful geography teacher.'
+  end
+end
+
+# Usage
+teacher_prompt = GeographyTeacherPrompt.new('gpt-4', 'What is the capital of France?')
+result = teacher_prompt.run
+```
+
+### Using Prompt with Tools
+
+You can combine the Prompt class with tools for more complex interactions:
+
+```ruby
+# Define a tool class
+class GetWeatherTool < LlmGateway::Tool
+  name 'get_weather'
+  description 'Get current weather for a location'
+  input_schema({
+    type: 'object',
+    properties: {
+      location: { type: 'string', description: 'City name' }
+    },
+    required: ['location']
+  })
+
+  def execute(input, login = nil)
+    # Your weather API implementation here
+    "The weather in #{input['location']} is sunny and 25°C"
+  end
+end
+
+class WeatherAssistantPrompt < LlmGateway::Prompt
+  def initialize(model, location)
+    super(model)
+    @location = location
+  end
+
+  def prompt
+    "What's the weather like in #{@location}?"
+  end
+
+  def system_prompt
+    'You are a helpful weather assistant.'
+  end
+
+  def tools
+    [GetWeatherTool]
+  end
+end
+
+# Usage
+weather_prompt = WeatherAssistantPrompt.new('claude-sonnet-4-20250514', 'Singapore')
+result = weather_prompt.run
+```
+
 ### Tool Usage (Function Calling)
 
 ```ruby
-# Define a tool
+# Define a tool class
+class GetWeatherTool < LlmGateway::Tool
+  name 'get_weather'
+  description 'Get current weather for a location'
+  input_schema({
+    type: 'object',
+    properties: {
+      location: { type: 'string', description: 'City name' }
+    },
+    required: ['location']
+  })
+
+  def execute(input, login = nil)
+    # Your weather API implementation here
+    "The weather in #{input['location']} is sunny and 25°C"
+  end
+end
+
+# Use the tool
 weather_tool = {
   name: 'get_weather',
   description: 'Get current weather for a location',
@@ -59,13 +166,97 @@ weather_tool = {
   }
 }
 
-# Use the tool
 result = LlmGateway::Client.chat(
   'claude-sonnet-4-20250514',
   'What\'s the weather in Singapore?',
   tools: [weather_tool],
   system: 'You are a helpful weather assistant.'
 )
+
+# Note: Tools are not automatically executed. The LLM will indicate when a tool should be called,
+# but it's up to you to find the appropriate tool and execute it based on the response.
+
+# Example of handling tool execution with conversation transcript:
+class WeatherAssistant
+  def initialize
+    @transcript = []
+    @weather_tool = {
+      name: 'get_weather',
+      description: 'Get current weather for a location',
+      input_schema: {
+        type: 'object',
+        properties: {
+          location: { type: 'string', description: 'City name' }
+        },
+        required: ['location']
+      }
+    }
+  end
+
+  attr_reader :weather_tool
+
+  def process_message(content)
+    # Add user message to transcript
+    @transcript << { role: 'user', content: [{ type: 'text', text: content }] }
+
+    result = LlmGateway::Client.chat(
+      'claude-sonnet-4-20250514',
+      @transcript,
+      tools: [@weather_tool],
+      system: 'You are a helpful weather assistant.'
+    )
+
+    process_response(result[:choices][0][:content])
+  end
+
+  private
+
+  def process_response(response)
+    # Add assistant response to transcript
+    @transcript << { role: 'assistant', content: response }
+
+    response.each do |message|
+      if message[:type] == 'text'
+        puts message[:text]
+      elsif message[:type] == 'tool_use'
+        result = handle_tool_use(message)
+
+        # Add tool result to transcript
+        tool_result = {
+          type: 'tool_result',
+          tool_use_id: message[:id],
+          content: result
+        }
+        @transcript << { role: 'user', content: [tool_result] }
+
+        # Continue conversation with full transcript context
+        follow_up = LlmGateway::Client.chat(
+          'claude-sonnet-4-20250514',
+          @transcript,
+          tools: [@weather_tool],
+          system: 'You are a helpful weather assistant.'
+        )
+
+        process_response(follow_up[:choices][0][:content])
+      end
+    end
+  end
+
+  def handle_tool_use(message)
+    tool_class = WeatherAssistantPrompt.find_tool(message[:name])
+    raise "Unknown tool: #{message[:name]}" unless tool_class
+
+    # Execute the tool with the provided input
+    tool_instance = tool_class.new
+    tool_instance.execute(message[:input])
+  rescue StandardError => e
+    "Error executing tool: #{e.message}"
+  end
+end
+
+# Usage
+assistant = WeatherAssistant.new
+assistant.process_message("What's the weather in Singapore?")
 ```
 
 ### Response Format

data/Rakefile

@@ -10,12 +10,12 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 begin
-  require "gem-release"
+  require "gem/release"
 
   desc "Release with changelog"
-  task :release do
+  task :gem_release do
     # Generate changelog first
-    sh "github_changelog_generator" # or your preferred changelog tool
+    sh "bundle exec github_changelog_generator  -u Hyper-Unearthing -p llm_gateway"
     sh "git add CHANGELOG.md"
     sh "git commit -m 'Update changelog' || echo 'No changelog changes'"
 

data/lib/llm_gateway/errors.rb

@@ -2,7 +2,9 @@
 
 module LlmGateway
   module Errors
-    class BaseError < StandardError
+    class BaseError < StandardError; end
+
+    class ClientError < BaseError
       attr_reader :code
 
       def initialize(message = nil, code = nil)
@@ -11,20 +13,26 @@ module LlmGateway
       end
     end
 
-    class BadRequestError < BaseError; end
-    class AuthenticationError < BaseError; end
-    class PermissionDeniedError < BaseError; end
-    class NotFoundError < BaseError; end
-    class ConflictError < BaseError; end
-    class UnprocessableEntityError < BaseError; end
-    class RateLimitError < BaseError; end
-    class InternalServerError < BaseError; end
-    class APIStatusError < BaseError; end
-    class APITimeoutError < BaseError; end
-    class APIConnectionError < BaseError; end
-    class OverloadError < BaseError; end
-    class UnknownError < BaseError; end
+    class BadRequestError < ClientError; end
+    class AuthenticationError < ClientError; end
+    class PermissionDeniedError < ClientError; end
+    class NotFoundError < ClientError; end
+    class ConflictError < ClientError; end
+    class UnprocessableEntityError < ClientError; end
+    class RateLimitError < ClientError; end
+    class InternalServerError < ClientError; end
+    class APIStatusError < ClientError; end
+    class APITimeoutError < ClientError; end
+    class APIConnectionError < ClientError; end
+    class OverloadError < ClientError; end
+    class UnknownError < ClientError; end
     class PromptTooLong < BadRequestError; end
-    class UnsupportedModel < BaseError; end
+    class UnsupportedModel < ClientError; end
+
+    class PromptError < BaseError; end
+
+    class HallucinationError < PromptError; end
+    class UnknownModel < PromptError; end
+    class InvalidResponseGrammar < PromptError; end
   end
 end

data/lib/llm_gateway/prompt.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module LlmGateway
+  class Prompt
+    attr_reader :model
+
+    def self.before_execute(*methods, &block)
+      before_execute_callbacks.concat(methods)
+      before_execute_callbacks << block if block_given?
+    end
+
+    def self.after_execute(*methods, &block)
+      after_execute_callbacks.concat(methods)
+      after_execute_callbacks << block if block_given?
+    end
+
+    def self.before_execute_callbacks
+      @before_execute_callbacks ||= []
+    end
+
+    def self.after_execute_callbacks
+      @after_execute_callbacks ||= []
+    end
+
+    def self.inherited(subclass)
+      super
+      subclass.instance_variable_set(:@before_execute_callbacks, before_execute_callbacks.dup)
+      subclass.instance_variable_set(:@after_execute_callbacks, after_execute_callbacks.dup)
+    end
+
+    def initialize(model)
+      @model = model
+    end
+
+    def run
+      run_callbacks(:before_execute, prompt)
+
+      response = post
+
+      response_content = if respond_to?(:extract_response)
+        extract_response(response)
+      else
+        response[:choices][0][:content]
+      end
+
+      result = if respond_to?(:parse_response)
+        parse_response(response_content)
+      else
+        response_content
+      end
+
+      run_callbacks(:after_execute, response, response_content)
+
+      result
+    end
+
+    def post
+      LlmGateway::Client.chat(model, prompt, tools: tools, system: system_prompt)
+    end
+
+    def tools
+      nil
+    end
+
+    def self.find_tool(tool_name)
+      tools.find { |tool| tool.tool_name == tool_name }
+    end
+
+    def system_prompt
+      nil
+    end
+
+    private
+
+    def run_callbacks(callback_type, *args)
+      callbacks = self.class.send("#{callback_type}_callbacks")
+      callbacks.each do |callback|
+        if callback.is_a?(Proc)
+          instance_exec(*args, &callback)
+        elsif callback.is_a?(Symbol) || callback.is_a?(String)
+          send(callback, *args)
+        end
+      end
+    end
+  end
+end

data/lib/llm_gateway/tool.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module LlmGateway
+  class Tool
+      def initialize(*args)
+        # Empty constructor to allow subclasses to call super
+      end
+
+      def self.name(value = nil)
+        @name = value if value
+        @name
+      end
+
+      def self.description(value = nil)
+        @description = value if value
+        @description
+      end
+
+      def self.input_schema(value = nil)
+        @input_schema = value if value
+        @input_schema
+      end
+
+      def self.cache(value = nil)
+        @cache = value if value
+        @cache
+      end
+
+      def self.definition
+        {
+          name: @name,
+          description: @description,
+          input_schema: @input_schema,
+          cache_control: @cache ? { type: "ephemeral" } : nil
+        }.compact
+      end
+
+      def self.tool_name
+        definition[:name]
+      end
+
+      def execute(input, login)
+        raise NotImplementedError, "Subclasses must implement execute"
+      end
+  end
+end

data/lib/llm_gateway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LlmGateway
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/llm_gateway.rb

@@ -6,6 +6,8 @@ require_relative "llm_gateway/errors"
 require_relative "llm_gateway/fluent_mapper"
 require_relative "llm_gateway/base_client"
 require_relative "llm_gateway/client"
+require_relative "llm_gateway/prompt"
+require_relative "llm_gateway/tool"
 
 # Load adapters - order matters for inheritance
 require_relative "llm_gateway/adapters/claude/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm_gateway
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - billybonks
@@ -39,6 +39,8 @@ files:
 - lib/llm_gateway/client.rb
 - lib/llm_gateway/errors.rb
 - lib/llm_gateway/fluent_mapper.rb
+- lib/llm_gateway/prompt.rb
+- lib/llm_gateway/tool.rb
 - lib/llm_gateway/utils.rb
 - lib/llm_gateway/version.rb
 - sig/llm_gateway.rbs