SignalApi

A simple library for working with the Signal API (see http://dev.signalhq.com)

Installation

Signal can be installed using RubyGems

gem install signal_api

Inside your script, be sure to

require "rubygems"
require "signal_api"

If you're using Bundler, add the following to your Gemfile

gem "signal_api"

and then run

bundle install

Before using any of the APIs, you will need to set your API key:

SignalApi.api_key = 'foobar123456abcxyz77'

You can find your Signal API key while logged into Signal and looking at your account settings.

You may also specify where Signal should log messages (optional):

SignalApi.logger = Rails.logger
SignalApi.logger = Logger.new(STDERR)

After SignalApi has been configured, you may use any of the API classes to interact with the Signal platform.