real_notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e1d6846f0fe0a2aa6a5ff726a6cbc65ddbb210e
+  data.tar.gz: e82c569a8db9071327d8b3ba4c0e4d831be01ce5
+SHA512:
+  metadata.gz: b3fee230a8badf0a556d228f404f877e53459e5e82a65d841f71bbaeacb1d6ad836991c8df803e99919e5f34d84069443f2778944beaf3b1f3e0a0ab9a9c5a0b
+  data.tar.gz: 3b1b4dc0da5840b412739c663cb88b851f29a67bb882942e13b250c6af12084436041426c3094908acae6b61fe244a8216180de52a0f46b7648adb9ea5ac0cf0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at abhishek.kanojia@vinsol.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in real_notification.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abhishek Kanojia
+
+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,134 @@
+# RealNotification
+
+Real Notification provides send push notification functionality to your rails application using action cable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'real_notification'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install real_notification
+
+## Usage
+
+Create a channel to broadcast notifications on. Real Notification provides a generator to do so.
+
+```ruby
+ rails generate real_notification:channel WebNotifications
+```
+This will generate a channel `channel/web_notifications.rb` and `web_notifications.js`
+
+**Note: If you do not supply name of channel Name of channel is 'notification' by default.**
+
+In your `application.scss`, Add following line:
+```ruby
+*= require notification
+```
+In your `application.js`, Add following line:
+```ruby
+//= require real_notification
+//= require bootstrap.min
+```
+Since this gem uses bootstrap alert make sure to install it as well. Here's how to:
+[How to install bootstrap and jquery to Rails ?](https://medium.com/@abhishek.kanojia/how-to-add-bootstrap-and-jquery-to-rails-application-ec18a89805e5)
+
+Include notification partial on your page.
+
+```ruby
+    <%= render partial: 'shared/notification' %>
+```
+**Start redis-server using command `redis-server`**
+
+Change cable adapter for your environment. `config/cable.yml`
+
+    development:
+      adapter: redis
+      url: redis://localhost:6379/1
+
+    test:
+      adapter: async
+
+    production:
+      adapter: redis
+      url: redis://localhost:6379/1
+
+### Start sending notifications:
+
+Real notification provides `broadcast_notification` class method that can be used with any model class. for example:
+```ruby
+    User.broadcast_notification({ title: 'New User', message: 'Hi from new user' })
+```
+
+Default channel: `'notification_channel'` if you don't supply channel name.
+
+```ruby
+    User.broadcast_notification('web_notifications_channel', { title: 'New User', message: 'Hi from new user' })
+```
+See `web_notifications.js`
+
+    /* globals App */
+    /* globals RealNotification */
+
+    App.web_notifications = App.cable.subscriptions.create("WebNotificationsChannel", {
+      connected: function() {
+        console.log('Notification Channel connected.');
+      },
+
+      disconnected: function() {
+        console.log('Notification Channel disconnected.');
+      },
+
+      received: function(data) {
+        var notification = new RealNotification({
+          delay: 7000, // default hide notification delay is 6000
+          position: 'top' // default position is top-right see available options below
+        });
+        notification.show(data);
+      }
+    });
+
+    /*
+
+      Available positions options are:
+
+      top : notification will be placed in middle top of screen.
+
+      top-left : notification will be placed in top left corner of screen.
+
+      top-right : notification will be placed in top left corner of screen.
+
+      bottom : notification will be placed in middle bottom of screen.
+
+      bottom-left : notification will be placed in bottom left corner of screen.
+
+      bottom-right : notification will be placed in bottom right corner of screen.
+
+    */
+
+#### Change position of notification and delay time using provided options:
+`delay:` autohide delay in milliseconds default to 6000. i.e 6 seconds.
+`position:` position of notification on screen, default is 'top-right'.
+
+### Notification Preview
+![real_notification](https://github.com/abhikanojia/images/blob/master/real_notification/real_notification.png?raw=true)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhikanojia/real_notification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RealNotification project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abhikanojia/real_notification/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/views/shared/_notification.html.erb

@@ -0,0 +1,5 @@
+<div class="alert alert-success alert-dismissible fade in" id="real-notification" data-notification='real-notification'>
+  <button class="close" data-dismiss="alert" aria-label="close">&times;</button>
+  <strong id="title">Alert!</strong>
+  <span id="message">This is new message</span>
+</div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "real_notification"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/real_notification/channel/channel_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/base'
+
+module RealNotification
+  module Generators
+    class ChannelGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../prototypes/', __FILE__)
+
+      argument :channel_name, type: :string, default: 'notification'
+
+      def create_channel_file
+        template "notification_channel.rb", "app/channels/#{file_name}_channel.rb"
+      end
+
+      def create_coffee_script
+        template "notification.js", "app/assets/javascripts/channels/#{file_name}.js"
+      end
+
+      private
+
+        def file_name
+          channel_name.underscore
+        end
+
+        def class_name_for_file
+          channel_name.underscore.downcase.split('_').map(&:capitalize).join
+        end
+    end
+  end
+end

data/lib/generators/real_notification/channel/prototypes/notification.js

@@ -0,0 +1,38 @@
+/* globals App */
+/* globals RealNotification */
+
+App.<%=file_name %> = App.cable.subscriptions.create("<%= class_name_for_file %>Channel", {
+  connected: function() {
+    console.log('Notification Channel connected.');
+  },
+
+  disconnected: function() {
+    console.log('Notification Channel disconnected.');
+  },
+
+  received: function(data) {
+    var notification = new RealNotification({
+      delay: 7000, // default hide notification delay is 6000
+      position: 'top' // default position is top-right see available options below
+    });
+    notification.show(data);
+  }
+});
+
+/*
+
+  Available positions options are:
+
+  top : notification will be placed in middle top of screen.
+
+  top-left : notification will be placed in top left corner of screen.
+
+  top-right : notification will be placed in top left corner of screen.
+
+  bottom : notification will be placed in middle bottom of screen.
+
+  bottom-left : notification will be placed in bottom left corner of screen.
+
+  bottom-right : notification will be placed in bottom right corner of screen.
+
+*/

data/lib/generators/real_notification/channel/prototypes/notification_channel.rb

@@ -0,0 +1,5 @@
+class <%= class_name_for_file %>Channel < ApplicationCable::Channel
+  def subscribed
+    stream_from "<%= file_name %>_channel"
+  end
+end

data/lib/real_notification.rb

@@ -0,0 +1,8 @@
+require "real_notification/version"
+require "real_notification/notification_helper" if defined? ActiveRecord::Base
+
+module RealNotification
+  module Rails
+    require 'real_notification/engine'
+  end
+end

data/lib/real_notification/engine.rb

@@ -0,0 +1,6 @@
+module RealNotification
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/real_notification/notification_helper.rb

@@ -0,0 +1,7 @@
+module NotificationHelper
+  def broadcast_notification(channel_name = 'notification_channel', data)
+    ActionCable.server.broadcast channel_name, data
+  end
+end
+
+ActiveRecord::Base.send :extend, NotificationHelper

data/lib/real_notification/version.rb

@@ -0,0 +1,3 @@
+module RealNotification
+  VERSION = "0.1.0"
+end

data/real_notification.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "real_notification/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "real_notification"
+  spec.version       = RealNotification::VERSION
+  spec.authors       = ["Abhishek Kanojia"]
+  spec.email         = ["abhishek.kanojia3193@gmail.com"]
+
+  spec.summary       = %q{ Real Notification provided push notification using action cable for rails application. }
+  spec.description   = %q{ Real Notification provided push notification using action cable for rails application. }
+  spec.homepage      = 'https://github.com/abhikanojia/real_notification'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'bootstrap-sass', '~> 3.3', '>= 3.3.7'
+  spec.add_dependency 'jquery-rails', '~> 4.3', '>= 4.3.3'
+  spec.add_dependency 'redis', '~> 4.0'
+end

data/vendor/assets/javascripts/real_notification.js

@@ -0,0 +1,61 @@
+function RealNotification(data) {
+  this.notificationDiv       = $('[data-notification=real-notification]');
+  this.notificationTitle     = this.notificationDiv.find('#title');
+  this.notificationMessage   = this.notificationDiv.find('#message');
+  this.setOptions(data);
+}
+
+RealNotification.prototype.setOptions = function(data) {
+  this.notificationHideDelay = (data && data.delay) ? data.delay : 6000;
+  this.notificationPosition  = (data && data.position) ? data.position : 'top-right';
+};
+
+RealNotification.prototype.CSS_CLASSES = {
+  top         : 'notification-top',
+  bottom      : 'notification-bottom',
+  topLeft     : 'notification-top-left',
+  topRight    : 'notification-top-right',
+  bottomLeft  : 'notification-bottom-left',
+  bottomRight : 'notification-bottom-right'
+};
+
+RealNotification.prototype.show = function(response) {
+  this.positionNotification();
+  this.notificationTitle.text(response.title);
+  this.notificationMessage.text(response.message);
+  this.notificationDiv.show()
+                      .delay(this.notificationHideDelay)
+                      .fadeOut();
+};
+
+RealNotification.prototype.positionNotification = function() {
+  switch(this.notificationPosition) {
+
+    case 'top':
+      this.notificationDiv.addClass(this.CSS_CLASSES.top);
+      break;
+
+    case 'top-left':
+      this.notificationDiv.addClass(this.CSS_CLASSES.topLeft);
+      break;
+
+    case 'bottom-left':
+      this.notificationDiv.addClass(this.CSS_CLASSES.bottomLeft);
+      break;
+
+    case 'bottom-right':
+      this.notificationDiv.addClass(this.CSS_CLASSES.bottomRight);
+      break;
+
+    case 'bottom':
+      this.notificationDiv.addClass(this.CSS_CLASSES.bottom);
+      break;
+
+    case 'top-right':
+      this.notificationDiv.addClass(this.CSS_CLASSES.topRight);
+      break;
+
+    default:
+      alert('RealNotification: Invalid position option supplied.');
+  }
+};

data/vendor/assets/stylesheets/notification.scss

@@ -0,0 +1,35 @@
+#real-notification{
+  position: fixed;
+}
+
+.notification-top {
+  top: 10px;
+  transform: translate(-50%, 0);
+  left: 50%;
+}
+
+.notification-bottom {
+  bottom: 10px;
+  transform: translate(-50%, 0);
+  left: 50%;
+}
+
+.notification-bottom-right {
+  bottom: 10px;
+  right: 60px;
+}
+
+.notification-bottom-left {
+  bottom: 10px;
+  left: 60px;
+}
+
+.notification-top-right {
+  top: 10px;
+  right: 60px;
+}
+
+.notification-top-left {
+  top: 10px;
+  right: 60px;
+}

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: real_notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhishek Kanojia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-29 00:00:00.000000000 Z
+dependencies:
+- !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: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: " Real Notification provided push notification using action cable for
+  rails application. "
+email:
+- abhishek.kanojia3193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/shared/_notification.html.erb
+- bin/console
+- bin/setup
+- lib/generators/real_notification/channel/channel_generator.rb
+- lib/generators/real_notification/channel/prototypes/notification.js
+- lib/generators/real_notification/channel/prototypes/notification_channel.rb
+- lib/real_notification.rb
+- lib/real_notification/engine.rb
+- lib/real_notification/notification_helper.rb
+- lib/real_notification/version.rb
+- real_notification.gemspec
+- vendor/assets/javascripts/real_notification.js
+- vendor/assets/stylesheets/notification.scss
+homepage: https://github.com/abhikanojia/real_notification
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Real Notification provided push notification using action cable for rails
+  application.
+test_files: []