Reading Time Calculator API - Ruby Gem

Reading Time Calculator estimates how long it will take to read a given text. It calculates reading time based on word count and customizable reading speed (WPM).

Installation

Add this line to your application's Gemfile:

gem 'apiverve_readingtime'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install apiverve_readingtime

Getting Started

Get your API key at APIVerve

Basic Usage

require 'apiverve_readingtime'

# Initialize the client
client = APIVerve::Readingtime::Client.new(api_key: "YOUR_API_KEY")

# Make a request
response = client.execute({
  text: "This is a sample article with multiple paragraphs. Reading time will be calculated based on word count. The average reading speed is 250 words per minute, which can be customized. This helps content creators provide accurate time estimates to their readers.",
  wpm: 250
})

# Print the response
puts response

Error Handling

begin
  response = client.execute({ text: "This is a sample article with multiple paragraphs. Reading time will be calculated based on word count. The average reading speed is 250 words per minute, which can be customized. This helps content creators provide accurate time estimates to their readers.", wpm: 250 })
  puts response["data"]
rescue APIVerve::Readingtime::ValidationError => e
  puts "Validation error: #{e.errors.join(', ')}"
rescue APIVerve::Readingtime::APIError => e
  puts "API error: #{e.message}"
  puts "Status code: #{e.status_code}"
end

Debug Mode

# Enable debug logging
client = APIVerve::Readingtime::Client.new(
  api_key: "YOUR_API_KEY",
  debug: true
)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "text_length": 257,
    "word_count": 41,
    "reading_time_minutes": 1,
    "reading_time_seconds": 10,
    "reading_time_text": "1 min read",
    "words_per_minute": 250
  }
}

Documentation

For more information, visit the API Documentation.

Support

License

This gem is available under the MIT License.