upmysport/onesignal

[![Stories in Ready](https://badge.waffle.io/upmysport/onesignal.png?label=ready&title=Ready)](https://waffle.io/upmysport/onesignal)
[![Build Status](https://circleci.com/gh/upmysport/onesignal.svg?style=shield)](https://circleci.com/gh/upmysport/onesignal)
[![Dependency Status](https://gemnasium.com/upmysport/one_signal.svg)](https://gemnasium.com/upmysport/one_signal)
[![Code Climate](https://codeclimate.com/github/upmysport/onesignal/badges/gpa.svg)](https://codeclimate.com/github/upmysport/onesignal)
# Onesignal

This Gem is a Ruby wrapper for the [Onesignal API](https://documentation.onesignal.com/docs/server-api-overview) which provides Push Notification delivery and automation.

## Installation

This project hasn't been released yet. It's under development.

## Usage

To use the API client it is necessary to set the server APP_ID. You can find the APP_ID on the settings page of your app.

```ruby
Onesignal.configure do |config|
  config.app_id = 'APP_ID'
end
```

Then the client will be ready to receive method calls on the Onesignal module.

```ruby
result = Onesignal.add_device(device_type: :ios, identifier: 'ce777617da7f548fe7a9ab6febb56')
Onesignal.notify(message: 'Test notification', devices_ids: result.device_id)
```

Methods supported by this gem and their parameters can be found in the [API Reference](https://documentation.onesignal.com/docs/server-api-overview)

## Contributing

1. Fork it ( https://github.com/[my-github-username]/onesignal/fork )
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 a new Pull Request