notification-handler 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 605a40546c724b10aefb6e030ad0a3b64cfd458fceee2419f442293c9795643d
+  data.tar.gz: 503aba2a31822b0c41e4f729b71a11a74295e013b2b9725260aba0bcdb836570
+SHA512:
+  metadata.gz: be4a36a5335dc8e2022cdac9ae1f0c08a71c8efc35b1f952663c94fe5b2ef0ac7fce08b5e72decd49e2c89c96b265333f237773e2b167f2cdb2321b87acf5b3e
+  data.tar.gz: ff7b244994f2c47a09e5f54485e0a390284daa61ce5c1cf2b6895cdc9228be15731f573d2728ee5fbea89b5c655bdc3e0cf9bc076f7e9a54d4a86208ec91a535

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2017-12-22
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# NotificationHandler
+
+[![Gem Version](https://badge.fury.io/rb/notification-handler.svg)](https://badge.fury.io/rb/notification-handler) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
+
+The most powerful (cross-platform) notifications handler & pusher API for Rails.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+NotificationHandler works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'notification-handler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install notification-handler
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'notification-handler', github: 'jonhue/notifications-rails/tree/master/notification-handler'
+```
+
+Now run the generator:
+
+    $ rails g notification_handler:install
+
+To wrap things up, migrate the changes to your database:
+
+    $ rails db:migrate
+
+---
+
+## Usage
+
+---
+
+## Configuration
+
+You can configure NotificationHandler by passing a block to `configure`. This can be done in `config/initializers/notification-handler.rb`:
+
+```ruby
+NotificationHandler.configure do |config|
+    config.default_type = 'notification'
+end
+```
+
+**`default_type`** Choose your default notification type. Takes a string. Defaults to `'notification'`.
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/notifications-rails/projects/2) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to NotificationHandler. Please read this short overview for some information about how to get started:
+
+[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)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/notifications-rails/graphs/contributors
+
+### Semantic Versioning
+
+NotificationHandler follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/generators/install_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class InstallGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates/install'
+    desc 'Install NotificationHandler'
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % ( current_migration_number(dirname) + 1 )
+        end
+    end
+
+    def create_initializer
+        template 'initializer.rb', 'config/initializers/notification-handler.rb'
+    end
+
+    def create_notifications_migration_file
+        migration_template 'notifications_migration.rb.erb', 'db/migrate/notifications_migration.rb', migration_version: migration_version
+    end
+    def create_notification_model
+        template 'notification_model.rb', 'app/models/notification.rb'
+    end
+
+    def show_readme
+        readme 'README.md'
+    end
+
+    private
+
+    def migration_version
+        if Rails.version >= '5.0.0'
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+
+end

data/generators/templates/install/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add NotificationHandler to your database.

data/generators/templates/install/initializer.rb

@@ -0,0 +1,6 @@
+NotificationHandler.configure do |config|
+
+    # Choose your default notification type. Takes a string.
+    # config.default_type = 'notification'
+
+end

data/generators/templates/install/notification_model.rb

@@ -0,0 +1,9 @@
+class Notification < ActiveRecord::Base
+
+    extend NotificationHandler::Library
+    extend NotificationHandler::Scopes
+
+    belongs_to :target, polymorphic: true
+    belongs_to :object, polymorphic: true
+
+end

data/generators/templates/install/notifications_migration.rb.erb

@@ -0,0 +1,14 @@
+class NotificationsMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        create_table :notifications do |t|
+
+            t.references :target, polymorphic: true, index: true
+            t.references :object, polymorphic: true, index: true
+
+            t.string :type, default: NotificationHandler.configuration.default_type, null: false, index: true
+
+            t.timestamps
+
+        end
+    end
+end

data/generators/type_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class TypeGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates/type'
+    desc 'Create a new notification type'
+    class_option :type, desc: 'Specify the notification type', type: :string, default: NotificationHandler.configuration.default_type, aliases: '-t'
+
+    def create_templates
+        template '_default.html.erb', "app/views/notifications/#{options[:type]}/_default.html.erb"
+        template '_action_cable.html.erb', "app/views/notifications/#{options[:type]}/_action_cable.html.erb" if defined?(NotificationPusher::ActionCable)
+        template '_email.html.erb', "app/views/notifications/#{options[:type]}/_email.html.erb" if defined?(NotificationPusher::Email)
+        template '_one_signal.html.erb', "app/views/notifications/#{options[:type]}/_one_signal.html.erb" if defined?(NotificationPusher::OneSignal)
+    end
+
+end

data/lib/notification_handler/configuration.rb

@@ -0,0 +1,22 @@
+module NotificationHandler
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        attr_accessor :default_type
+
+        def initialize
+            @default_type = 'notification'
+        end
+
+    end
+
+end

data/lib/notification_handler/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module NotificationHandler
+    class Engine < ::Rails::Engine
+    end
+end

data/lib/notification_handler/library.rb

@@ -0,0 +1,9 @@
+module NotificationHandler
+    module Library
+
+        private
+
+        DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base]
+
+    end
+end

data/lib/notification_handler/object.rb

@@ -0,0 +1,23 @@
+module NotificationHandler
+    module Object
+
+        def self.included base
+            base.extend ClassMethods
+        end
+
+        module ClassMethods
+            def notification_object
+                has_many :notifications, as: :object, dependent: :destroy
+                include NotificationHandler::Object::InstanceMethods
+                include NotificationHandler::Library
+            end
+        end
+
+        module InstanceMethods
+
+            # ...
+
+        end
+
+    end
+end

data/lib/notification_handler/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module NotificationHandler
+    class Railtie < Rails::Railtie
+
+        initializer 'notification-handler.active_record' do
+            ActiveSupport.on_load :active_record do
+                include NotificationHandler::Target
+                include NotificationHandler::Object
+            end
+        end
+
+    end
+end

data/lib/notification_handler/scopes.rb

@@ -0,0 +1,7 @@
+module NotificationHandler
+    module Scopes
+
+        # ...
+
+    end
+end

data/lib/notification_handler/target.rb

@@ -0,0 +1,23 @@
+module NotificationHandler
+    module Target
+
+        def self.included base
+            base.extend ClassMethods
+        end
+
+        module ClassMethods
+            def notification_target
+                has_many :notifications, as: :target, dependent: :destroy
+                include NotificationHandler::Target::InstanceMethods
+                include NotificationHandler::Library
+            end
+        end
+
+        module InstanceMethods
+
+            # ...
+
+        end
+
+    end
+end

data/lib/notification_handler.rb

@@ -0,0 +1,14 @@
+module NotificationHandler
+
+    require 'notification_handler/configuration'
+
+    # require 'notification_handler/engine'
+
+    autoload :Target, 'notification_handler/target'
+    autoload :Object, 'notification_handler/object'
+    autoload :Library, 'notification_handler/library'
+    autoload :Scopes, 'notification_handler/scopes'
+
+    require 'notification_handler/railtie'
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: notification-handler
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: "..."
+email: jonas.huebotter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- generators/install_generator.rb
+- generators/templates/install/README.md
+- generators/templates/install/initializer.rb
+- generators/templates/install/notification_model.rb
+- generators/templates/install/notifications_migration.rb.erb
+- generators/templates/type/_action_cable.html.erb
+- generators/templates/type/_default.html.erb
+- generators/templates/type/_email.html.erb
+- generators/templates/type/_one_signal.html.erb
+- generators/type_generator.rb
+- lib/notification_handler.rb
+- lib/notification_handler/configuration.rb
+- lib/notification_handler/engine.rb
+- lib/notification_handler/library.rb
+- lib/notification_handler/object.rb
+- lib/notification_handler/railtie.rb
+- lib/notification_handler/scopes.rb
+- lib/notification_handler/target.rb
+homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-handler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: "..."
+test_files: []