devise-onesignal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cae9341b2ac47712e879c7b7c03d7f0977ff691736b57b71616f6c05eb570b2
+  data.tar.gz: e94704597db1bde57076d4c27b5b3536b043f8381d359a36f0eeaffd1cf28097
+SHA512:
+  metadata.gz: 53e9877f03d83a08dea653fccf068e59bdc86833bfbd190d8f078a156cd3d7ec2b8b09f62316af604ae7f1263a2b3f360d465de2e77cac14e6969cb6ee3742b7
+  data.tar.gz: 41d36b70e24805a1bf2b892b65ad0aaac2d29b2c6db45d66e379b6190959a66725c9c57e30d3d7b3fd1383b234a3093cc140f371086d80cadd9b606297a1883a

data/.github/issue_template.md

@@ -0,0 +1,14 @@
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### Steps to reproduce
+Show a way to reproduce
+
+### System configuration
+
+**Ruby version**:
+
+**Rails version**:

data/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Finally, if your pull request affects documentation or any non-code
+changes, guidelines for those changes are [available
+here](https://github.com/jonhue/devise-onesignal/blob/master/CONTRIBUTING.md)
+
+Thanks for contributing to `devise-onesignal`!

data/.gitignore

@@ -0,0 +1,8 @@
+test/debug.log
+coverage
+rdoc
+memory
+*.gem
+.rvmrc
+Gemfile.lock
+log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+    - 2.3.3

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2017-12-18
+
+* initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at help@slooob.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing

data/DEPRECATIONS.md

@@ -0,0 +1,3 @@
+# Deprecations
+
+No deprecations

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+git_source :github do |repo_name|
+    "https://github.com/#{repo_name}"
+end
+
+gemspec

data/INSTALL.md

@@ -0,0 +1,16 @@
+**Thank you for installing devise-onesignal!**
+
+
+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`
+3) Add:
+
+    //= require OneSignalSDK
+    //= require devise-onesignal
+
+to your javascript index in app/assets/javascripts/application.js
+
+
+Learn more at https://github.com/jonhue/devise-onesignal.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+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,168 @@
+# devise-onesignal
+
+[![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.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+* [License](#license)
+
+---
+
+## Installation
+
+`devise-onesignal` works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'devise-onesignal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise-onesignal
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'devise-onesignal', github: 'jonhue/devise-onesignal'
+```
+
+Now run the generator:
+
+    $ rails g devise_one_signal
+
+To wrap things up, migrate the changes into your database:
+
+    $ rails db:migrate
+
+**Note:** Use `rake db:migrate` instead if you run Rails < 5.
+
+## Usage
+
+First of all [create your OneSignal app](https://onesignal.com) and set your application ID in the created initializer (`config/initializers/devise-onesignal.rb`).
+
+Now let's include the neccessary javascript files in our application (`apps/assets/javascripts/application.js`):
+
+```js
+//= require OneSignalSDK
+//= 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:
+
+```js
+document.addEventListener( 'turbolinks:load', function() {
+    OneSignalInit();
+});
+```
+
+### Subscribing / unsubscribing users
+
+This gem makes it fairly easy to subscribe and unsubscribe users from OneSignal. Just call the respective JavaScript function:
+
+```js
+OneSignalSubscribe();
+OneSignalUnsubscribe();
+```
+
+### Backend
+
+devise-onesignal introduces an `current_onesignal` method available in your controllers and views. It returns a hash:
+
+```ruby
+$ current_onesignal
+{id: 'e9b66bc5-a1e5-4f3f-8a3e-894f576b193a', permission: 'allow', user: UserObject}
+```
+
+**Note:** When no user is associated with that ID, the returned hash does not include the key.
+
+**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:
+
+```ruby
+$ User.first.onesignal_id
+'e9b66bc5-a1e5-4f3f-8a3e-894f576b193a'
+$ User.first.onesignal_permission
+'allow'
+```
+
+---
+
+## Configuration
+
+```ruby
+DeviseOneSignal::Configuration.app_id = 'OneSignal APP ID'
+```
+
+| 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` |
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/devise-onesignal/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/devise-onesignal/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to `devise-onesignal`. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](https://github.com/jonhue/devise-onesignal/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/devise-onesignal/blob/master/CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/devise-onesignal/graphs/contributors
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/app/controllers/concerns/one_signal_user.rb

@@ -0,0 +1,30 @@
+module OneSignalUser
+
+    extend ActiveSupport::Concern
+
+    included do
+        before_action :set_onesignal_user
+        helper_method :current_onesignal
+    end
+
+    def current_onesignal
+        current_onesignal[:id] = cookies[:oneSignalUserId]
+        current_onesignal[:permission] = cookies[:oneSignalUserPermission]
+        current_onesignal[OneSignalUser::Configuration.devise_class.downcase.to_sym] = OneSignalUser::Configuration.devise_class.constantize&.find_by(onesignal_id: current_onesignal[:id]) if cookies.has_key?(:oneSignalUserId)
+        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/devise-onesignal.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'devise-onesignal', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name                  = 'devise-onesignal'
+    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.authors               = 'Jonas Hübotter'
+    gem.email                 = 'jonas.huebotter@gmail.com'
+    gem.homepage              = 'https://github.com/jonhue/devise-onesignal'
+    gem.license               = 'MIT'
+
+    gem.files                 = `git ls-files`.split("\n")
+    gem.require_paths         = ['lib']
+
+    gem.post_install_message  = IO.read('INSTALL.md')
+
+    gem.required_ruby_version = '>= 2.3'
+
+    gem.add_development_dependency 'bundler', '~> 1.16'
+    gem.add_development_dependency 'rake', '~> 10.0'
+    gem.add_dependency 'rails', '>= 4.0'
+    gem.add_dependency 'devise', '~> 4.3'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'devise-onesignal'

data/lib/devise-onesignal.rb

@@ -0,0 +1,10 @@
+require 'devise-onesignal/version'
+
+module DeviseOneSignal
+
+    autoload :Configuration, 'devise-onesignal/configuration'
+
+    class Engine < ::Rails::Engine
+    end
+
+end

data/lib/devise-onesignal/configuration.rb

@@ -0,0 +1,17 @@
+module DeviseOneSignal
+    class Configuration
+
+        cattr_accessor :app_id, instance_accessor: false
+
+        def self.auto_register
+            @@auto_register || false
+        end
+        cattr_writer :auto_register, instance_accessor: false
+
+        def self.devise_class
+            @@devise_class || 'User'
+        end
+        cattr_writer :devise_class, instance_accessor: false
+
+    end
+end