stingray-exec

Stingray Traffic Manager Control API Client

Installation

Install it via gem:

$ gem install stingray-exec

Usage

TODO: yup

Hacking

Some (all?) of this may be obvious for those familiar with Ruby modern projects. It'll be okay.

Clone down a copy

git clone git://github.com/modcloth-labs/stingray-exec.git
pushd stingray-exec

Make sure you have bundler

gem install bundler

Pull in dependencies with bundler

bundle install

Verify basic operation with the stingray-exec script

bundle exec bin/stingray-exec --help

As you'll see in the usage text, all of the command-line flags may also be passed as environmental variables. The idea here is that it's sometimes easier to define an environmental variable soup instead of having to pass lots of flags for every invocation.

Running the tests

The test suite uses RSpec. By default, all specs tagged with :integration => true are excluded. This results in very little being tested. In order to exercise the really interesting tests, you'll have to define a STINGRAY_ENDOINT environmental variable. Some examples of how to do this are available in the .local.integration.env and .vagrant.integration.env files in the root of the project tree.

bundle exec rspec

Examples

There are some example stingray-exec scripts present in the ./examples directory. The stingray-exec script accepts a filename as positional argument, so using it in the shebang line works great.

WARNING: some of the examples are destructive, so don't go pointing them at production systems or any such nonsense.