has_notifications 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53a42da5488ffcea3d23b132c53990764b553e2a
+  data.tar.gz: 2607df858f571372633543023a521f1ade575213
+SHA512:
+  metadata.gz: 4cb8b5b2b87c13ab992e561934c043bac57decc8deba0d2d67a174692b1bc6bbca5af47164010ce5ef6424c9295741cc56c27b61ef1d16b019440c9385d27e1c
+  data.tar.gz: 7f0a04d378ede51f0c25e96186c80c0860caae6add05a4d05c2ed5de5742200ac339ba98abd4b82a36301b6ddac32184578c9e6039e467bcb09c5e7991a56d0a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.1
+
+install:
+  - bundle install
+
+cache: bundler
+
+script: 'bundle exec rspec spec'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_notifications.gemspec
+gemspec
+
+gem "rails", "~>4.2.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vlad Zagorodniy
+
+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,76 @@
+# Has Notifications
+
+[![Build Status](https://travis-ci.org/vladzzag/has_notifications.svg)](https://travis-ci.org/vladzzag/has_notifications)
+
+Simple notification system for Ruby on Rails.
+
+## Installation
+
+Generate tables that are required by ```has_notification```:
+```shell
+$ gem install has_notifications
+$ rails generate has_notifications:migration
+$ rake db:migrate
+```
+
+## Usage
+
+Model which will be notificated:
+```ruby
+class User < ActiveRecord::Base
+    has_notifications
+end
+```
+
+Notification model:
+```ruby
+class Notification < ActiveRecord::Base
+    acts_as_notification
+end
+```
+
+Notify:
+```ruby
+vlad = User.create!(name: "Vlad")
+notification = Notification.create!(message: "Hello, World!")
+
+vlad.notify(notification)
+```
+
+Get all notifications:
+```ruby
+vlad = User.first
+vlad.all_notifications
+=> [...]
+```
+
+Get all unwatched notifications:
+```ruby
+vlad = User.first
+vlad.unwatched_notifications
+=> [...]
+```
+
+Get all watched notifications:
+```ruby
+vlad = User.first
+vlad.watched_notifications
+=> [...]
+```
+
+Mark notification as watched:
+```ruby
+vlad = User.first
+notification = vlad.unwatched_notifications[0]
+=> <...>
+notification.mark_as_watched
+```
+
+## Contributing
+
+0. Take a look at TODO.txt
+1. Fork it ( https://github.com/vladzzag/has_notifications/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.txt

@@ -0,0 +1,3 @@
+- cache
+- dependencies
+- callbacks

data/bin/console

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

data/bin/setup

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

data/has_notifications.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_notifications"
+  spec.version       = HasNotifications::VERSION
+  spec.authors       = ["Vlad Zagorodniy"]
+  spec.email         = ["vladzzag@gmail.com"]
+
+  spec.summary       = %q{Notifications for Ruby on Rails}
+  spec.description   = %q{Simple notifications for Ruby on Rails.}
+  spec.homepage      = "https://github.com/vladzzag/has_notifications"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/generators/has_notifications/migration/migration_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/migration'
+
+module HasNotifications
+    class MigrationGenerator < Rails::Generators::Base
+        include Rails::Generators::Migration
+        desc "fdsfsfs"
+
+        def self.source_root
+            File.join(File.dirname(__FILE__), "templates")
+        end
+
+        def self.next_migration_number(path)
+            Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+
+        def create_migration_file
+            migration_template "migration.rb", "db/migrate/has_notifications_migration.rb"
+        end
+    end
+end

data/lib/generators/has_notifications/migration/templates/migration.rb

@@ -0,0 +1,18 @@
+class HasNotificationsMigration < ActiveRecord::Migration
+    def self.up
+        create_table :hn_notifications do |t|
+            t.references :destination, polymorphic: true
+            t.references :notification, polymorphic: true
+
+            t.boolean :watched, default: false
+ 
+            t.timestamps
+        end
+
+        add_index :hn_notifications, [:destination_id, :watched]
+    end
+
+    def self.down
+        drop_table :hn_notifications
+    end
+end

data/lib/has_notifications/acts_as_notification.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+
+module HasNotifications
+	module ActsAsNotification
+		def acts_as_notification
+			has_one :destination, class_name: "HasNotifications::HnNotification", as: :notification, dependent: :destroy
+		end
+	end
+end
+
+ActiveRecord::Base.extend(HasNotifications::ActsAsNotification)

data/lib/has_notifications/has_notifications.rb

@@ -0,0 +1,46 @@
+require 'active_record'
+require 'has_notifications/hn_notification'
+
+module HasNotifications
+	module HasNotifications
+		def has_notifications
+			has_many :notifications, class_name: "::HasNotifications::HnNotification", as: :destination, dependent: :destroy
+
+			# create instance methods
+			class_eval do
+				def notify(notification)
+					#
+					# Notify destination
+					#
+					hn_notification = ::HasNotifications::HnNotification.new
+					hn_notification.destination = self
+					hn_notification.notification = notification
+					hn_notification.save
+				end
+
+				def all_notifications
+					#
+					# Get all notifications
+					#
+					self.notifications
+				end
+
+				def unwatched_notifications
+					#
+					# Get all unwatched notifications
+					#
+					self.notifications.where(watched: false)
+				end
+
+				def watched_notifications
+					#
+					# Get all watched notifications
+					#
+					self.notifications.where(watched: true)
+				end
+			end
+		end
+	end
+end
+
+ActiveRecord::Base.extend(HasNotifications::HasNotifications)

data/lib/has_notifications/hn_notification.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+
+module HasNotifications
+	class HnNotification < ::ActiveRecord::Base
+		# relations
+		belongs_to :destination, polymorphic: true, dependent: :destroy
+		belongs_to :notification, polymorphic: true, dependent: :destroy
+
+		def mark_as_watched
+			#
+			# Mark notification as watched
+			#
+			self.update_attribute(:watched, true)
+		end
+
+		def mark_as_unwatched
+			#
+			# Mark notification as unwatched
+			#
+			self.update_attribute(:watched, false)
+		end
+	end
+end

data/lib/has_notifications/version.rb

@@ -0,0 +1,3 @@
+module HasNotifications
+  VERSION = "0.0.1"
+end

data/lib/has_notifications.rb

@@ -0,0 +1,7 @@
+require "has_notifications/version"
+require "has_notifications/has_notifications"
+require "has_notifications/acts_as_notification"
+
+
+module HasNotifications
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: has_notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Zagorodniy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: rake
+  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: sqlite3
+  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: Simple notifications for Ruby on Rails.
+email:
+- vladzzag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.txt
+- bin/console
+- bin/setup
+- has_notifications.gemspec
+- lib/generators/has_notifications/migration/migration_generator.rb
+- lib/generators/has_notifications/migration/templates/migration.rb
+- lib/has_notifications.rb
+- lib/has_notifications/acts_as_notification.rb
+- lib/has_notifications/has_notifications.rb
+- lib/has_notifications/hn_notification.rb
+- lib/has_notifications/version.rb
+homepage: https://github.com/vladzzag/has_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.4.6
+signing_key: 
+specification_version: 4
+summary: Notifications for Ruby on Rails
+test_files: []