calonso / ruby-push-notifications Goto Github PK

View Code? Open in Web Editor NEW

399.0 15.0 33.0 178 KB

iOS, Android and Windows Phone Push Notifications made easy!!

Home Page: https://rubygems.org/gems/ruby-push-notifications

License: MIT License

Ruby 100.00%

windows-phone android ruby push-notifications ios rubygem

ruby-push-notifications's Introduction

Ruby Push Notifications

iOS, Android and Windows Phone Push Notifications made easy!

Features

iOS and Android support
Complete error and retry management
Easy and intuitive API

Installation

Add this line to your application's Gemfile:

gem 'ruby-push-notifications'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby-push-notifications

Usage

Ruby Push Notifications gem usage is really easy.

After installing, require the gem
Create one or more notifications
Create the corresponding pusher
Push!!
Get feedback

For completely detailed examples:

Pending tasks

Feel free to contribute!!

Validate iOS notifications format and max size
Validate iOS tokens format
Validate GCM registration ids format
Validate GCM notifications format and max size
Split GCM notifications in parts if more than 1000 destinations are given (currently raising exception)
Integrate with APNS Feedback service
Validate MPNS notifications format
Validate MPNS data
Add other platforms (Amazon Fire...)

Contributing

Fork it ( https://github.com/calonso/ruby-push-notifications/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Troubleshooting

If you see "255 Unknown Error" error code

This error code is assigned when the connection to push notification server wasn't successful 255 UNKnown Error code

Checking your connection configuration for example with APNS connection. When your pem file and token are development make sure you configure the pusher for sandbox mode RubyPushNotifications::APNS::APNSPusher.new('the certificate', true))

or when your pem file and token are production you should configure the pusher for production mode (Set the sandbox mode to false when creating your pusher) RubyPushNotifications::APNS::APNSPusher.new('the certificate', false))

Changelog

Refer to the CHANGELOG.md file for detailed changes across versions.

ruby-push-notifications's People

Contributors

Stargazers

Watchers

ruby-push-notifications's Issues

Support WNS for UWP (Windows 10) apps

Can we add support for Windows Push Notification Services (WNS)? This will support pushing to Universal Windows Platform apps.

I got "Error message individual_results => 255" for ios push notification

Everything is ok for me when I tested in local and staging.

Until today I just pushed it to PROD I got error message about individual_results => 255 when I sent one device token. and I got below error when I sent more than one device tokens

NoMethodError: undefined method `unpack' for nil:NilClass

from /app/vendor/bundle/ruby/2.2.0/gems/ruby-push-notifications-0.3.1/lib/ruby-push-notifications/apns/apns_pusher.rb:59:in `push' from (irb):14

from /app/vendor/bundle/ruby/2.2.0/gems/railties-4.1.8/lib/rails/commands/console.rb:90:in `start'

from /app/vendor/bundle/ruby/2.2.0/gems/railties-4.1.8/lib/rails/commands/console.rb:9:in `start'

from /app/vendor/bundle/ruby/2.2.0/gems/railties-4.1.8/lib/rails/commands/commands_tasks.rb:69:in `console'

from /app/vendor/bundle/ruby/2.2.0/gems/railties-4.1.8/lib/rails/commands/commands_tasks.rb:40:in `run_command!'

from /app/vendor/bundle/ruby/2.2.0/gems/railties-4.1.8/lib/rails/commands.rb:17:in `<top (required)>'

from /app/bin/rails:8:in `require'

from /app/bin/rails:8:in `<main>'

I tested about pem file and device token they're correct.

Please help me Thank you so much.

Change Android example

In the GCM example the notification is created with:

{ text: "Hello GCM world" }

But it should be:

{ message: "Hello GCM world" }

apns-push-type header

Hi guys, trying to find a libirary that supports the new ios 13 apns push type headers, i am not seeing it in this library wondering if you guys are going to support it

https://github.com/calonso/ruby-push-notifications/blob/master/lib/ruby-push-notifications/apns/apns_notification.rb#L67

getaddrinfo: nodename nor servname provided, or not known (SocketError)

The host url that I'm requesting is https://api.push.apple.com/....
The actual url is the push token appended to the above url:

Therefore the actual url becomes https://api.push.apple.com/..../<push_token> which is uri

notification = RubyPushNotifications::APNS::APNSNotification.new tokens, { aps: { alert: 'Hello APNS World!', sound: 'true', badge: 1 } }

pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('Certificates.pem'), true, password, { host: uri })

On pusher.push [notification] I get getaddrinfo: nodename nor servname provided, or not known (SocketError).

The uri works perfectly via curl.

Firebase Cloud Messaging support

Hi! I was wondering if you are planning to support Firebase Cloud Messaging pushes!

https://firebase.google.com/docs/cloud-messaging/

Thanks!

require "Forwardable"

Hi, I've recently downloaded this gem, and I had an issue where I had to go inside the gem and add a 《require "Forwardable"》or the gem would prevent my program from working.

I'm using ruby 2.3.

FCM (Not released on rubygems yet)

FCM has been implemented but not released with current version on Rubygems.

For those features and testing use the below steps:

Remove current version installed from rubygems and manually build:

gem uninstall ruby-push-notifications
git clone this_repo
cd ruby-push-notifications
gem build ruby-push-notifications.gemspec
gem install ruby-push-notifications-x.x.x

you now have current branch version installed with the FCM implementation active.

Is there any specific formatting that needs to be done to the token for this gem?