devise-onesignal 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f650e900ff08e671a6ae3d04385c6c57e64f310ffbc06cf9fbbdd11b3bd917
-  data.tar.gz: 11a32381521ca68f8c60b3a657218dcc79e17bb06f2acd2284094c2da07a6c64
+  metadata.gz: b88207054f8bb5822b6c47f4932517eee81812ecb3ed7319087ed9660ff0ea88
+  data.tar.gz: f86553157eafcb7d9ef43c5fe7761c17a5d243470a40f95c03c3f1407da52277
 SHA512:
-  metadata.gz: a2f640c82b049573428632254904d39347777ea20071012b79fd3405c9bca69df558d2a0182d9090a15d2077d6bc71460e923e030650573b5b40ba56047757cc
-  data.tar.gz: 67033ef583f45281dca2c2e1ec09e60b0224fc08b11dbda877fb262135292ab097ad61003e59a47f0694ac06d619c4a6b52cecb2322105f219ba568c131eb487
+  metadata.gz: 2dc9e06943bf79803d871b8458874643791b7123ae78c8909303bed17405d67c80620fd717ee21bf7e0972d1d2c56aea1c43f87c7304261e67d38dc3ea7a2fe5
+  data.tar.gz: b99727eb1b459caa119dc3b57be474c9bc597264196823007ab15f6b306f50371167a2ec59378e23ffb0a8d1fc38d15ad67a34cf5c4b70480d467f26ae8dd157

data/CHANGELOG.md

@@ -4,6 +4,15 @@
 
 * nothing yet
 
+### 2.0.0 - 2017-12-19
+
+* features
+    * automatically include helpers and concerns
+    * configuration by passing a block to `configure`
+    * introducing `Device` activerecord model
+* enhancements
+    * rename `current_onesignal` method to `current_device`
+
 ### 1.2.1 - 2017-12-18
 
 * enhancements

data/DEPRECATIONS.md

@@ -1,3 +1,5 @@
 # Deprecations
 
-No deprecations
+### 2.0.0 - 2017-12-19
+
+* you should now configure devise-onesignal through a `configure` block

data/INSTALL.md

@@ -4,7 +4,7 @@
 There are three wo more steps to take:
 
 1) Enter your OneSignal App ID in config/initializers/devise-onesignal.rb
-2) Run `rails g devise_one_signal` and `rails db:migrate`
+2) Run `rails g devise-onesignal` and `rails db:migrate`
 3) Add:
 
     //= require OneSignalSDK
@@ -13,4 +13,4 @@ There are three wo more steps to take:
 to your javascript index in app/assets/javascripts/application.js
 
 
-Learn more at https://github.com/jonhue/devise-onesignal.
+Learn more at https://github.com/jonhue/devise-onesignal

data/README.md

@@ -2,7 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/devise-onesignal.svg)](https://badge.fury.io/rb/devise-onesignal) <img src="https://travis-ci.org/jonhue/devise-onesignal.svg?branch=master" />
 
-Implement user targeted cross-platform notifications with OneSignal & Devise in your Rails app. Working well together with [onesignal-ruby](https://github.com/tbalthazar/onesignal-ruby) to access the OneSignal API.
+Implement user targeted cross-platform notifications with OneSignal & Devise in your Rails app.
+
+This gem works well together with [notifications-rails](https://github.com/jonhue/notifications-rails) which introduces a notifications handling & pushing API. To build a cross-platform notification solution also add the [native](https://github.com/NativeGap/native-ruby) gem to your app.
 
 ---
 
@@ -10,6 +12,10 @@ Implement user targeted cross-platform notifications with OneSignal & Devise in
 
 * [Installation](#installation)
 * [Usage](#usage)
+    * [Device methods](#device-methods)
+    * [current_device](#current_device)
+    * [Subscribing](#subscribing)
+    * [Unsubscribing](#unsubscribing)
 * [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
@@ -20,7 +26,7 @@ Implement user targeted cross-platform notifications with OneSignal & Devise in
 
 ## Installation
 
-`devise-onesignal` works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+devise-onesignal works with Rails 5.0 onwards. You can add it to your `Gemfile` with:
 
 ```ruby
 gem 'devise-onesignal'
@@ -42,17 +48,21 @@ gem 'devise-onesignal', github: 'jonhue/devise-onesignal'
 
 Now run the generator:
 
-    $ rails g devise_one_signal
+    $ rails g devise_onesignal
 
 To wrap things up, migrate the changes into your database:
 
     $ rails db:migrate
 
-**Note:** Use `rake db:migrate` instead if you run Rails < 5.
+It is time to [create your OneSignal app](https://onesignal.com) if you haven't already and set your application ID in the created initializer (`config/initializers/devise-onesignal.rb`).
 
-## Usage
+Then add ...
 
-First of all [create your OneSignal app](https://onesignal.com) and set your application ID in the created initializer (`config/initializers/devise-onesignal.rb`).
+```ruby
+has_many :devices
+```
+
+... to your devise class. For example `User` in `app/models/user.rb`.
 
 Now let's include the neccessary javascript files in our application (`apps/assets/javascripts/application.js`):
 
@@ -61,15 +71,7 @@ Now let's include the neccessary javascript files in our application (`apps/asse
 //= require devise-onesignal
 ```
 
-Then include the `OneSignalUser` concern in your `ApplicationController`:
-
-```ruby
-class ApplicationController < ActionController::Base
-    include OneSignalUser
-end
-```
-
-As a last step initialize the javascript component when your assets load. If you are using Rails 5 with Turbolinks, this could look like this:
+Finally initialize the javascript component when your assets load. If you are using Rails 5 with Turbolinks, this could look like this:
 
 ```js
 document.addEventListener( 'turbolinks:load', function() {
@@ -77,52 +79,71 @@ document.addEventListener( 'turbolinks:load', function() {
 });
 ```
 
-### Subscribing / unsubscribing users
+## Usage
 
-This gem makes it fairly easy to subscribe and unsubscribe users from OneSignal. Just call the respective JavaScript function:
+### Device methods
 
-```js
-OneSignalSubscribe();
-OneSignalUnsubscribe();
-```
+devise-onesignal introduces a `Device` activerecord model. Every object of your devise class can have multiple devices, one for each device / browser they enabled OneSignal at least once.
+
+```ruby
+d = Device.first
 
-### Backend
+# Returns user (or other devise object) that this device belongs to. Can return `nil`.
+d.user
 
-devise-onesignal introduces an `current_onesignal` method available in your controllers and views. It returns a hash:
+# Returns OneSignal player id
+d.onesignal_id
 
-```ruby
-$ current_onesignal
-{id: 'e9b66bc5-a1e5-4f3f-8a3e-894f576b193a', permission: 'granted', user: UserObject}
-```
+# Returns OneSignal permission ( `granted`/`denied`/`default` )
+d.onesignal_permission
 
-**Note:** When no user is associated with that ID, the returned hash does not include the key.
+# Some timestamps
+d.last_used
+d.created_at
+d.updated_at
 
-**Note:** If the user has not enabled OneSignal yet, the hash won't return an ID / user but it still returns the permission. In this case `denied` or `default`.
 
-You can access the OneSignal PlayerId and Permission from the User object:
+# If device is ready to receive notifications
+d.onesignal_enabled?
 
-```ruby
-$ User.first.onesignal_id
-'e9b66bc5-a1e5-4f3f-8a3e-894f576b193a'
-$ User.first.onesignal_permission
-'granted'
+# If device has been disabled to receive notifications
+d.onesignal_disabled?
+
+# If device has been set previously to receive notifications or not
+d.onesignal_set?
 ```
 
+### current_device
+
+In your controllers and views you can access a `current_device` method that returns the `Device` object of the current OneSignal subscription. If the user browsing your site is not subscribed to OneSignal, `current_device` returns an uncommitted `Device` object with some helpful information, like the `permission` attribute, set.
+
+### Subscribing
+
+Just call `OneSignalSubscribe();` in your frontend code and OneSignal will ask your user for permission to send notifications. On the following request an existing `Device` object will either get updated or a new one will get created.
+
+### Unsubscribing
+
+**Note:** You most likely don't want to let your users unsubscribe from receiving notifications, but instead allow them to manually disable receiving any new notifications. For that purpose use the [notifications-rails](https://github.com/jonhue/notifications-rails) gem, which adds a notification API and detailed user settings.
+
+If you want to completely remove a user from OneSignal, call `OneSignalSubscribe();` in your javascript.
+
 ---
 
 ## Configuration
 
+You can configure devise-onesignal by passing a block to `configure`:
+
 ```ruby
-DeviseOneSignal::Configuration.app_id = 'OneSignal APP ID'
+DeviseOnesignal.configure do |config|
+    config.app_id = ''
+end
 ```
 
-| Option                 | Description                                                                | Default  |
-| ---------------------- | -------------------------------------------------------------------------- | -------- |
-| `app_id` (required)    | OneSignal application ID                                                   | `nil`    |
-| `devise_class`         | Devise class                                                               | `'User'` |
-| `auto_register`        | Whether or not the app should automatically try to subscribe the user      | `false`  |
-| `persist_notification` | Automatically dismiss the notification after ~20 seconds in Chrome         | `false`  |
-| `subscribe_with_modal` | Show a modal instead of a native window when subscribing user to OneSignal | `false`  |
+**`app_id` (required)** Your OneSignal app id. Create one here: https://onesignal.com
+**`devise_class`** Specify your devise class. Defaults to `'User'`.
+**`auto_register`** Automatically try to subscribe the user when loading a page. Defaults to `false`.
+**`persist_notification`** Automatically dismiss the notification after ~20 seconds in Chrome. Defaults to `false`.
+**`subscribe_with_modal`** Show a modal instead of a native browser window when subscribing a user to OneSignal. Defaults to `false`.
 
 ---
 

data/Rakefile

@@ -1,2 +1,2 @@
-require 'bundler/gem_tasks'
-task default: :spec
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/devise-onesignal.gemspec

@@ -3,7 +3,7 @@ require File.expand_path(File.join('..', 'lib', 'devise-onesignal', 'version'),
 
 Gem::Specification.new do |gem|
     gem.name                  = 'devise-onesignal'
-    gem.version               = DeviseOneSignal::VERSION
+    gem.version               = DeviseOnesignal::VERSION
     gem.platform              = Gem::Platform::RUBY
     gem.summary               = 'Implement user targeted cross-platform notifications in your Rails app'
     gem.description           = 'Implement user targeted cross-platform notifications with OneSignal & Devise in your Rails app.'
@@ -21,6 +21,6 @@ Gem::Specification.new do |gem|
 
     gem.add_development_dependency 'bundler', '~> 1.16'
     gem.add_development_dependency 'rake', '~> 10.0'
-    gem.add_dependency 'rails', '>= 4.0'
+    gem.add_dependency 'rails', '>= 5.0'
     gem.add_dependency 'devise', '~> 4.3'
 end

data/lib/devise-onesignal.rb

@@ -1,9 +1,24 @@
 require 'devise-onesignal/version'
 
-module DeviseOneSignal
+module DeviseOnesignal
 
     autoload :Configuration, 'devise-onesignal/configuration'
 
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    autoload :DeviceLib, 'devise-onesignal/device_lib'
+
+    autoload :DeviceConcern, 'devise-onesignal/device_concern'
+    autoload :DeviceHelper, 'devise-onesignal/device_helper'
+    require 'devise-onesignal/railtie'
+
     class Engine < ::Rails::Engine
     end
 

data/lib/devise-onesignal/configuration.rb

@@ -1,27 +1,18 @@
-module DeviseOneSignal
+module DeviseOnesignal
     class Configuration
 
-        cattr_accessor :app_id, instance_accessor: false
+        attr_accessor :app_id
+        attr_accessor :devise_class
+        attr_accessor :auto_register
+        attr_accessor :persist_notification
+        attr_accessor :subscribe_with_modal
 
-        def self.devise_class
-            @@devise_class || 'User'
+        def initialize
+            @devise_class = 'User'
+            @auto_register = false
+            @persist_notification = false
+            @subscribe_with_modal = false
         end
-        cattr_writer :devise_class, instance_accessor: false
-
-        def self.auto_register
-            @@auto_register || false
-        end
-        cattr_writer :auto_register, instance_accessor: false
-
-        def self.persist_notification
-            @@persist_notification || false
-        end
-        cattr_writer :persist_notification, instance_accessor: false
-
-        def self.subscribe_with_modal
-            @@subscribe_with_modal || false
-        end
-        cattr_writer :subscribe_with_modal, instance_accessor: false
 
     end
 end

data/lib/devise-onesignal/device_concern.rb

@@ -0,0 +1,26 @@
+module DeviseOnesignal
+    module DeviceConcern
+
+        extend ActiveSupport::Concern
+
+        extend DeviseOnesignal::DeviceHelper
+
+        included do
+            before_action :set_device
+        end
+
+        private
+
+        def set_device
+            unless cookies[:oneSignalUserId].nil?
+                onesignal_user_id = cookies[:oneSignalUserId]
+                device = Device.find_or_create_by! onesignal_id: onesignal_user_id
+                device.user = current_user if current_user
+                device.permission = cookies[:oneSignalUserPermission]
+                device.last_used = Time.now
+                device.save!
+            end
+        end
+
+    end
+end

data/lib/devise-onesignal/device_helper.rb

@@ -0,0 +1,17 @@
+module DeviseOnesignal
+    module DeviceHelper
+
+        def current_device
+            if cookies[:oneSignalUserId].nil?
+                device = Device.new
+                device.user = current_user if current_user
+                device.permission = cookies[:oneSignalUserPermission]
+                device.last_used = Time.now
+            else
+                device = Device.find_by(onesignal_id: cookies[:oneSignalUserId])
+            end
+            device
+        end
+
+    end
+end

data/lib/devise-onesignal/device_lib.rb

@@ -0,0 +1,15 @@
+module DeviseOnesignal
+    module DeviceLib
+
+        def onesignal_enabled?
+            self.permission == 'granted'
+        end
+        def onesignal_disabled?
+            self.permission == 'denied'
+        end
+        def onesignal_set?
+            !self.permission == 'default'
+        end
+
+    end
+end

data/lib/devise-onesignal/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module DeviseOnesignal
+    class Railtie < Rails::Railtie
+
+        initializer 'devise-onesignal.initialize' do
+            abort 'Set your OneSignal app id in `config/initializers/devise-onesignal.rb`' if DeviseOnesignal.configuration && ( DeviseOnesignal.configuration.app_id.nil? || DeviseOnesignal.configuration.app_id == '' )
+            ActiveSupport.on_load :action_controller do
+                include DeviseOnesignal::DeviceConcern
+            end
+            ActiveSupport.on_load :action_view do
+                include DeviseOnesignal::DeviceHelper
+            end
+        end
+
+    end
+end

data/lib/devise-onesignal/version.rb

@@ -1,5 +1,5 @@
-module DeviseOneSignal
+module DeviseOnesignal
 
-    VERSION = '1.2.1'
+    VERSION = '2.0.0'
 
 end

data/lib/generators/{devise_one_signal_generator.rb → devise_onesignal_generator.rb}

@@ -1,7 +1,7 @@
 require 'rails/generators'
 require 'rails/generators/migration'
 
-class DeviseOneSignalGenerator < Rails::Generators::Base
+class DeviseOnesignalGenerator < Rails::Generators::Base
 
     include Rails::Generators::Migration
 
@@ -12,18 +12,21 @@ class DeviseOneSignalGenerator < Rails::Generators::Base
         if ActiveRecord::Base.timestamped_migrations
             Time.now.utc.strftime '%Y%m%d%H%M%S'
         else
-            "%.3d" % (current_migration_number(dirname) + 1)
+            "%.3d" % ( current_migration_number(dirname) + 1 )
         end
     end
 
-    def create_migration_file
-        migration_template 'migration.rb.erb', 'db/migrate/devise_one_signal_migration.rb', migration_version: migration_version
-    end
-
     def create_initializer
         template 'initializer.rb', 'config/initializers/devise-onesignal.rb'
     end
 
+    def create_device_migration_file
+        migration_template 'devices_migration.rb.erb', 'db/migrate/devise_onesignal_migration.rb', migration_version: migration_version
+    end
+    def create_device_model
+        template 'device_model.rb', 'app/models/device.rb'
+    end
+
     def show_readme
         readme 'README.md'
     end

data/lib/generators/templates/device_model.rb

@@ -0,0 +1,7 @@
+class Device < ActiveRecord::Base
+
+    extend DeviseOnesignal::DeviceLib
+
+    belongs_to DeviseOnesignal.configuration.devise_class.downcase.to_sym, optional: true
+
+end

data/lib/generators/templates/devices_migration.rb.erb

@@ -0,0 +1,16 @@
+class DeviseOnesignalMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        create_table :devices do |t|
+
+            t.references DeviseOnesignal.configuration.devise_class.downcase.to_sym, index: true
+
+            t.string :onesignal_id, index: true, unique: true
+            t.string :onesignal_permission
+
+            t.datetime :last_used
+
+            t.timestamps
+
+        end
+    end
+end

data/lib/generators/templates/initializer.rb

@@ -1 +1,26 @@
-DeviseOneSignal::Configuration.app_id = 'OneSignal APP ID'
+DeviseOnesignal.configure do |config|
+
+    ### ONESIGNAL ###
+
+    # Your OneSignal app id. Create one here: https://onesignal.com
+    config.app_id = ''
+
+
+    ### DEVISE ###
+
+    # Specify your devise class. Defaults to `'User'`.
+    # config.devise_class = 'User'
+
+
+    ### CUSTOMIZATION ###
+
+    # Automatically try to subscribe the user when loading a page. Defaults to `false`.
+    # config.auto_register = false
+
+    # Automatically dismiss the notification after ~20 seconds in Chrome. Defaults to `false`.
+    # config.persist_notification = false
+
+    # Show a modal instead of a native browser window when subscribing a user to OneSignal. Defaults to `false`.
+    # config.subscribe_with_modal = false
+
+end

data/vendor/assets/javascripts/devise-onesignal.js.erb

@@ -8,8 +8,8 @@ function OneSignalInit() {
     // Do NOT call init() twice
     OneSignal.push([ 'init', {
         // Your other init options here
-        appId: '<%= DeviseOneSignal::Configuration.app_id %>',
-        autoRegister: <%= DeviseOneSignal::Configuration.auto_register ? 'true' : 'false' %>,
+        appId: '<%= DeviseOnesignal.configuration.app_id %>',
+        autoRegister: <%= DeviseOnesignal.configuration.auto_register ? 'true' : 'false' %>,
         welcomeNotification: {
             disable: true,
             title: '',
@@ -18,7 +18,7 @@ function OneSignalInit() {
         notifyButton: {
             enable: false
         },
-        persistNotification: <%= DeviseOneSignal::Configuration.persist_notification ? 'true' : 'false' %> // Automatically dismiss the notification after ~20 seconds in Chrome Desktop v47+
+        persistNotification: <%= DeviseOnesignal.configuration.persist_notification ? 'true' : 'false' %> // Automatically dismiss the notification after ~20 seconds in Chrome Desktop v47+
     }]);
 
     // Firstly this will check user id
@@ -43,7 +43,7 @@ function OneSignalSubscribe() {
         OneSignal.setSubscription(true);
     } else {
         OneSignal.registerForPushNotifications({
-            modalPrompt: <%= DeviseOneSignal::Configuration.subscribe_with_modal ? 'true' : 'false' %>
+            modalPrompt: <%= DeviseOnesignal.configuration.subscribe_with_modal ? 'true' : 'false' %>
         });
     };
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-onesignal
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +86,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/controllers/concerns/one_signal_user.rb
 - devise-onesignal.gemspec
 - init.rb
 - lib/devise-onesignal.rb
 - lib/devise-onesignal/configuration.rb
+- lib/devise-onesignal/device_concern.rb
+- lib/devise-onesignal/device_helper.rb
+- lib/devise-onesignal/device_lib.rb
+- lib/devise-onesignal/railtie.rb
 - lib/devise-onesignal/version.rb
-- lib/generators/devise_one_signal_generator.rb
+- lib/generators/devise_onesignal_generator.rb
 - lib/generators/templates/README.md
+- lib/generators/templates/device_model.rb
+- lib/generators/templates/devices_migration.rb.erb
 - lib/generators/templates/initializer.rb
-- lib/generators/templates/migration.rb.erb
 - vendor/assets/javascripts/OneSignalSDK.js
 - vendor/assets/javascripts/devise-onesignal.js.erb
 homepage: https://github.com/jonhue/devise-onesignal
@@ -109,7 +113,7 @@ post_install_message: |
   There are three wo more steps to take:
 
   1) Enter your OneSignal App ID in config/initializers/devise-onesignal.rb
-  2) Run `rails g devise_one_signal` and `rails db:migrate`
+  2) Run `rails g devise-onesignal` and `rails db:migrate`
   3) Add:
 
       //= require OneSignalSDK
@@ -118,7 +122,7 @@ post_install_message: |
   to your javascript index in app/assets/javascripts/application.js
 
 
-  Learn more at https://github.com/jonhue/devise-onesignal.
+  Learn more at https://github.com/jonhue/devise-onesignal
 rdoc_options: []
 require_paths:
 - lib

data/app/controllers/concerns/one_signal_user.rb

@@ -1,34 +0,0 @@
-module OneSignalUser
-
-    extend ActiveSupport::Concern
-
-    included do
-        before_action :set_onesignal_user
-        helper_method :current_onesignal
-    end
-
-    def current_onesignal
-        current_onesignal = {}
-        current_onesignal[:id] = cookies[:oneSignalUserId]
-        current_onesignal[:permission] = cookies[:oneSignalUserPermission]
-        current_onesignal[DeviseOneSignal::Configuration.devise_class.downcase.to_sym] = DeviseOneSignal::Configuration.devise_class.constantize&.find_by(onesignal_id: current_onesignal[:id]) if cookies.has_key?(:oneSignalUserId)
-        current_onesignal.each do |key, value|
-            current_onesignal.delete(key) if value == nil
-        end
-        current_onesignal
-    end
-
-    private
-
-    def set_onesignal_user
-        if current_user
-            onesignal_user_id = cookies[:oneSignalUserId]
-            if onesignal_user_id.nil?
-                current_user.update_attributes onesignal_id: nil, onesignal_permission: nil
-            else
-                current_user.update_attributes onesignal_id: onesignal_user_id, onesignal_permission: cookies[:oneSignalUserPermission]
-            end
-        end
-    end
-
-end

data/lib/generators/templates/migration.rb.erb

@@ -1,6 +0,0 @@
-class DeviseOneSignalMigration < ActiveRecord::Migration<%= migration_version %>
-    def change
-        add_column :<%= DeviseOneSignal::Configuration.devise_class.downcase.pluralize %>, :onesignal_id, :string, index: true, unique: true
-        add_column :<%= DeviseOneSignal::Configuration.devise_class.downcase.pluralize %>, :onesignal_permission, :string
-    end
-end