notification-settings 1.0.0.beta6 → 1.0.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42d75dc626956570315c4a44fda5cff64afbbb3cffd9285178c16a04a3698b9
-  data.tar.gz: 52e884e145132ecb9de437e9416e367186a0621ec7781026a63bf8a5cc720fd1
+  metadata.gz: f63fb9f4357cdf63bbdc200883a8cd4011a29da844c8e5fa7d5eee78bfa107a4
+  data.tar.gz: 905c9245c94a361a6e477ffa59e98d91cd58d90094581468847c0614787c27f1
 SHA512:
-  metadata.gz: bdb70daa32cf8d055c3aa36d4c4dc9eb03bb3d0e6d5465942d2e0c5f1b38781b6a7c1c972e35aacb19101e6df55849db73b91d7f882551f6261357abeadb9b2d
-  data.tar.gz: f574da3d94ad418d23ba42cb6918ddc35401a1cbfee23cd5c063baf4fc3d622e339b6c388c2f0d01b4b83d0a8eda2934ae77fca7d3605a380784a24aaa9c5dcf
+  metadata.gz: 9ad972080a92d39020ce11147873493906a75cc7eb7587b33ac2a9df1ccc5efe92a6af35405a7844b78f38d8e1245efc540b022ac1bb9c77338fb83698d31237
+  data.tar.gz: 55054ebb25086a00670ac41d672e5f3e86e737d04ca4ff3daa4aa0cdd58f7a806a951a8adf68bf68b2a0d42efaa431b28abd190ce73c79e6dd49e65c31d2366a

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0.beta6 - 2017-12-28
+
+* bugfixes
+    * fix lib loading problems
+
+### 1.0.0.beta5 - 2017-12-28
+
+* bugfixes
+    * fix generators
+    * fix lib loading problems
+    * fix syntax errors
+
+### 1.0.0.beta4 - 2017-12-27
+
+* features
+    * add settings functionality
+    * add `category` attribute to `Notification` instances
+    * add subscription functonality
+
+### 1.0.0.beta3 - 2017-12-25
+
+* features
+    * add `Setting` ActiveRecord model
+
+### 1.0.0.beta2 - 2017-12-23
+
+* no changes
+
+### 1.0.0.beta1 - 2017-12-22
+
+* initial release

data/README.md

@@ -1,17 +1,24 @@
-# NotificationsRails
+# NotificationSettings
 
-[![Gem Version](https://badge.fury.io/rb/notifications-rails.svg)](https://badge.fury.io/rb/notifications-rails) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
+[![Gem Version](https://badge.fury.io/rb/notification-settings.svg)](https://badge.fury.io/rb/notification-settings) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
 
-The most powerful notification solution for Rails. NotificationsRails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
-
-It integrates with the [Native](https://github.com/NativeGap/native-rails) gem to allow you to create a cross platform Rails app.
+Integrates with your authentication solution to craft a personalized user notification platform.
 
 ---
 
 ## Table of Contents
 
-* [Philosophy](#philosophy)
 * [Installation](#installation)
+* [Usage](#usage)
+    * [Categories](#categories)
+    * [Settings](#settings)
+        * [Category specific settings](#category-specific-settings)
+        * [Pusher specific settings](#pusher-specific-settings)
+        * [Updating settings](#updating-settings)
+    * [Subscriptions](#subscriptions)
+    * [Status](#status)
+* [Configuration](#configuration)
+    * [Status](#status)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
@@ -20,49 +27,181 @@ It integrates with the [Native](https://github.com/NativeGap/native-rails) gem t
 
 ---
 
-## Philosophy
+## Installation
 
-NotificationsRails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the notification-integration in your Rails app.
+NotificationSettings works with Rails 5 onwards. You can add it to your `Gemfile` with:
 
-**[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
+```ruby
+gem 'notification-settings'
+```
 
-**[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
+And then execute:
 
-**[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable), [OneSignal](notification-pusher-onesignal).
+    $ bundle
 
-**[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+Or install it yourself as:
+
+    $ gem install notification-settings
 
-You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'notification-settings', github: 'jonhue/notifications-rails'
+```
+
+Now run the generator:
+
+    $ rails g notification_settings:install
+
+To wrap things up, migrate the changes to your database:
+
+    $ rails db:migrate
 
 ---
 
-## Installation
+## Usage
 
-NotificationsRails works with Rails 5 onwards. You can add it to your `Gemfile` with:
+NotificationSettings will create a `NotificationSettings::Setting` record for every newly created `notification_target`-object. It is accessible by calling:
 
 ```ruby
-gem 'notifications-rails'
+User.first.notification_setting
 ```
 
-And then execute:
+### Categories
 
-    $ bundle
+NotificationSettings uses categories to allow your notification targets to define specific preferences. This is how you are able to specify the `category` of a `Notification` record:
 
-Or install it yourself as:
+```ruby
+notification = Notification.create target: User.first, object: Recipe.first, category: 'notification'
+```
 
-    $ gem install notifications-rails
+**Note:** The `category` attribute of any new `Notification` record will default to the [`default_category` configuration](#configuration).
 
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+You can also scope records by their category:
+
+```ruby
+# Return records with `'notification'` as category
+Notification.notification_category
+
+# Return records with `'follow'` as category
+Notification.follow_category
+```
+
+### Settings
+
+You can disable notifications for a given notification target:
+
+```ruby
+s = User.first.notification_setting
+s.settings[:enabled] = false
+```
+
+This will prevent you from creating any new notifications with this user as target.
+
+#### Category specific settings
+
+A user can also have category specific settings:
+
+```ruby
+s.category_settings[:category] = { enabled: false }
+```
+
+#### Pusher specific settings
+
+He can have global or category specific pusher settings:
+
+```ruby
+s.settings[:ActionMailer] = false
+s.category_settings[:category] = { ActionMailer: false }
+```
+
+#### Updating settings
+
+...
+
+### Subscriptions
+
+Subscriptions are a way to better handle settings for notifications from different objects to one notification target.
+
+This is how to subscribe/unsubscribe a target to an object:
+
+```ruby
+User.first.subscribe Recipe.first
+User.first.unsubscribe Recipe.first
+```
+
+Now you can easily notify all subscribers from the subscribable object:
+
+```ruby
+Recipe.first.notify_subscribers push: :ActionMailer
+```
+
+You can customize settings for a single subscription just as you would for a notification target:
+
+```ruby
+s = User.first.notification_subscriptions.first.notification_setting
+s.settings[:enabled] = false
+```
+
+[Learn more](#settings)
+
+### Status
+
+NotificationSettings comes with a handy feature called Status. The status of a record can temporarily disable the ability to create notifications for or to push notifications of a target.
+
+This is how to define a status:
 
 ```ruby
-gem 'notifications-rails', github: 'jonhue/notifications-rails'
+User.first.notification_setting.status = 'do not disturb'
+User.first.notification_setting.save
 ```
 
+**Note:** You can set `status` to any string you like.
+
+`status` has three possible values that are being used as defaults. Normally it defaults to `'online'`. If the `last_seen` [configuration](#configuration) option has been set, it can also default to `'idle'` or `'offline'` depending on the `idle_after` and `offline_after` [configuration](#configuration) options.
+
+If you have set `status` to a custom value, you can get back to using the defaults by setting it back to `nil`.
+
+You can define statuses that prevent creating new notifications for a target and statuses that just prevent pushing them:
+
+```ruby
+NotificationSettings.configure do |config|
+    config.do_not_notify_statuses = ['do not notify']
+    config.do_not_push_statuses = ['do not disturb']
+end
+```
+
+---
+
+## Configuration
+
+You can configure NotificationSettings by passing a block to `configure`. This can be done in `config/initializers/notification-settings.rb`:
+
+```ruby
+NotificationSettings.configure do |config|
+    config.default_category = 'notification'
+end
+```
+
+**`default_category`** Choose your default notification category. Takes a string. Defaults to `'notification'`.
+
+### Status
+
+**`idle_after`** Time duration without activity after which the status defaults to `'idle'`. Takes a time. Defaults to `10.minutes`.
+
+**`offline_after`** Time duration without activity after which the status defaults to `'offline'`. Takes a time. Defaults to `3.hours`.
+
+**`last_seen`** Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a string. Defaults to `'last_seen'`.
+
+**`do_not_notify_statuses`** Array of possible statuses that will prevent creating notifications for a target. Takes an array of strings. Defaults to `[]`.
+
+**`do_not_push_statuses`** Array of possible statuses that will prevent pushing notifications of a target. Takes an array of strings. Defaults to `['do not disturb']`
+
 ---
 
 ## To Do
 
-[Here](https://github.com/jonhue/notifications-rails/projects) is the full list of current projects.
+[Here](https://github.com/jonhue/notifications-rails/projects/4) is the full list of current projects.
 
 To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
 
@@ -70,9 +209,9 @@ To propose your ideas, initiate the discussion by adding a [new issue](https://g
 
 ## Contributing
 
-We hope that you will consider contributing to NotificationsRails. Please read this short overview for some information about how to get started:
+We hope that you will consider contributing to NotificationSettings. Please read this short overview for some information about how to get started:
 
-[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+[Learn more about contributing to this repository](https://github.com/jonhue/notifications-rails/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/notifications-rails/blob/master/CODE_OF_CONDUCT.md)
 
 ### Contributors
 
@@ -82,7 +221,7 @@ https://github.com/jonhue/notifications-rails/graphs/contributors
 
 ### Semantic Versioning
 
-NotificationsRails follows Semantic Versioning 2.0 as defined at http://semver.org.
+NotificationSettings follows Semantic Versioning 2.0 as defined at http://semver.org.
 
 ## License
 

data/lib/generators/notification_settings/install_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module NotificationSettings
+
+    class InstallGenerator < Rails::Generators::Base
+
+        include Rails::Generators::Migration
+
+        source_root File.join File.dirname(__FILE__), '../templates/install'
+        desc 'Install NotificationSettings'
+
+        def self.next_migration_number dirname
+            if ActiveRecord::Base.timestamped_migrations
+                Time.now.utc.strftime '%Y%m%d%H%M%S'
+            else
+                "%.3d" % ( current_migration_number(dirname) + 1 )
+            end
+        end
+
+        def create_initializer
+            template 'initializer.rb', 'config/initializers/notification-settings.rb'
+        end
+
+        def create_notifications_migration_file
+            migration_template 'notifications_migration.rb.erb', 'db/migrate/notification_settings_migration.rb', migration_version: migration_version
+        end
+
+        def show_readme
+            readme 'README.md'
+        end
+
+        private
+
+        def migration_version
+            if Rails.version >= '5.0.0'
+                "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+            end
+        end
+
+    end
+
+end

data/lib/generators/templates/install/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add NotificationSettings to your database.

data/lib/generators/templates/install/initializer.rb

@@ -0,0 +1,24 @@
+NotificationSettings.configure do |config|
+
+    # Choose your default notification category. Takes a string.
+    # config.default_category = 'notification'
+
+
+    ### STATUS ###
+
+    # Time duration without activity after which the status defaults to `'idle'`. Takes a time.
+    # config.idle_after = 10.minutes
+
+    # Time duration without activity after which the status defaults to `'offline'`. Takes a time.
+    # config.offline_after = 3.hours
+
+    # Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a string.
+    # config.last_seen = 'last_seen'
+
+    # Array of possible statuses that will prevent creating notifications for a target. Takes an array of strings.
+    # config.do_not_notify_statuses = []
+
+    # Array of possible statuses that will prevent pushing notifications of a target. Takes an array of strings.
+    # config.do_not_push_statuses = ['do not disturb']
+
+end

data/lib/generators/templates/install/notifications_migration.rb.erb

@@ -0,0 +1,29 @@
+class NotificationSettingsMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        add_column :notifications, :subscription_id, :bigint, index: true
+        add_column :notifications, :category, :string, index: true
+
+        create_table :notification_settings_settings do |t|
+
+            t.references :object, polymorphic: true, index: true
+            t.references :subscription, index: true
+
+            t.string :status
+
+            t.text :settings
+            t.text :category_settings
+
+            t.timestamps
+
+        end
+
+        create_table :notification_settings_subscriptions do |t|
+
+            t.references :subscriber, polymorphic: true, index: true
+            t.references :subscribable, polymorphic: true, index: true
+
+            t.timestamps
+
+        end
+    end
+end

data/lib/notification_settings/configuration.rb

@@ -0,0 +1,32 @@
+module NotificationSettings
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        attr_accessor :default_category
+        attr_accessor :last_seen
+        attr_accessor :idle_after
+        attr_accessor :offline_after
+        attr_accessor :do_not_notify_statuses
+        attr_accessor :do_not_push_statuses
+
+        def initialize
+            @default_category = 'notification'
+            @last_seen = 'last_seen'
+            @idle_after = 10.minutes
+            @offline_after = 3.hours
+            @do_not_notify_statuses = []
+            @do_not_push_statuses = ['do not disturb']
+        end
+
+    end
+
+end

data/lib/notification_settings/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module NotificationSettings
+    class Engine < ::Rails::Engine
+    end
+end

data/lib/notification_settings/notification_library.rb

@@ -0,0 +1,60 @@
+module NotificationSettings
+    module NotificationLibrary
+
+        before_create :validate_create
+
+        belongs_to :subscription, class_name: 'NotificationSettings::Subscription', optional: true
+
+        def category
+            self[:category] || NotificationRenderer.configuration.default_category
+        end
+
+        private
+
+        def validate_create
+            valid = true
+
+            if self.target.notification_setting.present?
+                # Status
+                valid = false if NotificationSettings.configuration.do_not_notify_statuses.include?(self.target.notification_setting.status)
+
+                # Settings
+                valid = false if !self.target.notification_setting.settings.dig(:enabled)
+                ## Category
+                valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, :enabled)
+            end
+
+            valid
+        end
+
+        def validate_push
+            valid = true
+
+            if self.target.notification_setting.present?
+                # Status
+                valid = false if NotificationSettings.configuration.do_not_push_statuses.include?(self.target.notification_setting.status)
+
+                # Settings
+                if self.push.kind_of?(Array)
+                    self.push.each do |pusher|
+                        valid = false if !self.target.notification_setting.settings.dig(pusher.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(pusher.to_sym).nil? )
+                        ## Category
+                        valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym).nil? )
+                    end
+                else
+                    valid = false if !self.target.notification_setting.settings.dig(self.push.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(self.push.to_sym).nil? )
+                    ## Category
+                    valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym).nil? )
+                end
+            end
+
+            valid
+        end
+
+        def initialize_pusher
+            return unless validate_push
+            super
+        end
+
+    end
+end

data/lib/notification_settings/notification_scopes.rb

@@ -0,0 +1,17 @@
+module NotificationSettings
+    module NotificationScopes
+
+        def method_missing m, *args
+            if m.to_s[/(.+)_category/]
+                where category: $1.singularize.classify
+            else
+                super
+            end
+        end
+
+        def respond_to? m, include_private = false
+            super || m.to_s[/(.+)_category/]
+        end
+
+    end
+end

data/lib/notification_settings/setting_library.rb

@@ -0,0 +1,16 @@
+module NotificationSettings
+    module SettingLibrary
+
+        def status
+            if self.object.respond_to?(NotificationSettings.configuration.last_seen) && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round >= NotificationSettings.configuration.idle_after && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round < NotificationSettings.configuration.offline_after
+                default = 'idle'
+            elsif self.object.respond_to?(NotificationSettings.configuration.last_seen) && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round >= NotificationSettings.configuration.offline_after
+                default = 'offline'
+            else
+                'online'
+            end
+            self[:status] || default
+        end
+
+    end
+end

data/lib/notification_settings/subscribable.rb

@@ -0,0 +1,15 @@
+module NotificationSettings
+    module Subscribable
+
+        has_many :notification_subscriptions, as: :subscribable, class_name: 'NotificationSettings::Subscription', dependent: :destroy
+        has_many :notification_subscribers, through: :notification_subscriptions, source: :subscriber
+
+        def notify_subscribers options = {}
+            options[:object] = self
+            self.notification_subscribers.each do |subscriber|
+                subscriber.notify options
+            end
+        end
+
+    end
+end

data/lib/notification_settings/subscriber.rb

@@ -0,0 +1,18 @@
+module NotificationSettings
+    module Subscriber
+
+        has_many :notification_subscriptions, as: :subscriber, class_name: 'NotificationSettings::Subscription', dependent: :destroy
+        has_many :notification_subscribables, through: :notification_subscriptions, source: :subscribable
+
+        def subscribe options = {}
+            options[:subscriber] = self
+            NotificationSettings::Subscription.create options
+        end
+
+        def unsubscribe subscribable
+            subscription = self.notification_subscriptions.find_by subscribable_id: subscribable.id, subscribable_type: subscribable.class.to_s
+            subscription.destroy
+        end
+
+    end
+end

data/lib/notification_settings/subscription_library.rb

@@ -0,0 +1,13 @@
+module NotificationSettings
+    module SubscriptionLibrary
+        
+        after_create_commit :create_notification_setting
+        
+        private
+        
+        def create_notification_setting
+            self.notification_setting.create!
+        end
+
+    end
+end

data/lib/notification_settings/target.rb

@@ -0,0 +1,15 @@
+module NotificationSettings
+    module Target
+
+        has_one :notification_setting, as: :object, class_name: 'NotificationSettings::Setting', dependent: :destroy
+
+        after_create_commit :create_notification_setting
+
+        private
+
+        def create_notification_setting
+            self.notification_setting.create!
+        end
+
+    end
+end

data/lib/notification_settings.rb

@@ -0,0 +1,15 @@
+module NotificationSettings
+
+    require 'notification_settings/configuration'
+
+    require 'notification_settings/engine'
+
+    autoload :Target, 'notification_settings/target'
+    autoload :Subscriber, 'notification_settings/subscriber'
+    autoload :Subscribable, 'notification_settings/subscribable'
+    autoload :SettingLibrary, 'notification_settings/setting_library'
+    autoload :SubscriptionLibrary, 'notification_settings/subscription_library'
+    autoload :NotificationLibrary, 'notification_settings/notification_library'
+    autoload :NotificationScopes, 'notification_settings/notification_scopes'
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notification-settings
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta6
+  version: 1.0.0.beta7
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -73,8 +73,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
+- lib/generators/notification_settings/install_generator.rb
+- lib/generators/templates/install/README.md
+- lib/generators/templates/install/initializer.rb
+- lib/generators/templates/install/notifications_migration.rb.erb
+- lib/notification_settings.rb
+- lib/notification_settings/configuration.rb
+- lib/notification_settings/engine.rb
+- lib/notification_settings/notification_library.rb
+- lib/notification_settings/notification_scopes.rb
+- lib/notification_settings/setting_library.rb
+- lib/notification_settings/subscribable.rb
+- lib/notification_settings/subscriber.rb
+- lib/notification_settings/subscription_library.rb
+- lib/notification_settings/target.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-settings
 licenses:
 - MIT
@@ -82,7 +97,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib/notification_settings.rb
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="