open_router 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a93aba25cb96e636386ff6124b516fd580fd1535b215d0e5152dd02873f01f5
-  data.tar.gz: cb2aae6801e85efb8b2e1603797ca2186ed696a019e29839d7fa5509573958e5
+  metadata.gz: 1ff9756e6285ab09ccaf109eabe0a36747e488450de363ce8ce460b94eb397bc
+  data.tar.gz: 3dcb3957fbbe02cc15d0c0806bcbd248b1b3e64e75f48e60789393285f70ed33
 SHA512:
-  metadata.gz: 8cbcf5b988d5a709d7de4289aa3dccd470af4975e8f9a37a826ff5df097f0fee04328a9fa3877a3299d1c5849370aeab3f3bada91617efcc10ab13a8116523d3
-  data.tar.gz: 91d41c29aee465880f59c1b6bcc121f559c929da2c7dec9be55ecc68f992031fa0c096655af0aa56942c9cd4076506e9dbf22d898c274d9fb653222269a871e0
+  metadata.gz: 644c0c1fd8ec173af8df82df65496483fa01560a38a8bf1aa23f6473b981333b216bad020f86f14a43f09450803af144891ee696af078ca4a274eaaae6d729ba
+  data.tar.gz: 52b2870105b521eae5bd34302d8c95232d018a407021d8dcff47eac0806fd81b6c4beea6191f3cc57e674af06de61cf9cb1f3d98934d4a86cfea31f09bb872f5

data/.rubocop.yml

@@ -1,5 +1,29 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: true
@@ -8,6 +32,3 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -5,8 +5,15 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in open_router.gemspec
 gemspec
 
+gem "activesupport", ">= 6.0"
+gem "dotenv", ">= 2"
+gem "pry", ">= 0.14"
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
 gem "rubocop", "~> 1.21"
+
+group :development do
+  gem "solargraph-rails", "~> 0.2.0.pre"
+  gem "sorbet"
+  gem "tapioca", require: false
+end

data/Gemfile.lock

@@ -1,32 +1,80 @@
 PATH
   remote: .
   specs:
-    open_router (0.1.0)
+    open_router (0.2.2)
+      activesupport (>= 6.0)
+      dotenv (>= 2)
       faraday (>= 1)
       faraday-multipart (>= 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    backport (1.2.0)
+    base64 (0.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.7)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
+    dotenv (3.1.0)
+    drb (2.2.1)
+    e2mmap (0.1.0)
+    erubi (1.12.0)
     faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.6)
     json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.22.3)
     multipart-post (2.3.0)
+    mutex_m (0.2.0)
+    netrc (0.11.0)
+    nokogiri (1.16.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.4-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    prism (0.24.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rbi (0.1.10)
+      prism (>= 0.18.0, < 0.25)
+      sorbet-runtime (>= 0.5.9204)
+    rbs (2.8.4)
     regexp_parser (2.8.1)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -56,16 +104,72 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    solargraph-rails (0.2.2.pre.4)
+      activesupport
+      solargraph (>= 0.41.1)
+    sorbet (0.5.11342)
+      sorbet-static (= 0.5.11342)
+    sorbet-runtime (0.5.11342)
+    sorbet-static (0.5.11342-universal-darwin)
+    sorbet-static (0.5.11342-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11342)
+      sorbet (= 0.5.11342)
+      sorbet-runtime (= 0.5.11342)
+    spoom (1.3.0)
+      erubi (>= 1.10.0)
+      prism (>= 0.19.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.13.1)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (>= 0.1.4, < 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.1)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    yard (0.9.36)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  activesupport (>= 6.0)
+  dotenv (>= 2)
   open_router!
+  pry (>= 0.14)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  solargraph-rails (~> 0.2.0.pre)
+  sorbet
+  tapioca
 
 BUNDLED WITH
    2.4.12

data/README.md

@@ -10,7 +10,7 @@ The [OpenRouter API](https://openrouter.ai/docs) is a single unified interface f
 - **Standardized API**: No need to change your code when switching between models or providers. You can even let users choose and pay for their own.
 - **Easy integration**: This Ruby gem provides a simple and intuitive interface to interact with the OpenRouter API, making it effortless to integrate AI capabilities into your Ruby applications.
 
-👬 This Ruby library was originally bootstrapped from the [🤖 OpenRouter](https://github.com/alexrudall/anthropic) gem by Alex Rudall, and subsequently extracted from the codebase of my fast-growing AI startup called [Olympia](https://olympia.chat?utm_source=open_router_gem&utm_medium=github) that lets you add AI-powered consultants to your startup!
+👬 This Ruby library was originally bootstrapped from the [🤖 Anthropic](https://github.com/alexrudall/anthropic) gem by Alex Rudall, and subsequently extracted from the codebase of my fast-growing AI startup called [Olympia](https://olympia.chat?utm_source=open_router_gem&utm_medium=github) that lets you add AI-powered consultants to your startup!
 
 🚢 Need someone to develop AI software for you using modern Ruby on Rails? My other company Magma Labs does exactly that: [magmalabs.io](https://www.magmalabs.io/?utm_source=open_router_gem&utm_medium=github). In fact, we also sell off-the-shelf solutions based on my early work on the field, via a platform called [MagmaChat](https://magmachat.ai?utm_source=open_router_gem&utm_medium=github)
 
@@ -91,7 +91,27 @@ puts response["choices"][0]["message"]["content"]
 
 ### Models
 
-Fetch the list of available models from the OpenRouter API:
+Pass an array to the `model` parameter to enable [explicit model routing](https://openrouter.ai/docs#model-routing).
+
+```ruby
+OpenRouter::Client.new.complete(
+  [
+    { role: "system", content: SYSTEM_PROMPT },
+    { role: "user", content: "Provide analysis of the data formatted as JSON:" }
+  ],
+  model: [
+    "mistralai/mixtral-8x7b-instruct:nitro",
+    "mistralai/mixtral-8x7b-instruct"
+  ],
+  extras: {
+    response_format: {
+      type: "json_object"
+    }
+  }
+)
+```
+
+[Browse full list of models available](https://openrouter.ai/models) or fetch from the OpenRouter API:
 
 ```ruby
 models = client.models
@@ -110,6 +130,10 @@ puts stats
 # => {"id"=>"generation-abcdefg", "object"=>"generation", "created"=>1684195200, "model"=>"openrouter/auto", "usage"=>{"prompt_tokens"=>10, "completion_tokens"=>50, "total_tokens"=>60}, "cost"=>0.0006}
 ```
 
+## Errors
+
+The client will raise an `OpenRouter::ServerError` in the case of an error returned from a completion (or empty response).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/OlympiaAI/open_router>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/OlympiaAI/open_router/blob/main/CODE_OF_CONDUCT.md).

data/lib/open_router/client.rb

@@ -1,31 +1,50 @@
 # frozen_string_literal: true
 
-require_relative 'http'
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash/indifferent_access"
+
+require_relative "http"
 
 module OpenRouter
+  class ServerError < StandardError; end
+
   class Client
     include OpenRouter::HTTP
 
     # Initializes the client with optional configurations.
-    def initialize
+    def initialize(access_token: nil, request_timeout: nil, uri_base: nil, extra_headers: {})
+      OpenRouter.configuration.access_token = access_token if access_token
+      OpenRouter.configuration.request_timeout = request_timeout if request_timeout
+      OpenRouter.configuration.uri_base = uri_base if uri_base
+      OpenRouter.configuration.extra_headers = extra_headers if extra_headers.any?
       yield(OpenRouter.configuration) if block_given?
     end
 
     # Performs a chat completion request to the OpenRouter API.
     # @param messages [Array<Hash>] Array of message hashes with role and content, like [{role: "user", content: "What is the meaning of life?"}]
-    # @param model [String] Model identifier, defaults to 'openrouter/auto'
+    # @param model [String|Array] Model identifier, or array of model identifiers if you want to fallback to the next model in case of failure
     # @param providers [Array<String>] Optional array of provider identifiers, ordered by priority
     # @param transforms [Array<String>] Optional array of strings that tell OpenRouter to apply a series of transformations to the prompt before sending it to the model. Transformations are applied in-order
     # @param extras [Hash] Optional hash of model-specific parameters to send to the OpenRouter API
     # @param stream [Proc, nil] Optional callable object for streaming
     # @return [Hash] The completion response.
-    def complete(messages, model: 'openrouter/auto', providers: [], transforms: [], extras: {}, stream: nil)
-      parameters = { model:, messages: }
+    def complete(messages, model: "openrouter/auto", providers: [], transforms: [], extras: {}, stream: nil)
+      parameters = { messages: }
+      if model.is_a?(String)
+        parameters[:model] = model
+      elsif model.is_a?(Array)
+        parameters[:models] = model
+        parameters[:route] = "fallback"
+      end
       parameters[:provider] = { provider: { order: providers } } if providers.any?
       parameters[:transforms] = transforms if transforms.any?
       parameters[:stream] = stream if stream
       parameters.merge!(extras)
-      json_post(path: "/chat/completions", parameters:)
+
+      json_post(path: "/chat/completions", parameters:).tap do |response|
+        raise ServerError, "Empty response from OpenRouter. Might be worth retrying once or twice." if response.blank?
+        raise ServerError, response.dig("error", "message") if response.dig("error", "message").present?
+      end.with_indifferent_access
     end
 
     # Fetches the list of available models from the OpenRouter API.

data/lib/open_router/version.rb

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

data/lib/open_router.rb

@@ -17,7 +17,7 @@ module OpenRouter
 
     DEFAULT_API_VERSION = "v1"
     DEFAULT_REQUEST_TIMEOUT = 120
-    DEFAULT_URI_BASE = 'https://openrouter.ai/api'
+    DEFAULT_URI_BASE = "https://openrouter.ai/api"
 
     def initialize
       @access_token = nil

data/open_router.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Ruby library for OpenRouter API."
   spec.homepage = "https://github.com/OlympiaAI/open_router"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.1"
+  spec.required_ruby_version = ">= 3.2.2"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/OlympiaAI/open_router"
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.end_with?('.gem') || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+      (File.expand_path(f) == __FILE__) || f.end_with?(".gem") || f.start_with?(*%w[bin/ test/ spec/ features/ .git
+                                                                                    .circleci appveyor])
     end
   end
 
@@ -27,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 6.0"
+  spec.add_dependency "dotenv", ">= 2"
   spec.add_dependency "faraday", ">= 1"
   spec.add_dependency "faraday-multipart", ">= 1"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: open_router
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -75,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.1
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Ruby library for OpenRouter API.