Sha256: 8faacce18f7f70b530a645c6b00891937a75a86dc57129a7547f65bb7a276a4c

Contents?: true

Size: 1.25 KB

Versions: 3

Compression:

Stored size: 1.25 KB

Contents

# CloseEncounters

… of the Third Party.

Add serices and events that can track responses from third-party services.

## Usage
Install it like any other rails engine.

```ruby
rails close_encounters:install:migrations
```

Then when you have it installed and migrated you can start tracking events.

```ruby
response = SomeThirdPartyService.call
CloseEncounters.contact("SomeThirdPartyService", status: response.status.to_i, response.body)
```

If the services regularly returns 200 responses, no new events will be recorded.
When it switches to a different status, a new event will be recorded.

```ruby
CloseEncounters.status("SomeThirdPartyService") # => 200
# evuntually you use `contact` and it records a 500 and you'll be able to get
CloseEncounters.status("SomeThirdPartyService") # => 500
```

### TODO

- [ ] Add JS to the gem to track events on the front-end.
- [ ] Add a UI to create and manage services.
- [ ] Add a UI to view events.

## Installation
Add this line to your application's Gemfile:

```ruby
gem "close_encounters"
```

And then execute:
```bash
$ bundle
```

Or install it yourself as:
```bash
$ gem install close_encounters
```

## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
close_encounters-0.1.3 README.md
close_encounters-0.1.2 README.md
close_encounters-0.1.1 README.md