Magnews

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/magnews. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'magnews'

And then execute:

$ bundle

Or install it yourself as:

$ gem install magnews

Usage

Create a configuration file like this:

Magnews.configure do |config|
  config.auth_token = Rails.application.secrets.magnews_token
  config.iddatabase = Rails.configuration.x.magnews.database_id
  config.logger = Rails.configuration.x.newsletter.logger
end

Contact create

To create a contact use .create! method with subscription parameters (more infos Magnews Rest API subscribe contact)

Magnews::Contact.create!(subscription_params)

Contacts list all (subscribed)

List all subscribed contacts to a list use .list_all. It returns an hash with email and contact id.

Magnews::Contact.list_all

Contacts list all (unsubscribed)

List all subscribed contacts to a list use .list_unsubscribed. It returns an hash with email and contact id.

Magnews::Contact.list_unsubscribed

Contact delete

To delete a contact use .delete! method with email and options (optionally).

Magnews::Contact.delete!('admin@example.com')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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/[USERNAME]/magnews. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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