magicbell-io/magicbell-ruby

A Ruby gem for communicating with the MagicBell API

magicbell-ruby's Issues

[Features] Automatically retry requests on network errors

Enable automatic retries on requests that fail due to a transient problem by configuring the maximum number of retries:

Global configuration

MagicBell.configure do |config|
  config.api_key = 'MAGICBELL_API_KEY'
  config.api_secret = 'MAGICBELL_API_SECRET'
  config.max_network_retries = 2
end

Per-request configuration

  magicbell = MagicBell::Client.new
  magicbell.max_network_retries = 2

Request example

# If the first request doesn't succeed, it will get retried twice

magicbell.create_notification(
  title: 'Rob assigned a task to you',
  recipients: [{
    external_id: 'DATABASE_ID'
  }]
)

[Chore] Add Contributing section to README

As a contributor, it's difficult to understand what you'd like me to do in order to be able to submit pull requests to this gem.

The PR templates mentions linters, security checks, and tests, but does not explain how to run or validate any of these things.

A contributing section in the README would be mighty helpful in explaining the few steps required for checking out the codebase and validating that changes are in-line with the requirements of the gem.

Remove BCC functionality

The BCC feature is being deprecated and needs to be removed.

[Features] Fallback to the global configuration if credentials are invalid

Is your feature request related to a problem? Please describe.
If one forgets to enter the right MagicBell credentials, people might be worried which account the notifications would go out on.

Describe the solution you'd like
Fallback to the global configuration if the given credentials are invalid.

Describe alternatives you've considered
Raise an error if the given credentials are invalid.