RubyGems - notification-pusher-onesignal - Versions diffs - 3.0.2 → 3.0.3 - Mend

notification-pusher-onesignal 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 (6) hide show

checksums.yaml +4 -4
data/README.md +43 -68
data/lib/notifications-rails.rb +6 -0
metadata +11 -10
data/lib/notification-pusher-onesignal.rb +0 -5
data/lib/notification_pusher/delivery_method/one_signal.rb +0 -38

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c15036170fea471bfcdffbfe6d0942156299783ca6a4585bcdc587bf7df79147
-  data.tar.gz: 2cad4bac934e4be208b38717a538cd3d5c418d11d18547f3f51aa27b9ab7b3db
+  metadata.gz: ae121b953df70ffadd0a49fffeb9a7021a22993725f02f833015f7fda0861466
+  data.tar.gz: 779daa39294bee3fb49a7601bcba73177f6c9d6374c49b0ae8a4e1c9f72eab63
 SHA512:
-  metadata.gz: f3dff691dc7e0024d7774b78cb46e0f28a3e8070b30268260489e50ef479004246413234b95936015d04b3b66a4105d216a27704d0ff80f0e9be4ab97d7ace19
-  data.tar.gz: 420657d2c60d5bc72d82dbfc8c9e199916b95f20f0ac79c58a6e53bd13276eadfbf1cccb82828f565924356b030a1ad6bed54244912d52db830c1a93dc939e06
+  metadata.gz: 5dc12ec76a46e637606b8ac4cf810df238b51bae3cd41e629ecea69d82ddb332568b806a8de0511a86dd12cd025e80f71c1d6910d7e39fe42f838688dea25ac6
+  data.tar.gz: 22641a2181d63da3a2b2747025d290b65ba74adfcef002a57102e0df9ecea320efbb9dd8fdfb769a2060a9e122f5315a0987803d889d25cee4ef589778d31ca0

data/README.md CHANGED

@@ -1,109 +1,84 @@
-# NotificationPusher for OneSignal
+# notifications-rails
-[![Gem Version](https://badge.fury.io/rb/notification-pusher-onesignal.svg)](https://badge.fury.io/rb/notification-pusher-onesignal) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
+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.
-A pusher to send cross-platform notifications with OneSignal.
+## Philosophy
----
+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.
-## Table of Contents
+**[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
-* [Installation](#installation)
-* [Usage](#usage)
-  * [Options](#options)
-* [To Do](#to-do)
-* [Contributing](#contributing)
-  * [Semantic versioning](#semantic-versioning)
+**[notification-renderer](notification-renderer):** Render your notifications in various contexts.
----
+**[notification-pusher](notification-pusher):** Deliver your notifications to various services, including [Email](notification-pusher/notification-pusher-actionmailer) and [OneSignal](notification-pusher/notification-pusher-onesignal).
+**[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
 ## Installation
-NotificationPusher for OneSignal works with Rails 5 onwards. You can add it to your `Gemfile` with:
+You can add notifications-rails to your `Gemfile` with:
 ```ruby
-gem 'notification-pusher-onesignal'
+gem 'notifications-rails'
 ```
-And then execute:
+And then run:
-    $ bundle
+    $ bundle install
 Or install it yourself as:
-    $ gem install notification-pusher-onesignal
----
-## Usage
-Register this delivery method in your `NotificationPusher` configuration:
+    $ gem install notifications-rails
-```ruby
-NotificationPusher.configure do |config|
-  config.register_delivery_method :one_signal, :OneSignal, app_id: 'f158a844-9f3c-4207-b246-e93603b0a970', auth_key: 'kODc3N2ItOTNC00NGzOGYtMzI5OWQ3ZmQ'
-end
-```
-Now you can deliver your notifications through OneSignal:
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 ```ruby
-notification = Notification.create(target: User.first, object: Recipe.first)
-notification.deliver(:one_signal, player_ids: ['f158a844-9f3c-4207-b246-e93603b0a970'], url: Rails.application.routes.url_helpers.root_url, contents: {
-  en: notification.object.title
-})
+gem 'notifications-rails', github: 'jonhue/notifications-rails'
 ```
-To get player id's you could use the [OnSignal](https://github.com/jonhue/onsignal-rails) gem. This is how that would look:
-```ruby
-notification.deliver(:one_signal, player_ids: notification.target.onesignal_player_ids)
-```
-You can also store OneSignal information in your notification opposed to specifying it when pushing:
-```ruby
-notification.metadata[:onesignal_url]      = Rails.application.routes.url_helpers.root_url
-notification.metadata[:onesignal_contents] = { en: 'My notification content' }
-notification.metadata[:onesignal_headings] = { en: 'My notification header' }
-notification.metadata[:onesignal_subtitle] = { en: 'My notification subtitle' }
-notification.save!
-notification.deliver(:one_signal, player_ids: notification.target.onesignal_player_ids)
-```
+## Usage
+Details on usage are provided in the [documentation](#philosophy) of the specific modules.
-### Options
+## Development
-**`app_id` (required)** OneSignal App ID. Takes a string.
+To start development you first have to fork this repository and locally clone your fork.
-**`auth_key` (required)** OneSignal API authentication key. Takes a string.
+Install the projects dependencies by running:
-**`player_ids`** Array of OneSignal Player ID's a notification should be pushed to. Takes an array of strings.
+    $ bundle install
-**`url`** Specify a URL for this notification. Takes a string.
+### Testing
-**`contents`** Globalized content of the notification. Takes a hash with languages as keys and strings as values.
+Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
-**`headings`** Globalized header of the notification. Takes a hash with languages as keys and strings as values.
+To run all tests:
-**`subtitle`** Globalized subtitle of the notification. Takes a hash with languages as keys and strings as values.
+    $ ./rspec
----
+To run RuboCop:
-## To Do
+    $ bundle exec rubocop
-We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/7) to coordinate the work on this project.
+You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
+## Contributing
----
+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).
-## Contributing
+## Releases
-We hope that you will consider contributing to NotificationPusher for OneSignal. Please read this short overview for some information about how to get started:
+[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).
-[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)
+notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
-### Semantic Versioning
+### Publishing
-NotificationPusher for OneSignal follows Semantic Versioning 2.0 as defined at http://semver.org.
+1. Review breaking changes and deprecations in `CHANGELOG.md`.
+1. Change the gem version in `VERSION`.
+1. Reset `CHANGELOG.md`.
+1. Create a pull request to merge the changes into `master`.
+1. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
+1. The release workflow will publish the gems to RubyGems.

data/lib/notifications-rails.rb ADDED

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'notification-handler'
+require 'notification-renderer'
+require 'notification-pusher'
+require 'notification-settings'

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher-onesignal
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notification-pusher
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: one_signal
   requirement: !ruby/object:Gem::Requirement
@@ -136,16 +136,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A pusher to send cross-platform notifications with OneSignal.
-email: me@jonhue.me
+description: A delivery method to send your notifications to devices on all platforms
+  with OneSignal.
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/notification-pusher-onesignal.rb
-- lib/notification_pusher/delivery_method/one_signal.rb
+- lib/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-onesignal
 licenses:
 - MIT
@@ -166,8 +166,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: A pusher to send cross-platform notifications with OneSignal
+summary: A delivery method to send your notifications to devices on all platforms
+  with OneSignal
 test_files: []

data/lib/notification-pusher-onesignal.rb DELETED

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-require 'one_signal'
-require 'notification-pusher'
-require_relative 'notification_pusher/delivery_method/one_signal'

data/lib/notification_pusher/delivery_method/one_signal.rb DELETED

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-module NotificationPusher
-  module DeliveryMethod
-    class OneSignal < NotificationPusher::DeliveryMethod::Base
-      def call
-        return unless options[:player_ids].any?
-        ::OneSignal::Notification.create params: {
-          app_id: options[:app_id],
-          url: url_param,
-          contents: contents_param,
-          headings: headings_param,
-          subtitle: subtitle_param,
-          include_player_ids: options[:player_ids]
-        }, opts: { auth_key: options[:auth_key] }
-      end
-      private
-      def url_param
-        options[:url]      || notification.metadata[:onesignal_url].to_h
-      end
-      def contents_param
-        options[:contents] || notification.metadata[:onesignal_contents].to_h
-      end
-      def headings_param
-        options[:headings] || notification.metadata[:onesignal_headings].to_h
-      end
-      def subtitle_param
-        options[:subtitle] || notification.metadata[:onesignal_subtitle].to_h
-      end
-    end
-  end
-end