rails-push-notifications 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28b29841df4ec35af174ea50b11d4d7a913e7e49
+  data.tar.gz: 7e22916e1d96da39482adb1f174a0981aa797863
+SHA512:
+  metadata.gz: 4b52a811881b2b7e3644da03f037bf5a45a114ff9a5e8f8c8630f57caa3c45decd4ae1770f5820a3c084a6e4fc9c5311c6e3cbad621583c64bc0ac313d4c79c5
+  data.tar.gz: a4be8fb817019db20905072f539e28dad0f8bd950144e0f4ca08071fe65c0d18002757d4faf31099649ffeb946fafe0a4d51143a99549fdd7319dd427073719f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# Rpn (Ruby on Rails Push Notifications)
+[![Build Status](https://travis-ci.org/calonso/rails-push-notifications.svg)](https://travis-ci.org/calonso/rails-push-notifications) [![Code Climate](https://codeclimate.com/github/calonso/rails-push-notifications/badges/gpa.svg)](https://codeclimate.com/github/calonso/rails-push-notifications) [![Test Coverage](https://codeclimate.com/github/calonso/rails-push-notifications/badges/coverage.svg)](https://codeclimate.com/github/calonso/rails-push-notifications)
+## Professional iOS, Android and Windows Phone push notifications for Ruby on Rails
+
+Rpn is an intuitive and easy to use gem that will allow you to easily add Push Notifications to your project.
+
+Rpn supports:
+
+* Multiple Apple/Android/WinPhone applications/configurations
+* Single and Bulk notifications
+* Fully customizable notification's contents
+
+## Live example
+
+Want to try this gem live?
+
+Browse [https://rails-push-notifications-test.herokuapp.com](https://rails-push-notifications-test.herokuapp.com) and play with it!
+The source code for that project is here: [https://github.com/calonso/rails_push_notifications_test](https://github.com/calonso/rails_push_notifications_test)
+
+## Installation
+To install the gem simply add this line to your Gemfile
+
+    gem 'rails-push-notifications', '~> 0.2'
+
+and then install it by running
+
+    $ bundle install
+
+Once you have it installed, you need to generate the database migrations in order to build the required database structure and then run the newly generated migrations. So do it by executing:
+
+    $ rails generate rails_push_notifications:migrations
+    $ rake db:migrate
+
+## Applications setup
+
+First step when using RailsPushNotifications is to setup Apple/Android/WinPhone applications to which the notifications will be associated to. Each platform has it's own details and process.
+
+### Apple Applications setup
+
+Once you have configured your app as Apple Push Notifications Service enabled and you have requested and downloaded both the development and production certificates, it's time to convert them to a readable format (.pem) to import them into Rpn afterwards.
+
+To convert the certificates the first you need is to export them as .p12 files. To do this:
+
+1. Open Keychain Application of your Macintosh computer
+2. Find the recently generated certificates. Click the disclosure button on the left of your certificate and select both the certificate and the contained key
+3. Right click and select 'Export 2 items...'. Then select the desired .p12 format and save it to your disk
+
+Once exported, to convert it to the readable .pem format simply run:
+
+    $ openssl pkcs12 -in <your .p12 filename> -out <your output .pem filename>.pem -nodes -clcerts
+
+Now it's time to create our applications
+
+    app = RailsPushNotifications::APNSApp.new
+    app.apns_dev_cert = File.read('path/to/your/development/certificate.pem')
+    app.apns_prod_cert = File.read('path/to/your/production/certificate.pem')
+    app.sandbox_mode = true
+    app.save
+
+And that's it!! You can create as many different applications as you want. RailsPushNotifications gem allows it.
+
+### Android Applications setup
+
+The only thing you need is the API_KEY that you will get from the Google APIS Console > API Access
+
+    app = RailsPushNotifications::GCMApp.new
+    app.gcm_key = '<your app api key>'
+    app.save
+
+That's all. You have your applications' configurations stored in RailsPushNotification.
+
+### WindowsPhone Applications setup
+
+This case is similar but even simpler than APNS Apps
+
+    app = RailsPushNotifications::MPNSApp.new
+    app.cert = File.read('path/to/your/certificate.pem')
+    app.save
+
+## Creating notifications
+
+The notifications interface is common to all kind of apps, but depending on the type of underlying app
+the destinations and the data format will vary, so for example
+
+### Apple notifications
+
+    app = <Your Apple app>
+    notification = app.notifications.create(
+      destinations: [
+        'Your first destination token',
+        'Your second destination token'
+      ],
+      data: { aps: { alert: 'Hello APNS World!', sound: 'true', badge: 1 } }
+    )
+
+### GCM Notifications
+
+    app = <Your GCM app>
+    notification = app.notifications.create(
+      destinations: [
+        'Your first destination token',
+        'Your second destination token'
+      ],
+      data: { text: 'Hello GCM World!' }
+    )
+
+### WindowsPhone Notifications
+
+    app = <Your WindowsPhone app>
+    notification = app.notifications.create(
+      destinations: [
+        'Your first destination url',
+        'Your second destination url'
+      ],
+      data: { title: 'Title', message: 'Hello MPNS World!', type: :toast }
+    )
+
+## Pushing notifications
+
+Eventually we want to actually push our notifications. For that task all the different apps
+have a `push_notifications` method which will find the associated and not yet pushed notifications
+and actually push them.
+
+    app = <Your app>
+    # Create several notifications for your app
+    app.push_notifications
+
+As this task can be potentially very time consuming you will probably want to invoke it in
+a background worker
+
+And that's all!! I hope you find this gem useful and please, feel free to contribute with
+any improvement/bug you may find.
+
+## Pending tasks
+
+Please, feel free to contribute in building any of those or adding more stuff to this list!
+
+* Better generation of the data for each kind of notification. Hiding the particulars
+to avoid bugs
+
+## Contributing
+
+1. Fork it ( https://github.com/calonso/rails-push-notifications/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
+
+Released under the MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/generators/rails-push-notifications/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generate migrations needed to create RPN tables
+
+Example:
+    rails generate ror_push_notifications:migrations
+

data/lib/generators/rails-push-notifications/migrations_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module RailsPushNotifications
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates/migrations', __FILE__)
+
+      def create_migrations
+        templates = [
+          'create_rails_push_notifications_apps',
+          'create_rails_push_notifications_notifications'
+        ]
+
+        templates.each do |file|
+          migration_template("#{file}.rb", "db/migrate/#{file}.rb")
+        end
+      end
+
+      def self.next_migration_number(path)
+        @count ||= 0
+        @count += 1
+        (Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + @count).to_s
+      end
+    end
+  end
+end

data/lib/generators/rails-push-notifications/templates/migrations/create_rails_push_notifications_apps.rb

@@ -0,0 +1,23 @@
+class CreateRailsPushNotificationsApps < ActiveRecord::Migration
+  def self.up
+    create_table :rails_push_notifications_apns_apps do |t|
+      t.text :apns_dev_cert
+      t.text :apns_prod_cert
+      t.boolean :sandbox_mode, deafult: true
+
+      t.timestamps null: false
+    end
+
+    create_table :rails_push_notifications_gcm_apps do |t|
+      t.string :gcm_key
+
+      t.timestamps null: false
+    end
+
+    create_table :rails_push_notifications_mpns_apps do |t|
+      t.text :cert
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/rails-push-notifications/templates/migrations/create_rails_push_notifications_notifications.rb

@@ -0,0 +1,22 @@
+class CreateRailsPushNotificationsNotifications < ActiveRecord::Migration
+  def change
+    create_table :rails_push_notifications_notifications do |t|
+      t.text :destinations
+      t.integer :app_id
+      t.string :app_type
+      t.text :data
+      t.text :results
+      t.integer :success
+      t.integer :failed
+      t.boolean :sent, default: false
+
+      t.timestamps null: false
+    end
+
+    add_index(
+      :rails_push_notifications_notifications,
+      [:app_id, :app_type, :sent],
+      name: 'app_and_sent_index_on_rails_push_notifications'
+    )
+  end
+end

data/lib/rails-push-notifications.rb

@@ -0,0 +1,4 @@
+require 'ruby-push-notifications'
+require 'rails-push-notifications/apps'
+require 'rails-push-notifications/notification'
+require 'rails-push-notifications/rails_push_notifications_railtie'

data/lib/rails-push-notifications/apps.rb

@@ -0,0 +1,4 @@
+require 'rails-push-notifications/apps/base_app'
+require 'rails-push-notifications/apps/apns_app'
+require 'rails-push-notifications/apps/gcm_app'
+require 'rails-push-notifications/apps/mpns_app'

data/lib/rails-push-notifications/apps/apns_app.rb

@@ -0,0 +1,24 @@
+module RailsPushNotifications
+  class APNSApp < BaseApp
+    self.table_name = 'rails_push_notifications_apns_apps'
+
+    validates :apns_dev_cert, presence: true
+    validates :apns_prod_cert, presence: true
+
+    before_validation { |app| app.sandbox_mode = true if app.sandbox_mode.nil? }
+
+    private
+
+    def cert
+      sandbox_mode ? apns_dev_cert : apns_prod_cert
+    end
+
+    def build_pusher
+      RubyPushNotifications::APNS::APNSPusher.new cert, sandbox_mode
+    end
+
+    def notification_type
+      RubyPushNotifications::APNS::APNSNotification
+    end
+  end
+end

data/lib/rails-push-notifications/apps/base_app.rb

@@ -0,0 +1,26 @@
+module RailsPushNotifications
+  class BaseApp < ActiveRecord::Base
+
+    self.abstract_class = true
+
+    has_many :notifications, as: :app
+
+    def push_notifications
+      pending = find_pending
+      to_send = pending.map do |notification|
+        notification_type.new notification.destinations, notification.data
+      end
+      pusher = build_pusher
+      pusher.push to_send
+      pending.each_with_index do |p, i|
+        p.update_attributes! results: to_send[i].results
+      end
+    end
+
+    protected
+
+    def find_pending
+      notifications.where sent: false
+    end
+  end
+end

data/lib/rails-push-notifications/apps/gcm_app.rb

@@ -0,0 +1,17 @@
+module RailsPushNotifications
+  class GCMApp < BaseApp
+    self.table_name = 'rails_push_notifications_gcm_apps'
+
+    validates :gcm_key, presence: true
+
+    private
+
+    def build_pusher
+      RubyPushNotifications::GCM::GCMPusher.new gcm_key
+    end
+
+    def notification_type
+      RubyPushNotifications::GCM::GCMNotification
+    end
+  end
+end

data/lib/rails-push-notifications/apps/mpns_app.rb

@@ -0,0 +1,17 @@
+module RailsPushNotifications
+  class MPNSApp < BaseApp
+    self.table_name = 'rails_push_notifications_mpns_apps'
+
+    validates :cert, presence: true
+
+    private
+
+    def build_pusher
+      RubyPushNotifications::MPNS::MPNSPusher.new cert
+    end
+
+    def notification_type
+      RubyPushNotifications::MPNS::MPNSNotification
+    end
+  end
+end

data/lib/rails-push-notifications/notification.rb

@@ -0,0 +1,29 @@
+module RailsPushNotifications
+  class Notification < ActiveRecord::Base
+
+    self.table_name = 'rails_push_notifications_notifications'
+
+    belongs_to :app, polymorphic: true
+
+    validates :app, presence: true
+    validates :data, presence: true
+    validates :destinations, presence: true, length: { minimum: 1 }
+
+    serialize :data, Hash
+    serialize :destinations, Array
+    serialize :results
+
+    before_save do |record|
+      record.sent = !record.results.nil?
+      true
+    end
+
+    before_save do |record|
+      if record.results_changed? && record.results
+        record.success = record.results.success
+        record.failed = record.results.failed
+      end
+      true
+    end
+  end
+end

data/lib/rails-push-notifications/rails_push_notifications_railtie.rb

@@ -0,0 +1,7 @@
+module RailsPushNotifications
+  class RailsPushNotificationsRailtie < Rails::Railtie
+    generators do
+      require 'generators/rails-push-notifications/migrations_generator'
+    end
+  end
+end

data/lib/rails-push-notifications/version.rb

@@ -0,0 +1,3 @@
+module RailsPushNotifications
+  VERSION = '0.2.0'
+end

data/spec/apps/apns_app_spec.rb

@@ -0,0 +1,96 @@
+module RailsPushNotifications
+  describe APNSApp, type: :model do
+    it 'creates an instance given valid attributes' do
+      APNSApp.create! attributes_for :apns_app
+    end
+
+    describe 'validations' do
+
+      let(:app) { build :apns_app }
+
+      it 'requires an apns dev cert' do
+        app.apns_dev_cert = nil
+        expect(app).to_not be_valid
+      end
+
+      it 'requires an apns prod cert' do
+        app.apns_prod_cert = nil
+        expect(app).to_not be_valid
+      end
+
+      describe 'sandbox mode' do
+        it 'automatically sets sandbox mode if missing' do
+          app.sandbox_mode = nil
+          expect do
+            app.valid?
+          end.to change { app.sandbox_mode }.from(nil).to true
+        end
+
+        it 'uses the value if given' do
+          app.sandbox_mode = false
+          expect do
+            app.valid?
+          end.to_not change { app.sandbox_mode }.from false
+        end
+      end
+    end
+
+    describe 'notifications relationship' do
+      let(:app) { create :apns_app }
+
+      it 'can create new notifications' do
+        expect do
+          app.notifications.create attributes_for :apns_notification
+        end.to change { app.reload.notifications.count }.from(0).to 1
+      end
+    end
+
+    describe '#push_notifications' do
+      let(:app) { create :apns_app }
+      let(:notifications) do
+        (1..10).map { create :apns_notification, app: app }
+      end
+      let(:single_notification) { create :apns_notification, app: app }
+
+      let(:connection) do
+        instance_double(RubyPushNotifications::APNS::APNSConnection).
+          as_null_object
+      end
+
+      before do
+        allow(RubyPushNotifications::APNS::APNSConnection).
+          to receive(:open).with(app.apns_dev_cert, app.sandbox_mode).
+          and_return connection
+        allow(IO).to receive(:select).and_return []
+      end
+
+      it 'assigns results' do
+        expect do
+          app.push_notifications
+        end.to change {
+          notifications.map do |n|
+            n.reload.results && n.results.individual_results
+          end
+        }.from([nil] * 10).
+          to([[RubyPushNotifications::APNS::NO_ERROR_STATUS_CODE]] * 10)
+      end
+
+      it 'marks as sent' do
+        expect do
+          app.push_notifications
+        end.to change { single_notification.reload.sent }.from(false).to true
+      end
+
+      context 'with an already sent notification' do
+        let!(:sent_notification) { create :apns_notification, app: app }
+
+        before { app.push_notifications }
+
+        it "doesn't send already sent notifications" do
+          expect(connection).to_not receive(:write)
+          app.push_notifications
+        end
+      end
+    end
+  end
+end