Ruby + ParseAPI

Ruby. Make your first call.

Install the official Ruby client and bring ParseAPI into your code.

Official Ruby SDK

Ruby install

gem install parseapi

Your language. The same ParseAPI.

Get connected

One country. Your first request.

Look up the United States and print its name.

Install the library.

Terminal

gem install parseapi

Add your secret key.

Create a secret key in Keys. Set it in the terminal that will run the example. Keep it on your server.

Terminal environment

export PARSEAPI_KEY='YOUR_API_KEY'

Make a request.

Save this as example.rb, then run it. This lookup uses your plan's request allowance.

example.rb

require "parseapi"

parse = ParseAPI.new # Reads PARSEAPI_KEY.
begin
  country = parse.country("US")
  puts country["name"]
ensure
  parse.close
end

Run

ruby example.rb

Expected outputUnited States

Handle API errors

Read the error code and request ID when an API request fails. Branch on the code, such as not_found, rather than the message. A response with valid: false is a successful lookup. Transport failures still propagate.

example.rb with error handling

require "parseapi"

parse = ParseAPI.new # Reads PARSEAPI_KEY.

begin
  country = parse.country("US")
  puts country["name"]
rescue ParseAPI::Error => error
  warn "#{error.code} #{error.status} #{error.request_id}"
  raise
ensure
  parse.close
end

Requests and retries

SDK methods follow the API routes. Unknown response values stay unknown, rather than becoming empty strings or guesses.

Ordinary lookups retry temporary failures. Separately metered checks make one attempt by default. You can configure the retry count. See the retry policy.

Build with a working example

Build a local weather card

Build a currency picker

Show an event in the visitor's time zone