unotifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a19987dbc68516497b96678c785b0d4c48f5e99fe0ac2c51b0b361ec389914da
+  data.tar.gz: d45bd37bd9de65c2d8f27ca48ee390013ab6d15cf68e68e83232f00647ca7bb4
+SHA512:
+  metadata.gz: 6371d94478f0443dd43d6b48a46f796bd40d7c5efa8cf2ea249aed2f25d420459e1800d2df991d778c4bae3ab558aab3cab0e30ce8c390c1d980ee807290eba3
+  data.tar.gz: fef78dda39517b3e146a483a2370add2220949e9258ad685bde790137699a883a1b0c0ee9ddbe853fa4eb3ea276865d95e89899721c62989c986905ec7bcbda4

data/.gitignore

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

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 unotifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    unotifier (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  i18n
+  unotifier!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Artem Rashev
+
+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,44 @@
+# UNotifier
+
+[![Build Status](https://travis-ci.com/mgpnd/unotifier.svg?branch=master)](https://travis-ci.com/mgpnd/unotifier)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unotifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unotifier
+
+## Usage
+
+To store your notifications in database UNotifier uses provided ActiveRecord model. It must have the next attributes:
+* `id` - required
+* `key` - required
+* `target` - required
+* `title` - required
+* `body` - optional
+* `autohide_delay` - optional
+* `link` - optional
+
+`target` is a user or any other notification reciever entity. It also must provide several attributes:
+* `login`
+* `online?` - to determine whether to send *onsite* or *external* notification
+* `locale` - to send proper locale to I18n
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mgpnd/unotifier.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unotifier"
+
+# 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.
+
+require "pry"
+Pry.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/configuration.rb

@@ -0,0 +1,15 @@
+module UNotifier
+  class Configuration
+    attr_accessor :site_providers
+    attr_accessor :external_providers
+    attr_accessor :resource_class
+    attr_accessor :notifications_path
+
+    def initialize
+      @site_providers = []
+      @external_providers = []
+      @resource_class = nil
+      @notifications_path = nil
+    end
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,57 @@
+module UNotifier
+  class UNotifierError < StandardError; end
+
+  class NotificationsConfigNotFoundError < UNotifierError
+    attr_reader :path, :absolute_path
+
+    def initialize(path)
+      @path = path
+      @absolute_path = File.expand_path(@path)
+      message = "Configuration file not found at #{@absolute_path}"
+      super(message)
+    end
+  end
+
+  class NotificationNotFoundError < UNotifierError
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+      message = "Notification with key '#{@key}' not found"
+      super(message)
+    end
+  end
+
+  class UnknownTargetError < UNotifierError
+    attr_reader :key, :target
+
+    def initialize(key, target)
+      @key = key
+      @target = target
+      message = "Unknown target '#{@target}' for notification '#{@key}'"
+      super(message)
+    end
+  end
+
+  class EmptyLocaleKeyError < UNotifierError
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+      message = ":locale_key parameter is required for fetching '#{key}' locale"
+      super(message)
+    end
+  end
+
+  class UnknownLocaleKeyError < UNotifierError
+    attr_reader :key, :locale_key, :options
+
+    def initialize(key, locale_key, options)
+      @key = key
+      @locale_key = locale_key
+      @options = options
+      message = "Unkown locale key '#{@locale_key}' for '#{@key}'. Available options: #{@options}"
+      super(message)
+    end
+  end
+end

data/lib/provider/action_cable.rb

@@ -0,0 +1,33 @@
+module UNotifier
+  module Provider
+    class ActionCable
+      attr_reader :server
+      attr_accessor :autohide_delay, :channel_name
+
+      def initialize(server, channel_name: nil, autohide_delay: 30)
+        @server = server
+        @autohide_delay = autohide_delay
+        @channel_name =
+          channel_name ||
+          -> (notification) { "notifications_for_user_#{notification.target.login}" }
+      end
+
+      def notify(notification)
+        if notification.target.online?
+          @server.broadcast @channel_name.call(notification), serialize_notification(notification)
+        end
+      end
+
+      def serialize_notification(notification)
+        {
+          id: notification.id,
+          title: notification.title,
+          body: notification.body,
+          autohide_delay: notification.autohide_delay || @autohide_delay,
+          user_login: notification.target.login,
+          link: notification.link,
+        }
+      end
+    end
+  end
+end

data/lib/provider/action_mailer.rb

@@ -0,0 +1,14 @@
+module UNotifier
+  module Provider
+    class ActionMailer
+      def initialize(mailer, sending_method: :new_notification)
+        @mailer = mailer
+        @sending_method = sending_method
+      end
+
+      def notify(notification)
+        @mailer.public_send(@sending_method, notification).deliver
+      end
+    end
+  end
+end

data/lib/provider.rb

@@ -0,0 +1,7 @@
+require_relative "provider/action_cable"
+require_relative "provider/action_mailer"
+
+module UNotifier
+  module Provider
+  end
+end

data/lib/unotifier/version.rb

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

data/lib/unotifier.rb

@@ -0,0 +1,111 @@
+require "yaml"
+require "i18n"
+
+require_relative "unotifier/version"
+require_relative "exceptions"
+require_relative "provider"
+require_relative "configuration"
+
+module UNotifier
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.notifications_config
+    @notifications_config ||= YAML.load_file(configuration.notifications_path)
+  rescue Errno::ENOENT => e
+    raise NotificationsConfigNotFoundError.new(configuration.notifications_path)
+  end
+
+  def self.reload!
+    @configuration = nil
+    @notifications_config = nil
+  end
+
+  def self.load_notification(key)
+    notifications_config.dig(*key.split('.'))
+  end
+
+  def self.load_notification!(key)
+    notification = load_notification(key)
+    raise NotificationNotFoundError.new(key) unless notification
+    notification
+  end
+
+  def self.urgency_for(key, params = {})
+    config = load_notification!(key)
+
+    if config["target"].kind_of?(Hash)
+      urgency = config.dig("target", params[:target], "urgency")
+      raise UnknownTargetError.new(key, params[:target]) unless urgency
+      urgency
+    else
+      config["urgency"]
+    end
+  end
+
+  def self.locale_key_for(key, params = {})
+    config = load_notification!(key)
+
+    if config["locale_options"].kind_of?(Array)
+      raise EmptyLocaleKeyError.new(key) unless params[:locale_key]
+      raise UnknownLocaleKeyError.new(
+        key, params[:locale_key], config["locale_options"]
+      ) unless config["locale_options"].include?(params[:locale_key])
+      "notifications.#{key}.#{params[:locale_key]}"
+    else
+      "notifications.#{key}"
+    end
+  end
+
+  def self.notify(key, target, params = {})
+    user_settings = target.notification_settings[key]
+    user_settings ||= "external"
+    config = load_notification!(key)
+    locale_key = locale_key_for(key, params)
+    urgency = urgency_for(key, params)
+
+    notification = configuration.resource_class.new(
+      key: key,
+      title: I18n.t("#{locale_key}.title", params.merge(locale: target.locale, default: "")),
+      body: I18n.t("#{locale_key}.title", params.merge(locale: target.locale, default: "")),
+      link: params[:link],
+      urgency: urgency
+    )
+    notification.save!
+
+    notify_with = []
+
+    case urgency
+    when "immediate"
+      notify_with += configuration.site_providers if notification.target.online?
+      notify_with += configuration.external_providers
+    when "regular"
+      if notification.target.online?
+        notify_with += configuration.site_providers
+      elsif user_settings == "external"
+        notify_with += configuration.external_providers
+      end
+    when "optional"
+      if user_settings != "off"
+        if notification.target.online?
+          notify_with += configuration.site_providers
+        elsif user_settings == "external"
+          notify_with += configuration.external_providers
+        end
+      end
+    when "onsite"
+      notify_with += configuration.site_providers if notification.target.online?
+    end
+
+    notify_with.each { |p| p.notify(notification) }
+  end
+end

data/unotifier.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "unotifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "unotifier"
+  spec.version       = UNotifier::VERSION
+  spec.authors       = ["Artem Rashev"]
+  spec.email         = ["stillintop@gmail.com"]
+
+  spec.summary       = "Ultimate user notification tool for web apps"
+  spec.homepage      = "https://github.com/mgpnd/unotifier"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["sourc_code_uri"] = "https://github.com/mgpnd/unotifier"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) || f.match(%r{^(\.rspec|\.travis\.yml)}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "i18n"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: unotifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Rashev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stillintop@gmail.com
+executables:
+- console
+- rake
+- rspec
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/configuration.rb
+- lib/exceptions.rb
+- lib/provider.rb
+- lib/provider/action_cable.rb
+- lib/provider/action_mailer.rb
+- lib/unotifier.rb
+- lib/unotifier/version.rb
+- unotifier.gemspec
+homepage: https://github.com/mgpnd/unotifier
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mgpnd/unotifier
+  sourc_code_uri: https://github.com/mgpnd/unotifier
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Ultimate user notification tool for web apps
+test_files: []