ruby-you

Tests	Coverage

A Ruby client for interacting with the You.com API, including the Smart, Research, Search, and News endpoints. This gem provides a simple and consistent interface, along with configurable retry logic, rate-limit handling, debugging options, and comprehensive error handling.

• Smart API: Send queries to https://chat-api.you.com/smart.
• Research API: Send queries to https://chat-api.you.com/research.
• Search API: Query https://api.ydc-index.io/search for web search results.
• News API: Query https://api.ydc-index.io/news for news results.

• Ruby 2.6 or higher.

Add this line to your application's Gemfile:

gem 'ruby-you'

Then execute

bundle install

Or install it yourself as:

gem build ruby-you.gemspec
gem install ruby-you-0.1.1.gem

The client requires an API key. You can provide this as an environment variable YOU_API_KEY or pass it directly when initializing the client.

You can also configure logging and debugging:

require 'you'

You.configure do |config|
  config.debug = true                  # enable debug mode for verbose logging
  config.logger = Logger.new($stdout)  # customize the logger, defaults to $stdout with WARN level
end

require 'you'

client = You::Client.new(api_key: "YOUR_API_KEY")
# or you can simply set the YOU_API_KEY on your envs and do:
default_client = You.client

# Smart API
response = client.smart(query: "What is the capital of France?", instructions: "Respond in bullet points.")
puts response["answer"]

# Research API
research_result = client.research(query: "Explain quantum computing in simple terms")
puts research_result["answer"]

# Search API
search_result = client.search(query: "Ruby programming", num_web_results: 5, safesearch: "moderate")
puts search_result["hits"]

# News API
news_result = client.news(query: "latest tech news", count: 5, recency: "day")
puts news_result["news"]["results"]

• query (String, required)
• chat_id (String, optional)
• instructions (String, optional)

• query (String, required)
• chat_id (String, optional)

• query (String, required)
• num_web_results (Integer, optional)
• offset (Integer, optional)
• country (String, optional)
• safesearch (String, optional, defaults to moderate)

• query (String, required)
• count (Integer, optional)
• offset (Integer, optional)
• country (String, optional)
• search_lang (String, optional)
• ui_lang (String, optional)
• safesearch (String, optional)
• spellcheck (Boolean, optional)
• recency (String, optional: day, week, month, year)

• query (String, required)

The client raises custom exceptions for non-200 responses:

• You::BadRequestError (400)
• You::UnauthorizedError (401)
• You::ForbiddenError (403)
• You::NotFoundError (404)
• You::UnprocessableEntityError (422)
• You::RateLimitError (429)
• You::InternalServerError (500)
• You::BadGatewayError (502)
• You::ServiceUnavailableError (503)
• You::GatewayTimeoutError (504)
• You::Error for all other errors.

Rate-limit errors (429) are retried up to max_retries times with an exponential backoff or a Retry-After delay if provided by the server.

Set You.configuration.debug = true to enable detailed logs of requests and responses. These logs include:

• Outgoing request method, URL, and parameters.
• Response status code, headers, and body.

You can customize the logger with You.configuration.logger.

This gem uses RSpec and WebMock for testing.

Install the dependencies:

bundle install

Run the tests:

rspec

The test suite covers:

• Successful requests
• Various error responses and the corresponding exceptions
• Rate-limit handling and retry logic
• Debug/logging functionality

• Fork the project
• Create a new feature branch (git checkout -b feature/my-feature)
• Commit your changes (git commit -m 'Add new feature')
• Push to the branch (git push origin feature/my-feature)
• Create a new Pull Request
• Release the gem: bundle exec rake release

This project is licensed under the MIT License - see the LICENSE.txt file for details.