ngrok API client library for Ruby

This library wraps the ngrok HTTP API to make it easier to consume in Ruby.

Installation

This library is published on Rubygems

gem install ngrok-api

Support

The best place to get support using this library is through the ngrok Slack Community. If you find any bugs, please contribute by opening a new GitHub issue.

Documentation

A quickstart guide and a full API reference are included in the ngrok Ruby API documentation

Quickstart

Please consult the documentation for additional examples.

require 'ngrokapi'
client = NgrokAPI::Client.new(api_key: '<API KEY>')

# Get an instance of the api_keys client and list all API keys
keys_client = client.api_keys
keys_client.list

# Or set up an edge and backend with the ability to change your configuration later
edge = client.edges.https.create!(
  description: "A Ruby Created Edge",
  metadata: '{"client": "ruby"}',
  hostports: ["your-subdomain.ngrok.io:443"]
)

backend = client.backends.tunnel_group.create!(
  description: "A Ruby Created Backend",
  labels: {"client_example": "ruby"}
)

route = client.edges.https_routes.create!(
  edge_id: edge.id,
  match_type: "path_prefix",
  match: "/",
  description: "Root",
  backend: NgrokAPI::Models::EndpointBackendMutate.new(attrs: {"enabled": true, "backend_id": backend.id}),
  compression: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": true})
)

client.edge_modules.https_edge_route_compression.replace!(
  edge_id: edge.id,
  id: route.id,
  a_module: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": false})
)

Local Documentation

Documentation can be generated with the command:

bundle exec yard doc 'lib/**/*.rb'

This will generate documentation which can be viewed within the doc folder.

Specs

Specs can be run with the command:

bundle exec rake

This will generate a coverage report which can be viewed within the coverage folder.

Rubocop

Rubocop can be run with the command:

# Run rubocop on lib folder
bundle exec rubocop 'lib'

# Run rubcop on all files
bundle exec rubocop

Building (internal)

This is intended for ngrok employees who are updating this client library.

On a standard Ubuntu machine, you will need these packages to get gems to build/install properly:

sudo apt install gcc make ruby-dev

Then to actually install:

gem install bundler --user-install

# may need to change the ruby version here if yours is different
~/.local/share/gem/ruby/3.0.0/bin/bundle install --path "$HOME/.local/share/gem"

This will update the Gemfile.lock as a side-effect.