Skip to content

iarie/pwush

Repository files navigation

Gem Version Maintainability Test Coverage

Pwush

Pwush is a remote api toolkit for Pushwoosh

Installation

Add this line to your application's Gemfile:

gem 'pwush', '~> 0.4.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pwush

Basic Usage

Setup pwush client

MyPW = Pwush.new(auth: 'AUTH_KEY', app: 'APP_CODE', timeout: { connect: 5, read: 10, write: 2 })

Push message

MyPW.create_message(content: 'Hello, there!')

Using built-in struct

first_message = Pwush::Message.new(
  content: { en: 'Hello' },
  send_date: '2018-04-06 23:00',
  timezone: 'Europe/London',
  devices: ['token1', 'token2'],
  ios_title: 'This is the test message',
  ios_subtitle: 'subtitle!'
)

second_message = Pwush::Message.new(
  content: { es: 'Hola' },
  send_date: '2018-04-06 23:00',
  timezone: 'Europe/Madrid',
  devices: ['token3', 'token4'],
  android_banner: 'This is the test message',
  android_gcm_ttl: 3600
)

MyPW.push(first_message, second_message)

Result

The result is dry-monads Success or Failure, read about it

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/iarie/pwush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the PwRb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.