autoflux-openai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 805cad0d30d93ebd6ab10fcf7b093cee81b7c3ef24dae357041cc91537c93f60
+  data.tar.gz: 317759138e823d94021e4b3d972a6f3a8e9a80932910e6637263437d8d04aad6
+SHA512:
+  metadata.gz: 89362f8361df4892e6d530bc9d441380424fde7b42032b7e82a7151ae1b067deac046083fd7163d9b5a8c5e5ea6b047720975528cf098eb5a1d0b7b23d9977b4
+  data.tar.gz: d00d8dbfabca33ddb7cf1c7d8b461d50cbcfa8afdf0a73b76e88d345def96cbd7bcc3907862021a00b840f1dc8f148812f040730565535bfe3cc1c851dfe40c9

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --verbose --edit $1

data/.husky/pre-commit

@@ -0,0 +1 @@
+bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Qiu ZhengXian
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,125 @@
+Autoflux::OpenAI
+===
+
+This gem implements [autoflux](https://github.com/elct9620/autoflux) agent to use OpenAI as the backend.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add autoflux-openai
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install autoflux-openai
+```
+
+## Usage
+
+The use the agent, set the `OPENAI_API_KEY` environment variable that the agent can use to authenticate with OpenAI.
+
+```ruby
+agent = Autoflux::OpenAI::Agent.new(model: "gpt-4o-mini")
+res = agent.call("Hello, world!")
+# => "Hello, world!" from OpenAI
+```
+
+> The agent will return `content` from the as the interface of the `autoflux` agent.
+
+### Tool
+
+You can attach tool to the agent to give it more capabilities.
+
+```ruby
+uppercase = Autoflux::OpenAI::Tool.new(
+    name: "uppercase",
+    description: "Convert the content to uppercase",
+    parameters: {
+        type: "object",
+        properties: {
+            text: {
+                type: "string"
+            }
+        }
+    }
+) do |params|
+    { text: params[:text].upcase }
+end
+
+agent = Autoflux::OpenAI::Agent.new(
+    model: "gpt-4o-mini",
+    tools: [uppercase],
+    memory: [
+        { role: "system", content: "Always transform the user input and don't do anything else." }
+    ]
+)
+res = agent.call("Hello, world!")
+# => "HELLO, WORLD!" from OpenAI
+```
+
+### Client
+
+This gem embeds a lightweight client to interact with OpenAI API. The client can be used to interact with OpenAI API directly.
+
+```ruby
+client = Autoflux::OpenAI::Client.new(api_key: "your-api-key")
+res = client.call(
+    model: "gpt-4o-mini",
+    messages: [{ role: "user", content: "Hello, world!" }]
+)
+# => { choices: [{ message: { role: "assistant", content: "Hello World!" }}] }
+```
+
+If your api key or endpoint is not default, you can specify them in the client.
+
+```ruby
+client = Autoflux::OpenAI::Client.new(
+    api_key: "your-api-key",
+    endpoint: URI("https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/openai")
+)
+client.call(
+    model: "gpt-4o-mini",
+    messages: [{ role: "user", content: "Hello, world!" }]
+)
+```
+
+### Memory
+
+The agent default use a Ruby array to store the conversation history. If you want to use a different memory store, you can implement the `Autoflux::OpenAI::_Memory` interface and pass it to the agent.
+
+```ruby
+class MyMemory
+    def initialize
+        @store = []
+    end
+
+    def push(message)
+        @store.push(message)
+    end
+
+    def <<(message)
+        push(message)
+    end
+
+    def to_a
+        @store.last(100)
+    end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/autoflux-openai.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "steep/rake_task"
+Steep::RakeTask.new do |t|
+  t.check.severity_level = :error
+  t.watch.verbose
+end
+
+task default: %i[spec rubocop steep]

data/Steepfile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# D = Steep::Diagnostic
+#
+target :lib do
+  check "lib" # Directory name
+  signature "sig"
+  ignore_signature "sig/test"
+
+  library "net-http"
+  library "json"
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   unreferenced!                     # Skip type checking the `lib` code when types in `test` target is changed
+#   signature "sig/test"              # Put RBS files for tests under `sig/test`
+#   check "test"                      # Type check Ruby scripts under `test`
+#
+#   configure_code_diagnostics(D::Ruby.lenient)      # Weak type checking for test code
+#
+#   # library "pathname"              # Standard libraries
+# end

data/commitlint.config.js

@@ -0,0 +1 @@
+export default { extends: ['@commitlint/config-conventional'] };

data/lib/autoflux/openai/agent.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module OpenAI
+    # The agent is design to use OpenAI as an agent
+    class Agent
+      attr_reader :model, :memory
+
+      def initialize(model:, client: Client.new, tools: [], memory: [])
+        @client = client
+        @model = model
+        @memory = memory
+        @_tools = tools
+      end
+
+      def call(prompt, **context)
+        @memory << { role: :user, content: prompt }
+
+        loop do
+          res = complete
+          @memory << res
+          break res[:content] || "" unless res[:tool_calls]&.any?
+
+          res[:tool_calls].each do |call|
+            @memory << { role: :tool, content: use(call, **context).to_json, tool_call_id: call[:id] }
+          end
+        end
+      end
+
+      def tools # rubocop:disable Metrics/MethodLength
+        return unless @_tools.any?
+
+        @tools ||= @_tools.map do |tool|
+          {
+            type: :function,
+            function: {
+              name: tool.name,
+              description: tool.description,
+              parameters: tool.parameters
+            }
+          }
+        end
+      end
+
+      def tool(name)
+        @_tools.find { |tool| tool.name == name }
+      end
+
+      def use(call, **context)
+        name = call.dig(:function, :name)
+        params = JSON.parse(call.dig(:function, :arguments), symbolize_names: true)
+
+        tool(name)&.call(params, **context) || { error: "tool not found: #{name}" }
+      rescue JSON::ParserError
+        { error: "unable parse argument as JSON" }
+      end
+
+      private
+
+      def complete
+        @client.call(
+          model: @model,
+          messages: @memory.to_a,
+          tools: tools
+        ).dig(:choices, 0, :message)
+      end
+    end
+  end
+end

data/lib/autoflux/openai/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module Autoflux
+  module OpenAI
+    # The minimal completion api client to interact with OpenAI
+    class Client
+      DEFAULT_ENDPOINT = URI("https://api.openai.com/v1/chat/completions")
+
+      def initialize(api_key: nil, endpoint: DEFAULT_ENDPOINT)
+        @api_key = ENV.fetch("OPENAI_API_KEY", api_key)
+        @endpoint = endpoint
+      end
+
+      def call(payload)
+        res = http.post(@endpoint.path || "", payload.to_json, headers)
+        raise Error, res.body unless res.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(res.body, symbolize_names: true)
+      rescue JSON::ParserError
+        {}
+      end
+
+      protected
+
+      def headers
+        @headers ||= {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@api_key}"
+        }
+      end
+
+      def http
+        @http ||= Net::HTTP.new(@endpoint.host || "", @endpoint.port).tap do |http|
+          http.use_ssl = @endpoint.scheme == "https"
+        end
+      end
+    end
+  end
+end

data/lib/autoflux/openai/tool.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module OpenAI
+    # The tool is simple tool wrapper for the agent
+    class Tool
+      attr_reader :name, :description, :parameters
+
+      def initialize(name:, description:, parameters: [], &executor)
+        @name = name
+        @description = description
+        @parameters = parameters
+        @executor = executor
+      end
+
+      def call(params, **context)
+        raise Error, "Executor is not defined" unless @executor
+
+        @executor.call(params, **context)
+      end
+    end
+  end
+end

data/lib/autoflux/openai/version.rb

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

data/lib/autoflux/openai.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "openai/version"
+
+module Autoflux
+  # The lightweight OpenAI agent for Autoflux
+  module OpenAI
+    class Error < StandardError; end
+
+    require_relative "openai/client"
+    require_relative "openai/agent"
+    require_relative "openai/tool"
+  end
+end