activeclient_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e4355874cf52251d674000e9d6b6affa02deed86dd42a426d202262792cb1ab
+  data.tar.gz: dfd3243aff05f261a33eafe79fe06cf19c29de640d0501d790f3143554599eb5
+SHA512:
+  metadata.gz: 5b7e5fb4b6a5d7ca31e2259df22b4e9bc6a5f29a25bdfc5c0b0396b431caa57b3fadaa9e8dc585705e8d066bf126ec4debf00c026f9db9276c8aa983fc9a7763
+  data.tar.gz: 2bddd36d9c27340fa490c60b96fa85bbf6a27feecea15e443260fb34541dc101942f2df0fbfaef67ca437cf31487014e6acba643502f977759d737de7a825be8

data/README.md

@@ -0,0 +1,83 @@
+# ActiveClient
+
+Basic API client interface
+
+## Example OpenAI client
+
+```ruby
+class OpenAI < ActiveClient::Base
+  class BadRequestError < StandardError
+  end
+
+  def initialize(model = "gpt-4o-mini-2024-07-18")
+    @model = model
+    super()
+  end
+
+  def response(input, name, schema, tools = [])
+    response = post "responses", **request_params(input, name, schema, tools)
+
+    raise BadRequestError, response unless response.success?
+
+    JSON.parse(response.body.to_h["output"].
+      find { it["type"] == "message" }.dig("content", 0, "text"))
+  end
+
+  def create_vector_store(name, *file_ids)
+    post("vector_stores", name:, file_ids:,
+                          expires_after: { days: 1, anchor: :last_active_at })
+  end
+
+  def vector_store(id)
+    get("vector_stores/#{id}")
+  end
+
+  def vector_stores
+    get("vector_stores")
+  end
+
+  def files
+    get("files")
+  end
+
+  def upload_file(name, content)
+    multipart_post("files", [%w(purpose user_data),
+                             ["file", StringIO.new(content),
+                              { filename: name, content_type: "text/plain" }]])
+  end
+
+  private
+
+    attr_reader :model
+
+    def default_headers = super.merge("Authorization" => token_header)
+    def base_url = "https://api.openai.com/v1"
+    def token_header = "Bearer #{credentials.dig(:open_ai, :token)}"
+
+    def request_params(input, name, schema, tools)
+      { input:, model:, store: false, top_p: 1.0, tools:, text: { format: {
+        type: :json_schema, name:, schema:, strict: true
+      } } }
+    end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activeclient_api"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activeclient_api
+```
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/active_client/base.rb

@@ -0,0 +1,118 @@
+class ActiveClient::Base
+  Response = Struct.new(:body, :success?)
+
+  def get(path, skip_parsing: false, **query)
+    make_request(Net::HTTP::Get, path, skip_parsing:, query:)
+  end
+
+  def post(path, **body)
+    make_request(Net::HTTP::Post, path, body:)
+  end
+
+  def delete(path)
+    make_request(Net::HTTP::Delete, path)
+  end
+
+  def multipart_post(path, body, skip_parsing: false)
+    instrument(klass: Net::HTTP::Post, path:, query: nil,
+               body: nil) do |http, request|
+      request.set_form(body, "multipart/form-data")
+
+      response = http.request(request)
+
+      Response.new(parse_response(response.body, skip_parsing),
+                   response.is_a?(Net::HTTPSuccess))
+    end
+  end
+
+  private
+
+    def instrument(klass:, path:, query:, body:)
+      uri, http, request = construct_request(klass:, path:, query:)
+      request.body = default_body.merge(body).to_json if body.present?
+      loggable = loggable_uri(uri)
+      args = { name: self.class.name.demodulize, uri: loggable }
+
+      ActiveSupport::Notifications.
+        instrument("request.active_client", args) { yield http, request }
+    end
+
+    def make_request(klass, path, skip_parsing: false, query: {}, body: {})
+      instrument(klass:, path:, query:, body:) do |http, request|
+        response = http.request(request)
+
+        Response.new(parse_response(response.body, skip_parsing),
+                     response.is_a?(Net::HTTPSuccess))
+      end
+    end
+
+    def parse_response(body, skip_parsing)
+      if skip_parsing
+        body
+      else
+        JSON.parse(body)
+      end
+    end
+
+    def construct_request(klass:, path:, query:)
+      uri = construct_uri(path:, query:)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.instance_of?(URI::HTTPS)
+      http.read_timeout = 1200
+
+      [uri, http, klass.new(uri.request_uri, default_headers)]
+    end
+
+    def construct_uri(path:, query:)
+      if base_url.present?
+        URI(URI::DEFAULT_PARSER.escape(File.join(base_url, path)))
+      else
+        URI(URI::DEFAULT_PARSER.escape(path))
+      end.tap { |uri| build_query(uri, query) }
+    end
+
+    def build_query(uri, query)
+      return unless query.present? || default_query.present?
+
+      uri.query = URI.encode_www_form(default_query.merge(query))
+    end
+
+    def default_headers
+      { "Accept" => "application/json",
+        "Content-Type" => "application/json" }
+    end
+
+    def default_query
+      {}
+    end
+
+    def default_body
+      {}
+    end
+
+    def base_url
+    end
+
+    def token_header
+      raise NotImplementedError
+    end
+
+    def credentials
+      Rails.application.credentials
+    end
+
+    def all_credentials
+      credentials.to_h.values.flat_map do |cred|
+        cred.try(:values).presence || cred
+      end
+    end
+
+    def loggable_uri(uri)
+      uri.to_s.tap do |loggable|
+        all_credentials.each do |s|
+          loggable.gsub!(s, "[FILTERED]")
+        end
+      end
+    end
+end

data/lib/active_client/log_subscriber.rb

@@ -0,0 +1,34 @@
+require "active_support/version"
+require "active_support/deprecation"
+require "active_support/deprecator"
+require "active_support/log_subscriber"
+require "active_support/isolated_execution_state"
+
+module ActiveClient
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def self.runtime=(value)
+      Thread.current[:active_client_runtime] = value
+    end
+
+    def self.runtime
+      Thread.current[:active_client_runtime] ||= 0
+    end
+
+    # :nocov:
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+    # :nocov:
+
+    def request(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      log_name = color("#{event.payload[:name]} (#{event.duration.round(1)}ms)",
+                       YELLOW, bold: true)
+
+      debug "  #{log_name}  #{color(event.payload[:uri], YELLOW, bold: true)}"
+    end
+  end
+end

data/lib/active_client/railtie.rb

@@ -0,0 +1,4 @@
+module ActiveClient
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/active_client/version.rb

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

data/lib/active_client.rb

@@ -0,0 +1,9 @@
+require "active_client/version"
+require "active_client/railtie"
+require "active_client/log_subscriber"
+require "active_client/base"
+
+module ActiveClient
+end
+
+ActiveClient::LogSubscriber.attach_to :active_client

data/lib/activeclient_api.rb

@@ -0,0 +1 @@
+require "active_client"

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: activeclient_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Pezza
+bindir: bin
+cert_chain: []
+date: 2025-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+email:
+- pezza@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/active_client.rb
+- lib/active_client/base.rb
+- lib/active_client/log_subscriber.rb
+- lib/active_client/railtie.rb
+- lib/active_client/version.rb
+- lib/activeclient_api.rb
+homepage: https://github.com/npezza93/activeclient
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.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: Basic client for make api classes
+test_files: []