SilverPop API
A Ruby wrapper for the SilverPop API
[][travis] [travis]: http://travis-ci.org/upworthy/silverpop
Installation
$ gem install silverpop
Documentation
http://rdoc.info/gems/silverpop
Usage Examples
require 'silverpop'
require 'oauth2'
#Generate your OAuth2 access token
client = OAuth2::Client.new(SILVERPOP_CLIENT_ID, SILVERPOP_CLIENT_SECRET, site: "https://api1.silverpop.com/oauth/token")
access_token = OAuth2::AccessToken.from_hash(client, refresh_token: SILVERPOP_REFRESH_TOKEN).refresh!
@client = SilverPop.new({access_token: access_token.token, url: "https://api1.silverpop.com"})
#add_recipeint
#pass in user variables, database contact list, and contact list id
a = @client.add_recipient({email:"test@example.com"}, 123, [456])
resp.Envelope.Body.RESULT.SUCCESS # => "TRUE"
Contributing
In the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by fixing issues
- by reviewing patches
Submitting an Issue
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
- Fork the repository.
- Create a topic branch.
- Add specs for your unimplemented feature or bug fix.
- Run
bundle exec rake spec
. If your specs pass, return to step 3. - Implement your feature or bug fix.
- Run
bundle exec rake spec
. If your specs fail, return to step 5. - Run
open coverage/index.html
. If your changes are not completely covered by your tests, return to step 3. - Add documentation for your feature or bug fix.
- Run
bundle exec rake yard
. If your changes are not 100% documented, go back to step 8. - Add, commit, and push your changes.
- Submit a pull request.
Copyright
Copyright (c) 2013 Upworthy. See LICENSE for details.