unagi-notifications 1.0.0

data/lib/assets/javascripts/unagi-notifications.js

@@ -0,0 +1,88 @@
+var initialize = function() {
+  var opts = $('#js-notifications-container');
+
+  if (opts.length == 0) {
+    return;
+  }
+
+  if (firebase.apps.length === 0) {
+    var config = {
+      apiKey:      `${opts.data('firebase-api-key')}`,
+      authDomain:  `${opts.data('firebase-project-id')}.firebaseapp.com/`,
+      databaseURL: `https://${opts.data('firebase-project-id')}.firebaseio.com/`,
+    };
+
+    firebase.initializeApp(config);
+  }
+
+  var destination = opts.data('destination');
+
+  var ref = firebase
+    .database()
+    .ref(`notifications/${destination}`);
+
+  ref.off();
+
+  ref
+    .orderByChild('read_at')
+    .equalTo(false)
+    .on('child_added', onNotificationAdded.bind(this));
+};
+
+var onNotificationAdded = function(notification) {
+  var value = notification.val();
+  var key   = notification.key;
+
+  appendNotification(value, key);
+  setNotificationsCount();
+}
+
+var appendNotification = function(notification, key) {
+  var container = $('#js-notifications-container');
+
+  var notification_container       = container.data('notification-container');
+  var notification_container_class = container.data('notification-container-class');
+  var notification_class           = container.data('notification-class');
+
+  var id = 'js-notification-' + Math.random().toString(36).substr(2, 9)
+
+  var html = "" +
+    "<" + notification_container + " class='" + notification_container_class +"' id='" + id +"'>" +
+      "<a href='" + notification.link + "'>" +
+        "<span class='js-notification " + notification_class + "'>" +
+          notification.text +
+        "</span>" +
+      "</a>" +
+    "</" + notification_container + ">"
+
+  container.prepend(html);
+  bindOnClickListener(id, key, notification);
+};
+
+var bindOnClickListener = function(html_id, key, notification) {
+  var opts = $('#js-notifications-container');
+
+  $('#' + html_id).on('click', function() {
+    firebase
+      .database()
+      .ref(`notifications/${opts.data('destination')}`)
+      .child(key)
+      .update({
+        read_at: Date.now()
+      });
+  });
+};
+
+var setNotificationsCount = function() {
+  var container = $('#js-notifications-count');
+
+  if (container.length == 0){
+    return;
+  }
+
+  container.text($('.js-notification').length);
+};
+
+$(document).ready(initialize);                 // No Turbolinks
+$(document).on('page:load', initialize);       // Rails <= 4
+$(document).on('turbolinks:load', initialize); // Rails 5

data/lib/notifications/engine.rb

@@ -0,0 +1,7 @@
+module Notifications
+  class Engine < Rails::Engine
+    initializer 'notifications' do
+      ActionView::Base.send(:include, Notifications::Helper)
+    end
+  end
+end

data/lib/notifications/helper.rb

@@ -0,0 +1,37 @@
+module Notifications
+  module Helper
+    def notifications_for(destination, opts = {})
+      opts = set_default_options(opts)
+
+      content_tag opts[:container], '',
+        id:    'js-notifications-container',
+        class: opts[:container_class],
+        data:  {
+          firebase_project_id:          Notifications.configuration.firebase_project_id,
+          firebase_api_key:             Notifications.configuration.firebase_api_key,
+          destination:                  destination,
+          notification_container:       opts[:notification_container],
+          notification_container_class: opts[:notification_container_class],
+          notification_class:           opts[:notification_class]
+        }
+    end
+
+    def notifications_count_for(origin, opts = {})
+      content_tag (opts[:container] || :div), '',
+        id:    'js-notifications-count',
+        class: opts[:container_class]
+    end
+
+    private
+
+    def set_default_options(opts)
+      opts[:container]                    ||= :div
+      opts[:container_class]              ||= ''
+      opts[:notification_container]       ||= :div
+      opts[:notification_container_class] ||= ''
+      opts[:notificaton_class]            ||= ''
+
+      opts
+    end
+  end
+end

data/lib/notifications/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+require 'action_view/base'
+
+module Notifications
+  class Railtie < ::Rails::Railtie #:nodoc:
+    config.after_initialize do
+      Notifications::ViewHelpers = ActionView::Base.new
+    end
+  end
+end

data/lib/notifications/uploader.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'json'
+require 'faraday'
+
+module Notifications
+  class Uploader
+    class << self
+      def call(origin: nil, destination:, text:, link:, created_at: Time.now)
+        message = JSON.generate(
+          origin:     origin,
+          text:       text,
+          link:       link,
+          read_at:    false,
+          created_at: created_at.to_datetime.to_i
+        )
+
+        connection = Faraday.new(url: firebase_host)
+
+        connection.post do |req|
+          req.url "/notifications/#{destination}.json"
+          req.headers['Content-Type'] = 'application/json'
+          req.body = message
+        end
+      end
+
+      private
+
+      def firebase_host
+        project_id = Notifications.configuration.firebase_project_id
+
+        "https://#{project_id}.firebaseio.com"
+      end
+    end
+  end
+end

data/lib/notifications/version.rb

@@ -0,0 +1,3 @@
+module Notifications
+  VERSION = '1.0.0'
+end

data/lib/notifications.rb

@@ -0,0 +1,27 @@
+require 'rails/railtie'
+require 'action_view/railtie'
+require 'action_controller/railtie'
+
+module Notifications
+  def self.configure
+    @configuration ||= Configuration.new
+
+    yield @configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration
+  end
+
+  class Configuration
+    attr_accessor :firebase_project_id, :firebase_api_key
+  end
+
+  configure
+end
+
+require 'notifications/version'
+require 'notifications/uploader'
+require 'notifications/engine'
+require 'notifications/railtie'
+require 'notifications/helper'

data/notifications.gemspec

@@ -0,0 +1,45 @@
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'unagi-notifications'
+  spec.version       = Notifications::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Lucas Hourquebie']
+  spec.email         = ['lucashour1993@gmail.com']
+
+  spec.summary       = 'Notifications system integration'
+  spec.description   = 'Notifications system using Google Firebase for Realtime Database'
+  spec.homepage      = 'http://unagi.com.ar'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = [
+    'lib/notifications',
+    'lib/notifications/uploader',
+    'lib/notifications/engine',
+    'lib/notifications/realtie',
+    'lib/notifications/helper'
+  ]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'actionpack', '>= 3.2'
+  spec.add_runtime_dependency 'railties', '>= 3.2'
+  spec.add_dependency 'faraday'
+end

data/test/notifications_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+class NotificationsTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Notifications::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "notifications"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: unagi-notifications
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Hourquebie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-11 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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Notifications system using Google Firebase for Realtime Database
+email:
+- lucashour1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/assets/javascripts/firebase.js
+- lib/assets/javascripts/unagi-notifications.js
+- lib/notifications.rb
+- lib/notifications/engine.rb
+- lib/notifications/helper.rb
+- lib/notifications/railtie.rb
+- lib/notifications/uploader.rb
+- lib/notifications/version.rb
+- notifications.gemspec
+- test/notifications_test.rb
+- test/test_helper.rb
+homepage: http://unagi.com.ar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Notifications system integration
+test_files: []