notifications-rails 2.0.0 → 4.0.0

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.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +36 -62
  3. metadata +32 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c00f58505ef2af495a1e7c3ce279bffd43492c49e9436600961f75dd6bd7fd7c
4
- data.tar.gz: 6b2db9ec719f45cab30007e2cbbcede8d86b392bcb3cb8924f63bd9ab6736684
3
+ metadata.gz: 58698097fc5326cfec6695f7f83c4028f2ece2356f42271b5fb2e1a887c92538
4
+ data.tar.gz: feead0c94b1473562e151265960bf9768481cd3bca1fbdcf8d4526a0e7fe583a
5
5
  SHA512:
6
- metadata.gz: 6e1df29020f66bd52c77b8cbc90e3c03fc9677d3b4e47dbfe7af3d7d61babd343a346681c8b7e462667bad7c0789d29c38460b18d27d3438a703db299982a885
7
- data.tar.gz: a1779c54826365c2a35599d5795e8e717fd8f0a81a976f9eb14401e784ab4462af03bd5b38c5385eea5c8493a382901a45c3b0258414dcdc56415b6d816e646b
6
+ metadata.gz: 983209e83e188962b074ced7990262a6bfd54570ed33ed716f8f1bf2d7f9a5ed7afa1fee623394778b38886ce0e5cc357a5fa43266559f101b85868bc6d17f9f
7
+ data.tar.gz: 47e91a2b47b02e32bed402caccbafe8a3c73b9e61e52bc34361abb39734511905ef29a5a9cd538a3e17184ef379d7aa914c025033c8eecac26b78d286751b70c
data/README.md CHANGED
@@ -1,50 +1,32 @@
1
- # Notifications Rails
1
+ # notifications-rails
2
2
 
3
- [![Gem Version](https://badge.fury.io/rb/notifications-rails.svg)](https://badge.fury.io/rb/notifications-rails) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
4
-
5
- The most powerful notification solution for Rails. Notifications Rails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
6
-
7
- ---
8
-
9
- ## Table of Contents
10
-
11
- * [Philosophy](#philosophy)
12
- * [Installation](#installation)
13
- * [Testing](#testing)
14
- * [Release](#release)
15
- * [To do](#to-do)
16
- * [Contributing](#contributing)
17
- * [Semantic versioning](#semantic-versioning)
18
-
19
- ---
3
+ A flexible notification library supporting the delivery to external services, rendering in various environments, and user configuration by category.
20
4
 
21
5
  ## Philosophy
22
6
 
23
- Notifications Rails 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.
24
-
25
- **[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
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.
26
8
 
27
- **[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
9
+ **[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
28
10
 
29
- **[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher/notification-pusher-actionmailer) & [OneSignal](notification-pusher/notification-pusher-onesignal).
11
+ **[notification-renderer](notification-renderer):** Render your notifications in various contexts.
30
12
 
31
- **[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
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).
32
14
 
33
- You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
15
+ **[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
34
16
 
35
- ---
17
+ You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
36
18
 
37
19
  ## Installation
38
20
 
39
- Notifications Rails works with Rails 5 onwards. You can add it to your `Gemfile` with:
21
+ You can add notifications-rails to your `Gemfile` with:
40
22
 
41
23
  ```ruby
42
24
  gem 'notifications-rails'
43
25
  ```
44
26
 
45
- And then execute:
27
+ And then run:
46
28
 
47
- $ bundle
29
+ $ bundle install
48
30
 
49
31
  Or install it yourself as:
50
32
 
@@ -56,55 +38,47 @@ If you always want to be up to date fetch the latest from GitHub in your `Gemfil
56
38
  gem 'notifications-rails', github: 'jonhue/notifications-rails'
57
39
  ```
58
40
 
59
- ---
60
-
61
- ## Testing
41
+ ## Usage
62
42
 
63
- Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
64
-
65
- 1. Fork this repository
66
- 2. Clone your forked git locally
67
- 3. Install dependencies
68
-
69
- `$ bundle install`
70
-
71
- 4. Run tests
43
+ Details on usage are provided in the [documentation](#philosophy) of the specific modules.
72
44
 
73
- `$ scripts/rspec`
45
+ ## Development
74
46
 
75
- 5. Run RuboCop
47
+ To start development you first have to fork this repository and locally clone your fork.
76
48
 
77
- `$ bundle exec rubocop`
49
+ Install the projects dependencies by running:
78
50
 
79
- ---
51
+ $ bundle install
80
52
 
81
- ## Release
53
+ ### Testing
82
54
 
83
- 1. Review breaking changes and deprecations in CHANGELOG.md
84
- 2. Change the gem version [here](VERSION)
85
- 3. Publish to https://rubygems.org
55
+ Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
86
56
 
87
- `$ release <version>`
57
+ To run all tests:
88
58
 
89
- 4. Create a new release and include breaking changes and deprecations from CHANGELOG.md
90
- 5. Reset CHANGELOG.md
59
+ $ ./rspec
91
60
 
92
- ---
61
+ To run RuboCop:
93
62
 
94
- ## To do
63
+ $ bundle exec rubocop
95
64
 
96
- We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/9) to coordinate the work on this project.
65
+ You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
97
66
 
98
- To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
67
+ ## Contributing
99
68
 
100
- ---
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).
101
70
 
102
- ## Contributing
71
+ ## Releases
103
72
 
104
- We hope that you will consider contributing to Notifications Rails. Please read this short overview for some information about how to get started:
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).
105
74
 
106
- [Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
75
+ notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
107
76
 
108
- ### Semantic Versioning
77
+ ### Publishing
109
78
 
110
- Notifications Rails follows Semantic Versioning 2.0 as defined at http://semver.org.
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.
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: 2.0.0
4
+ version: 4.0.0
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: 2019-06-04 00:00:00.000000000 Z
11
+ date: 2022-04-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: notification-handler
@@ -16,56 +16,56 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 2.0.0
19
+ version: 4.0.0
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: 2.0.0
26
+ version: 4.0.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: notification-pusher
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 2.0.0
33
+ version: 4.0.0
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: 2.0.0
40
+ version: 4.0.0
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: notification-renderer
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - '='
46
46
  - !ruby/object:Gem::Version
47
- version: 2.0.0
47
+ version: 4.0.0
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: 2.0.0
54
+ version: 4.0.0
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: 2.0.0
61
+ version: 4.0.0
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: 2.0.0
68
+ version: 4.0.0
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: factory_bot
71
71
  requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
136
136
  - - ">="
137
137
  - !ruby/object:Gem::Version
138
138
  version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop-rails
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'
139
153
  - !ruby/object:Gem::Dependency
140
154
  name: rubocop-rspec
141
155
  requirement: !ruby/object:Gem::Requirement
@@ -164,10 +178,10 @@ dependencies:
164
178
  - - ">="
165
179
  - !ruby/object:Gem::Version
166
180
  version: '0'
167
- description: The most powerful notification solution for Rails. Notifications Rails
168
- simplifies the handling, rendering, user-integration and cross-platform pushing
169
- of notifications through its simple API.
170
- email: me@jonhue.me
181
+ description: notifications-rails is the most powerful notification library for Rails.
182
+ It offers not only simple APIs to create and render notifications but also supports
183
+ user-integration and cross-platform delivery of notifications.
184
+ email: jonas.huebotter@gmail.com
171
185
  executables: []
172
186
  extensions: []
173
187
  extra_rdoc_files: []
@@ -187,16 +201,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
187
201
  requirements:
188
202
  - - ">="
189
203
  - !ruby/object:Gem::Version
190
- version: '2.3'
204
+ version: '2.7'
191
205
  required_rubygems_version: !ruby/object:Gem::Requirement
192
206
  requirements:
193
207
  - - ">="
194
208
  - !ruby/object:Gem::Version
195
209
  version: '0'
196
210
  requirements: []
197
- rubygems_version: 3.0.3
211
+ rubygems_version: 3.3.7
198
212
  signing_key:
199
213
  specification_version: 4
200
- summary: The most powerful (cross-platform) notifications handler & pusher API for
201
- Rails
214
+ summary: The most powerful library for the handling and (cross-platform) delivery
215
+ of notifications with Rails
202
216
  test_files: []