claude-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b216c34d33d43142418a12fa080388398044f0552c2146b990a4d78d04f98d82
+  data.tar.gz: 9f82ea13bea11b376aa10b058fba3d45afbc04100fe0fd103e7a6cbd8de5b46a
+SHA512:
+  metadata.gz: f774be056a44ab57dd6bab72f0dd7d98e9c25a76f52b7524809beeab003bd14ac400a9b93d8a67323e5902fc91be745131980925f074a47878e61b79727055db
+  data.tar.gz: dcba4a5ff5c4472aa21222d20a37edc7558ae5d5b46abc332b4354844d93f1ff5c121e69766163bbb02f93fb8ca7a26e01da8ec7154fc1b6d533f8081f575f4b

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/claude-ruby.iml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, rbenv: 2.6.8) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.4, rbenv: 2.6.8) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, rbenv: 2.6.8) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.6.8" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/claude-ruby.iml" filepath="$PROJECT_DIR$/.idea/claude-ruby.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-0310-
+
+- Initial release

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in claude-ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"
+
+gem 'rest-client'
+
+group :test do
+    gem 'simplecov', require: false
+    gem 'simplecov_json_formatter', require: false
+end
+  
+  

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Web Ventures Ltd (NZ)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Claude Ruby
+
+[![Gem Version](https://badge.fury.io/rb/claude-ruby.svg)](https://badge.fury.io/rb/claude-ruby) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Maintainability](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/maintainability)](https://codeclimate.com/github/webven/claude-ruby/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/test_coverage)](https://codeclimate.com/github/webven/claude-ruby/test_coverage) [![CI](https://github.com/webven/claude-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/webven/claude-ruby/actions/workflows/ci.yml)
+
+`claude-ruby` gem is an unofficial ruby SDK for interacting with the Anthropic API, for generating and streaming messages through Claude
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'claude-ruby'
+```
+
+And then execute:
+
+```ruby
+$ bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install claude-ruby
+```
+
+## Usage
+
+To use this gemyou'll need an API key from Anthropic, which can be obtained from the Anthropic console  
+by following the Get API Access link on the [Anthrpic API page](https://www.anthropic.com/api).
+
+Set your API key as an environment variable then you can create a new `Claude::Client` instance:
+
+```ruby
+require 'claude/client'
+
+api_key = ENV['YOUR_ANTROPIC_API_KEY']
+claude_client = Claude::Client.new(api_key)
+```
+
+## Messages
+
+The anthropic messages endpoint allows you to: 
+```
+Send a structured list of input messages with text and/or image content, 
+and the model will generate the next message in the conversation.
+The Messages API can be used for for either single queries or stateless multi-turn conversations.
+```
+
+Using the claude-ruby gem you can call the Anthropic messages API by passing in an array of messages
+where each element is a hash containing `role` and `content` properties.
+
+The `messages` method allows converse with the Claude model in chat form. 
+It requires an array of messages where each message is a hash with two properties: `role` and `content`.
+
+`role` can be: 
+- `'user'`: This represents the user's input. 
+- `'assistant'`: This optional role represents the model's output.
+
+Simple example with a single user message:
+
+```ruby
+messages = [
+  {
+    role: "user",
+    content: "Who was the first team to win the rugby world cup?"
+  }
+]
+
+response = claude_client.messages(messages)
+```
+
+The response contains a bunch of metadata and the model's message response.
+To extract the message text you can you code like this:
+
+```ruby
+response['content'][0]['text']
+```
+
+You can continue the conversation by calling the `messages` method again with an expanded messages array:
+
+```ruby
+
+messages << {role: "assistant", content: "New Zealand won the first Rugby World Cup in 1987"}
+messages << {role: "user", content: "Who came third and fourth in that competition?"}
+
+response = claude_client.messages(messages)
+puts response['content'][0]['text'] # This will give you the updated message
+```
+
+Example with a more sophisticated message structure:
+
+```ruby
+system = "Only reply in Spanish."
+
+messages = [
+  {
+    role: "user",
+    content: "Hi there."
+  },
+  {
+    role: "assistant",
+    content: "Hola, como estás?"
+  },
+  {
+    role: "user",
+    content: "How long does it take to fly from Auckland to Buenos Aires?"
+  },
+]
+
+response = claude_client.messages(messages, {system: system})
+```
+
+For further details of the API visit https://docs.anthropic.com/claude/reference/messages_post
+
+## Changelog
+
+For a detailed list of changes for each version of this project, please see the [CHANGELOG](CHANGELOG.md).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webven/claude-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Trademarks
+
+This is an unofficial gem which has not been developed by Anthropic.  
+We make no claims for the trademarks of 'Anthropic' and 'Claude', which are registered by Anthropic PBC. 

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/claude/client.rb

@@ -0,0 +1,55 @@
+require 'rest-client'
+require 'json'
+
+module Claude
+  class Client
+
+    def initialize(api_key)
+      @api_key = api_key
+      @endpoint = 'https://api.anthropic.com/v1'
+    end
+
+    def messages(messages, params = {})
+      model = params[:model] || 'claude-3-opus-20240229'
+      max_tokens = params[:max_tokens] || 1024
+
+      url = "#{@endpoint}/messages"
+
+      data = {
+        model: model,
+        messages: messages,
+        system: params[:system],
+        max_tokens: max_tokens,
+        metadata: params[:metadata],
+        stop_sequences: params[:stop_sequences],
+        stream: params[:stream],
+        temperature: params[:temperature],
+        top_p: params[:top_p],
+        top_k: params[:top_k],
+      }.compact
+
+      request_api(url, data)
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'anthropic-version' => "2023-06-01",
+        'x-api-key' => "#{@api_key}",
+      }
+    end
+
+    private
+
+    def request_api(url, data, method = :post)
+      begin
+        response = RestClient::Request.execute(method: method, url: url, payload: data.to_json, headers: headers)
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        error_msg = JSON.parse(e.response.body)['error']['message']
+        raise RestClient::ExceptionWithResponse.new("#{e.message}: #{error_msg} (#{e.http_code})"), nil, e.backtrace
+      end
+    end
+
+  end
+end

data/lib/claude/ruby/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Claude
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

data/lib/claude/ruby.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "ruby/version"
+
+module Claude
+  module Ruby
+    class Error < StandardError; end
+  end
+end

data/sig/claude/ruby.rbs

@@ -0,0 +1,6 @@
+module Claude
+  module Ruby
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: claude-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Web Ventures Ltd
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial ruby SDK for interacting with the Anthropic API, for generating
+  and streaming messages through Claude.
+email:
+- webven@mailgab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/claude-ruby.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/claude/client.rb
+- lib/claude/ruby.rb
+- lib/claude/ruby/version.rb
+- sig/claude/ruby.rbs
+homepage: https://github.com/webven/claude-ruby.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/webven/claude-ruby.git
+  source_code_uri: https://github.com/webven/claude-ruby.git
+  changelog_uri: https://github.com/webven/claude-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A Ruby SDK for the Anthropic Claude API
+test_files: []