notification-handler 1.0.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 605a40546c724b10aefb6e030ad0a3b64cfd458fceee2419f442293c9795643d
4
+ data.tar.gz: 503aba2a31822b0c41e4f729b71a11a74295e013b2b9725260aba0bcdb836570
5
+ SHA512:
6
+ metadata.gz: be4a36a5335dc8e2022cdac9ae1f0c08a71c8efc35b1f952663c94fe5b2ef0ac7fce08b5e72decd49e2c89c96b265333f237773e2b167f2cdb2321b87acf5b3e
7
+ data.tar.gz: ff7b244994f2c47a09e5f54485e0a390284daa61ce5c1cf2b6895cdc9228be15731f573d2728ee5fbea89b5c655bdc3e0cf9bc076f7e9a54d4a86208ec91a535
data/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ # Changelog
2
+
3
+ ### master
4
+
5
+ * nothing yet
6
+
7
+ ### 1.0.0 - 2017-12-22
8
+
9
+ * initial release
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2017 Jonas Hübotter
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,118 @@
1
+ # NotificationHandler
2
+
3
+ [![Gem Version](https://badge.fury.io/rb/notification-handler.svg)](https://badge.fury.io/rb/notification-handler) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
4
+
5
+ The most powerful (cross-platform) notifications handler & pusher API for Rails.
6
+
7
+ ---
8
+
9
+ ## Table of Contents
10
+
11
+ * [Installation](#installation)
12
+ * [Usage](#usage)
13
+ * [Configuration](#configuration)
14
+ * [To Do](#to-do)
15
+ * [Contributing](#contributing)
16
+ * [Contributors](#contributors)
17
+ * [Semantic versioning](#semantic-versioning)
18
+ * [License](#license)
19
+
20
+ ---
21
+
22
+ ## Installation
23
+
24
+ NotificationHandler works with Rails 5 onwards. You can add it to your `Gemfile` with:
25
+
26
+ ```ruby
27
+ gem 'notification-handler'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ $ bundle
33
+
34
+ Or install it yourself as:
35
+
36
+ $ gem install notification-handler
37
+
38
+ If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
39
+
40
+ ```ruby
41
+ gem 'notification-handler', github: 'jonhue/notifications-rails/tree/master/notification-handler'
42
+ ```
43
+
44
+ Now run the generator:
45
+
46
+ $ rails g notification_handler:install
47
+
48
+ To wrap things up, migrate the changes to your database:
49
+
50
+ $ rails db:migrate
51
+
52
+ ---
53
+
54
+ ## Usage
55
+
56
+ ---
57
+
58
+ ## Configuration
59
+
60
+ You can configure NotificationHandler by passing a block to `configure`. This can be done in `config/initializers/notification-handler.rb`:
61
+
62
+ ```ruby
63
+ NotificationHandler.configure do |config|
64
+ config.default_type = 'notification'
65
+ end
66
+ ```
67
+
68
+ **`default_type`** Choose your default notification type. Takes a string. Defaults to `'notification'`.
69
+
70
+ ---
71
+
72
+ ## To Do
73
+
74
+ [Here](https://github.com/jonhue/notifications-rails/projects/2) is the full list of current projects.
75
+
76
+ To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
77
+
78
+ ---
79
+
80
+ ## Contributing
81
+
82
+ We hope that you will consider contributing to NotificationHandler. Please read this short overview for some information about how to get started:
83
+
84
+ [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)
85
+
86
+ ### Contributors
87
+
88
+ Give the people some :heart: who are working on this project. See them all at:
89
+
90
+ https://github.com/jonhue/notifications-rails/graphs/contributors
91
+
92
+ ### Semantic Versioning
93
+
94
+ NotificationHandler follows Semantic Versioning 2.0 as defined at http://semver.org.
95
+
96
+ ## License
97
+
98
+ MIT License
99
+
100
+ Copyright (c) 2017 Jonas Hübotter
101
+
102
+ Permission is hereby granted, free of charge, to any person obtaining a copy
103
+ of this software and associated documentation files (the "Software"), to deal
104
+ in the Software without restriction, including without limitation the rights
105
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
106
+ copies of the Software, and to permit persons to whom the Software is
107
+ furnished to do so, subject to the following conditions:
108
+
109
+ The above copyright notice and this permission notice shall be included in all
110
+ copies or substantial portions of the Software.
111
+
112
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
113
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
114
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
115
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
116
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
117
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
118
+ SOFTWARE.
@@ -0,0 +1,42 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/migration'
3
+
4
+ class InstallGenerator < Rails::Generators::Base
5
+
6
+ include Rails::Generators::Migration
7
+
8
+ source_root File.join File.dirname(__FILE__), 'templates/install'
9
+ desc 'Install NotificationHandler'
10
+
11
+ def self.next_migration_number dirname
12
+ if ActiveRecord::Base.timestamped_migrations
13
+ Time.now.utc.strftime '%Y%m%d%H%M%S'
14
+ else
15
+ "%.3d" % ( current_migration_number(dirname) + 1 )
16
+ end
17
+ end
18
+
19
+ def create_initializer
20
+ template 'initializer.rb', 'config/initializers/notification-handler.rb'
21
+ end
22
+
23
+ def create_notifications_migration_file
24
+ migration_template 'notifications_migration.rb.erb', 'db/migrate/notifications_migration.rb', migration_version: migration_version
25
+ end
26
+ def create_notification_model
27
+ template 'notification_model.rb', 'app/models/notification.rb'
28
+ end
29
+
30
+ def show_readme
31
+ readme 'README.md'
32
+ end
33
+
34
+ private
35
+
36
+ def migration_version
37
+ if Rails.version >= '5.0.0'
38
+ "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
39
+ end
40
+ end
41
+
42
+ end
@@ -0,0 +1 @@
1
+ Now run `rails db:migrate` to add NotificationHandler to your database.
@@ -0,0 +1,6 @@
1
+ NotificationHandler.configure do |config|
2
+
3
+ # Choose your default notification type. Takes a string.
4
+ # config.default_type = 'notification'
5
+
6
+ end
@@ -0,0 +1,9 @@
1
+ class Notification < ActiveRecord::Base
2
+
3
+ extend NotificationHandler::Library
4
+ extend NotificationHandler::Scopes
5
+
6
+ belongs_to :target, polymorphic: true
7
+ belongs_to :object, polymorphic: true
8
+
9
+ end
@@ -0,0 +1,14 @@
1
+ class NotificationsMigration < ActiveRecord::Migration<%= migration_version %>
2
+ def change
3
+ create_table :notifications do |t|
4
+
5
+ t.references :target, polymorphic: true, index: true
6
+ t.references :object, polymorphic: true, index: true
7
+
8
+ t.string :type, default: NotificationHandler.configuration.default_type, null: false, index: true
9
+
10
+ t.timestamps
11
+
12
+ end
13
+ end
14
+ end
File without changes
File without changes
File without changes
File without changes
@@ -0,0 +1,19 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/migration'
3
+
4
+ class TypeGenerator < Rails::Generators::Base
5
+
6
+ include Rails::Generators::Migration
7
+
8
+ source_root File.join File.dirname(__FILE__), 'templates/type'
9
+ desc 'Create a new notification type'
10
+ class_option :type, desc: 'Specify the notification type', type: :string, default: NotificationHandler.configuration.default_type, aliases: '-t'
11
+
12
+ def create_templates
13
+ template '_default.html.erb', "app/views/notifications/#{options[:type]}/_default.html.erb"
14
+ template '_action_cable.html.erb', "app/views/notifications/#{options[:type]}/_action_cable.html.erb" if defined?(NotificationPusher::ActionCable)
15
+ template '_email.html.erb', "app/views/notifications/#{options[:type]}/_email.html.erb" if defined?(NotificationPusher::Email)
16
+ template '_one_signal.html.erb', "app/views/notifications/#{options[:type]}/_one_signal.html.erb" if defined?(NotificationPusher::OneSignal)
17
+ end
18
+
19
+ end
@@ -0,0 +1,22 @@
1
+ module NotificationHandler
2
+
3
+ class << self
4
+ attr_accessor :configuration
5
+ end
6
+
7
+ def self.configure
8
+ self.configuration ||= Configuration.new
9
+ yield configuration
10
+ end
11
+
12
+ class Configuration
13
+
14
+ attr_accessor :default_type
15
+
16
+ def initialize
17
+ @default_type = 'notification'
18
+ end
19
+
20
+ end
21
+
22
+ end
@@ -0,0 +1,6 @@
1
+ require 'rails'
2
+
3
+ module NotificationHandler
4
+ class Engine < ::Rails::Engine
5
+ end
6
+ end
@@ -0,0 +1,9 @@
1
+ module NotificationHandler
2
+ module Library
3
+
4
+ private
5
+
6
+ DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base]
7
+
8
+ end
9
+ end
@@ -0,0 +1,23 @@
1
+ module NotificationHandler
2
+ module Object
3
+
4
+ def self.included base
5
+ base.extend ClassMethods
6
+ end
7
+
8
+ module ClassMethods
9
+ def notification_object
10
+ has_many :notifications, as: :object, dependent: :destroy
11
+ include NotificationHandler::Object::InstanceMethods
12
+ include NotificationHandler::Library
13
+ end
14
+ end
15
+
16
+ module InstanceMethods
17
+
18
+ # ...
19
+
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,14 @@
1
+ require 'rails'
2
+
3
+ module NotificationHandler
4
+ class Railtie < Rails::Railtie
5
+
6
+ initializer 'notification-handler.active_record' do
7
+ ActiveSupport.on_load :active_record do
8
+ include NotificationHandler::Target
9
+ include NotificationHandler::Object
10
+ end
11
+ end
12
+
13
+ end
14
+ end
@@ -0,0 +1,7 @@
1
+ module NotificationHandler
2
+ module Scopes
3
+
4
+ # ...
5
+
6
+ end
7
+ end
@@ -0,0 +1,23 @@
1
+ module NotificationHandler
2
+ module Target
3
+
4
+ def self.included base
5
+ base.extend ClassMethods
6
+ end
7
+
8
+ module ClassMethods
9
+ def notification_target
10
+ has_many :notifications, as: :target, dependent: :destroy
11
+ include NotificationHandler::Target::InstanceMethods
12
+ include NotificationHandler::Library
13
+ end
14
+ end
15
+
16
+ module InstanceMethods
17
+
18
+ # ...
19
+
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,14 @@
1
+ module NotificationHandler
2
+
3
+ require 'notification_handler/configuration'
4
+
5
+ # require 'notification_handler/engine'
6
+
7
+ autoload :Target, 'notification_handler/target'
8
+ autoload :Object, 'notification_handler/object'
9
+ autoload :Library, 'notification_handler/library'
10
+ autoload :Scopes, 'notification_handler/scopes'
11
+
12
+ require 'notification_handler/railtie'
13
+
14
+ end
metadata ADDED
@@ -0,0 +1,134 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: notification-handler
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0.beta1
5
+ platform: ruby
6
+ authors:
7
+ - Jonas Hübotter
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2017-12-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '5.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '5.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.16'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.16'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec-rails
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.52'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.52'
83
+ description: "..."
84
+ email: jonas.huebotter@gmail.com
85
+ executables: []
86
+ extensions: []
87
+ extra_rdoc_files: []
88
+ files:
89
+ - CHANGELOG.md
90
+ - LICENSE
91
+ - README.md
92
+ - generators/install_generator.rb
93
+ - generators/templates/install/README.md
94
+ - generators/templates/install/initializer.rb
95
+ - generators/templates/install/notification_model.rb
96
+ - generators/templates/install/notifications_migration.rb.erb
97
+ - generators/templates/type/_action_cable.html.erb
98
+ - generators/templates/type/_default.html.erb
99
+ - generators/templates/type/_email.html.erb
100
+ - generators/templates/type/_one_signal.html.erb
101
+ - generators/type_generator.rb
102
+ - lib/notification_handler.rb
103
+ - lib/notification_handler/configuration.rb
104
+ - lib/notification_handler/engine.rb
105
+ - lib/notification_handler/library.rb
106
+ - lib/notification_handler/object.rb
107
+ - lib/notification_handler/railtie.rb
108
+ - lib/notification_handler/scopes.rb
109
+ - lib/notification_handler/target.rb
110
+ homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-handler
111
+ licenses:
112
+ - MIT
113
+ metadata: {}
114
+ post_install_message:
115
+ rdoc_options: []
116
+ require_paths:
117
+ - lib
118
+ required_ruby_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '2.3'
123
+ required_rubygems_version: !ruby/object:Gem::Requirement
124
+ requirements:
125
+ - - ">"
126
+ - !ruby/object:Gem::Version
127
+ version: 1.3.1
128
+ requirements: []
129
+ rubyforge_project:
130
+ rubygems_version: 2.7.3
131
+ signing_key:
132
+ specification_version: 4
133
+ summary: "..."
134
+ test_files: []