notifications-rails 1.2.4 → 3.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -21
  3. data/README.md +84 -109
  4. data/lib/notifications-rails.rb +6 -4
  5. metadata +100 -46
  6. data/INSTALL.md +0 -14
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e1aaab0ff99681c22bdbeca6c6763b15e50a2880a79bc55ac23bbd6d7fc0c08
4
- data.tar.gz: df212944d884605e5ab5543b18e90b9e34f2d6faa62ca678c94853f9c5ea7227
3
+ metadata.gz: 68709090e0f368917cc99f20067aa5e25e014d0b1dbda3ccb226883aabda5e41
4
+ data.tar.gz: 3051e71df8295ed08917f8d93f7bb0226a3f6ebf2e381614a8df3794dbd85766
5
5
  SHA512:
6
- metadata.gz: 0061226ceb86f0ae0709fbdf45683a94cf73aa794b9360c020f5c8972a75f661443d47156e95432b9961c0f38c9dc0a4f11cbc3984b4256397820957c767a155
7
- data.tar.gz: 801bd4b5d04473d49816993e3d9904e9247b8f356014c3b5d235bf2167d117b32ef1b41fe898eaa4b3af52ec3b6d2dfce032e6383b34fb998b98120e6f3e9e72
6
+ metadata.gz: ee5a33f3ec5c5cde9c2b26d98bc979a581c2fbadbd4dcf8c69c855a686794c18da7fec5f1449a602f0f0d30c785fce9870eac70ab0c2e46ff3b8e9d8cb5f78dc
7
+ data.tar.gz: 900ca2cf6630e06fb6c533ffcfc93e831981b8bff9c8da9fc9eb44502954438bdb0fcf5ab1042dfa06d4d3baa2910a541304f967f98e35a1a51d11606a485f9b
data/LICENSE CHANGED
@@ -1,21 +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.
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 CHANGED
@@ -1,109 +1,84 @@
1
- # NotificationsRails
2
-
3
- [![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" />
4
-
5
- The most powerful notification solution for Rails. NotificationsRails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
6
-
7
- It integrates with the [Native](https://github.com/NativeGap/native-rails) gem to allow you to create a cross platform Rails app.
8
-
9
- ---
10
-
11
- ## Table of Contents
12
-
13
- * [Philosophy](#philosophy)
14
- * [Installation](#installation)
15
- * [To Do](#to-do)
16
- * [Contributing](#contributing)
17
- * [Contributors](#contributors)
18
- * [Semantic versioning](#semantic-versioning)
19
- * [License](#license)
20
-
21
- ---
22
-
23
- ## Philosophy
24
-
25
- 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.
26
-
27
- **[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
28
-
29
- **[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
30
-
31
- **[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher/notification-pusher-actionmailer), [ActionCable](notification-pusher/notification-pusher-actioncable), [OneSignal](notification-pusher/notification-pusher-onesignal).
32
-
33
- **[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
34
-
35
- You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
36
-
37
- ---
38
-
39
- ## Installation
40
-
41
- NotificationsRails works with Rails 5 onwards. You can add it to your `Gemfile` with:
42
-
43
- ```ruby
44
- gem 'notifications-rails'
45
- ```
46
-
47
- And then execute:
48
-
49
- $ bundle
50
-
51
- Or install it yourself as:
52
-
53
- $ gem install notifications-rails
54
-
55
- If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
56
-
57
- ```ruby
58
- gem 'notifications-rails', github: 'jonhue/notifications-rails'
59
- ```
60
-
61
- ---
62
-
63
- ## To Do
64
-
65
- [Here](https://github.com/jonhue/notifications-rails/projects) is the full list of current projects.
66
-
67
- To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
68
-
69
- ---
70
-
71
- ## Contributing
72
-
73
- We hope that you will consider contributing to NotificationsRails. Please read this short overview for some information about how to get started:
74
-
75
- [Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
76
-
77
- ### Contributors
78
-
79
- Give the people some :heart: who are working on this project. See them all at:
80
-
81
- https://github.com/jonhue/notifications-rails/graphs/contributors
82
-
83
- ### Semantic Versioning
84
-
85
- NotificationsRails follows Semantic Versioning 2.0 as defined at http://semver.org.
86
-
87
- ## License
88
-
89
- MIT License
90
-
91
- Copyright (c) 2017 Jonas Hübotter
92
-
93
- Permission is hereby granted, free of charge, to any person obtaining a copy
94
- of this software and associated documentation files (the "Software"), to deal
95
- in the Software without restriction, including without limitation the rights
96
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
97
- copies of the Software, and to permit persons to whom the Software is
98
- furnished to do so, subject to the following conditions:
99
-
100
- The above copyright notice and this permission notice shall be included in all
101
- copies or substantial portions of the Software.
102
-
103
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
104
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
105
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
106
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
107
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
108
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
109
- SOFTWARE.
1
+ # notifications-rails
2
+
3
+ notifications-rails is the most powerful notification library for Rails. It offers not only simple APIs to create and render notifications but also supports user-integration and cross-platform delivery of notifications.
4
+
5
+ ## Philosophy
6
+
7
+ notifications-rails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the integration of notifications in your Rails app.
8
+
9
+ **[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
10
+
11
+ **[notification-renderer](notification-renderer):** Render your notifications in various contexts.
12
+
13
+ **[notification-pusher](notification-pusher):** Deliver your notifications to various services, including [Email](notification-pusher/notification-pusher-actionmailer) and [OneSignal](notification-pusher/notification-pusher-onesignal).
14
+
15
+ **[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
16
+
17
+ You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
18
+
19
+ ## Installation
20
+
21
+ You can add notifications-rails to your `Gemfile` with:
22
+
23
+ ```ruby
24
+ gem 'notifications-rails'
25
+ ```
26
+
27
+ And then run:
28
+
29
+ $ bundle install
30
+
31
+ Or install it yourself as:
32
+
33
+ $ gem install notifications-rails
34
+
35
+ If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
36
+
37
+ ```ruby
38
+ gem 'notifications-rails', github: 'jonhue/notifications-rails'
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ Details on usage are provided in the [documentation](#philosophy) of the specific modules.
44
+
45
+ ## Development
46
+
47
+ To start development you first have to fork this repository and locally clone your fork.
48
+
49
+ Install the projects dependencies by running:
50
+
51
+ $ bundle install
52
+
53
+ ### Testing
54
+
55
+ Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
56
+
57
+ To run all tests:
58
+
59
+ $ ./rspec
60
+
61
+ To run RuboCop:
62
+
63
+ $ bundle exec rubocop
64
+
65
+ You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
66
+
67
+ ## Contributing
68
+
69
+ We warmly welcome everyone who is intersted in contributing. Please reference our [contributing guidelines](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
70
+
71
+ ## Releases
72
+
73
+ [Here](https://github.com/jonhue/notifications-rails/releases) you can find details on all past releases. Unreleased breaking changes that are on the current master can be found [here](CHANGELOG.md).
74
+
75
+ notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
76
+
77
+ ### Publishing
78
+
79
+ 1. Review breaking changes and deprecations in `CHANGELOG.md`.
80
+ 1. Change the gem version in `VERSION`.
81
+ 1. Reset `CHANGELOG.md`.
82
+ 1. Create a pull request to merge the changes into `master`.
83
+ 1. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
84
+ 1. The release workflow will publish the gems to RubyGems.
data/lib/notifications-rails.rb CHANGED
@@ -1,4 +1,6 @@
1
- require 'notification-handler'
2
- require 'notification-renderer'
3
- require 'notification-pusher'
4
- require 'notification-settings'
1
+ # frozen_string_literal: true
2
+
3
+ require 'notification-handler'
4
+ require 'notification-renderer'
5
+ require 'notification-pusher'
6
+ require 'notification-settings'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: notifications-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.4
4
+ version: 3.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonas Hübotter
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-03-17 00:00:00.000000000 Z
11
+ date: 2020-12-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: notification-handler
@@ -16,93 +16,162 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 1.2.4
19
+ version: 3.0.3
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 1.2.4
26
+ version: 3.0.3
27
27
  - !ruby/object:Gem::Dependency
28
- name: notification-renderer
28
+ name: notification-pusher
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 1.2.4
33
+ version: 3.0.3
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 1.2.4
40
+ version: 3.0.3
41
41
  - !ruby/object:Gem::Dependency
42
- name: notification-pusher
42
+ name: notification-renderer
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - '='
46
46
  - !ruby/object:Gem::Version
47
- version: 1.2.4
47
+ version: 3.0.3
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - '='
53
53
  - !ruby/object:Gem::Version
54
- version: 1.2.4
54
+ version: 3.0.3
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: notification-settings
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - '='
60
60
  - !ruby/object:Gem::Version
61
- version: 1.2.4
61
+ version: 3.0.3
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - '='
67
67
  - !ruby/object:Gem::Version
68
- version: 1.2.4
68
+ version: 3.0.3
69
+ - !ruby/object:Gem::Dependency
70
+ name: factory_bot
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
69
83
  - !ruby/object:Gem::Dependency
70
- name: rspec
84
+ name: pry
71
85
  requirement: !ruby/object:Gem::Requirement
72
86
  requirements:
73
- - - "~>"
87
+ - - ">="
74
88
  - !ruby/object:Gem::Version
75
- version: '3.7'
89
+ version: '0'
76
90
  type: :development
77
91
  prerelease: false
78
92
  version_requirements: !ruby/object:Gem::Requirement
79
93
  requirements:
80
- - - "~>"
94
+ - - ">="
81
95
  - !ruby/object:Gem::Version
82
- version: '3.7'
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rails
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rspec-rails
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
83
125
  - !ruby/object:Gem::Dependency
84
126
  name: rubocop
85
127
  requirement: !ruby/object:Gem::Requirement
86
128
  requirements:
87
- - - "~>"
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop-rspec
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: sqlite3
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
88
158
  - !ruby/object:Gem::Version
89
- version: '0.52'
159
+ version: '0'
90
160
  type: :development
91
161
  prerelease: false
92
162
  version_requirements: !ruby/object:Gem::Requirement
93
163
  requirements:
94
- - - "~>"
164
+ - - ">="
95
165
  - !ruby/object:Gem::Version
96
- version: '0.52'
97
- description: The most powerful notification solution for Rails. NotificationsRails
98
- simplifies the handling, rendering, user-integration and cross-platform pushing
99
- of notifications through its simple API.
100
- email: me@jonhue.me
166
+ version: '0'
167
+ description: notifications-rails is the most powerful notification library for Rails.
168
+ It offers not only simple APIs to create and render notifications but also supports
169
+ user-integration and cross-platform delivery of notifications.
170
+ email: jonas.huebotter@gmail.com
101
171
  executables: []
102
172
  extensions: []
103
173
  extra_rdoc_files: []
104
174
  files:
105
- - INSTALL.md
106
175
  - LICENSE
107
176
  - README.md
108
177
  - lib/notifications-rails.rb
@@ -110,21 +179,7 @@ homepage: https://github.com/jonhue/notifications-rails
110
179
  licenses:
111
180
  - MIT
112
181
  metadata: {}
113
- post_install_message: |
114
- **Thank you for installing NotificationsRails!**
115
-
116
-
117
- To wrap up installing NotificationsRails, run the generators to install each component.
118
-
119
- ```
120
- rails g notification_handler:install
121
- rails g notification_renderer:install
122
- rails g notification_pusher:install
123
- rails g notification_settings:install
124
- ```
125
-
126
-
127
- Learn more at https://github.com/jonhue/notifications-rails
182
+ post_install_message:
128
183
  rdoc_options: []
129
184
  require_paths:
130
185
  - lib
@@ -132,17 +187,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
132
187
  requirements:
133
188
  - - ">="
134
189
  - !ruby/object:Gem::Version
135
- version: '2.3'
190
+ version: '2.5'
136
191
  required_rubygems_version: !ruby/object:Gem::Requirement
137
192
  requirements:
138
193
  - - ">="
139
194
  - !ruby/object:Gem::Version
140
195
  version: '0'
141
196
  requirements: []
142
- rubyforge_project:
143
- rubygems_version: 2.7.4
197
+ rubygems_version: 3.1.4
144
198
  signing_key:
145
199
  specification_version: 4
146
- summary: The most powerful (cross-platform) notifications handler & pusher API for
147
- Rails
200
+ summary: The most powerful library for the handling and (cross-platform) delivery
201
+ of notifications with Rails
148
202
  test_files: []
data/INSTALL.md DELETED
@@ -1,14 +0,0 @@
1
- **Thank you for installing NotificationsRails!**
2
-
3
-
4
- To wrap up installing NotificationsRails, run the generators to install each component.
5
-
6
- ```
7
- rails g notification_handler:install
8
- rails g notification_renderer:install
9
- rails g notification_pusher:install
10
- rails g notification_settings:install
11
- ```
12
-
13
-
14
- Learn more at https://github.com/jonhue/notifications-rails