https://github.com/interactive-pioneers/maileon
Ruby wrapper for Maileon API.
https://github.com/interactive-pioneers/maileon
api-wrapper doi email maileon marketing
Last synced: about 2 months ago
JSON representation
Ruby wrapper for Maileon API.
- Host: GitHub
- URL: https://github.com/interactive-pioneers/maileon
- Owner: interactive-pioneers
- License: gpl-3.0
- Created: 2014-08-20T14:55:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-22T15:18:49.000Z (over 8 years ago)
- Last Synced: 2024-12-01T02:22:42.924Z (11 months ago)
- Topics: api-wrapper, doi, email, maileon, marketing
- Language: Ruby
- Homepage:
- Size: 56.6 KB
- Stars: 1
- Watchers: 6
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Maileon [](https://travis-ci.org/interactive-pioneers/maileon) [](http://badge.fury.io/rb/maileon) [](https://coveralls.io/r/interactive-pioneers/maileon)
Ruby wrapper for Maileon email marketing software API.
- Supported Ruby versions:
- 2.2.3 (recommended)
- 2.1.6
- 2.0.0-p645
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'maileon'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install maileon
## Usage
Below API requests are currently supported by the gem:
### Ping
``` ruby
api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
maileon.ping
```
### Subscribe
``` ruby
api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
attribs = {
:email => "subscriber@email.com"
}
body = {
:email => "subscriber@email.com",
:custom_fields => {
:CUSTOM_FIELD_DEFINED_AT_MAILEON => "1"
},
:standard_fields => {
:SALUTATION => "Herr",
:GENDER => "m",
:FIRSTNAME => "Max",
:LASTNAME => "Mustermann",
:LOCALE => "de_DE",
:CITY => "Hamburg",
:COUNTRY => "Germany",
:ZIP => "22675",
:ADDRESS => "Friedensallee",
:HNR => "9"
}
}
maileon.create_contact(attribs, body)
```
### Unsubscribe
``` ruby
api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
attribs = {
:email => "subscriber@email.com"
}
maileon.delete_contact(attribs)
```
## Contributing
### Bug reports, suggestions
- File all your issues, feature requests [here](https://github.com/interactive-pioneers/maileon/issues)
- If filing a bug report, follow the convention of _Steps to reproduce_ / _What happens?_ / _What should happen?_
- __If you're a developer, write a failing test instead of a bug report__ and send a Pull Request
### Code
1. Fork it ( https://github.com/[my-github-username]/maileon/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Develop your feature by concepts of [TDD](http://en.wikipedia.org/wiki/Test-driven_development). Run `guard` in parallel to automatically run your tests
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Licence
Copyright © 2015 Interactive Pioneers GmbH. Licenced under [GPLv3](LICENSE).