communique 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4282da96cb9a61a9691507909e8d511f2da8fa4b
+  data.tar.gz: 09dc4429a835f01447c008e1e4e23db770cff6ea
+SHA512:
+  metadata.gz: 2bf8e0dbfe3afe81ed803695cc0ffc30e492f8af1ee81e1e320556ac16d125aeef5efed70220e56559f0048e6155d1730c818ef0b372c6a55e5771c78c4fdd0c
+  data.tar.gz: ac9c69e09463481bda95285af9252836ad71481238f977f11e8292034bc054b64383e39a263e49a2a038d7fdda04109e83ca7ec847cccc38b96201aed44ee251

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in communique.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vestorly
+
+MIT License
+
+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,34 @@
+# Communiqué
+
+Simple way to store warnings and errors affecting users as messages. Stored
+messages can be linked to a helpful link so they can read more about the problem
+
+to test it out without a rails environment
+`irb -Ilib -rcommunique`
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'communique'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install communique
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/Vestorly/communique/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,2 @@
+require "bundler/gem_tasks"
+

data/communique.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'communique/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "communique"
+  spec.version       = Communique::VERSION
+  spec.authors       = ["Michael Polycarpou"]
+  spec.email         = ["michaelpolycarpou@gmail.com"]
+  spec.summary       = %q{
+    Simple way to store warnings and errors affecting users as messages. Stored
+    messages can be linked to a helpful link so they can read more about the problem
+  }
+  spec.description   = %q{
+    Includes a couple models and an api to make it easy to create notifications and
+    the actions associated with them.
+  }
+  spec.homepage      = "https://www.vestorly.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mongoid", "~> 4.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency "database_cleaner", "~> 1.4"
+end

data/config/mongoid.yml

@@ -0,0 +1,12 @@
+development:
+  sessions:
+    default:
+      database: communique_development
+      hosts:
+        - localhost:27017
+test:
+  sessions:
+    default:
+      database: communique_test
+      hosts:
+        - localhost:27017

data/lib/communique.rb

@@ -0,0 +1,32 @@
+require "communique/version"
+require "communique/configuration"
+require "communique/models/action"
+require "communique/models/notifiable"
+require "communique/models/notification"
+require "communique/handler"
+
+module Communique
+  def self.notify(notifiable, action_key, context_info=nil)
+    action = Action.find_or_create_by(key: action_key)
+
+    notification = Notification.create(
+      notifiable: notifiable,
+      context_info: context_info,
+      action_key: action_key,
+      action: action
+    )
+
+    Handler.external_services notification
+
+    notification.id.to_s
+  end
+
+  def self.actions
+    Action.all.to_a
+  end
+
+  def self.viewed_all! notifiable
+    Notification.viewed_all! notifiable
+  end
+
+end

data/lib/communique/configuration.rb

@@ -0,0 +1,19 @@
+module Communique
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure(&block)
+    self.config ||= Configuration.new
+    yield config if block_given?
+  end
+
+  class Configuration
+    attr_accessor :user_klass
+    attr_accessor :notification_handler
+
+    def set_notification_handler(&block)
+      @notification_handler = block
+    end
+  end
+end

data/lib/communique/handler.rb

@@ -0,0 +1,27 @@
+module Communique
+  class NotificationHandlerNotCallable < StandardError; end
+  class Handler
+    def self.external_services notification
+      config = Communique.config
+      return if config.nil?
+      return if config.notification_handler.nil?
+
+      validate_notification_handler!(config.notification_handler)
+      config.notification_handler.call(
+        notification,
+        notification.action,
+        notification.notifiable
+      )
+    end
+
+    def self.validate_notification_handler!(handler)
+      if !handler.respond_to? :call
+        raise NotificationHandlerNotCallable.new(
+          "notification_handler needs to be nil or a callable block"
+        )
+      end
+    end
+
+    private_class_method :validate_notification_handler!
+  end
+end

data/lib/communique/models/action.rb

@@ -0,0 +1,20 @@
+require 'mongoid'
+module Communique
+  class Action
+    include ::Mongoid::Document
+    include ::Mongoid::Timestamps
+
+    field :key
+    field :name
+    field :url
+    field :description
+    field :image_url
+    field :level
+    field :send_email, type: Boolean, default: false
+    has_many :notifications
+
+    def act
+      'lets act on this'
+    end
+  end
+end

data/lib/communique/models/notifiable.rb

@@ -0,0 +1,11 @@
+module Communique
+  module Notifiable
+
+    extend ActiveSupport::Concern
+    included do
+      has_many :notifications,
+        class_name: 'Communique::Notification',
+                as: :notifiable
+    end
+  end
+end

data/lib/communique/models/notification.rb

@@ -0,0 +1,22 @@
+require 'mongoid'
+module Communique
+  class Notification
+    include ::Mongoid::Document
+    include ::Mongoid::Timestamps
+
+    field :seen, type: Boolean, default: false
+    field :action_key
+    field :context_info, type: Hash
+
+    belongs_to :notifiable, polymorphic: true
+    belongs_to :action
+
+    def notify
+      'successful notification'
+    end
+
+    def self.viewed_all! notifiable
+      notifiable.notifications.update_all(seen: true)
+    end
+  end
+end

data/lib/communique/version.rb

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

data/spec/communique_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+describe Communique do
+
+end

data/spec/models/handler_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+describe Communique::Handler do
+  describe '#external_services' do
+    context 'no config block' do
+
+      it 'works with no config block' do
+        expect(Communique::Handler).to receive(:external_services).and_return nil
+
+        dummy = NotifiableDummy.create
+        Communique.notify(
+          dummy,
+          'death_star_deadlock',
+          name: 'locked star',
+          location: 'it moves really fast'
+        )
+      end
+    end
+
+    context 'with config block' do
+      let(:dummy_handler){HandlerDummy.new}
+      before(:each) do
+
+        Communique.configure do |config|
+          config.set_notification_handler do |notification, action, dummy|
+            dummy_handler.push_notification(notification, action, dummy)
+          end
+        end
+      end
+
+      it 'external block gets called' do
+        dummy = NotifiableDummy.create
+        Communique.notify(
+          dummy,
+          'death_star_deadlock',
+          name: 'locked star',
+          location: 'it moves really fast'
+        )
+
+        expect(dummy_handler.notification.context_info[:name]).to eq('locked star')
+        expect(dummy_handler.action.key).to eq('death_star_deadlock')
+        expect(dummy_handler.notifiable.class.name).to eq('NotifiableDummy')
+      end
+    end
+  end
+end

data/spec/models/notification_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+describe Communique::Notification do
+  describe '#viewed_all' do
+    it 'makes all notifications seen' do
+      dummy = NotifiableDummy.create
+      Communique.notify(
+        dummy,
+        'r2d2_broke_with_a_500',
+        name: 'broken robot',
+        location: 'proxy issue'
+      )
+      Communique.notify(
+        dummy,
+        '3CPO_fell_down_and_hit_his_head',
+        name: 'broken robot',
+        location: 'nginx caching issue'
+      )
+      expect(dummy.notifications.count).to be 2
+
+      expect(dummy.notifications.first.seen).to be false
+      expect(dummy.notifications.last.seen).to be false
+
+      Communique.viewed_all! dummy
+      dummy.reload
+
+      expect(dummy.notifications.first.seen).to be true
+      expect(dummy.notifications.last.seen).to be true
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), './models'))
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '../config'))
+
+require 'database_cleaner'
+require 'mongoid'
+require 'communique'
+require "support/dummy/notifiable_dummy.rb"
+require "support/dummy/handler_dummy.rb"
+require "models/notification_spec.rb"
+
+Mongoid.load!("./config/mongoid.yml", :test)
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

data/spec/support/dummy/handler_dummy.rb

@@ -0,0 +1,11 @@
+class HandlerDummy
+  attr_reader :notification
+  attr_reader :action
+  attr_reader :notifiable
+
+  def push_notification notification, action, notifiable
+    @notification = notification
+    @action = action
+    @notifiable = notifiable
+  end
+end

data/spec/support/dummy/notifiable_dummy.rb

@@ -0,0 +1,6 @@
+require 'mongoid'
+class NotifiableDummy
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Communique::Notifiable
+end

data/spec/support/dummy/notifiable_dummy_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require 'pry'
+describe NotifiableDummy do
+ # it 'has a configuration already set' do
+ #   expect(Communique.config).to_not be_nil
+ # end
+
+  it 'has notifications' do
+    dummy = NotifiableDummy.new
+
+    Communique.notify(
+      dummy,
+      'pleasant_day',
+      name: 'hello',
+      problem: 'beautiful day'
+
+    )
+    expect(dummy.notifications.first.context_info[:name]).to eq('hello')
+
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: communique
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Polycarpou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: "\n    Includes a couple models and an api to make it easy to create
+  notifications and\n    the actions associated with them.\n  "
+email:
+- michaelpolycarpou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- communique.gemspec
+- config/mongoid.yml
+- lib/communique.rb
+- lib/communique/configuration.rb
+- lib/communique/handler.rb
+- lib/communique/models/action.rb
+- lib/communique/models/notifiable.rb
+- lib/communique/models/notification.rb
+- lib/communique/version.rb
+- spec/communique_spec.rb
+- spec/models/handler_spec.rb
+- spec/models/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy/handler_dummy.rb
+- spec/support/dummy/notifiable_dummy.rb
+- spec/support/dummy/notifiable_dummy_spec.rb
+homepage: https://www.vestorly.com/
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple way to store warnings and errors affecting users as messages. Stored
+  messages can be linked to a helpful link so they can read more about the problem
+test_files:
+- spec/communique_spec.rb
+- spec/models/handler_spec.rb
+- spec/models/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy/handler_dummy.rb
+- spec/support/dummy/notifiable_dummy.rb
+- spec/support/dummy/notifiable_dummy_spec.rb
+has_rdoc: