MaropostApi

A simple ruby wrapper for Maropost (http://maropost.com/) API.

Installation

Add this line to your application's Gemfile:

gem 'maropost_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install maropost_api

Usage

Initialize a Client object with client = MaropostApi::Client.new(auth_token: '<TOKEN>', account_number: '<ID>') And here are the methods available:

# To find a contact by email:
client.contacts.add_to_list(email: '[email protected]')

# To add a contact to a list
client.contacts.add_to_list(list_ids: '<id>', params: {email: '[email protected]'})

# To update a contact
client.contacts.update(list_ids: '<id>', params: {email: '[email protected]', first_name: 'test-updated'})

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hosseintoussi/maropost_api.

License

The gem is available as open source under the terms of the MIT License.