<commit_before># Comsat

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem 'comsat'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install comsat

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
<commit_msg>First pass at getting more information into the README<commit_after># Comsat

Notifications gem

This is the first iteration for making notifications easy to use from all
services. This is only a stop gap with a centralized service planned to manage
credentials and to keep from duplicating efforts.

Credentials are passed in a URL structure, for example, here is what a scheme
for Campfire might look like:

    campfire://<api_key>:X@blossom.campfirenow.com/Test%20Room

The schema name maps to the service name, the rest we pass to the service to
deal with.

## Messages

Messages should be one of three types, 'notice', 'alert', 'resolve'.

Messages are datum's that contain three pieces of information:

* message
* source
* message_id

The 'source' is where this message originates, for example, "nagios". The
'message_id' should be a unique identifier for this message, and for certain
services should be used on alert/resolve messages to easily resolve them (i.e.
PagerDuty).

## Services

Each service should define three methods, one for each type of message:

* send_notice
* send_alert
* send_resolve

These provide the common interface between all of the services.

## Installation

Add this line to your application's Gemfile:

    gem 'comsat'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install comsat

## Usage

```
client = Comsat::Client.new(["campfire://<api_key>:X@blossom.campfirenow.com/Test%20Room"])
client.send_notice({:message => "message here", :source => "nagios", :message_id => "unique_id"})
```

## Contributing

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

{'fraction_non_alphanumeric': 0.08448275862068966, 'fraction_numerical': 0.00603448275862069, 'mean_word_length': 4.2274774774774775, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 8, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2288057', 'n_tokens_mistral': 690, 'n_tokens_neox': 662, 'n_words': 310}