Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
.rubocop.yml
README.md
changelog_client.gemspec

README.md

Changelog Client

Send an event to a Changelog server

Installation

Install it yourself as:

$ gem install changelog_client

Usage

A basic usage with the built-in severities:

require 'changelog_client'
client = ChangelogClient.new('my-server-address', my-port)
client.send('This is the message', 'INFO', 'my-category')

You can pass other severity as an int:

client.send('This is the message', 8, 'my-category')

Alternatively you can add extra headers:

client.send('This is the message', 'INFO', 'misc', 'Authorization' => 'Basic b64encoded')

On success, it returs true on failure, it returns false.

Default built-in severities

You can pass any integer number as a severity parameter or any built-in severity string, which can be the following:

  • 'INFO' - 1
  • 'NOTIFICATION' - 2
  • 'WARNING' - 3
  • 'ERROR' - 4
  • 'CRITICAL' - 5

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request