superagi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1109bc83d866891b9a49c0f029536824dd65895a64941e24a3b6c00e2e15f1d
+  data.tar.gz: 815b50f3d3c237354c64b46da34f61fafec6252bcdae843d5989ba1198f10040
+SHA512:
+  metadata.gz: e9a06e3bb7db1570373e08767485484b4052df9f0731a8b8f44e6bbf67528a8d217d1c0f96e6be158167f0aad9255a3c004ca3b8db405a4ca725910d4cd28a04
+  data.tar.gz: c84e0b997d14bbe4466a8a71431d0ff400e415f6d110a88143c0f1fe64e611fa80922f95a89c8494c12f43e016435c4d2505eb3f92f3f0d9c8156b995911a02e

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1 # Use 2.1 to enable using orbs and other features.
+
+# Declare the orbs that we'll use in our config.
+orbs:
+  ruby: circleci/ruby@1.0
+
+jobs:
+  rubocop:
+    parallelism: 1
+    docker:
+      - image: cimg/ruby:3.1-node
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      ruby-image:
+        type: string
+    parallelism: 1
+    docker:
+      - image: << parameters.ruby-image >>
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run tests
+          command: bundle exec rspec -fd
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - rubocop
+      - test:
+          matrix:
+            parameters:
+              ruby-image:
+                - cimg/ruby:2.6-node
+                - cimg/ruby:2.7-node
+                - cimg/ruby:3.0-node
+                - cimg/ruby:3.1-node
+                - cimg/ruby:3.2-node

data/.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:3.2.2-slim-bullseye
+
+ENV TZ="Europe/London"
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+  && apt-get -y install --no-install-recommends \
+  apt-utils \
+  build-essential \
+  curl \
+  git \
+  vim \
+  zsh
+
+RUN gem install bundler
+
+WORKDIR /workspace

data/.devcontainer/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/ruby-rails-postgres
+// Update the VARIANT arg in docker-compose.yml to pick a Ruby version
+{
+  "name": "superagi",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspace",
+  "containerEnv": {
+    "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}",
+    "GITHUB_USER": "${localEnv:GITHUB_USER}"
+  },
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "rebornix.Ruby",
+        "sleistner.vscode-fileutils",
+        "ms-azuretools.vscode-docker",
+        "samverschueren.final-newline",
+        "GitHub.copilot",
+        "usernamehw.remove-empty-lines",
+        "wingrunr21.vscode-ruby",
+      ]
+    }
+  },
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "bundle install",
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "features": {
+    "git": "os-provided",
+    "github-cli": "latest"
+  }
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,19 @@
+version: "3"
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ..:/workspace:cached
+      - bundle_cache:/bundle
+
+    command: sleep infinity
+
+    environment:
+      TZ: Europe/London
+
+volumes:
+  bundle_cache:

data/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: alexrudall
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: webmock
+    versions:
+    - 3.11.1
+    - 3.11.3
+  - dependency-name: rspec
+    versions:
+    - 3.10.0

data/.gitignore

@@ -0,0 +1,74 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status
+
+# IDE
+.idea
+.idea/
+.idea/*
+.vscode
+.vs/
+
+# Mac
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Lint/AmbiguousOperator:
+  # https://github.com/rubocop/rubocop/issues/4294
+  Exclude:
+    - "lib/superagi/client.rb"
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-10-25
+
+### Added
+
+- Initialise repository.
+- Add SuperAGI::Client to connect to SuperAGI API using user credentials.
+- Add SuperAGI::Agent#create to create a new agent.
+- Add spec for Client with a cached response using VCR.
+- Add CircleCI to run the specs on pull requests.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexrudall@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/superagi. 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/alexrudall/superagi/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Include gem dependencies from superagi.gemspec
+gemspec
+
+gem "byebug", "~> 11.1.3"
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.50.2"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.19.1"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    superagi (0.1.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    faraday (2.7.11)
+      base64
+      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)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.50.2)
+  superagi!
+  vcr (~> 6.1.0)
+  webmock (~> 3.19.1)
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Alex Rudall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# SuperAGI
+
+[![Gem Version](https://badge.fury.io/rb/superagi.svg)](https://badge.fury.io/rb/superagi)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/superagi/blob/main/LICENSE.txt)
+[![CircleCI Build Status](https://circleci.com/gh/alexrudall/superagi.svg?style=shield)](https://circleci.com/gh/alexrudall/superagi)
+
+Use the [SuperAGI API](https://superagi.com/blog/superagi-api/) with Ruby! 🦄❤️
+
+Create and Manage Agents in your Ruby app...
+
+🚢 Hire me: [peaceterms.com](https://railsai.com?utm_source=superagi&utm_medium=readme&utm_id=26072023)
+
+[🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🤖 OpenAI Gem](https://github.com/alexrudall/ruby-openai) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "superagi"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+### Gem install
+
+Or install with:
+
+```bash
+$ gem install superagi
+```
+
+and require with:
+
+```ruby
+require "superagi"
+```
+
+## Usage
+
+- Get your API key from [https://app.superagi.com/](https://app.superagi.com/)
+- Click Go to settings, API Keys, Create Key
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = SuperAGI::Client.new(secret_key: "secret_key_goes_here")
+```
+
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `superagi.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+
+```ruby
+SuperAGI.configure do |config|
+    config.secret_key = ENV.fetch("SUPERAGI_SECRET_KEY")
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = SuperAGI::Client.new
+```
+
+You can still override the config defaults when making new clients; any options not included will fall back to any global config set with SuperAGI.configure. e.g. in this example the request_timeout, etc. will fallback to any set globally using SuperAGI.configure, with only the secret_key overridden:
+
+```ruby
+client = SuperAGI::Client.new(secret_key: "secret_key_goes_here")
+```
+
+#### Custom timeout or base URI
+
+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. You can also change the base URI used for all requests.
+
+```ruby
+client = SuperAGI::Client.new(
+    secret_key: "secret_key_goes_here",
+    uri_base: "https://app.alternativeapi.com/",
+    request_timeout: 240,
+    extra_headers: {
+      "X-Proxy-TTL" => "43200", # For https://github.com/6/superagi-caching-proxy-worker#specifying-a-cache-ttl
+      "X-Proxy-Refresh": "true", # For https://github.com/6/superagi-caching-proxy-worker#refreshing-the-cache
+      "Helicone-Auth": "Bearer HELICONE_API_KEY", # For https://docs.helicone.ai/getting-started/integration-method/superagi-proxy
+      "helicone-stream-force-format" => "true", # Use this with Helicone otherwise streaming drops chunks # https://github.com/alexrudall/superagi/issues/251
+    }
+)
+```
+
+or when configuring the gem:
+
+```ruby
+SuperAGI.configure do |config|
+    config.secret_key = ENV.fetch("SUPERAGI_SECRET_KEY")
+    config.uri_base = "https://app.alternativeapi.com/" # Optional
+    config.request_timeout = 240 # Optional
+    config.extra_headers = {
+      "abc" => "123",
+      "def": "456",
+    } # Optional
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can 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`.
+
+### Warning
+
+If you have an `SUPERAGI_SECRET_KEY` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+
+## Release
+
+First run the specs without VCR so they actually hit the API. This will cost 2 cents or more. Set SUPERAGI_SECRET_KEY in your environment or pass it in like this:
+
+```
+SUPERAGI_SECRET_KEY=123abc bundle exec rspec
+```
+
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, 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/alexrudall/superagi>. 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/alexrudall/superagi/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby SuperAGI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/superagi/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "superagi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby/superagi.rb

@@ -0,0 +1,2 @@
+require_relative "../superagi"
+require_relative "../superagi/compatibility"

data/lib/superagi/agent.rb

@@ -0,0 +1,74 @@
+module SuperAGI
+  class Agent
+    # '{"loc":["body","constraints"],"msg":"field
+    #     required","type":"value_error.missing"},{"loc":["body","tools"],"msg":"field
+    #     required","type":"value_error.missing"},{"loc":["body","iteration_interval"],"msg":"field
+    #     required","type":"value_error.missing"},{"loc":["body","max_iterations"],"msg":"field
+    #     required","type":"value_error.missing"}]}'
+
+    def initialize(client:)
+      @client = client
+    end
+
+    def create(parameters:)
+      parameters = valid_parameters(parameters: parameters)
+      @client.json_post(path: "/agent", parameters: parameters)
+    end
+
+    # def update(id:, parameters: {})
+    # end
+
+    # def pause(id:)
+    # end
+
+    # def resume(id:)
+    # end
+
+    # def delete(id:)
+    # end
+
+    # def status(id:)
+    # end
+
+    # def resources(id:)
+    # end
+
+    private
+
+    DEFAULT_PARAMETERS = {
+      agent_workflow: "Goal Based Workflow",
+      model: "gpt-4"
+    }.freeze
+    ARRAY_PARAMETERS = %w[
+      constraints
+      goal
+      tools
+    ].freeze
+    REQUIRED_PARAMETERS = (%w[
+      description
+      instruction
+      iteration_interval
+      max_iterations
+      name
+    ] + ARRAY_PARAMETERS + DEFAULT_PARAMETERS.keys).freeze
+
+    def valid_parameters(parameters:)
+      parameters = DEFAULT_PARAMETERS.merge(parameters)
+      validate_presence(parameters: parameters)
+      validate_arrays(parameters: parameters)
+      parameters
+    end
+
+    def validate_presence(parameters:)
+      REQUIRED_PARAMETERS.each do |key|
+        raise ArgumentError, "#{key} is required" unless parameters[key.to_sym]
+      end
+    end
+
+    def validate_arrays(parameters:)
+      ARRAY_PARAMETERS.each do |key|
+        raise ArgumentError, "#{key} must be an array" unless parameters[key.to_sym].is_a?(Array)
+      end
+    end
+  end
+end

data/lib/superagi/client.rb

@@ -0,0 +1,27 @@
+module SuperAGI
+  class Client
+    include SuperAGI::HTTP
+
+    CONFIG_KEYS = %i[
+      api_type
+      api_version
+      secret_key
+      uri_base
+      request_timeout
+      extra_headers
+    ].freeze
+    attr_reader *CONFIG_KEYS
+
+    def initialize(config = {})
+      CONFIG_KEYS.each do |key|
+        # Set instance variables like api_type & secret_key. Fall back to global config
+        # if not present.
+        instance_variable_set("@#{key}", config[key] || SuperAGI.configuration.send(key))
+      end
+    end
+
+    def agent
+      @agent ||= SuperAGI::Agent.new(client: self)
+    end
+  end
+end

data/lib/superagi/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module SuperAGI
+    VERSION = ::SuperAGI::VERSION
+
+    Error = ::SuperAGI::Error
+    ConfigurationError = ::SuperAGI::ConfigurationError
+    Configuration = ::SuperAGI::Configuration
+  end
+end

data/lib/superagi/http.rb

@@ -0,0 +1,55 @@
+module SuperAGI
+  module HTTP
+    def get(path:)
+      to_json(conn.get(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    def json_post(path:, parameters:)
+      to_json(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    def delete(path:)
+      to_json(conn.delete(uri(path: path)) do |req|
+        req.headers = headers
+      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
+
+    def conn(multipart: false)
+      Faraday.new do |f|
+        f.options[:timeout] = @request_timeout
+        f.request(:multipart) if multipart
+      end
+    end
+
+    def uri(path:)
+      File.join(@uri_base, @api_version, path)
+    end
+
+    def headers
+      superagi_headers.merge(@extra_headers || {})
+    end
+
+    def superagi_headers
+      {
+        "Content-Type" => "application/json",
+        "X-api-key" => @secret_key
+      }
+    end
+  end
+end

data/lib/superagi/version.rb

@@ -0,0 +1,3 @@
+module SuperAGI
+  VERSION = "0.1.0".freeze
+end

data/lib/superagi.rb

@@ -0,0 +1,49 @@
+require "faraday"
+require "faraday/multipart"
+
+require_relative "superagi/http"
+require_relative "superagi/client"
+require_relative "superagi/agent"
+
+module SuperAGI
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :secret_key
+    attr_accessor :api_type, :api_version, :uri_base, :request_timeout,
+                  :extra_headers
+
+    DEFAULT_API_VERSION = "v1".freeze
+    DEFAULT_URI_BASE = "https://app.superagi.com/api/".freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @secret_key = nil
+      @api_type = nil
+      @api_version = DEFAULT_API_VERSION
+      @uri_base = DEFAULT_URI_BASE
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+      @extra_headers = nil
+    end
+
+    def secret_key
+      return @secret_key if @secret_key
+
+      error_text = "SuperAGI secret key missing! See https://github.com/alexrudall/superagi#usage"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= SuperAGI::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/pull_request_template.md

@@ -0,0 +1,5 @@
+## All Submissions:
+
+* [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

data/superagi.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/superagi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "superagi"
+  spec.version       = SuperAGI::VERSION
+  spec.authors       = ["Alex"]
+  spec.email         = ["alexrudall@users.noreply.github.com"]
+
+  spec.summary       = "SuperAGI API + Ruby! 🦄❤️"
+  spec.homepage      = "https://github.com/alexrudall/superagi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/alexrudall/superagi"
+  spec.metadata["changelog_uri"] = "https://github.com/alexrudall/superagi/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 1"
+  spec.add_dependency "faraday-multipart", ">= 1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: superagi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: 
+email:
+- alexrudall@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby/superagi.rb
+- lib/superagi.rb
+- lib/superagi/agent.rb
+- lib/superagi/client.rb
+- lib/superagi/compatibility.rb
+- lib/superagi/http.rb
+- lib/superagi/version.rb
+- pull_request_template.md
+- superagi.gemspec
+homepage: https://github.com/alexrudall/superagi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alexrudall/superagi
+  source_code_uri: https://github.com/alexrudall/superagi
+  changelog_uri: https://github.com/alexrudall/superagi/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: "SuperAGI API + Ruby! \U0001F984❤️"
+test_files: []