notification-pusher-onesignal 2.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e0d569e256c162ee1e9ec709b2a324a6371da9dda921377ffb8221edcbe4e9f
-  data.tar.gz: b228cbdeacaf05e420b4ae32774703f654f4d64f53810d57aa80529a071c017f
+  metadata.gz: c4a7571c13dff52d7dd4db1fdb9e24372e4f9b2a5a60b9dfbd80677d0e1257f8
+  data.tar.gz: adcfa042e05403dc2a0afdce6d0c274dbce61275886505a21dac5c2355fda780
 SHA512:
-  metadata.gz: 236b9a2b53d1547a0316b386e3cbe975b13bc641e551bb2a61168685810850cb6d4d8ac63e08f31bcaa57b9740ac57ea04bfedccb0a5a3b53d72047dd569689f
-  data.tar.gz: 51a5fadd33ca0e67d92136741cc8a2da7751ae7275cf645aa2a99cfdfdfa502f23fc572ee2c08557c8e3c86b40f797f9e50821ca009b73ee9abb7dfafb40b582
+  metadata.gz: 487d9e91b85b13346780f5b6035592d0c8d8ecb67476803ad78f19f03baabcf5b6dfdb26bc89bb114189ca9af821e66fb60aeb412743e248d36db90e3d0fe6c3
+  data.tar.gz: 8267a103a8cbf1a5fc171c7dddf24a1e5d9d6b31cc1a87d588ad245942f6b829b697df0c9479f773e99c971b969bd12c5cdfab307282d33e4d81d9cbc3896403

data/README.md

@@ -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)
+A flexible notification library supporting the delivery to external services, rendering in various environments, and user configuration by category.
 
-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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher-onesignal
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notification-pusher
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: one_signal
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +136,21 @@ 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
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/jonhue/notifications-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -158,15 +159,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 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

@@ -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

@@ -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