smollama 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9f331024c63381cad8781105f25f9c86f8d1745f89ee4ec6ce230e65646500b
+  data.tar.gz: 14b790b0158ac0cd54a9520e37d68eab471cbc5951e9a38274bbc3da51d9df93
+SHA512:
+  metadata.gz: 7f9e09789dcabfc5282332fda7742f7a054547e9c0df57b349282db5ab7d4dba7ead148da52b0a5345aa921b94d07d611feec48f34e20672473933776c6cfff0
+  data.tar.gz: e81e862f8534d92d9b929dfe6ee0901b3f39030cb55610572d4a2dbf1f6f5e4c29a90866b9fd26c74226b494795a612ce6df5adf4fb49458d806ab3eb9b9706b

data/README.md

@@ -0,0 +1,154 @@
+# SmolLama
+
+A simple, lightweight Ruby client for the Ollama API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smollama'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smollama
+
+## Usage
+
+### Basic Configuration
+
+Configure the client at application startup:
+
+```ruby
+require 'smollama'
+
+Smollama::Client.configure do |config|
+  config.server_ip = '127.0.0.1' # 192.168.0.x or similar if you're running Ollama in a box in your LAN
+  config.server_port = 11434  # optional, defaults to 11434
+  config.default_model = 'gpt-oss'
+end
+```
+
+### Simple Chat
+
+```ruby
+client = Smollama::Client.new
+
+response = client.ask("Hello, how are you?")
+puts response[:content]
+```
+
+### Chat with Parameters
+
+```ruby
+response = client.chat(
+  "Explain quantum computing",
+  temperature: 0.6, # NOTE: use 0.2 for coding tasks
+  top_p: 0.98,
+  max_tokens: 500
+)
+puts response[:content]
+```
+
+### Streaming Responses
+
+```ruby
+client.chat("Tell me a story", stream: true) do |chunk|
+  print chunk['message']['content'] if chunk['message']
+end
+```
+
+### Chat with Conversation History
+
+```ruby
+messages = [
+  { role: 'system', content: 'You are a helpful assistant.' },
+  { role: 'user', content: 'What is Ruby?' },
+  { role: 'assistant', content: 'Ruby is a dynamic programming language.' },
+  { role: 'user', content: 'What makes it special?' }
+]
+
+response = client.chat_with_history(messages, temperature: 0.8)
+puts response[:content]
+```
+
+### Using Different Models
+
+```ruby
+# Use a different model for a specific client
+special_client = Smollama::Client.new(model: 'llama2')
+response = special_client.ask("Hello!")
+```
+
+### Server Health Check
+
+```ruby
+if client.ping
+  puts "Ollama server is reachable"
+else
+  puts "Cannot reach Ollama server"
+end
+```
+
+### List Available Models
+
+```ruby
+models = client.list_models
+puts "Available models: #{models['models'].map { |m| m['name'] }.join(', ')}"
+```
+
+## Configuration Options
+
+- `server_ip`: The IP address of your Ollama server (required)
+- `server_port`: The port number (optional, defaults to 11434)
+- `default_model`: The default model to use for all clients
+
+## Chat Parameters
+
+- `temperature`: Controls randomness (0.0 to 1.0)
+- `top_p`: Controls nucleus sampling (0.0 to 1.0)
+- `max_tokens`: Maximum number of tokens to generate
+- `stream`: Enable streaming responses (boolean)
+
+## Response Format
+
+Non-streaming responses return a hash with:
+
+- `:content` - The generated text
+- `:model` - Model used
+- `:created_at` - Timestamp
+- `:total_duration` - Total processing time
+- `:eval_count` - Number of tokens evaluated
+- `:eval_duration` - Evaluation time
+
+## Error Handling
+
+The client gracefully handles errors and returns error information in the response:
+
+```ruby
+response = client.ask("Hello")
+if response[:error]
+  puts "Error: #{response[:error]}"
+else
+  puts response[:content]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/makevoid/smollama.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Build and publish gem to RubyGems"
+task :publish do
+  puts "Building gem..."
+  system("gem build smollama.gemspec")
+  
+  gem_file = Dir["smollama-*.gem"].first
+  if gem_file
+    puts "Publishing #{gem_file} to RubyGems..."
+    system("gem push #{gem_file}")
+    
+    puts "Cleaning up..."
+    File.delete(gem_file)
+  else
+    puts "No gem file found to publish!"
+  end
+end
+
+desc "Build gem without publishing"
+task :build do
+  system("gem build smollama.gemspec")
+end
+
+desc "Install gem locally"
+task :install => :build do
+  gem_file = Dir["smollama-*.gem"].first
+  if gem_file
+    system("gem install #{gem_file}")
+    File.delete(gem_file)
+  end
+end

data/lib/smollama/client.rb

@@ -0,0 +1,189 @@
+require 'excon'
+require 'json'
+
+module Smollama
+  class Client
+    # Class-level configuration
+    class << self
+      attr_accessor :server_ip, :server_port, :default_model
+
+      def configure
+        yield self if block_given?
+      end
+
+      def base_url
+        raise "Server IP not configured" unless server_ip
+        port = server_port || 11434
+        "http://#{server_ip}:#{port}"
+      end
+    end
+
+    # Initialize with optional overrides
+    def initialize(model: nil)
+      @model = model || self.class.default_model
+      raise "Model not specified" unless @model
+
+      @connection = Excon.new(
+        "#{self.class.base_url}/api/chat",
+        persistent: true,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+
+    # Main chat method with configurable parameters
+    def chat(message, temperature: nil, top_p: nil, max_tokens: nil, stream: false)
+      messages = build_messages(message)
+
+      payload = {
+        model: @model,
+        messages: messages,
+        stream: stream
+      }
+
+      # Add optional parameters if provided
+      payload[:options] = {} if temperature || top_p
+      payload[:options][:temperature] = temperature if temperature
+      payload[:options][:top_p] = top_p if top_p
+      payload[:options][:num_predict] = max_tokens if max_tokens
+
+      if stream
+        stream_response(payload) { |chunk| yield chunk if block_given? }
+      else
+        send_request(payload)
+      end
+    end
+
+    # Convenience method for single message chat
+    def ask(prompt, **options)
+      chat(prompt, **options)
+    end
+
+    # Chat with conversation history
+    def chat_with_history(messages, **options)
+      raise "Messages must be an array" unless messages.is_a?(Array)
+
+      payload = {
+        model: @model,
+        messages: messages,
+        stream: options[:stream] || false
+      }
+
+      # Add optional parameters
+      payload[:options] = {}
+      payload[:options][:temperature] = options[:temperature] if options[:temperature]
+      payload[:options][:top_p] = options[:top_p] if options[:top_p]
+      payload[:options][:num_predict] = options[:max_tokens] if options[:max_tokens]
+
+      if payload[:stream]
+        stream_response(payload) { |chunk| yield chunk if block_given? }
+      else
+        send_request(payload)
+      end
+    end
+
+    # Get available models
+    def list_models
+      response = Excon.get(
+        "#{self.class.base_url}/api/tags",
+        headers: { 'Content-Type' => 'application/json' }
+      )
+
+      JSON.parse(response.body)
+    rescue Excon::Error => e
+      { error: "Failed to list models: #{e.message}" }
+    end
+
+    # Check if server is reachable
+    def ping
+      response = Excon.get("#{self.class.base_url}/")
+      response.status == 200
+    rescue Excon::Error
+      false
+    end
+
+    private
+
+    def build_messages(input)
+      case input
+      when String
+        [{ role: 'user', content: input }]
+      when Hash
+        [input]
+      when Array
+        input
+      else
+        raise "Invalid message format"
+      end
+    end
+
+    def send_request(payload)
+      response = @connection.post(
+        body: payload.to_json,
+        read_timeout: 120,
+        write_timeout: 120
+      )
+
+      parse_response(response)
+    rescue Excon::Error::Timeout => e
+      { error: "Request timeout: #{e.message}" }
+    rescue Excon::Error => e
+      { error: "Request failed: #{e.message}" }
+    end
+
+    def stream_response(payload)
+      buffer = ""
+
+      @connection.post(
+        body: payload.to_json,
+        read_timeout: 120,
+        write_timeout: 120,
+        response_block: lambda do |chunk, remaining_bytes, total_bytes|
+          buffer += chunk
+
+          # Process complete JSON objects from buffer
+          while (line_end = buffer.index("\n"))
+            line = buffer[0...line_end]
+            buffer = buffer[(line_end + 1)..-1]
+
+            next if line.strip.empty?
+
+            begin
+              data = JSON.parse(line)
+              yield data if block_given?
+            rescue JSON::ParserError => e
+              puts "Failed to parse JSON: #{e.message}"
+            end
+          end
+        end
+      )
+
+      { status: 'stream_complete' }
+    rescue Excon::Error => e
+      { error: "Stream failed: #{e.message}" }
+    end
+
+    def parse_response(response)
+      return { error: "Empty response" } if response.body.nil? || response.body.empty?
+
+      data = JSON.parse(response.body)
+
+      # Extract the assistant's message content
+      if data['message']
+        {
+          content: data['message']['content'],
+          model: data['model'],
+          created_at: data['created_at'],
+          total_duration: data['total_duration'],
+          eval_count: data['eval_count'],
+          eval_duration: data['eval_duration']
+        }
+      else
+        data
+      end
+    rescue JSON::ParserError => e
+      { error: "Failed to parse response: #{e.message}", raw: response.body }
+    end
+  end
+end

data/lib/smollama/version.rb

@@ -0,0 +1,3 @@
+module Smollama
+  VERSION = "0.1.0"
+end

data/lib/smollama.rb

@@ -0,0 +1,5 @@
+require_relative "smollama/version"
+require_relative "smollama/client"
+
+module Smollama
+end

data/smollama.gemspec

@@ -0,0 +1,33 @@
+require_relative "lib/smollama/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "smollama"
+  spec.version = Smollama::VERSION
+  spec.authors = ["makevoid"]
+  spec.email = ["makevoid@example.com"]
+
+  spec.summary = "A simple Ruby client for Ollama API"
+  spec.description = "SmolLama is a lightweight Ruby client for interacting with the Ollama API. It provides a simple interface for chat completions, streaming responses, and model management."
+  spec.homepage = "https://github.com/makevoid/smollama"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/makevoid/smollama"
+  spec.metadata["changelog_uri"] = "https://github.com/makevoid/smollama/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir["{lib}/**/*", "*.md", "*.gemspec", "Rakefile"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "excon", "~> 0.100"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: smollama
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- makevoid
+bindir: exe
+cert_chain: []
+date: 2025-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.100'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.100'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: SmolLama is a lightweight Ruby client for interacting with the Ollama
+  API. It provides a simple interface for chat completions, streaming responses, and
+  model management.
+email:
+- makevoid@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/smollama.rb
+- lib/smollama/client.rb
+- lib/smollama/version.rb
+- smollama.gemspec
+homepage: https://github.com/makevoid/smollama
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/makevoid/smollama
+  source_code_uri: https://github.com/makevoid/smollama
+  changelog_uri: https://github.com/makevoid/smollama/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A simple Ruby client for Ollama API
+test_files: []