communique 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e1a1839bb2dd00049f9602e26f5fe86a805ac7b
-  data.tar.gz: c2aaaf42e4849fc803cdf3011707f99ef92f391c
+  metadata.gz: 83a7e5be37e23918ac8477417e6bb769d3e0d524
+  data.tar.gz: 9e754661e47632b80ab8e1076941141ad0b37e8a
 SHA512:
-  metadata.gz: 05088d1b1f8d3e2bdfc5df9a9fcaf676a60459e48dbf510afdda5ce3c525c50eb916ce095f6cf9b6a854701ec0ecb32586d0f697de6aa87c5d1f4da0a1d398f2
-  data.tar.gz: 2d016b7f8c3acf78905a8f4481eb242b5b0484e03bae35fdee154cc6f0473b164ee477ee7af454f8592d06f53b002bfb9dcfa4882daabda0f0b2e8e2d230a48f
+  metadata.gz: 627f1c1c594e0484808169074b956f1cd80fc26856192087db062d891696d97223c8d270998405d3aa123b855f136a3f45a8792b494fb0c9602a4bcecfc9e7d7
+  data.tar.gz: 16278c48625816efe4083323d06e782b1392a4834aac19589502ceafc6cc59aaa0c0e830ed96aaaabd233993cf57686afb027da51dfa4c19ab71df5a6352410a

data/README.md

@@ -1,6 +1,7 @@
-# Communiqué
-
 ![communique logo](https://raw.github.com/Vestorly/communique/master/assets/logo.png)
+
+[![Code Climate](https://codeclimate.com/github/Vestorly/communique/badges/gpa.svg)](https://codeclimate.com/github/Vestorly/communique)
+
 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
 
@@ -23,8 +24,18 @@ Or install it yourself as:
     $ gem install communique
 
 ## Usage
+`include Communique::Notifiable` in the model you want to have notifications eg. the user model.
 
-TODO: Write usage instructions here
+To create a notification:
+```
+Communique.notify(
+    @user,
+    'this_is_the_action_key',
+    context: 'you get some context',
+    more_context: 'you get some context',
+    even_more_context: 'you get some context'
+    )
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/communique.gemspec

@@ -4,29 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'communique/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "communique"
+  spec.name          = 'communique'
   spec.version       = Communique::VERSION
-  spec.authors       = ["Michael Polycarpou"]
-  spec.email         = ["michaelpolycarpou@gmail.com"]
-  spec.summary       = %q{
+  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"
+    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.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"
+  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'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-gem-adapter'
 end

data/lib/communique.rb

@@ -1,12 +1,13 @@
-require "communique/version"
-require "communique/configuration"
-require "communique/models/action"
-require "communique/models/notifiable"
-require "communique/models/notification"
-require "communique/handler"
-
+require 'communique/version'
+require 'communique/configuration'
+require 'communique/models/action'
+require 'communique/models/notifiable'
+require 'communique/models/notification'
+require 'communique/handler'
+
+# communique external methods
 module Communique
-  def self.notify(notifiable, action_key, context_info=nil)
+  def self.notify(notifiable, action_key, context_info = nil)
     action = Action.find_or_create_by(key: action_key)
 
     notification = Notification.create(
@@ -25,15 +26,15 @@ module Communique
     Action.all.to_a
   end
 
-  def self.viewed_all! notifiable
-    Notification.viewed_all! notifiable
+  def self.viewed_all!(notifiable)
+    Notification.viewed_all!(notifiable)
   end
 
-  def self.viewed! notifiable, seen_notification_ids
+  def self.viewed!(notifiable, seen_notification_ids)
     Notification.viewed! notifiable, seen_notification_ids
   end
 
-  def self.count_unseen notifiable
+  def self.count_unseen(notifiable)
     Notification.count_unseen notifiable
   end
 end

data/lib/communique/configuration.rb

@@ -1,13 +1,15 @@
+# top level gem module
 module Communique
   class << self
     attr_accessor :config
   end
 
-  def self.configure(&block)
+  def self.configure
     self.config ||= Configuration.new
     yield config if block_given?
   end
 
+  # Configuration is in charge of handlers other future configurations
   class Configuration
     attr_accessor :user_klass
     attr_accessor :notification_handler

data/lib/communique/handler.rb

@@ -1,7 +1,9 @@
 module Communique
   class NotificationHandlerNotCallable < StandardError; end
+
+  # notification handler can do things like send push notifications and emails
   class Handler
-    def self.external_services notification
+    def self.external_services(notification)
       config = Communique.config
       return if config.nil?
       return if config.notification_handler.nil?
@@ -15,9 +17,10 @@ module Communique
     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"
+      unless handler.respond_to?(:call)
+        fail(
+          NotificationHandlerNotCallable,
+          'notification_handler needs to be nil or a callable block'
         )
       end
     end

data/lib/communique/models/action.rb

@@ -1,5 +1,7 @@
 require 'mongoid'
 module Communique
+  # notificaitons contain an action which gives more info about a certain
+  # message/error. These are what is shown to the user
   class Action
     include ::Mongoid::Document
     include ::Mongoid::Timestamps
@@ -12,9 +14,5 @@ module Communique
     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

@@ -1,11 +1,13 @@
 module Communique
+  # generic model that contains many notifications
   module Notifiable
-
     extend ActiveSupport::Concern
     included do
-      has_many :notifications,
+      has_many(
+        :notifications,
         class_name: 'Communique::Notification',
-                as: :notifiable
+        as: :notifiable
+      )
     end
   end
 end

data/lib/communique/models/notification.rb

@@ -1,5 +1,6 @@
 require 'mongoid'
 module Communique
+  # active model definition for notifications
   class Notification
     include ::Mongoid::Document
     include ::Mongoid::Timestamps
@@ -11,22 +12,18 @@ module Communique
     belongs_to :notifiable, polymorphic: true
     belongs_to :action
 
-    def notify
-      'successful notification'
-    end
-
-    def self.viewed_all! notifiable
+    def self.viewed_all!(notifiable)
       notifiable.notifications.update_all(seen: true)
     end
 
-    def self.viewed! notifiable, seen_notification_ids
+    def self.viewed!(notifiable, seen_notification_ids)
       notifiable.notifications.where(
-        :_id.in =>  seen_notification_ids
-      ).update_all(:seen => true)
+        :_id.in => seen_notification_ids
+      ).update_all(seen: true)
     end
 
-    def self.count_unseen notifiable
-      notifiable.notifications.where(:seen => false).count
+    def self.count_unseen(notifiable)
+      notifiable.notifications.where(seen: false).count
     end
   end
 end

data/lib/communique/version.rb

@@ -1,3 +1,4 @@
+# gem version
 module Communique
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/spec/communique_spec.rb

@@ -1,4 +1,24 @@
-require "spec_helper"
+require 'spec_helper'
 describe Communique do
-
+  describe '#actions' do
+    it 'returns all actions' 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(Communique.actions.count).to eq 2
+      expect(Communique.actions.map(&:key)).to contain_exactly(
+        'r2d2_broke_with_a_500', '3CPO_fell_down_and_hit_his_head'
+      )
+    end
+  end
 end

data/spec/models/handler_spec.rb

@@ -1,10 +1,11 @@
-require "spec_helper"
+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
+        expect(Communique::Handler)
+          .to receive(:external_services)
+          .and_return nil
 
         dummy = NotifiableDummy.create
         Communique.notify(
@@ -16,10 +17,9 @@ describe Communique::Handler do
       end
     end
 
-    context 'with config block' do
-      let(:dummy_handler){HandlerDummy.new}
+    context 'with valid 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)
@@ -36,10 +36,40 @@ describe Communique::Handler do
           location: 'it moves really fast'
         )
 
-        expect(dummy_handler.notification.context_info[:name]).to eq('locked star')
+        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
+
+    context 'with invalid config block' do
+      let(:dummy_handler) { HandlerDummy.new }
+      before(:each) do
+        Communique.configure do |config|
+          config.notification_handler = 'not callable'
+        end
+      end
+      after(:each) do
+        Communique.configure do |config|
+          config.notification_handler = nil
+        end
+      end
+
+      it 'external block gets called' do
+        dummy = NotifiableDummy.create
+        expect do
+          Communique.notify(
+            dummy,
+            'death_star_deadlock',
+            name: 'locked star',
+            location: 'it moves really fast'
+          )
+        end.to raise_error(
+          Communique::NotificationHandlerNotCallable,
+          'notification_handler needs to be nil or a callable block'
+        )
+      end
+    end
   end
 end

data/spec/models/notification_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 describe Communique::Notification do
   describe '#viewed_all!' do
     it 'makes all notifications seen' do
@@ -25,7 +25,6 @@ describe Communique::Notification do
 
       expect(dummy.notifications.first.seen).to be true
       expect(dummy.notifications.last.seen).to be true
-
     end
   end
 
@@ -54,7 +53,6 @@ describe Communique::Notification do
 
       expect(dummy.notifications.first.seen).to be true
       expect(dummy.notifications.last.seen).to be false
-
     end
   end
 
@@ -77,7 +75,6 @@ describe Communique::Notification do
       Communique.viewed_all! dummy
       dummy.reload
       expect(Communique.count_unseen(dummy)).to be 0
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,15 +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 'simplecov'
+require 'simplecov-gem-adapter'
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.start('gem')
+
+['../lib', './models', '../config'].each do |f|
+  $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), f))
+end
 
 require 'database_cleaner'
 require 'mongoid'
 require 'communique'
-require "support/dummy/notifiable_dummy.rb"
-require "support/dummy/handler_dummy.rb"
-require "models/notification_spec.rb"
+require 'support/dummy/notifiable_dummy.rb'
+require 'support/dummy/handler_dummy.rb'
+require 'models/notification_spec.rb'
 
-Mongoid.load!("./config/mongoid.yml", :test)
+Mongoid.load!('./config/mongoid.yml', :test)
 
 RSpec.configure do |config|
   config.before(:suite) do

data/spec/support/dummy/handler_dummy.rb

@@ -1,9 +1,12 @@
+# support spec class that would be replaced with a pusher or email sender.
+# It is able to save the parameters passed to it
+# so that we can test their values.
 class HandlerDummy
   attr_reader :notification
   attr_reader :action
   attr_reader :notifiable
 
-  def push_notification notification, action, notifiable
+  def push_notification(notification, action, notifiable)
     @notification = notification
     @action = action
     @notifiable = notifiable

data/spec/support/dummy/notifiable_dummy.rb

@@ -1,4 +1,5 @@
 require 'mongoid'
+# class that has notifications used for testing
 class NotifiableDummy
   include Mongoid::Document
   include Mongoid::Timestamps

data/spec/support/dummy/notifiable_dummy_spec.rb

@@ -1,9 +1,8 @@
-require "spec_helper"
-require 'pry'
+require 'spec_helper'
 describe NotifiableDummy do
- # it 'has a configuration already set' do
- #   expect(Communique.config).to_not be_nil
- # end
+  it 'has a configuration already set' do
+    expect(Communique.config).to_not be_nil
+  end
 
   it 'has notifications' do
     dummy = NotifiableDummy.new
@@ -16,7 +15,5 @@ describe NotifiableDummy do
 
     )
     expect(dummy.notifications.first.context_info[:name]).to eq('hello')
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: communique
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Polycarpou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,8 +80,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !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: simplecov
+  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: simplecov-gem-adapter
+  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: "\n    Includes a couple models and an api to make it easy to create
-  notifications and\n    the actions associated with them.\n  "
+  notifications\n    and the actions associated with them.\n  "
 email:
 - michaelpolycarpou@gmail.com
 executables: []