Tip Calculator API - Ruby Gem

Tip Calculator is a tool for calculating tips and splitting bills among multiple people. It provides common tip percentage comparisons and per-person breakdowns.

Installation

Add this line to your application's Gemfile:

gem 'apiverve_tipcalculator'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install apiverve_tipcalculator

Getting Started

Get your API key at APIVerve

Basic Usage

require 'apiverve_tipcalculator'

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

# Make a request
response = client.execute({
  amount: 100,
  percentage: 15,
  people: 1,
  currency: "USD"
})

# Print the response
puts response

Error Handling

begin
  response = client.execute({ amount: 100, percentage: 15, people: 1, currency: "USD" })
  puts response["data"]
rescue APIVerve::Tipcalculator::ValidationError => e
  puts "Validation error: #{e.errors.join(', ')}"
rescue APIVerve::Tipcalculator::APIError => e
  puts "API error: #{e.message}"
  puts "Status code: #{e.status_code}"
end

Debug Mode

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

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "bill_amount": 100,
    "tip_percentage": 18,
    "tip_amount": 18,
    "total_amount": 118,
    "currency": "USD",
    "split_between": 4,
    "per_person": {
      "bill_amount": 25,
      "tip_amount": 4.5,
      "total_amount": 29.5
    },
    "common_tip_amounts": [
      {
        "percentage": 10,
        "tip_amount": 10,
        "total": 110,
        "per_person": 27.5
      },
      {
        "percentage": 15,
        "tip_amount": 15,
        "total": 115,
        "per_person": 28.75
      },
      {
        "percentage": 20,
        "tip_amount": 20,
        "total": 120,
        "per_person": 30
      }
    ],
    "formatted": {
      "bill_amount": "$100.00",
      "tip_amount": "$18.00",
      "total_amount": "$118.00",
      "per_person_total": "$29.50"
    }
  }
}

Documentation

For more information, visit the API Documentation.

Support

License

This gem is available under the MIT License.