rails_notice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6035f65eff452bf429c0155519166cfc5cb1b2c112ca3879a469bad8fca32419
+  data.tar.gz: cf0d0719aa33c2ec36b2cbeae67787d3b6f0b25ea4fd65e7b5695b04a8434e02
+SHA512:
+  metadata.gz: 5285845671c1fbacc6c78b7a581dc35bdba0bd6eaf36ac2e54c3cd04d0935f0fb44484b72053d6c2e86f8648fd7e51468cc2283a37247e94188059bc22c3f52b
+  data.tar.gz: 1fde483a10c0530bc44c38251b0650be3c7e3e1824db0e60d938b42802268e85cdeddb1b67887e9b031a469732b1d1b2c4fa3f3beb3fac203c48ac74e610fe6a

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,76 @@
+# RailsNotice
+Short description and motivation.
+
+## Usage
+### Set the cable.yml
+Should set adapter as redis in development
+```yaml
+development:
+  adapter: redis
+  url: redis://localhost:6379/1
+```
+
+### Import the js and css in the page which you want show notifications
+```erb
+<%= javascript_include_tag 'rails_notice/cable', 'data-turbolinks-eval': 'false' %>
+<%= stylesheet_link_tag 'rails_notice/cable' %>
+```
+
+### View: add link
+```erb
+<%= link_to notifications_path, class: 'item', remote: true, id: 'notify_show' do %>
+  <i class="bell icon"></i>
+  <span id="notice_count" style="padding-left: 5px"><%= current_user.unread_count %></span>
+<% end %>
+```
+
+### Model Setting
+```ruby
+# which model can receive notifications
+class User < ApplicationRecord
+  include TheReceivable
+end
+
+```
+
+### Controller Setting
+```ruby
+class ApplicationController < ActionController::Base
+  include RailsNoticeController
+  
+end
+```
+
+### Channel Setting
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    prepend RailsNoticeConnection
+
+  end
+end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_notice'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_notice
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsNotice'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/rails_notice_manifest.js

@@ -0,0 +1,3 @@
+//= link rails_notice/cable.css
+//= link rails_notice/cable.js
+//= link_tree ../javascripts/controllers .js

data/app/assets/javascripts/controllers/rails_notice_admin/notification_settings/index.js

@@ -0,0 +1,17 @@
+$('#q_receiver_type').dropdown();
+$('#q_receiver_id').dropdown({
+  apiSettings: {
+    url: '/receivers/search?q={query}&receiver_type={receiver_type}',
+    beforeSend: function(settings) {
+      settings.urlData.receiver_type = document.querySelector('select[name="q[receiver_type]"]').value;
+      return settings;
+    }
+  },
+  fields: {
+    name: 'name',
+    value: 'id'
+  },
+  minCharacters: 2
+});
+
+$('.ui.toggle.checkbox').checkbox();

data/app/assets/javascripts/controllers/rails_notice_admin/notifications/index.js

@@ -0,0 +1,15 @@
+$('#q_receiver_type').dropdown();
+$('#q_receiver_id').dropdown({
+  apiSettings: {
+    url: '/receivers/search?q={query}&receiver_type={receiver_type}',
+    beforeSend: function(settings) {
+      settings.urlData.receiver_type = document.querySelector('select[name="q[receiver_type]"]').value;
+      return settings;
+    }
+  },
+  fields: {
+    name: 'name',
+    value: 'id'
+  },
+  minCharacters: 2
+});

data/app/assets/javascripts/controllers/rails_notice_admin/notify_settings/edit.js

@@ -0,0 +1,3 @@
+//= require ./new
+$('#notify_setting_only_verbose_columns').dropdown();
+$('#notify_setting_except_verbose_columns').dropdown();

data/app/assets/javascripts/controllers/rails_notice_admin/notify_settings/index.js

@@ -0,0 +1,17 @@
+$('#q_receiver_type').dropdown();
+$('#q_receiver_id').dropdown({
+  apiSettings: {
+    url: '/receivers/search?q={query}&receiver_type={receiver_type}',
+    beforeSend: function(settings) {
+      settings.urlData.receiver_type = document.querySelector('select[name="q[receiver_type]"]').value;
+      return settings;
+    }
+  },
+  fields: {
+    name: 'name',
+    value: 'id'
+  },
+  minCharacters: 2
+});
+
+$('.ui.toggle.checkbox').checkbox();

data/app/assets/javascripts/controllers/rails_notice_admin/notify_settings/new.js

@@ -0,0 +1,18 @@
+//= require rails_com/fetch_xhr_script
+$('#notify_setting_notifiable_type').dropdown({
+  placeholder: false,
+  onChange: function(value, text, $selectedItem) {
+    var search_path = '/admin/notify_settings/columns';
+    var search_url = new URL(window.location.origin + search_path);
+    search_url.searchParams.set('notifiable_type', value);
+
+    var params = {
+      credentials: 'same-origin',
+      headers: {
+        'Accept': 'application/javascript',
+        'X-CSRF-Token': document.head.querySelector("[name=csrf-token]").content
+      }
+    };
+    fetch_xhr_script(search_url, params);
+  }
+});

data/app/assets/javascripts/rails_notice/cable.js

@@ -0,0 +1,19 @@
+//= require action_cable
+//= require ./messenger.min
+//= require ./messenger-theme-future
+//= require rails_com/fetch_xhr_script
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer('/cable');
+
+}).call(this);
+
+Messenger.options = {
+  extraClasses: 'messenger-fixed messenger-on-bottom messenger-on-right',
+  theme: 'air',
+  parentLocations: ['footer']
+};

data/app/assets/javascripts/rails_notice/channels/notices.js

@@ -0,0 +1,39 @@
+App.cable.subscriptions.create('NoticesChannel', {
+  collection: function() {
+    return $("[data-channel='notices']");
+  },
+  received: function(data) {
+    this.collection().css('color', '#ff7f24');
+    this.collection().html(data.body);
+
+    var msg = Messenger().post({
+      message: data.body,
+      type: 'info',
+      showCloseButton: true,
+      hideAfter: data.showtime,
+      actions: {
+        confirm: {
+          label: 'Confirm',
+          action: function(e){
+            var url = '/notifications/' + data.id + '/read';
+            var params = {
+              credentials: 'same-origin',
+              headers: {
+                'Accept': 'application/javascript',
+                'X-CSRF-Token': document.head.querySelector("[name=csrf-token]").content
+              }
+            };
+            fetch_xhr_script(url, params);
+            window.location.href = data.link;
+          }
+        }
+      }
+    });
+
+    $('#notify_show').css('color', '#ff7f24');
+    $('#notice_count').html(data.count);
+  },
+  connected: function() {
+    console.log('Notice channel connected success');
+  }
+});

data/app/assets/javascripts/rails_notice/messenger-theme-future.js

@@ -0,0 +1,33 @@
+(function() {
+  var $, FutureMessage, spinner_template,
+    __hasProp = {}.hasOwnProperty,
+    __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
+
+  $ = jQuery;
+
+  spinner_template = '<div class="messenger-spinner">\n    <span class="messenger-spinner-side messenger-spinner-side-left">\n        <span class="messenger-spinner-fill"></span>\n    </span>\n    <span class="messenger-spinner-side messenger-spinner-side-right">\n        <span class="messenger-spinner-fill"></span>\n    </span>\n</div>';
+
+  FutureMessage = (function(_super) {
+
+    __extends(FutureMessage, _super);
+
+    function FutureMessage() {
+      return FutureMessage.__super__.constructor.apply(this, arguments);
+    }
+
+    FutureMessage.prototype.template = function(opts) {
+      var $message;
+      $message = FutureMessage.__super__.template.apply(this, arguments);
+      $message.append($(spinner_template));
+      return $message;
+    };
+
+    return FutureMessage;
+
+  })(window.Messenger.Message);
+
+  window.Messenger.themes.future = {
+    Message: FutureMessage
+  };
+
+}).call(this);