open_router 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff9756e6285ab09ccaf109eabe0a36747e488450de363ce8ce460b94eb397bc
-  data.tar.gz: 3dcb3957fbbe02cc15d0c0806bcbd248b1b3e64e75f48e60789393285f70ed33
+  metadata.gz: 3f81b52efb709758f501e3e43fd3967d36a0cde6b78aefd2512b21aafa0f3f5d
+  data.tar.gz: 347a0b754f0ed374ab6bdb0847e8efe1f762370c4c4e7b1faf1e3a7813dece10
 SHA512:
-  metadata.gz: 644c0c1fd8ec173af8df82df65496483fa01560a38a8bf1aa23f6473b981333b216bad020f86f14a43f09450803af144891ee696af078ca4a274eaaae6d729ba
-  data.tar.gz: 52b2870105b521eae5bd34302d8c95232d018a407021d8dcff47eac0806fd81b6c4beea6191f3cc57e674af06de61cf9cb1f3d98934d4a86cfea31f09bb872f5
+  metadata.gz: 64d714806a4cda2841d1310357db4a8ed2737a064530676f484fe4213d2dfc863e6143b159915f57177f33448ca03585b953b164cb0825929d426ec2beeb30ba
+  data.tar.gz: a0fe64e1d6dcc790c478fa888f5b1db43edaec01001ca5f6903481042fb41a65d8808951d78bc49904797074620e8fdbb9616ffedcb8b1be2c0a1ee667b2de55

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,13 +6,13 @@ 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

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.2"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_router
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport