gnumarcelo / campaigning

A Ruby Gem to access the Campaing Monitor API (http://www.campaignmonitor.com/api) using SOAP protocol.

This URL has Read+Write access

name age message
file .bnsignore Thu Mar 26 03:15:07 -0700 2009 first commit [gnumarcelo]
file .gitignore Fri Apr 10 09:51:00 -0700 2009 refactored to use jeweler GEM [gnumarcelo]
file LICENSE Fri Apr 10 09:51:00 -0700 2009 refactored to use jeweler GEM [gnumarcelo]
file README.rdoc Loading commit data...
file Rakefile Fri May 22 06:20:56 -0700 2009 created all RDoc and fix some method [gnumarcelo]
file TODO.txt
file VERSION.yml
file campaigning.gemspec
directory lib/
directory sample/
directory test/
README.rdoc

Campaigning

This RubyGem provides access to the CampaignMonitor API(www.campaignmonitor.com/api) using SOAP.

Pre-requisites

An account with Campaign Monitor and the API Key (www.campaignmonitor.com).

Resources

Dependencies

This gem requires the following gems:

 Soap4r (1.5.8)

 Jeweler (http://technicalpickles.com/posts/craft-the-perfect-gem-with-jeweler)

Installing

  sudo gem install gnumarcelo-campaigning -s http://gems.github.com

How to play

Just set a constant named CAMPAIGN_MONITOR_API_KEY with your Campaign monitor API key and start to play like the examples below:

Sample use of the Client class:

  #Here is how to get a list of all clients...
  clients = Campaigning::Client.get_all_clients

  #Here is how to create a brand new subscriber list for an Client
  client = Campaigning::Client.find_by_name("Client One Company")
  list = Campaigning::List.create(
    :client_id => client.clientID,
    :title => "List of people from Brazil",
    :comfirm_opt_in => false
  )

For further examples please check at the sample directory.

Copyright

Copyright © 2009 Marcelo Menezes. See LICENSE for details.