Overview

These are the instructions to install and use the Ruby client library for Tacklebox. Tacklebox is an open-source serverless framework that offers webhooks as a service.

It includes:

• a CLI tool to deploy and manage AWS infrastructure
• 4 client libraries (JavaScript, Ruby, Python, and Go)
• a RESTful API
• a management UI

You can read more about our case study here.

The Team

Juan Palma Software Engineer Phoenix, AZ

Kevin Counihan Software Engineer Seattle, WA

Armando Mota Software Engineer Los Angeles, CA

Kayl Thomas Software Engineer Atlanta, GA

Getting Started

Install the Ruby library

Add this line to your application's Gemfile:

gem 'tacklebox'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install tacklebox

Use the Ruby library

Once you install the Ruby library for Tacklebox, you can start using it like so:

require 'tacklebox'

# Initialize a Tacklebox object using the API Key and API Host
# obtained after running 'tacklebox deploy'
tacklebox = Tacklebox.new(API_KEY, API_HOST)

Once you include the package and initialize a Tacklebox object, you can do many things. For example, you can create a service like so:

tacklebox.service.create({ "name" => "service1" })

Once you create services, event types, users and subscriptions, you can create a new event like so:

service_id = "d90af763-5839-4a90-834c-5512980984f5"
user_id = "cabea1b5-b485-41b7-8146-72ece22dc458"

event_data = {
  "event_type" => "greet",
  "payload" => {
    "message" => "Hello from the Ruby wrapper!"
  },
  "idempotency_key" => "1"
}

tacklebox.event.create(service_id, user_id, event_data)

If you want to see the message log for a specific user and service:

service_id = "d90af763-5839-4a90-834c-5512980984f5"
user_id = "cabea1b5-b485-41b7-8146-72ece22dc458"

tacklebox.message.list(service_id, user_id)