hoc_notifications 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62be5823a8756c4bf02ede76c304d15078c549f8
+  data.tar.gz: 4294a7886a6259785182cfba2c92258ad96d501c
+SHA512:
+  metadata.gz: b6ae70fdc2eb7c4a79d3f031627ab431aab1b3b098c0de33e4854e8a22a90a94a664563b3875a53d477fe25920b10071e1bbb373d66d57aa4aea3b5c62a25e75
+  data.tar.gz: 563d2003c56c0a58107f7ab94a7f5f0e666bec028cf2a23908ed8728def91262674bba493e348b2266dcd9a2de65e44fac2a3d9647ad9e4b40313041d43f752e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gert Lavsen
+
+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,109 @@
+# HocNotifications
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hoc_notifications`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoc_notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hoc_notifications
+
+## Usage
+
+### Make application ready for hoc_notifications
+Install by running:
+
+    $ rails generate hoc_notifications:install
+
+
+    $ rake db:migrate
+This will create, models and migrations
+
+### Extend models
+
+#### Receiver
+Add the `acts_as_hoc_notications_receiver` to models you want to be able to receive notifications and override `handle_received_notification(hoc_notification)` to get notified in the model when a notifications is received. This can be used to eg. send a push notification with acts_s_hoc_pushable
+
+```ruby
+#app/models/user.rb
+class User < ApplicationRecord
+  acts_as_hoc_notifications_receiver
+  #acts_as_hoc_pushable
+
+  def handle_received_notification(hoc_notification)
+    # handle notification here. eg send push notification
+    #send_push_notification(....)
+  end
+end
+```
+The model now has a has_many `received_notifications` relation.
+The model also have a method called `mark_as_seen(id)` which can be used to mark a notification as seen.
+
+
+#### Sender
+Add the `acts_as_hoc_notications_sender` to models you want to be able to be used as sender for notifications
+```ruby
+#app/models/user.rb
+class User < ApplicationRecord
+  acts_as_hoc_notifications_receiver
+  acts_as_hoc_notifications_sender
+  #acts_as_hoc_pushable
+
+  def handle_received_notification(hoc_notification)
+    # handle notification here. eg send push notification
+    #send_push_notification(....)
+  end
+end
+```
+As seen the receiver and sender can be the same model.
+This extend the model with a has_many `sent_notifications` relation.
+
+#### Notifiable
+Add the `acts_as_hoc_notifications_notifiable` to models you want to be able to notify about.
+```ruby
+class Comment < ApplicationRecord
+  acts_as_hoc_notifications_notifiable
+  belongs_to :user
+  belongs_to :post
+
+  after_create :create_notification
+  def create_notification
+    Comment.create_notification(
+      sender: user,
+      recipients: (post.commented_users.to_a + [post.user] - [user]).uniq,
+      notifiable: self,
+      action: :create,
+      title: "Created comment",
+      message: "#{user.name} commented on #{post.title}",
+      data: nil
+    )
+  end
+end
+class Post < ApplicationRecord
+  belongs_to :user
+  has_many :comments
+  has_many :commented_users, through: :comments, source: :user
+
+  acts_as_hoc_notifications_notifiable
+end
+
+
+```
+This extend the model with a has_many `notifications` relation and the `create_notification` method
+ActiveRecords callbacks, like `after_create` can be used to make a notification.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hoc_notifications"
+
+# 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/hoc_notifications.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hoc_notifications/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hoc_notifications"
+  spec.version       = HocNotifications::VERSION
+  spec.authors       = ["Gert Lavsen"]
+  spec.email         = ["gert@houseofcode.io"]
+
+  spec.summary       = "Notifications made easy"
+  spec.description   = "Notifications made easy"
+  spec.homepage      = "https://github.com/house-of-code/hoc_notifications"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/generators/hoc_notifications/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/migration'
+
+module HocNotifications
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      #def copy_initializer_file
+      #  template "initializer.rb", "config/initializers/hoc_notifications.rb"
+      #end
+
+      def copy_migration_files
+        migration_template "migration/create_hoc_notifications.rb", "db/migrate/create_hoc_notifications.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          sleep 1 # make sure each time we get a different timestamp
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/generators/hoc_notifications/templates/migration/create_hoc_notifications.rb

@@ -0,0 +1,25 @@
+class CreateHocNotifications < ActiveRecord::Migration
+  def change
+    create_table :hoc_notifications do |t|
+      t.integer :recipient_id
+      t.string :recipient_type
+
+      t.integer :sender_id
+      t.string :sender_type
+
+      t.integer :notifiable_id
+      t.string :notifiable_type
+
+      t.string :title, null: false, default: ""
+      t.string :message, null: false, default: ""
+
+      t.string :action, null: false, default: ""
+
+      t.text :data, null: false, default: ""
+
+      t.datetime :seen_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/hoc_notifications/active_record/hoc_notification.rb

@@ -0,0 +1,36 @@
+module HocNotifications
+  class HocNotification < ActiveRecord::Base
+    belongs_to :recipient, polymorphic: true
+    belongs_to :sender, polymorphic: true
+    belongs_to :notifiable, polymorphic: true
+
+    scope :unread, -> { where(seen_at: nil) }
+
+    serialize :data, Hash
+
+    after_create -> {
+      return if recipient.nil?
+      if recipient.class.method_defined? :handle_received_notification
+        recipient.handle_received_notification(self)
+      end
+    }
+
+    def self.create_notifications(sender:, recipients:, notifiable:, action:, title:, message:, **data)
+      recipients.each do |recipient|
+        create(sender: sender,
+               recipient: recipient,
+               notifiable: notifiable,
+               action: action,
+               data: data,
+               seen_at: nil,
+               title: title,
+               message: message
+             )
+      end
+    end
+
+    def mark_as_seen
+      update_attributes(seen_at: Time.current)
+    end
+  end
+end

data/lib/hoc_notifications/acts_as_hoc_notifications_notifiable.rb

@@ -0,0 +1,32 @@
+module HocNotifications
+  module ActsAsHocNotificationsNotifiable
+    extend ActiveSupport::Concern
+    included do
+    end
+
+
+    module ClassMethods
+      def acts_as_hoc_notifications_notifiable(**options)
+        has_many :notifications,
+        as: :notifiable,
+        class_name: 'HocNotifications::HocNotification',
+        dependent: :nullify
+
+      end
+
+      def create_notification(sender:, recipients:, notifiable:, action:, title:, message:, **data)
+        HocNotifications::HocNotification.create_notifications(
+          sender: sender,
+          recipients: recipients,
+          notifiable: notifiable,
+          action: action,
+          title: title,
+          message: message,
+          **data
+        )
+      end
+
+    end
+  end
+end
+ActiveRecord::Base.send :include, HocNotifications::ActsAsHocNotificationsNotifiable

data/lib/hoc_notifications/acts_as_hoc_notifications_receiver.rb

@@ -0,0 +1,27 @@
+module HocNotifications
+  module ActsAsHocNotificationsReceiver
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_hoc_notifications_receiver(_options = {})
+        has_many :received_notifications,
+                 as: :recipient,
+                 class_name: 'HocNotifications::HocNotification',
+                 dependent: :destroy
+      end
+    end
+
+    def handle_received_notification(hoc_notification)
+    end
+
+    def mark_notification_as_read(id)
+      received_notifications.find(id).mark_as_seen
+    end
+
+  end
+end
+ActiveRecord::Base.send :include,
+                        HocNotifications::ActsAsHocNotificationsReceiver

data/lib/hoc_notifications/acts_as_hoc_notifications_sender.rb

@@ -0,0 +1,20 @@
+module HocNotifications
+  module ActsAsHocNotificationsSender
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+
+    module ClassMethods
+      def acts_as_hoc_notifications_sender(_options = {})
+        has_many :sent_notifications,
+                 as: :sender,
+                 class_name: 'HocNotifications::HocNotification',
+                 dependent: :destroy
+      end
+    end
+  end
+end
+ActiveRecord::Base.send :include,
+                        HocNotifications::ActsAsHocNotificationsSender

data/lib/hoc_notifications/hoc_notification_action.rb

@@ -0,0 +1,8 @@
+module HocNotifications
+  class HocNotificationAction
+    def initialize(action:, title:, message:, sender:, recipients:, notifiable:, data: )
+
+    end
+    attr_accessor :action, :message, :title, :sender, :recipients, :notifiable, :data
+  end
+end

data/lib/hoc_notifications/version.rb

@@ -0,0 +1,3 @@
+module HocNotifications
+  VERSION = "1.0.0"
+end

data/lib/hoc_notifications.rb

@@ -0,0 +1,9 @@
+require "hoc_notifications/version"
+require "hoc_notifications/acts_as_hoc_notifications_receiver"
+require "hoc_notifications/acts_as_hoc_notifications_sender"
+require "hoc_notifications/acts_as_hoc_notifications_notifiable"
+require "hoc_notifications/hoc_notification_action"
+require "hoc_notifications/active_record/hoc_notification.rb"
+module HocNotifications
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: hoc_notifications
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gert Lavsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-04 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.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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'
+description: Notifications made easy
+email:
+- gert@houseofcode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hoc_notifications.gemspec
+- lib/generators/hoc_notifications/install_generator.rb
+- lib/generators/hoc_notifications/templates/migration/create_hoc_notifications.rb
+- lib/hoc_notifications.rb
+- lib/hoc_notifications/active_record/hoc_notification.rb
+- lib/hoc_notifications/acts_as_hoc_notifications_notifiable.rb
+- lib/hoc_notifications/acts_as_hoc_notifications_receiver.rb
+- lib/hoc_notifications/acts_as_hoc_notifications_sender.rb
+- lib/hoc_notifications/hoc_notification_action.rb
+- lib/hoc_notifications/version.rb
+homepage: https://github.com/house-of-code/hoc_notifications
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Notifications made easy
+test_files: []