https://github.com/satnami/rtpush

The terminal push notification service for Ruby.
https://github.com/satnami/rtpush

apns cli fcm firebase-cloud-messaging instapush notification-service notifications ruby slack twilio-sms

Last synced: about 17 hours ago
JSON representation

The terminal push notification service for Ruby.

• Host: GitHub
• URL: https://github.com/satnami/rtpush
• Owner: satnami
• License: mit
• Created: 2018-01-02T03:01:53.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T20:58:27.000Z (over 3 years ago)
• Last Synced: 2024-12-15T20:32:53.618Z (about 1 month ago)
• Topics: apns, cli, fcm, firebase-cloud-messaging, instapush, notification-service, notifications, ruby, slack, twilio-sms
• Language: Ruby
• Homepage:
• Size: 25.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Gem Version](https://badge.fury.io/rb/rtpush.svg)](https://badge.fury.io/rb/rtpush) [![Maintainability](https://api.codeclimate.com/v1/badges/687aec30cf02fad5b6eb/maintainability)](https://codeclimate.com/github/satnami/rtpush/maintainability)

# RTPush. The terminal push notification service for Ruby.

## Supported Services

  * [**FCM Push Notification Service**](https://firebase.google.com/docs/cloud-messaging/)

  * [**Instapush Notification Service**](https://instapush.im/)

  * [**Slack Notification Service**](https://api.slack.com/incoming-webhooks)

  * [**Twilio Messaging Service**](https://www.twilio.com/docs/api/messaging/)

  

## Installation

```

$ gem install rtpush

```

## Configuring

You can use [dotenv](https://github.com/bkeepers/dotenv), which is included in the Gemfile,

to fill in any values that you can't or won't supply through the environment.

In order of precedence RTPush uses:

1. Environment variables (for example MY_VALUE=abc)

2. Values provided in a .env file

3. Default values from .env.default

## Configuration Parameters

```

NOTIFICATION_TITLE=XX

REDIS_URL=XX

SLACK_WEBHOOK=XX

TWILIO_TO_NUMBER=XX

TWILIO_FROM_NUMBER=XX

TWILIO_AUTH_TOKEN=XX

TWILIO_ACCOUNT_SID=XX

GCM_PRIORITY=XX

GCM_AUTH_KEY=XX

GCM_ANDROID_APP_NAME=XX

GCM_ANDROID_DEVICE_TOKEN=XX

INSTAPUSH_APP_ID=XX

INSTAPUSH_APP_SECRET=XX

INSTAPUSH_APP_EVENT=XX

```

## Setup guide

```

TBD

```

## Usage

rtpush strategy1,strategy2 message

```

$ rtpush sms,slack,mobile,insta hello 

```

## Test

```

rspec spec

```

## Improvement

```

TBD

```