notifications-rails 3.0.2 → 3.0.3

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 -60
  3. metadata +18 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fa70738c1147aab6ca2e301b45a6ae977795b08e3c018d6ff77a0e9af3b481ac
4
- data.tar.gz: 58d4e6d3ebf2ac3ee75eefe001dccab6bddc744b912387cb775b54349ccd4e98
3
+ metadata.gz: 68709090e0f368917cc99f20067aa5e25e014d0b1dbda3ccb226883aabda5e41
4
+ data.tar.gz: 3051e71df8295ed08917f8d93f7bb0226a3f6ebf2e381614a8df3794dbd85766
5
5
  SHA512:
6
- metadata.gz: 9e515df1f12a5ab9981c275281ddddcbf2123a1097d1c9c9e32ddd75b5e5897403fc930da07b38683ac2f6aa66a1095dcb6cb5dd9c2fbc6a1418cd7dd98421cd
7
- data.tar.gz: 65bb52cda9715b0438e1e51acf98d0435ce325a578404fc574bb8656d9a5e105d67e0d59217edd71f85ab0d5a4eda8f559154abf5fa8a1219b3ae5faa1a7f2f0
6
+ metadata.gz: ee5a33f3ec5c5cde9c2b26d98bc979a581c2fbadbd4dcf8c69c855a686794c18da7fec5f1449a602f0f0d30c785fce9870eac70ab0c2e46ff3b8e9d8cb5f78dc
7
+ data.tar.gz: 900ca2cf6630e06fb6c533ffcfc93e831981b8bff9c8da9fc9eb44502954438bdb0fcf5ab1042dfa06d4d3baa2910a541304f967f98e35a1a51d11606a485f9b
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
+ 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.
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,53 +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
- ---
41
+ ## Usage
60
42
 
61
- ## Testing
43
+ Details on usage are provided in the [documentation](#philosophy) of the specific modules.
62
44
 
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`
45
+ ## Development
70
46
 
71
- 4. Run tests
47
+ To start development you first have to fork this repository and locally clone your fork.
72
48
 
73
- `$ ./rspec`
49
+ Install the projects dependencies by running:
74
50
 
75
- 5. Run RuboCop
51
+ $ bundle install
76
52
 
77
- `$ bundle exec rubocop`
53
+ ### Testing
78
54
 
79
- ---
55
+ Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
80
56
 
81
- ## Release
57
+ To run all tests:
82
58
 
83
- 1. Review breaking changes and deprecations in CHANGELOG.md
84
- 2. Change the gem version [here](VERSION)
85
- 3. Reset CHANGELOG.md
86
- 4. Create a pull request to merge the changes into `master`
87
- 5. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
88
- 6. The release workflow will publish the gems to RubyGems and the GitHub Package Registry
59
+ $ ./rspec
89
60
 
90
- ---
61
+ To run RuboCop:
91
62
 
92
- ## To do
63
+ $ bundle exec rubocop
93
64
 
94
- 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`.
95
66
 
96
- To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
67
+ ## Contributing
97
68
 
98
- ---
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).
99
70
 
100
- ## Contributing
71
+ ## Releases
101
72
 
102
- 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).
103
74
 
104
- [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).
105
76
 
106
- ### Semantic Versioning
77
+ ### Publishing
107
78
 
108
- 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: 3.0.2
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: 2019-10-10 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,56 +16,56 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 3.0.2
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: 3.0.2
26
+ version: 3.0.3
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: 3.0.2
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: 3.0.2
40
+ version: 3.0.3
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: 3.0.2
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: 3.0.2
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: 3.0.2
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: 3.0.2
68
+ version: 3.0.3
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: factory_bot
71
71
  requirement: !ruby/object:Gem::Requirement
@@ -164,10 +164,10 @@ dependencies:
164
164
  - - ">="
165
165
  - !ruby/object:Gem::Version
166
166
  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
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
171
171
  executables: []
172
172
  extensions: []
173
173
  extra_rdoc_files: []
@@ -187,16 +187,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
187
187
  requirements:
188
188
  - - ">="
189
189
  - !ruby/object:Gem::Version
190
- version: '2.3'
190
+ version: '2.5'
191
191
  required_rubygems_version: !ruby/object:Gem::Requirement
192
192
  requirements:
193
193
  - - ">="
194
194
  - !ruby/object:Gem::Version
195
195
  version: '0'
196
196
  requirements: []
197
- rubygems_version: 3.0.3
197
+ rubygems_version: 3.1.4
198
198
  signing_key:
199
199
  specification_version: 4
200
- summary: The most powerful (cross-platform) notifications handler & pusher API for
201
- Rails
200
+ summary: The most powerful library for the handling and (cross-platform) delivery
201
+ of notifications with Rails
202
202
  test_files: []