devise-onesignal 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 107a9075cb4ba1e6aa859142f8ad429ef18470f32bc515b754e522c96b4771e8
-  data.tar.gz: 513f23e8a4ca0a60f7535c0e5e68f43f1c8421ed368e86e76cea524b4ab0784a
+  metadata.gz: bb032ba7dc17d0e039d2e4639d045017315cfccd837e57360f138635eb68a1af
+  data.tar.gz: fd986da1ce7fede417100cb77203cee79654d9dd1a69ade70d5a980614dd00cc
 SHA512:
-  metadata.gz: a523ec599d55ab9c7a3bcc35210dfaf9a2f43c6934589ac174a10cd9b6b2a1b8995a369a5eb0d20305ddf2b0d7e02a2dbd08e0c7743a09be0e75a77c68bb0eb2
-  data.tar.gz: 68cc49c37097dfef72fce53965c54413474aaf7577b940f7526d01d2575b0244e524eb0461db5c6e79da4ea624d9c9398568aefd9a4b3e7515ced9d4335034bb
+  metadata.gz: c3775ea071a90365e87cb8296735b78f5f9ae5858a551f746440ab0dc4e7e71271fa8aa1ec830c80fb8d93cb20b12c08abc9b0efe04469ae8cc32ca2827ac4fb
+  data.tar.gz: 0bb3c6fb16252a8a99c334c6de7c596343f4684b278f172efa128b732797245d67b53a79ace98645b98fe576497912cd82e23de7d4b58f89bc84bb85e00da38b

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 * nothing yet
 
+### 3.0.0 - 2017-12-21
+
+* features
+    * made Devise optional
+    * added `owner` association to `Device` model
+* enhancements
+    * renamed elements of the javascript API
+
 ### 2.0.1 - 2017-12-20
 
 * bugfixes

data/DEPRECATIONS.md

@@ -1,5 +1,9 @@
 # Deprecations
 
+### 3.0.0 - 2017-12-21
+
+* `devise_class` configuration method removed
+
 ### 2.0.0 - 2017-12-19
 
 * you should now configure devise-onesignal through a `configure` block

data/README.md

@@ -2,7 +2,7 @@
 
 [![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.
+Implement user targeted cross-platform notifications with OneSignal & Devise in your Rails app. This gem can also be used without Devise, but it is primarily intended to be used along with some sort of user-management-system.
 
 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.
 
@@ -20,6 +20,7 @@ This gem works well together with [notifications-rails](https://github.com/jonhu
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
 * [License](#license)
 
 ---
@@ -56,15 +57,13 @@ To wrap things up, migrate the changes into your database:
 
 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`).
 
-Then add ...
+Define an association in those models whose objects are supposed to be associated with OneSignal players. For example `User` in `app/models/user.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`):
+Now let us include the neccessary javascript files in our application (`apps/assets/javascripts/application.js`):
 
 ```js
 //= require OneSignalSDK
@@ -81,6 +80,20 @@ document.addEventListener( 'turbolinks:load', function() {
 
 ## Usage
 
+### Devise object
+
+You most likely want to associate your devise object (e.g. `current_user`) with your OneSignal integration. Now, if your Devise model is called `User` and the `current_user` method is available you don't have to worry about that.
+
+Let's say our Devise model is named `Admin`. Just add `private` method to your `ApplicationController`:
+
+```ruby
+def set_device_owner
+    current_admin if current_admin
+end
+```
+
+**Note:** Essentially `set_device_owner` has to return a class object *or* `nil`.
+
 ### Device methods
 
 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.
@@ -88,8 +101,8 @@ devise-onesignal introduces a `Device` activerecord model. Every object of your
 ```ruby
 d = Device.first
 
-# Returns user (or other devise object) that this device belongs to. Can return `nil`.
-d.user
+# Returns object associated with device. Can return `nil`.
+d.owner
 
 # Returns OneSignal player id
 d.onesignal_id
@@ -131,7 +144,7 @@ If you want to completely remove a user from OneSignal, call `OneSignalUnsubscri
 
 ## Configuration
 
-You can configure devise-onesignal by passing a block to `configure`:
+You can configure devise-onesignal by passing a block to `configure`. This can be done in `config/initializers/devise-onesignal.rb`:
 
 ```ruby
 DeviseOnesignal.configure do |config|
@@ -141,8 +154,6 @@ end
 
 **`app_id` (required)** Your OneSignal app id. Takes a string. Create one here: https://onesignal.com
 
-**`devise_class`** Specify your devise class. Takes a string. Defaults to `'User'`.
-
 **`auto_register`** Automatically try to subscribe the user when loading a page. Takes a boolean. Defaults to `false`.
 
 **`persist_notification`** Automatically dismiss the notification after ~20 seconds in Chrome. Takes a boolean. Defaults to `false`.
@@ -171,6 +182,10 @@ Give the people some :heart: who are working on this project. See them all at:
 
 https://github.com/jonhue/devise-onesignal/graphs/contributors
 
+### Semantic Versioning
+
+Sandboxy follows Semantic Versioning 2.0 as defined at http://semver.org.
+
 ## License
 
 MIT License

data/devise-onesignal.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
     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.'
+    gem.description           = 'Implement user targeted cross-platform notifications with OneSignal & Devise in your Rails app. This gem can also be used without Devise, but it is primarily intended to be used along with some sort of user-management-system.'
     gem.authors               = 'Jonas Hübotter'
     gem.email                 = 'jonas.huebotter@gmail.com'
     gem.homepage              = 'https://github.com/jonhue/devise-onesignal'
@@ -22,5 +22,4 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency 'bundler', '~> 1.16'
     gem.add_development_dependency 'rake', '~> 10.0'
     gem.add_dependency 'rails', '>= 5.0'
-    gem.add_dependency 'devise', '~> 4.3'
 end

data/lib/devise-onesignal/configuration.rb

@@ -2,13 +2,11 @@ module DeviseOnesignal
     class Configuration
 
         attr_accessor :app_id
-        attr_accessor :devise_class
         attr_accessor :auto_register
         attr_accessor :persist_notification
         attr_accessor :subscribe_with_modal
 
         def initialize
-            @devise_class = 'User'
             @auto_register = false
             @persist_notification = false
             @subscribe_with_modal = false

data/lib/devise-onesignal/device_concern.rb

@@ -12,15 +12,19 @@ module DeviseOnesignal
         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.onesignal_permission = cookies[:oneSignalUserPermission]
+            unless cookies[:oneSignalPlayerId].nil?
+                onesignal_player_id = cookies[:oneSignalPlayerId]
+                device = Device.find_or_create_by! onesignal_id: onesignal_player_id
+                device.onesignal_permission = cookies[:oneSignalPlayerPermission]
                 device.last_used = Time.now
+                device.owner = set_device_owner
                 device.save!
             end
         end
 
+        def set_device_owner
+            current_user if current_user
+        end
+
     end
 end

data/lib/devise-onesignal/device_helper.rb

@@ -2,13 +2,13 @@ module DeviseOnesignal
     module DeviceHelper
 
         def current_device
-            if cookies[:oneSignalUserId].nil?
+            if cookies[:oneSignalPlayerId].nil?
                 device = Device.new
-                device.user = current_user if current_user
-                device.onesignal_permission = cookies[:oneSignalUserPermission]
+                device.onesignal_permission = cookies[:oneSignalPlayerPermission]
+                device.owner = set_device_owner
                 device.last_used = Time.now
             else
-                device = Device.find_by(onesignal_id: cookies[:oneSignalUserId])
+                device = Device.find_by onesignal_id: cookies[:oneSignalPlayerId]
             end
             device
         end

data/lib/devise-onesignal/version.rb

@@ -1,5 +1,5 @@
 module DeviseOnesignal
 
-    VERSION = '2.0.1'
+    VERSION = '3.0.0'
 
 end

data/lib/generators/templates/device_model.rb

@@ -2,6 +2,6 @@ class Device < ActiveRecord::Base
 
     extend DeviseOnesignal::DeviceLib
 
-    belongs_to DeviseOnesignal.configuration.devise_class.downcase.to_sym, optional: true
+    belongs_to :owner, polymorphic: true, optional: true
 
 end

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

@@ -2,7 +2,7 @@ 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.references :owner, polymorphic: true, index: true
 
             t.string :onesignal_id, index: true, unique: true
             t.string :onesignal_permission

data/lib/generators/templates/initializer.rb

@@ -1,19 +1,9 @@
 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
 

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

@@ -1,13 +1,11 @@
-var useragentid = null;
+var OneSignalPlayerId = null;
 var OneSignal = window.OneSignal || [];
 
 
 
 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' %>,
         welcomeNotification: {
@@ -21,15 +19,14 @@ function OneSignalInit() {
         persistNotification: <%= DeviseOnesignal.configuration.persist_notification ? 'true' : 'false' %> // Automatically dismiss the notification after ~20 seconds in Chrome Desktop v47+
     }]);
 
-    // Firstly this will check user id
     OneSignal.push(function() {
-        OneSignal.getUserId().then(function(userId) {
-            if ( userId != null ) {
-                useragentid = userId;
-                document.cookie = 'oneSignalUserId=' + userId;
+        OneSignal.getUserId().then(function(playerId) {
+            if ( playerId != null ) {
+                OneSignalPlayerId = playerId;
+                document.cookie = 'oneSignalPlayerId=' + playerId;
             };
             OneSignal.push([ 'getNotificationPermission', function(permission) {
-                document.cookie = 'oneSignalUserPermission=' + permission;
+                document.cookie = 'oneSignalPlayerPermission=' + permission;
             }]);
         });
     });
@@ -39,7 +36,7 @@ function OneSignalInit() {
 
 
 function OneSignalSubscribe() {
-    if ( useragentid != null ) {
+    if ( OneSignalPlayerId != null ) {
         OneSignal.setSubscription(true);
     } else {
         OneSignal.registerForPushNotifications({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-onesignal
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,22 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: devise
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
 description: Implement user targeted cross-platform notifications with OneSignal &
-  Devise in your Rails app.
+  Devise in your Rails app. This gem can also be used without Devise, but it is primarily
+  intended to be used along with some sort of user-management-system.
 email: jonas.huebotter@gmail.com
 executables: []
 extensions: []