From 0381a89ec0e8dd3d4fe5b3b39dc095d9aacbe8d8 Mon Sep 17 00:00:00 2001 From: David Rice Date: Mon, 8 Apr 2024 14:16:51 +0100 Subject: [PATCH] Initial release --- .github/workflows/main.yml | 27 +++++++++++ .github/workflows/release.yml | 35 +++++++++++++++ .gitignore | 13 ++++++ .rspec | 3 ++ .rubocop.yml | 19 ++++++++ CHANGELOG.md | 5 +++ CODE_OF_CONDUCT.md | 84 ++++++++++++++++++++++++++++++++++ Gemfile | 12 +++++ Gemfile.lock | 78 ++++++++++++++++++++++++++++++++ README.md | 85 +++++++++++++++++++++++++++++++++++ Rakefile | 12 +++++ bin/console | 11 +++++ bin/setup | 8 ++++ lib/perplexity.rb | 50 +++++++++++++++++++++ lib/perplexity/version.rb | 5 +++ perplexity.gemspec | 37 +++++++++++++++ sig/perplexity.rbs | 17 +++++++ spec/perplexity_spec.rb | 7 +++ spec/spec_helper.rb | 15 +++++++ 19 files changed, 523 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .rubocop.yml create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/perplexity.rb create mode 100644 lib/perplexity/version.rb create mode 100644 perplexity.gemspec create mode 100644 sig/perplexity.rbs create mode 100644 spec/perplexity_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..37a9318 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,27 @@ +name: Ruby + +on: + push: + branches: + - main + + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + name: Ruby ${{ matrix.ruby }} + strategy: + matrix: + ruby: + - '3.3.0' + + steps: + - uses: actions/checkout@v4 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby }} + bundler-cache: true + - name: Run the default task + run: bundle exec rake diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..1cf6ed4 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,35 @@ +name: Release + +on: + workflow_run: + workflows: ["main"] + types: + - completed + branches: ["main"] + +jobs: + release: + name: Push gem to RubyGems.org + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'success' }} + + permissions: + id-token: write + contents: write + + steps: + - uses: actions/checkout@v4 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + ruby-version: 3.3.0 + + - name: Build gem + run: | + gem install bundler + bundle install --jobs 4 --retry 3 + gem build *.gemspec + + - uses: rubygems/release-gem@v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..328aea8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status + +.env \ No newline at end of file diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..268eeab --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,19 @@ +AllCops: + TargetRubyVersion: 2.6 + SuggestExtensions: false + NewCops: enable + +Style/StringLiterals: + Enabled: true + EnforcedStyle: double_quotes + +Style/StringLiteralsInInterpolation: + Enabled: true + EnforcedStyle: double_quotes + +Layout/LineLength: + Max: 120 + +# TODO: Enable this cop after figuring out why it is failing even though we have mfa required set to true +Gemspec/RequireMFA: + Enabled: false \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b50390c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## [Unreleased] + +## [0.1.0] - 2024-04-08 + +- Initial release diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2759198 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,84 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders 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, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@davidjrice.co.uk. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, +available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..fef82c0 --- /dev/null +++ b/Gemfile @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +# Specify your gem's dependencies in perplexity.gemspec +gemspec + +gem "rake", "~> 13.0" + +gem "rspec", "~> 3.0" + +gem "rubocop", "~> 1.21" diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..a63e0c5 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,78 @@ +PATH + remote: . + specs: + perplexity (0.1.0) + ruby-openai (~> 6.5.0) + +GEM + remote: https://rubygems.org/ + specs: + ast (2.4.2) + diff-lcs (1.5.1) + event_stream_parser (1.0.0) + faraday (2.9.0) + faraday-net_http (>= 2.0, < 3.2) + faraday-multipart (1.0.4) + multipart-post (~> 2) + faraday-net_http (3.1.0) + net-http + json (2.7.2) + language_server-protocol (3.17.0.3) + multipart-post (2.4.0) + net-http (0.4.1) + uri + parallel (1.24.0) + parser (3.3.0.5) + ast (~> 2.4.1) + racc + racc (1.7.3) + rainbow (3.1.1) + rake (13.2.1) + regexp_parser (2.9.0) + rexml (3.2.6) + rspec (3.13.0) + rspec-core (~> 3.13.0) + rspec-expectations (~> 3.13.0) + rspec-mocks (~> 3.13.0) + rspec-core (3.13.0) + rspec-support (~> 3.13.0) + rspec-expectations (3.13.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-mocks (3.13.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-support (3.13.1) + rubocop (1.62.1) + json (~> 2.3) + language_server-protocol (>= 3.17.0) + parallel (~> 1.10) + parser (>= 3.3.0.2) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.31.1, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.31.2) + parser (>= 3.3.0.4) + ruby-openai (6.5.0) + event_stream_parser (>= 0.3.0, < 2.0.0) + faraday (>= 1) + faraday-multipart (>= 1) + ruby-progressbar (1.13.0) + unicode-display_width (2.5.0) + uri (0.13.0) + +PLATFORMS + arm64-darwin-23 + ruby + +DEPENDENCIES + perplexity! + rake (~> 13.0) + rspec (~> 3.0) + rubocop (~> 1.21) + +BUNDLED WITH + 2.5.3 diff --git a/README.md b/README.md new file mode 100644 index 0000000..7696e0b --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# perplexity + +An unofficial client for the [Perplexity AI](https://www.perplexity.ai) API. + +## Installation + +Install the gem and add to the application's Gemfile by executing: + + $ bundle add perplexity + +If bundler is not being used to manage dependencies, install the gem by executing: + + $ gem install perplexity + +## Usage + +1. add your `PERPLEXITY_API_KEY` to your environment variables (typically in a `.env` file) + +``` +PERPLEXITY_API_KEY=pplx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +2. source the `.env` file + +```zsh +export $(cat .env) +``` + +3. Interact with `perplexity` + +```ruby +messages = [ + { + role: 'system', + content: 'Be precise and concise' + }, + { + role: 'user', + content: 'good strategy games for macOS' + } +] + +parameters = { + model: 'sonar-small-online', + messages: messages +} + +perplexity = Perplexity::API.new(api_key: ENV.fetch('PERPLEXITY_API_KEY')) +response = perplexity.client.chat(parameters: parameters) +``` + +```ruby +require 'pp' +pp response +=> +{"id"=>"8db8e4d7-73ef-4313-9f74-3b08cec81139", + "model"=>"sonar-small-online", + "created"=>7232621, + "usage"=>{"prompt_tokens"=>42, "completion_tokens"=>115, "total_tokens"=>157}, + "object"=>"chat.completion", + "choices"=> + [{"index"=>0, + "finish_reason"=>"stop", + "message"=> + {"role"=>"assistant", + "content"=> + "Some good strategy games for macOS include \"Civilization VI,\" \"Crusader Kings III,\" \"StarCraft II,\" and \"Stellaris\". Additionally, \"Planetary Annihilation\" and \"HomeWorld Deserts of Kharak\" are mentioned as fun strategy games for macOS. Other notable strategy games for Mac include \"Company of Heroes,\" \"Warhammer,\" \"Total War series,\" \"Cities: Skylines,\" and \"FTL: Faster Than Light\"."}, + "delta"=>{"role"=>"assistant", "content"=>""}}]}``` +``` + +## 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 with the code. + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/davidjrice/perplexity. 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/davidjrice/perplexity/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 Perplexity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davidjrice/perplexity/blob/main/CODE_OF_CONDUCT.md). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..cca7175 --- /dev/null +++ b/Rakefile @@ -0,0 +1,12 @@ +# 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 + +task default: %i[spec rubocop] diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..070db07 --- /dev/null +++ b/bin/console @@ -0,0 +1,11 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "perplexity" + +# 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. + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/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 diff --git a/lib/perplexity.rb b/lib/perplexity.rb new file mode 100644 index 0000000..1019412 --- /dev/null +++ b/lib/perplexity.rb @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +require "openai" +require_relative "perplexity/version" + +module Perplexity + class Error < StandardError; end + class ConfigurationError < Error; end + + # Public: Perplexity AI API client + class API + attr_writer :api_key + + DEFAULT_URI_BASE = "https://api.perplexity.ai" + DEFAULT_REQUEST_TIMEOUT = 120 + MODELS = %w[ + sonar-small-chat + sonar-small-online + sonar-medium-chat + sonar-medium-online + codellama-70b-instruct + mistral-7b-instruct + mixtral-8x7b-instruct + ].freeze + + def initialize(api_key: nil) + @api_key = api_key + configure! + end + + def configure! + raise ConfigurationError, "API key is required" unless @api_key + + OpenAI.configure do |config| + config.access_token = @api_key + config.uri_base = DEFAULT_URI_BASE + config.api_version = "" # NOTE: Perplexity API URLs are not versioned + config.extra_headers = { "Content-Type" => "application/json" } + end + end + + def client + @client ||= OpenAI::Client.new + end + + def models + MODELS + end + end +end diff --git a/lib/perplexity/version.rb b/lib/perplexity/version.rb new file mode 100644 index 0000000..33ec4bd --- /dev/null +++ b/lib/perplexity/version.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +module Perplexity + VERSION = "0.1.0" +end diff --git a/perplexity.gemspec b/perplexity.gemspec new file mode 100644 index 0000000..dcf45d1 --- /dev/null +++ b/perplexity.gemspec @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require_relative "lib/perplexity/version" + +Gem::Specification.new do |spec| + spec.name = "perplexity" + spec.version = Perplexity::VERSION + spec.authors = ["David Rice"] + spec.email = ["me@davidjrice.co.uk"] + + spec.summary = "Client for the Perplexity AI API" + spec.description = "OpenAI based API client for the Perplexity AI API" + spec.homepage = "https://github.com/davidjrice/perplexity" + spec.license = "MIT" + spec.required_ruby_version = ">= 2.6.0" + + spec.metadata["rubygems_mfa_required"] = true + spec.metadata["allowed_push_host"] = "https://rubygems.org'" + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = spec.homepage + # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." + + # 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(__dir__) do + `git ls-files -z`.split("\x0").reject do |f| + (File.expand_path(f) == __FILE__) || + f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile]) + end + end + # TODO: make gem executable as a command line tool + # spec.bindir = "exe" + # spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_dependency "ruby-openai", "~> 6.5.0" +end diff --git a/sig/perplexity.rbs b/sig/perplexity.rbs new file mode 100644 index 0000000..65128f3 --- /dev/null +++ b/sig/perplexity.rbs @@ -0,0 +1,17 @@ +module Perplexity + class Error < StandardError; end + class ConfigurationError < Error; end + + class API + attr_writer api_key: String + + DEFAULT_URI_BASE: String + DEFAULT_REQUEST_TIMEOUT: Integer + MODELS: Array[String] + + def initialize: (?api_key: String) -> void + def configure!: -> void + def client: -> OpenAI::Client + def models: -> Array[String] + end +end \ No newline at end of file diff --git a/spec/perplexity_spec.rb b/spec/perplexity_spec.rb new file mode 100644 index 0000000..ac2fcdc --- /dev/null +++ b/spec/perplexity_spec.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +RSpec.describe Perplexity do + it "has a version number" do + expect(Perplexity::VERSION).not_to be nil + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..ad60bff --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +require "perplexity" + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = ".rspec_status" + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end