fcm-rails-push-notifications 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9598012750f8ccf4873ae6e5985bc978c9f504be
+  data.tar.gz: 7e12d994ea80a6ff257fd2c945ab6a4d51006cfe
+SHA512:
+  metadata.gz: 9c8fa43b070c14df34d558812f2a7e2ce7c0232ae6e6bffee160dc058a518f62a879865ec54f651243143001908eb36dd731d8d3e8230ef43837708fa8ccd01b
+  data.tar.gz: 06953b99a1168dc985ee990c545bb185336f2e3d1e1c27b608240fb970bde432157292d11bb8bcbef5077109bf182d50f40e0bec8d212620d6e122e04f6331e2

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,152 @@
+# 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/coverage)
+## Professional iOS, Android and Windows Phone push notifications for Ruby on Rails
+
+RailsPushNotifications is an intuitive and easy to use gem that will allow you to easily add Push Notifications to your project.
+
+RailsPushNotifications key features:
+
+* Multiple Apple/Android/WinPhone applications/configurations
+* Single and Bulk notifications
+* Fully customizable notification's contents
+* Detailed feedback on each individual notification's push results.
+
+## 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.0'
+
+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 thing you need to do 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: { message: '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.
+* Rake task to push all notifications from all applications.
+
+## 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,15 @@
+require "rubygems"
+require "bundler/setup"
+require 'bundler'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => :appraisal
+end
+

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

@@ -0,0 +1,6 @@
+Description:
+    Generate migrations needed to create RailsPushNotifications tables
+
+Example:
+    rails generate rails_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,29 @@
+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
+
+    create_table :rails_push_notifications_fcm_apps do |t|
+      t.string :fcm_key
+
+      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,5 @@
+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/fcm_app'
+require 'rails-push-notifications/apps/mpns_app'

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

@@ -0,0 +1,36 @@
+module RailsPushNotifications
+  #
+  # This class represents an Apple iOS application.
+  #
+  # @author Carlos Alonso
+  #
+  class APNSApp < BaseApp
+    self.table_name = 'rails_push_notifications_apns_apps'
+
+    # Requires a development certificate
+    validates :apns_dev_cert, presence: true
+    # Requires a production certificate
+    validates :apns_prod_cert, presence: true
+
+    before_validation { |app| app.sandbox_mode = true if app.sandbox_mode.nil? }
+
+    private
+
+    # @return [String] the certificate(dev or prod) to use
+    def cert
+      sandbox_mode ? apns_dev_cert : apns_prod_cert
+    end
+
+    # @return [RubyPushNotifications::APNS::APNSPusher] configured and
+    #   ready to push
+    def build_pusher
+      RubyPushNotifications::APNS::APNSPusher.new cert, sandbox_mode
+    end
+
+    # @return [RubyPushNotifications::APNS::APNSNotification]. The type of
+    #   notifications this app manages
+    def notification_type
+      RubyPushNotifications::APNS::APNSNotification
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module RailsPushNotifications
+  #
+  # Abstract. This class is the base of all application entity type.
+  #
+  # @author Carlos Alonso
+  #
+  class BaseApp < ActiveRecord::Base
+
+    self.abstract_class = true
+
+    # has_many notifications
+    has_many :notifications, as: :app
+
+    #
+    # This method will find all notifications owned by this app and
+    # push them.
+    #
+    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
+
+    #
+    # Method that searches the owned notifications for those not yet sent
+    #
+    def find_pending
+      notifications.where sent: false
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RailsPushNotifications
+  #
+  # This class represents an Android FCM application.
+  #
+  # @author Carlos Alonso
+  #
+  class FCMApp < BaseApp
+    self.table_name = 'rails_push_notifications_fcm_apps'
+
+    # Requires a fcm_key
+    validates :fcm_key, presence: true
+
+    private
+
+    # @return [RubyPushNotifications::FCM::FCMPusher] configured and
+    #   ready to push
+    def build_pusher
+      RubyPushNotifications::FCM::FCMPusher.new fcm_key
+    end
+
+    # @return [RubyPushNotifications::FCM::FCMNotification]. The type of
+    #   notifications this app manages
+    def notification_type
+      RubyPushNotifications::FCM::FCMNotification
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RailsPushNotifications
+  #
+  # This class represents an Android GCM application.
+  #
+  # @author Carlos Alonso
+  #
+  class GCMApp < BaseApp
+    self.table_name = 'rails_push_notifications_gcm_apps'
+
+    # Requires a gcm_key
+    validates :gcm_key, presence: true
+
+    private
+
+    # @return [RubyPushNotifications::GCM::GCMPusher] configured and
+    #   ready to push
+    def build_pusher
+      RubyPushNotifications::GCM::GCMPusher.new gcm_key
+    end
+
+    # @return [RubyPushNotifications::GCM::GCMNotification]. The type of
+    #   notifications this app manages
+    def notification_type
+      RubyPushNotifications::GCM::GCMNotification
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RailsPushNotifications
+  #
+  # This class represents an Windows Phone application.
+  #
+  # @author Carlos Alonso
+  #
+  class MPNSApp < BaseApp
+    self.table_name = 'rails_push_notifications_mpns_apps'
+
+    # Requires the certificate
+    validates :cert, presence: true
+
+    private
+
+    # @return [RubyPushNotifications::MPNS::MPNSPusher] configured and
+    #   ready to push
+    def build_pusher
+      RubyPushNotifications::MPNS::MPNSPusher.new cert
+    end
+
+    # @return [RubyPushNotifications::MPNS::MPNSNotification]. The type of
+    #   notifications this app manages
+    def notification_type
+      RubyPushNotifications::MPNS::MPNSNotification
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module RailsPushNotifications
+  #
+  # This class represents the Notification Entity.
+  #
+  # @author Carlos Alonso
+  #
+  class Notification < ActiveRecord::Base
+
+    self.table_name = 'rails_push_notifications_notifications'
+
+    # belongs_to an app
+    belongs_to :app, polymorphic: true
+
+    # Requires an app
+    validates :app, presence: true
+    # Requires data
+    validates :data, presence: true
+    # Requires at least one destination
+    validates :destinations, presence: true, length: { minimum: 1 }
+
+    serialize :data, Hash
+    serialize :destinations, Array
+    serialize :results
+
+    # Automatically manages the sent flag, setting it to true as soon as
+    # it is assigned results.
+    before_save do |record|
+      record.sent = !record.results.nil?
+      true
+    end
+
+    # Automatically manages the success and failed fields, setting them to the
+    # value specified by the results assigned.
+    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,12 @@
+module RailsPushNotifications
+  #
+  # This class exports the migrations generator to Rails
+  #
+  # @author Carlos Alonso
+  #
+  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.4'
+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

data/spec/apps/gcm_app_spec.rb

@@ -0,0 +1,69 @@
+module RailsPushNotifications
+  describe GCMApp, type: :model do
+
+    it 'creates an instance given valid attributes' do
+      GCMApp.create! attributes_for :gcm_app
+    end
+
+    describe 'validations' do
+      let(:app) { build :gcm_app }
+
+      it 'requires a gcm key' do
+        app.gcm_key = nil
+        expect(app).to_not be_valid
+      end
+    end
+
+    describe 'notifications relationship' do
+      let(:app) { create :gcm_app }
+
+      it 'can create new notifications' do
+        expect do
+          app.notifications.create attributes_for :gcm_notification
+        end.to change { app.reload.notifications.count }.from(0).to 1
+      end
+    end
+
+    describe '#push_notifications' do
+      let(:app) { create :gcm_app }
+      let(:notifications) do
+        (1..10).map { create :gcm_notification, app: app }
+      end
+      let(:single_notification) { create :gcm_notification, app: app }
+
+      let(:response) { JSON.dump a: 1 }
+
+      before do
+        stub_request(:post, 'https://android.googleapis.com/gcm/send').
+          to_return status: [200, 'OK'], body: response
+      end
+
+      it 'assigns results' do
+        expect do
+          app.push_notifications
+        end.to change {
+          notifications.map { |n| n.reload.results }
+          }.from([nil] * 10).
+          to([RubyPushNotifications::GCM::GCMResponse.new(200, response)] * 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(RubyPushNotifications::GCM::GCMConnection).
+            to_not receive(:post)
+          app.push_notifications
+        end
+      end
+    end
+  end
+end

data/spec/apps/mpns_app_spec.rb

@@ -0,0 +1,75 @@
+module RailsPushNotifications
+  describe MPNSApp, type: :model do
+
+    it 'creates an instance given valid attributes' do
+      MPNSApp.create! attributes_for :mpns_app
+    end
+
+    describe 'validations' do
+
+      let(:app) { build :mpns_app }
+
+      it 'requires the certificate' do
+        app.cert = nil
+        expect(app).to_not be_valid
+      end
+    end
+
+    describe 'notifications relationship' do
+
+      let(:app) { create :mpns_app }
+
+      it 'can create new notifications' do
+        expect do
+          app.notifications.create attributes_for :mpns_notification
+        end.to change { app.reload.notifications.count }.from(0).to 1
+      end
+    end
+
+    describe '#push_notifications' do
+
+      let(:app) { create :mpns_app }
+      let(:notifications) {
+        (1..10).map { create :mpns_notification, app: app }
+      }
+      let(:single_notification) { create :mpns_notification, app: app }
+
+      let(:headers) {
+          {
+            'x-notificationstatus' => 'Received',
+            'x-deviceconnectionstatus' => 'Connected',
+            'x-subscriptionstatus' => 'Active'
+          }
+        }
+      let(:response) { [ { device_url: 'http://s.notify.live.net/1', headers: headers, code: 200 } ]}
+
+      before do
+        stub_request(:post, %r{s.notify.live.net}).
+            to_return status: [200, 'OK'], headers: headers
+      end
+
+      it 'assigns results' do
+        expect do
+          app.push_notifications
+        end.to change { notifications.map { |n| n.reload.results } }.from([nil] * 10).to([RubyPushNotifications::MPNS::MPNSResponse.new(response)] * 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 :mpns_notification, app: app }
+
+        before { app.push_notifications }
+
+        it "doesn't send already sent notifications" do
+          expect(RubyPushNotifications::MPNS::MPNSConnection).to_not receive(:post)
+          app.push_notifications
+        end
+      end
+    end
+  end
+end

data/spec/factories/apps.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory :apns_app, class: 'RailsPushNotifications::APNSApp' do
+    apns_dev_cert  'abc'
+    apns_prod_cert 'def'
+    sandbox_mode   true
+  end
+
+  factory :gcm_app, class: 'RailsPushNotifications::GCMApp' do
+    gcm_key 'abc123def456'
+  end
+
+  factory :mpns_app, class: 'RailsPushNotifications::MPNSApp' do
+    cert 'abc'
+  end
+end

data/spec/factories/notifications.rb

@@ -0,0 +1,20 @@
+
+FactoryGirl.define do
+  factory :apns_notification, class: 'RailsPushNotifications::Notification' do
+    association   :app, factory: :apns_app, strategy: :create
+    data          a: 1
+    destinations  ['1']
+  end
+
+  factory :gcm_notification, class: 'RailsPushNotifications::Notification' do
+    association   :app, factory: :gcm_app, strategy: :create
+    data          a: 1
+    destinations  ['1']
+  end
+
+  factory :mpns_notification, class: 'RailsPushNotifications::Notification' do
+    association   :app, factory: :mpns_app, strategy: :create
+    data          message: { value1: 'hello' }
+    destinations  ['http://s.notify.live.net/1']
+  end
+end

data/spec/generators/migrations_generator_spec.rb

@@ -0,0 +1,25 @@
+require 'generators/rails-push-notifications/migrations_generator'
+
+describe RailsPushNotifications::Generators::MigrationsGenerator, type: :generator do
+  destination File.expand_path("../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  after do
+    rm_rf destination_root
+  end
+
+  it 'creates the migrations' do
+    expect(destination_root).to have_structure do
+      directory 'db' do
+        directory 'migrate' do
+          migration 'create_rails_push_notifications_apps'
+          migration 'create_rails_push_notifications_notifications'
+        end
+      end
+    end
+  end
+end

data/spec/notification_spec.rb

@@ -0,0 +1,98 @@
+
+module RailsPushNotifications
+  describe Notification, type: :model do
+
+    class FakeResults
+      attr_reader :value1, :success, :failed
+
+      def initialize(value1, success, failed)
+        @value1 = value1
+        @success = success
+        @failed = failed
+      end
+
+      def ==(other)
+        other != nil && other.is_a?(FakeResults) &&
+        @value1 == other.value1 && @success == other.success &&
+        @failed == failed || super(other)
+      end
+    end
+
+    let(:notification) { build :apns_notification }
+
+    describe 'app relationship' do
+      it 'requires an app' do
+        notification.app = nil
+        expect(notification).to_not be_valid
+      end
+
+      it 'belongs to an app' do
+        expect(notification.app).to be_a APNSApp
+      end
+    end
+
+    describe 'data' do
+      it 'requires data' do
+        notification.data = nil
+        expect(notification).to_not be_valid
+      end
+
+      it 'has to be a Hash' do
+        expect do
+          notification.data = 'dummy text'
+          notification.save
+        end.to raise_error ActiveRecord::SerializationTypeMismatch
+      end
+    end
+
+    describe 'destinations' do
+      it 'requires destinations' do
+        notification.destinations = nil
+        expect(notification).to_not be_valid
+      end
+
+      it 'has to be an array' do
+        expect do
+          notification.destinations = 'dummy destinations'
+          notification.save
+        end.to raise_error ActiveRecord::SerializationTypeMismatch
+      end
+
+      it 'has to contain at least one destination' do
+        notification.destinations = []
+        expect(notification).to_not be_valid
+      end
+    end
+
+    describe 'sent' do
+      it 'is false by default' do
+        notification.save
+        expect(notification.sent).to eq false
+      end
+
+      it 'is sent if results assigned' do
+        notification.save
+        expect do
+          notification.results = FakeResults.new(1, 2, 3)
+          notification.save
+        end.to change { notification.reload.sent }.from(false).to true
+      end
+    end
+
+    describe 'results' do
+
+      let(:success) { 1 }
+      let(:failed) { 3 }
+      let(:results) { FakeResults.new 'abc', success, failed }
+
+      it 'serializes any object' do
+        notification.results = results
+        notification.save
+        notification.reload
+        expect(notification.results).to eq results
+        expect(notification.success).to eq success
+        expect(notification.failed).to eq failed
+      end
+    end
+  end
+end

data/spec/rails_apps/rails3_2.rb

@@ -0,0 +1,47 @@
+require 'rails'
+require 'rails/all'
+require 'action_view/testing/resolvers'
+require 'rails/test_help'
+
+require 'rails-push-notifications'
+
+class RailsPushNotificationsApp < Rails::Application
+  config.root = File.expand_path("../../..", __FILE__)
+  config.cache_classes = true
+
+  config.eager_load = false
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection = false
+
+  config.active_support.deprecation = :stderr
+
+  config.middleware.delete "Rack::Lock"
+  config.middleware.delete "ActionDispatch::Flash"
+  config.middleware.delete "ActionDispatch::BestStandardsSupport"
+  config.secret_token = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+  routes.append do
+    get "/" => "welcome#index"
+  end
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  layout 'application'
+  self.view_paths = [ActionView::FixtureResolver.new(
+    "layouts/application.html.erb" => '<%= yield %>',
+    "welcome/index.html.erb"=> 'Hello from index.html.erb',
+  )]
+
+  def index
+  end
+
+end
+
+RailsPushNotificationsApp.initialize!

data/spec/rails_apps/rails4.rb

@@ -0,0 +1,47 @@
+require 'rails'
+require 'rails/all'
+require 'action_view/testing/resolvers'
+
+require 'rails-push-notifications'
+
+module RailsPushNotificationsApp
+  class Application < Rails::Application
+    config.root = File.expand_path("../../..", __FILE__)
+    config.cache_classes = true
+
+    config.eager_load = false
+    config.static_cache_control = "public, max-age=3600"
+
+    config.consider_all_requests_local       = true
+    config.action_controller.perform_caching = false
+
+    config.action_dispatch.show_exceptions = false
+
+    config.action_controller.allow_forgery_protection = false
+
+    config.active_support.deprecation = :stderr
+
+    config.middleware.delete "Rack::Lock"
+    config.middleware.delete "ActionDispatch::Flash"
+    config.middleware.delete "ActionDispatch::BestStandardsSupport"
+    config.secret_key_base = '49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk'
+    routes.append do
+      get "/" => "application#index"
+    end
+  end
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  layout 'application'
+  self.view_paths = [ActionView::FixtureResolver.new(
+    "layouts/application.html.erb" => '<%= yield %>',
+    "welcome/index.html.erb"=> 'Hello from index.html.erb',
+  )]
+
+  def index
+  end
+
+end
+
+RailsPushNotificationsApp::Application.initialize!

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+Bundler.setup
+
+require 'rails'
+
+ENV['RAILS_ENV'] = 'test'
+
+case "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+when '3.2'
+  ENV['DATABASE_URL'] = 'sqlite3://localhost/:memory:'
+  require 'rails_apps/rails3_2'
+  require 'active_record/migration'
+when '4.0'
+  ENV['DATABASE_URL'] = 'sqlite3://localhost/:memory:'
+  require 'rails_apps/rails4'
+when '4.1', '4.2'
+  ENV['DATABASE_URL'] = 'sqlite3::memory:'
+  require 'rails_apps/rails4'
+else
+  raise NotImplementedError.new "Rails Push Notifications gem doesn't support Rails #{Rails.version}"
+end
+
+Bundler.require :default
+Bundler.require :development
+
+require 'webmock/rspec'
+require 'rspec/rails'
+require 'ruby-push-notifications'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+files = Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib', 'generators', 'rails-push-notifications', 'templates', 'migrations', '*.rb'))
+
+migrations = []
+files.each_with_index do |file, version|
+  name, scope = file.scan(/([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/).first
+
+  name = name.camelize
+
+  migrations << ActiveRecord::MigrationProxy.new(name, version, file, scope)
+end
+
+migrations.sort_by(&:version)
+
+migrator = ActiveRecord::Migrator.new(:up, migrations)
+
+if Rails::VERSION::MAJOR == 3
+  migrator.instance_variable_set(:@migrations, migrations)
+end
+
+migrator.migrate
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.order = :random
+end
+
+WebMock.disable_net_connect!(:allow => "codeclimate.com")

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+FactoryGirl.find_definitions

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: fcm-rails-push-notifications
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- Santhu MS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fcm-ruby-push-notifications
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Rails gem to push notifications for iOS, Android and Windows Phone devices
+email:
+- santhu.ms83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/rails-push-notifications/USAGE
+- lib/generators/rails-push-notifications/migrations_generator.rb
+- lib/generators/rails-push-notifications/templates/migrations/create_rails_push_notifications_apps.rb
+- lib/generators/rails-push-notifications/templates/migrations/create_rails_push_notifications_notifications.rb
+- lib/rails-push-notifications.rb
+- lib/rails-push-notifications/apps.rb
+- lib/rails-push-notifications/apps/apns_app.rb
+- lib/rails-push-notifications/apps/base_app.rb
+- lib/rails-push-notifications/apps/fcm_app.rb
+- lib/rails-push-notifications/apps/gcm_app.rb
+- lib/rails-push-notifications/apps/mpns_app.rb
+- lib/rails-push-notifications/notification.rb
+- lib/rails-push-notifications/rails_push_notifications_railtie.rb
+- lib/rails-push-notifications/version.rb
+- spec/apps/apns_app_spec.rb
+- spec/apps/gcm_app_spec.rb
+- spec/apps/mpns_app_spec.rb
+- spec/factories/apps.rb
+- spec/factories/notifications.rb
+- spec/generators/migrations_generator_spec.rb
+- spec/notification_spec.rb
+- spec/rails_apps/rails3_2.rb
+- spec/rails_apps/rails4.rb
+- spec/spec_helper.rb
+- spec/support/factory_girl.rb
+homepage: https://github.com/santhums/rails-push-notifications
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Professional iOS, Android and Windows Phone push notifications for Ruby on
+  Rails
+test_files:
+- spec/apps/apns_app_spec.rb
+- spec/apps/mpns_app_spec.rb
+- spec/apps/gcm_app_spec.rb
+- spec/support/factory_girl.rb
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+- spec/generators/migrations_generator_spec.rb
+- spec/rails_apps/rails3_2.rb
+- spec/rails_apps/rails4.rb
+- spec/factories/apps.rb
+- spec/factories/notifications.rb