Sha256: 890206438019c4be2b051f7ea3f3da8917d26f22bea9b4fa821c21f843066fcc

Contents?: true

Size: 1.12 KB

Versions: 1

Compression:

Stored size: 1.12 KB

Contents

# Pushkin

Pushkin is a simple http client for sending various user/system events to Pushkin API endpoint. It's used primarily for logging events in ticketing services.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'pushkin-logger'
```

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

## Basic Usage
```ruby
client = Pushkin::Client.new(
  ENV['PUSHKIN_API_URL'],
  ENV['PUSHKIN_API_TOKEN']
)

data = {
  log_level: 'info', # optional ['info', 'warn', 'error'], default: 'system'
  action: 'my.action',
  properties: { foo: 'bar' }
}

client.push(data)
```
## Advanced
Predefined actions to track orders and tickets sold:
```ruby
order.intent
coupon.create
coupon.activate
ticket.order
ticket.create
ticket.preregister
ticket.upload
ticket.download
payment.received
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

## Contributing

Bug reports and pull requests are welcome on GitLab at https://gitlab.vesputi.com/mobilitybox/pushkin-gem.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
pushkin-logger-0.1.0 README.md