Installation

Table of contents

1. Installation
   1. Install
   2. Development Setup
   3. Verify
   4. Next Steps

---

Install

Requirements: Ruby ≥ 4.0.2. OpenSSL is bundled with Ruby — no separate install needed.

Add to your Gemfile:

gem 'safire'

Then run:

bundle install

Or install directly:

gem install safire

---

Development Setup

Clone the repo and set up the development environment:

git clone https://github.com/vanessuniq/safire.git
cd safire
bin/setup          # Install dependencies
bundle exec rspec  # Run tests to verify
bin/console        # Interactive prompt

To serve the docs site locally:

bin/docs                                           # Generate YARD API docs
cd docs && bundle install && bundle exec jekyll serve

Then visit http://localhost:4000/safire/.

---

Verify

A quick smoke test to confirm the gem is installed and SMART discovery is working:

require 'safire'

client = Safire::Client.new(
  base_url:     'https://launch.smarthealthit.org/v/r4/sim/eyJoIjoiMSJ9/fhir',
  client_id:    'test',
  redirect_uri: 'https://example.com/callback',
  scopes:       ['openid', 'profile', 'patient/*.read']
)

metadata = client.server_metadata
puts metadata.authorization_endpoint
# => https://launch.smarthealthit.org/.../auth/authorize

If you see an authorization endpoint URL, the gem is working. For troubleshooting, see the Troubleshooting Guide.

---

Next Steps

Configuration	Client credentials, logging, and protocol selection
SMART on FHIR	Authorization flows for public and confidential clients
Security Guide	HTTPS requirements, credential protection, token storage
API Reference	Complete YARD documentation