open_router 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 617d2bf77818298ec2a2b1f3c56ffd8ae344a969b2e3875c65017cbe9462d084
-  data.tar.gz: 0a1f88cc14ed99e96f1a54629ddbfb0139626235824c15edb6aa693df149a39c
+  metadata.gz: 3f81b52efb709758f501e3e43fd3967d36a0cde6b78aefd2512b21aafa0f3f5d
+  data.tar.gz: 347a0b754f0ed374ab6bdb0847e8efe1f762370c4c4e7b1faf1e3a7813dece10
 SHA512:
-  metadata.gz: '0787bb54df0cf1f38eba5263a58c7840a48d0aa5f4ddb1bef4eb47f95b2b4568ee934b4ab1d666d927a09e94f06a68ad5ade55f54ae6fed0d9af4ef78ec7f0e1'
-  data.tar.gz: bd2bf9db26382fea15ab814336e937fb73f1c7fa117d404311c82489a8248254af7ea7a593e74c57ceee43b4a573cf48650887facdf19758e4558c5df94f3a53
+  metadata.gz: 64d714806a4cda2841d1310357db4a8ed2737a064530676f484fe4213d2dfc863e6143b159915f57177f33448ca03585b953b164cb0825929d426ec2beeb30ba
+  data.tar.gz: a0fe64e1d6dcc790c478fa888f5b1db43edaec01001ca5f6903481042fb41a65d8808951d78bc49904797074620e8fdbb9616ffedcb8b1be2c0a1ee667b2de55

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-## [Unreleased]
+## [0.3.0] - 2024-05-03
+
+- Uses Faraday's built-in JSON mode
+- Added support for configuring Faraday and its middleware
+- Spec creates a STDOUT logger by default (headers, bodies, errors)
+- Spec filters Bearer token from logs by default
 
 ## [0.1.0] - 2024-03-19
 
 - Initial release
+
+## [Unreleased]

data/Gemfile

@@ -6,8 +6,14 @@ source "https://rubygems.org"
 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 "dotenv", ">= 2"
+  gem "pry", ">= 0.14"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.21"
+  gem "solargraph-rails", "~> 0.2.0.pre"
+  gem "sorbet"
+  gem "tapioca", require: false
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_router (0.2.1)
+    open_router (0.2.2)
       activesupport (>= 6.0)
       dotenv (>= 2)
       faraday (>= 1)
@@ -21,7 +21,9 @@ GEM
       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)
@@ -29,6 +31,8 @@ GEM
     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)
@@ -37,23 +41,40 @@ GEM
     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)
@@ -83,9 +104,56 @@ 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
@@ -99,6 +167,9 @@ DEPENDENCIES
   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

@@ -63,6 +63,32 @@ Then you can create a client like this:
 client = OpenRouter::Client.new
 ```
 
+#### Configure Faraday
+
+The configuration object exposes a [`faraday`](https://github.com/lostisland/faraday-retry) method that you can pass a block to configure Faraday settings and middleware.
+
+This example adds `faraday-retry` and a logger that redacts the api key so it doesn't get leaked to logs.
+
+```ruby
+require 'faraday/retry'
+
+retry_options = {
+  max: 2,
+  interval: 0.05,
+  interval_randomness: 0.5,
+  backoff_factor: 2
+}
+
+OpenRouter::Client.new(access_token: ENV["ACCESS_TOKEN"]) do |config|
+  config.faraday do |f|
+    f.request :retry, retry_options
+    f.response :logger, ::Logger.new($stdout), { headers: true, bodies: true, errors: true } do |logger|
+      logger.filter(/(Bearer) (\S+)/, '\1[REDACTED]')
+    end
+  end
+end
+```
+
 #### Change version or timeout
 
 The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client.

data/lib/open_router/client.rb

@@ -41,7 +41,7 @@ module OpenRouter
       parameters[:stream] = stream if stream
       parameters.merge!(extras)
 
-      json_post(path: "/chat/completions", parameters:).tap do |response|
+      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

data/lib/open_router/http.rb

@@ -3,13 +3,13 @@
 module OpenRouter
   module HTTP
     def get(path:)
-      to_json(conn.get(uri(path:)) do |req|
+      conn.get(uri(path:)) do |req|
         req.headers = headers
-      end&.body)
+      end&.body
     end
 
-    def json_post(path:, parameters:)
-      to_json(conn.post(uri(path:)) do |req|
+    def post(path:, parameters:)
+      conn.post(uri(path:)) do |req|
         if parameters[:stream].respond_to?(:call)
           req.options.on_data = to_json_stream(user_proc: parameters[:stream])
           parameters[:stream] = true # Necessary to tell OpenRouter to stream.
@@ -17,33 +17,24 @@ module OpenRouter
 
         req.headers = headers
         req.body = parameters.to_json
-      end&.body)
+      end&.body
     end
 
     def multipart_post(path:, parameters: nil)
-      to_json(conn(multipart: true).post(uri(path:)) do |req|
+      conn(multipart: true).post(uri(path:)) do |req|
         req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
         req.body = multipart_parameters(parameters)
-      end&.body)
+      end&.body
     end
 
     def delete(path:)
-      to_json(conn.delete(uri(path:)) do |req|
+      conn.delete(uri(path:)) do |req|
         req.headers = headers
-      end&.body)
+      end&.body
     end
 
     private
 
-    def to_json(string)
-      return unless string
-
-      JSON.parse(string)
-    rescue JSON::ParserError
-      # Convert a multiline string of JSON objects to a JSON array.
-      JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
-    end
-
     # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.
     # For each chunk, the inner user_proc is called giving it the JSON object. The JSON object could
     # be a data object or an error object as described in the OpenRouter API documentation.
@@ -66,6 +57,11 @@ module OpenRouter
       Faraday.new do |f|
         f.options[:timeout] = OpenRouter.configuration.request_timeout
         f.request(:multipart) if multipart
+        f.use MiddlewareErrors if @log_errors
+        f.response :raise_error
+        f.response :json
+
+        OpenRouter.configuration.faraday_config&.call(f)
       end
     end
 

data/lib/open_router/version.rb

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

data/lib/open_router.rb

@@ -13,18 +13,19 @@ module OpenRouter
 
   class Configuration
     attr_writer :access_token
-    attr_accessor :api_version, :extra_headers, :request_timeout, :uri_base
+    attr_accessor :api_version, :extra_headers, :faraday_config, :log_errors, :request_timeout, :uri_base
 
     DEFAULT_API_VERSION = "v1"
     DEFAULT_REQUEST_TIMEOUT = 120
     DEFAULT_URI_BASE = "https://openrouter.ai/api"
 
     def initialize
-      @access_token = nil
-      @uri_base = DEFAULT_URI_BASE
-      @api_version = DEFAULT_API_VERSION
-      @request_timeout = DEFAULT_REQUEST_TIMEOUT
-      @extra_headers = {}
+      self.access_token = nil
+      self.api_version = DEFAULT_API_VERSION
+      self.extra_headers = {}
+      self.log_errors = false
+      self.request_timeout = DEFAULT_REQUEST_TIMEOUT
+      self.uri_base = DEFAULT_URI_BASE
     end
 
     def access_token
@@ -33,6 +34,10 @@ module OpenRouter
       raise ConfigurationError, "OpenRouter access token missing!"
     end
 
+    def faraday(&block)
+      self.faraday_config = block
+    end
+
     def site_name=(value)
       @extra_headers["X-Title"] = value
     end

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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_router
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -103,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.