perplexity_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4890f02cef8111904b2e427ef9196eefd7a55e107fa8f56cd0cceba0eec3cbf
+  data.tar.gz: b3074af0a14e6e715015ba0d8b753f5ca23a806a0f3642c0d5ba52a8d2b5bd3d
+SHA512:
+  metadata.gz: 57050c2753a57e1b4de5149b692ed455bf2e0504b15497a9a78b96210365d16759be024f8f7add6926c7b9be8e5756db89135c6c50408c83fa8345cd6629c721
+  data.tar.gz: cb135987f010d46daf1af7fafcb599a475b3af8989b8e5e1f1f7eed4a73d53d254d64579aaa6d882e9f14697c5e83b551f604c077289f99b40ce55555f77a5a6

data/.env.sample

@@ -0,0 +1,10 @@
+# Perplexity API Key (Required)
+PERPLEXITY_API_KEY=your_api_key_here
+
+# Optional Configuration
+# PERPLEXITY_API_BASE=https://api.perplexity.ai
+# PERPLEXITY_DEFAULT_MODEL=sonar
+# PERPLEXITY_TEMPERATURE=0.7
+# PERPLEXITY_MAX_TOKENS=1024
+# PERPLEXITY_TOP_P=0.9
+# PERPLEXITY_TOP_K=0

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+.env.test
+
+# 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?--*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

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 TODO: Write your email address. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in perplexity_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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/PUBLISHING.md

@@ -0,0 +1,101 @@
+# Publishing Guide for Perplexity API Gem
+
+This document explains the steps to publish the Perplexity API Gem to [RubyGems.org](https://rubygems.org).
+
+## Prerequisites
+
+1. Have a RubyGems account
+2. Have the `gem` command installed
+3. Have git installed
+
+## Publishing Steps
+
+### 1. Check the gemspec file
+
+Verify that the `perplexity_api.gemspec` file has the following items correctly set:
+
+- `spec.authors` - Your name
+- `spec.email` - Your email address
+- `spec.summary` - A brief description of the gem
+- `spec.description` - A detailed description of the gem
+- `spec.homepage` - The URL of the gem's homepage (usually a GitHub repository URL)
+- `spec.metadata["source_code_uri"]` - The URI of the source code
+- `spec.metadata["changelog_uri"]` - The URI of the changelog
+
+### 2. Check the version number
+
+Verify that the version number in `lib/perplexity_api/version.rb` is appropriate.
+
+### 3. Run the tests
+
+Make sure all tests pass:
+
+```
+$ bundle exec rake spec
+```
+
+### 4. Build the gem
+
+Build the gem:
+
+```
+$ gem build perplexity_api.gemspec
+```
+
+This will create a `perplexity_api-x.y.z.gem` file (where x.y.z is the version number).
+
+### 5. Test the gem installation (optional)
+
+Install the built gem locally to verify it works correctly:
+
+```
+$ gem install ./perplexity_api-x.y.z.gem
+```
+
+### 6. Publish to RubyGems
+
+Publish the gem to RubyGems:
+
+```
+$ gem push perplexity_api-x.y.z.gem
+```
+
+If this is your first time, you'll be prompted for your RubyGems username and password.
+
+### 7. Verify the publication
+
+Visit [RubyGems.org](https://rubygems.org) to verify that the gem was published successfully:
+
+```
+https://rubygems.org/gems/perplexity_api
+```
+
+## Version Update Steps
+
+1. Make code changes
+2. Add/update tests
+3. Update the version number in `lib/perplexity_api/version.rb`
+4. Update the changelog (if you have a CHANGELOG.md)
+5. Follow steps 3-7 from the "Publishing Steps" section above
+
+## Creating Git Tags (Recommended)
+
+It's recommended to create git tags for each version:
+
+```
+$ git tag -a v0.1.0 -m "Version 0.1.0"
+$ git push origin v0.1.0
+```
+
+## Troubleshooting
+
+### If publication fails
+
+- Check that there are no `TODO` items left in the gemspec file
+- Verify your RubyGems account information
+- Check your network connection
+
+### If installation fails
+
+- Verify that dependencies are correctly set
+- Check that the Ruby version requirement is appropriate

data/README.md

@@ -0,0 +1,116 @@
+# PerplexityApi
+
+A Ruby wrapper gem for Perplexity AI's API. This gem allows you to easily integrate Perplexity AI's powerful language models into your Ruby applications.
+
+## Features
+
+- API key can be configured externally
+- Ability to select the latest models
+- Simple interface to send messages and get results
+- Options can be customized or use defaults
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'perplexity_api'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install perplexity_api
+```
+
+## Usage
+
+### Configuration
+
+There are multiple ways to configure the API key:
+
+#### 1. Using Environment Variables (Recommended)
+
+The gem will automatically look for environment variables. Create a `.env` file in your project root:
+
+```
+PERPLEXITY_API_KEY=your-api-key-here
+```
+
+A sample `.env.sample` file is included in the repository as a template. Copy it to create your own `.env` file:
+
+```bash
+cp .env.sample .env
+```
+
+Then edit the `.env` file with your actual API key. Make sure to add `.env` to your `.gitignore` file to avoid committing sensitive information.
+
+You can also configure other options via environment variables:
+
+```
+PERPLEXITY_DEFAULT_MODEL=sonar
+PERPLEXITY_TEMPERATURE=0.5
+PERPLEXITY_MAX_TOKENS=2048
+PERPLEXITY_TOP_P=0.9
+PERPLEXITY_TOP_K=0
+```
+
+#### 2. Using Ruby Configuration
+
+To configure the API key in your code:
+
+```ruby
+PerplexityApi.configure do |config|
+  config.api_key = "your-api-key"
+  # Optionally change other settings
+  # config.default_model = "sonar"
+  # config.default_options = { temperature: 0.5, max_tokens: 2048 }
+end
+```
+
+### Basic Usage
+
+The simplest way to send a message and get a response:
+
+```ruby
+response = PerplexityApi.chat("Hello, Perplexity AI!")
+puts response["choices"][0]["message"]["content"]
+```
+
+### Using a Client Instance
+
+For more detailed control, you can create a client instance:
+
+```ruby
+client = PerplexityApi.new(
+  api_key: "your-api-key",  # Optional if already configured
+  model: "sonar",  # Override default model
+  options: {
+    temperature: 0.5,
+    max_tokens: 2048,
+    top_p: 0.9,
+    top_k: 0
+  }
+)
+
+response = client.chat("Enter your complex question here...")
+puts response["choices"][0]["message"]["content"]
+```
+
+## Models
+
+For the most up-to-date list of models, refer to the [Perplexity AI official documentation](https://docs.perplexity.ai/guides/model-cards).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

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 "perplexity_api"
+
+# 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/perplexity_api/client.rb

@@ -0,0 +1,46 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module PerplexityApi
+  class Client
+    attr_reader :config
+
+    def initialize(api_key: nil, model: nil, options: {})
+      @config = PerplexityApi.configuration.dup
+      @config.api_key = api_key if api_key != nil
+      @model = model || @config.default_model
+      @options = @config.default_options.merge(options)
+    end
+
+    # Method to send a message and get a response
+    def chat(message)
+      @config.validate!
+      
+      uri = URI.parse("#{@config.api_base}/chat/completions")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.path)
+      request["Content-Type"] = "application/json"
+      request["Authorization"] = "Bearer #{@config.api_key}"
+
+      request.body = {
+        model: @model,
+        messages: [{ role: "user", content: message }],
+        temperature: @options[:temperature],
+        max_tokens: @options[:max_tokens],
+        top_p: @options[:top_p],
+        top_k: @options[:top_k]
+      }.to_json
+
+      response = http.request(request)
+      
+      if response.code.to_i == 200
+        JSON.parse(response.body)
+      else
+        raise Error, "API call failed: #{response.code} #{response.body}"
+      end
+    end
+  end
+end

data/lib/perplexity_api/configuration.rb

@@ -0,0 +1,31 @@
+module PerplexityApi
+  class Configuration
+    attr_accessor :api_key, :api_base, :default_model, :default_options
+
+    def initialize
+      @api_key = ENV["PERPLEXITY_API_KEY"]
+      @api_base = ENV["PERPLEXITY_API_BASE"] || "https://api.perplexity.ai"
+      @default_model = ENV["PERPLEXITY_DEFAULT_MODEL"] || "sonar"
+      @default_options = {
+        temperature: ENV["PERPLEXITY_TEMPERATURE"] ? ENV["PERPLEXITY_TEMPERATURE"].to_f : 0.7,
+        max_tokens: ENV["PERPLEXITY_MAX_TOKENS"] ? ENV["PERPLEXITY_MAX_TOKENS"].to_i : 1024,
+        top_p: ENV["PERPLEXITY_TOP_P"] ? ENV["PERPLEXITY_TOP_P"].to_f : 0.9,
+        top_k: ENV["PERPLEXITY_TOP_K"] ? ENV["PERPLEXITY_TOP_K"].to_i : 0
+      }
+    end
+
+    def validate!
+      raise Error, "API key is not set." unless api_key
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+  end
+end

data/lib/perplexity_api/version.rb

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

data/lib/perplexity_api.rb

@@ -0,0 +1,32 @@
+require "perplexity_api/version"
+require "perplexity_api/configuration"
+require "perplexity_api/client"
+
+# Load dotenv if available
+begin
+  require "dotenv"
+  Dotenv.load
+rescue LoadError
+  # dotenv is not available, continue without it
+end
+
+module PerplexityApi
+  class Error < StandardError; end
+  
+  # Helper method to create a client instance
+  def self.new(api_key: nil, model: nil, options: {})
+    Client.new(api_key: api_key, model: model, options: options)
+  end
+  
+  # Helper method to directly send a message
+  def self.chat(message, api_key: nil, model: nil, options: {})
+    client = Client.new(api_key: api_key, model: model, options: options)
+    client.chat(message)
+  end
+  
+  # Helper method to get available models
+  def self.models(api_key: nil)
+    client = Client.new(api_key: api_key)
+    client.models
+  end
+end

data/perplexity_api.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "perplexity_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "perplexity_api"
+  spec.version       = PerplexityApi::VERSION
+  spec.authors       = ["Hisafumi Kikkawa"]
+  spec.email         = ["hisafumi.kikkawa@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for Perplexity API}
+  spec.description   = %q{A Ruby library for easily using Perplexity AI's API. Allows setting API keys, selecting models, and customizing options.}
+  spec.homepage      = "https://github.com/hisafumi-kikkawa/perplexity_api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/hisafumi-kikkawa/perplexity_api"
+    spec.metadata["changelog_uri"] = "https://github.com/hisafumi-kikkawa/perplexity_api/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  
+  spec.required_ruby_version = ">= 2.6.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: perplexity_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hisafumi Kikkawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: A Ruby library for easily using Perplexity AI's API. Allows setting API
+  keys, selecting models, and customizing options.
+email:
+- hisafumi.kikkawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- PUBLISHING.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/perplexity_api.rb
+- lib/perplexity_api/client.rb
+- lib/perplexity_api/configuration.rb
+- lib/perplexity_api/version.rb
+- perplexity_api.gemspec
+homepage: https://github.com/hisafumi-kikkawa/perplexity_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/hisafumi-kikkawa/perplexity_api
+  source_code_uri: https://github.com/hisafumi-kikkawa/perplexity_api
+  changelog_uri: https://github.com/hisafumi-kikkawa/perplexity_api/blob/master/CHANGELOG.md
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Perplexity API
+test_files: []