Skip to content
Is the VerticalResponse API making you dizzy?
Ruby Shell
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gitignore
.rvmrc
.travis.yml
Gemfile
Gemfile.lock
README.rdoc
Rakefile
TODO.rdoc
dev-setup.sh
vertigo.gemspec

README.rdoc

Vertigo

Is the VerticalResponse API making you dizzy?

Vertigo is a simple Ruby wrapper that makes working with the VerticalResponse SOAP API much more Ruby-like. It manages your session_id, as well as letting you write methods as launch_email_campaign rather than launchEmailCampaign, and use symbols as keys rather than strings.

Author: Benjamin Oakes <hello@benjaminoakes.com>, @benjaminoakes

(More info)

Installation

Simply add Vertigo to your Gemfile:

gem 'vertigo'

If you are unlucky enough not to be using Bundler:

gem install vertigo

Usage

Basic example:

require 'vertigo'

client = Vertigo::Client.new('username', 'password', :duration_minutes => 5)

# Launch a campaign whose ID you already know:
client.launch_email_campaign(:campaign_id => 123456)

For more info, please see Vertigo::Client.

Compatibility

Contributing

Wow, you want to contribute? That's awesome! Thanks!

To set up your development environment, please run:

bash dev-setup.sh

Among other things, that command makes sure you have run `git flow init` (which makes managing contributions easier). Please develop on the develop branch. When you have something you'd like to share, send a pull request to @benjaminoakes.

Notes on Gems

Misc.

When writing documentation, this is handy:

bundle exec yard server --reload

Thanks

  • Forrest Chang (@fkchang2000) for the name

Something went wrong with that request. Please try again.