hertz 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c8e68503e096686df34154aa408c9be5c6da1b2
-  data.tar.gz: 29e1f953432781ae90ce94c4df6b852eb51874ce
+SHA256:
+  metadata.gz: 6d6cb83749f5c26265f7c4e034bc4d7b4a860ff9e976bd9749ece869d04b0312
+  data.tar.gz: dbbf0fe3c453b17d7178849aa50114ee38dfe319b4b1a41ae26ad29009f7d743
 SHA512:
-  metadata.gz: 71e5878ddeb33fb7624b16856773816ed0179703f749cca80ad5ee54b68ccec2657318f3f508a83b582612e6adbc320dbbf1933c6049d0e5a73fc346add26cf6
-  data.tar.gz: b096290f7a0dd92c9769d741e9c9001ef4020a91e2caf37d1be73deb6c5767af7d7da696f757ba5e07f27ac8d2d99f66f4fe6033569893456516d51ce0e4f228
+  metadata.gz: 1f27a28147d6d505617f383480afd38161c3bc2ab86dd5bcc1c2554ca3bd511f0a3e89303bdef31692d2bd9633e5df81c265980570f322037ab364c8ce197f71
+  data.tar.gz: 8b7e1d023865f0f17a83a5e56ad891c62b6d6a1fd4e23a2efb201b1356a58cfdbce8468c5a4ef6d388d0f41af5b4d079c20306125e9b42fe1c3ee8bb58f826bf

data/README.md

@@ -1,8 +1,8 @@
 # Hertz
 
-[![Gem Version](https://img.shields.io/gem/v/hertz.svg?maxAge=3600&style=flat-square)](https://rubygems.org/gems/hertz)
-[![Dependency Status](https://img.shields.io/gemnasium/alessandro1997/hertz.svg?maxAge=3600&style=flat-square)](https://gemnasium.com/github.com/alessandro1997/hertz)
-[![Code Climate](https://img.shields.io/codeclimate/github/alessandro1997/hertz.svg?maxAge=3600&style=flat-square)](https://codeclimate.com/github/alessandro1997/hertz)
+[![Build Status](https://travis-ci.org/aldesantis/hertz.svg?branch=master)](https://travis-ci.org/aldesantis/hertz)
+[![Coverage Status](https://coveralls.io/repos/github/aldesantis/hertz/badge.svg?branch=master)](https://coveralls.io/github/aldesantis/hertz?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/84d43f19a0ec0bf62ede/maintainability)](https://codeclimate.com/github/aldesantis/hertz/maintainability)
 
 Hertz is a Ruby on Rails engine for sending in-app notifications to your users.
 
@@ -33,8 +33,7 @@ $ rails g hertz:install
 $ rake db:migrate
 ```
 
-Finally, add the following to the model that will receive the notifications
-(e.g. `User`):
+Finally, add the following to the model that will receive the notifications (e.g. `User`):
 
 ```ruby
 class User < ActiveRecord::Base
@@ -46,39 +45,32 @@ end
 
 ### Using couriers
 
-Couriers are what Hertz uses to deliver notifications to your users. For
-instance, you might have a courier for delivering notifications by SMS and
-another one for delivering them by email.
+Couriers are what Hertz uses to deliver notifications to your users. For instance, you might have a courier for 
+delivering notifications by SMS and another one for delivering them by email.
 
 Creating a new courier in Hertz is easy:
 
 ```ruby
 module Hertz
-  module Courier
-    class Sms
-      def self.deliver_notification(notification)
-        # ...
-      end
+  class Sms
+    def self.deliver_notification(notification)
+      # ...
     end
   end
 end
 ```
 
-Again, you don't have to use couriers if you only display notifications on your
-website using standard AR methods.
-
 ### Creating new notification types
 
-In Hertz, every notification is a model. If you want to create a new
-notification type, just create a new model inheriting from
-`Hertz::Notification`:
+In Hertz, every notification is a model. If you want to create a new notification type, just create a new model
+inheriting from `Hertz::Notification`:
 
 ```ruby
 class CommentNotification < Hertz::Notification
 end
 ```
-Since not all notifications might implement interfaces for all couriers, you
-have to manually specify which couriers they implement via `deliver_by`:
+Since not all notifications might implement interfaces for all couriers, you have to manually specify which couriers 
+they implement via `deliver_by`:
 
 ```ruby
 class CommentNotification < Hertz::Notification
@@ -88,8 +80,8 @@ end
 
 Notifications are not required to implement any couriers.
 
-You can set common couriers (i.e. couriers that will be used for all
-notifications) by putting the following into an initializer:
+You can set common couriers (i.e. couriers that will be used for all notifications) by putting the following into an 
+initializer:
 
 ```ruby
 Hertz.configure do |config|
@@ -99,8 +91,7 @@ end
 
 ### Attaching metadata to a notification
 
-You can attach custom metadata to a notification, but make sure it can be
-cleanly stored in an hstore:
+You can attach custom metadata to a notification, but make sure it can be cleanly stored in an hstore:
 
 ```ruby
 notification = CommentNotification.new(meta: { comment_id: comment.id })
@@ -117,8 +108,7 @@ class CommentNotification < Hertz::Notification
 end
 ```
 
-Note that you should always access your metadata with string keys, regardless of
-the type you use when attaching it.
+Note that you should always access your metadata with string keys, regardless of the type you use when attaching it.
 
 ### Notifying users
 
@@ -134,6 +124,7 @@ You can access a user's notifications with `#notifications`:
 
 ```ruby
 current_user.notifications
+current_user.notifications.read
 current_user.notifications.unread
 ```
 
@@ -146,9 +137,8 @@ notification.mark_as_unread
 
 ### Tracking delivery status
 
-Hertz provides an API couriers can use to mark the notification as delivered.
-This allows you to know which couriers have successfully delivered your
-notifications and helps prevent double deliveries:
+Hertz provides an API couriers can use to mark the notification as delivered. This allows you to know which couriers
+have successfully delivered your notifications and helps prevent double deliveries:
 
 ```ruby
 notification.delivered_with?(:email) # => false
@@ -156,24 +146,19 @@ notification.mark_delivered_with(:email) # => Hertz::Delivery
 notification.delivered_with?(:email) # => true
 ```
 
-Hertz does not enforce usage of the delivery API in any way, so some couriers
-might not take advantage of it.
+Hertz does not enforce usage of the delivery API in any way, so some couriers might not take advantage of it.
 
 ## Available couriers
 
-- [hertz-courier-twilio](https://github.com/alessandro1997/hertz-courier-twilio):
-  delivers notifications by SMS with the Twilio API.
-- [hertz-courier-email](https://github.com/alessandro1997/hertz-courier-email):
-  delivers notifications by email with ActionMailer.
-- [hertz-courier-intercom](https://github.com/alessandro1997/hertz-courier-intercom):
-  delivers notifications as Intercom conversations.
+- [hertz-twilio](https://github.com/aldesantis/hertz-twilio): delivers notifications by SMS with the
+  Twilio API.
+- [hertz-email](https://github.com/aldesantis/hertz-email): delivers notifications by email with 
+  ActionMailer.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/alessandro1997/hertz.
+Bug reports and pull requests are welcome on GitHub at https://github.com/aldesantis/hertz.
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/app/models/hertz/delivery.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hertz
   class Delivery < ActiveRecord::Base
     belongs_to :notification, inverse_of: :deliveries

data/app/models/hertz/notification.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 module Hertz
   class Notification < ActiveRecord::Base
     @couriers = []
 
+    scope :read, -> { where 'read_at IS NOT NULL' }
     scope :unread, -> { where 'read_at IS NULL' }
 
     belongs_to :receiver, inverse_of: :notifications, polymorphic: true

data/db/migrate/20160415174901_create_hertz_notifications.rb

@@ -1,4 +1,4 @@
-class CreateHertzNotifications < ActiveRecord::Migration
+class CreateHertzNotifications < ActiveRecord::Migration[5.0]
   def change
     enable_extension 'hstore'
 

data/db/migrate/20160627084018_create_hertz_notification_deliveries.rb

@@ -1,4 +1,4 @@
-class CreateHertzNotificationDeliveries < ActiveRecord::Migration
+class CreateHertzNotificationDeliveries < ActiveRecord::Migration[5.0]
   def change
     create_table :hertz_notification_deliveries do |t|
       t.integer :notification_id, null: false

data/db/migrate/20160628084342_rename_notification_deliveries_to_deliveries.rb

@@ -1,4 +1,4 @@
-class RenameNotificationDeliveriesToDeliveries < ActiveRecord::Migration
+class RenameNotificationDeliveriesToDeliveries < ActiveRecord::Migration[5.0]
   def change
     rename_table :hertz_notification_deliveries, :hertz_deliveries
   end

data/lib/generators/hertz/install_generator.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Hertz
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def copy_initializer_file
       copy_file 'initializer.rb', 'config/initializers/hertz.rb'

data/lib/generators/hertz/templates/initializer.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 Hertz.configure do |config|
 end

data/lib/hertz.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'hertz/engine'
 
 require 'hertz/notifiable'

data/lib/hertz/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hertz
   class Engine < ::Rails::Engine
     isolate_namespace Hertz

data/lib/hertz/notifiable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hertz
   module Notifiable
     def self.included(base)

data/lib/hertz/notification_deliverer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hertz
   class NotificationDeliverer
     class << self
@@ -15,7 +16,7 @@ module Hertz
       end
 
       def build_courier(courier)
-        "Hertz::Courier::#{courier.to_s.camelcase}".constantize
+        "Hertz::#{courier.to_s.camelcase}".constantize
       end
     end
   end

data/lib/hertz/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hertz
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/spec/dummy/config/database.travis.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  database: hertz_test
+  username: postgres

data/spec/factories/hertz/deliveries.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-FactoryGirl.define do
+
+FactoryBot.define do
   factory :delivery, class: 'Hertz::Delivery' do
     association :notification, strategy: :build
-    courier 'test'
+    courier { 'test' }
   end
 end

data/spec/factories/hertz/notifications.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-FactoryGirl.define do
+
+FactoryBot.define do
   factory :notification, class: 'Hertz::Notification' do
-    type 'Hertz::Notification'
+    type { 'Hertz::Notification' }
     association :receiver, factory: :user, strategy: :build
 
     trait :read do

data/spec/factories/users.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-FactoryGirl.define do
+
+FactoryBot.define do
   factory :user do
   end
 end

data/spec/hertz/hertz_spec.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 RSpec.describe Hertz do
   describe '.configure' do
-    after(:each) { described_class.common_couriers = [] }
+    after { described_class.common_couriers = [] }
 
     it 'configures the module' do
       expect {

data/spec/hertz/notifiable_spec.rb

@@ -1,40 +1,39 @@
 # frozen_string_literal: true
-module Hertz
-  RSpec.describe Notifiable do
-    let(:user) { create(:user) }
 
-    describe '.notifications' do
-      let!(:notification) { create(:notification, receiver: user) }
+RSpec.describe Hertz::Notifiable do
+  let(:user) { create(:user) }
 
-      it "returns the receiver's notifications" do
-        expect(user.notifications).to eq([notification])
-      end
+  describe '.notifications' do
+    let!(:notification) { create(:notification, receiver: user) }
+
+    it "returns the receiver's notifications" do
+      expect(user.notifications).to eq([notification])
     end
+  end
 
-    describe '#notify' do
-      before(:all) do
-        class TestNotification < Hertz::Notification; end
-      end
+  describe '#notify' do
+    before do
+      class TestNotification < Hertz::Notification; end
+    end
 
-      context 'with a notification object' do
-        subject { -> { user.notify(TestNotification.new) } }
+    context 'with a notification object' do
+      subject { -> { user.notify(TestNotification.new) } }
 
-        it 'notifies the receiver' do
-          expect(subject).to change(user.notifications, :count).by(1)
-        end
+      it 'notifies the receiver' do
+        expect(subject).to change(user.notifications, :count).by(1)
       end
+    end
 
-      context 'with a notification class' do
-        subject { -> { user.notify(TestNotification, foo: 'bar') } }
+    context 'with a notification class' do
+      subject { -> { user.notify(TestNotification, foo: 'bar') } }
 
-        it 'notifies the receiver' do
-          expect(subject).to change(user.notifications, :count).by(1)
-        end
+      it 'notifies the receiver' do
+        expect(subject).to change(user.notifications, :count).by(1)
+      end
 
-        it 'sets the provided meta' do
-          subject.call
-          expect(user.notifications.last.meta).to eq('foo' => 'bar')
-        end
+      it 'sets the provided meta' do
+        subject.call
+        expect(user.notifications.last.meta).to eq('foo' => 'bar')
       end
     end
   end

data/spec/hertz/notification_deliverer_spec.rb

@@ -1,65 +1,58 @@
 # frozen_string_literal: true
-module Hertz
-  RSpec.describe NotificationDeliverer do
-    subject { described_class }
 
-    before(:all) do
-      module Courier
-        class Test
-          def self.deliver_notification(_notification)
-          end
-        end
+RSpec.describe Hertz::NotificationDeliverer do
+  subject { described_class }
+
+  before do
+    module Hertz
+      class Test
+        def self.deliver_notification(_notification); end
       end
     end
+  end
 
-    describe '#deliver' do
-      let(:notification) do
-        Class.new(TestNotification) do
-          deliver_by :test
-        end.new
-      end
+  describe '#deliver' do
+    let(:notification) do
+      Class.new(TestNotification) do
+        deliver_by :test
+      end.new
+    end
 
-      it 'delivers the notification through the couriers' do
-        expect(Hertz::Courier::Test).to receive(:deliver_notification)
-          .once
-          .with(notification)
+    it 'delivers the notification through the couriers' do
+      expect(Hertz::Test).to receive(:deliver_notification)
+        .once
+        .with(notification)
 
-        subject.deliver(notification)
-      end
+      subject.deliver(notification)
+    end
 
-      context 'when common couriers are defined' do
-        before(:all) do
-          module Courier
-            class Common
-              def self.deliver_notification(_notification)
-              end
-            end
+    context 'when common couriers are defined' do
+      before do
+        module Hertz
+          class Common
+            def self.deliver_notification(_notification); end
           end
         end
 
-        before(:each) do
-          allow(Hertz).to receive(:common_couriers)
-            .and_return([:common])
-
-          allow(Hertz::Courier::Test).to receive(:deliver_notification)
-          allow(Hertz::Courier::Common).to receive(:deliver_notification)
-        end
+        allow(Hertz).to receive(:common_couriers).and_return([:common])
+        allow(Hertz::Test).to receive(:deliver_notification)
+        allow(Hertz::Common).to receive(:deliver_notification)
+      end
 
-        it 'uses common couriers' do
-          expect(Hertz::Courier::Test).to receive(:deliver_notification)
-            .once
-            .with(notification)
+      it 'uses common couriers' do
+        expect(Hertz::Test).to receive(:deliver_notification)
+          .once
+          .with(notification)
 
-          subject.deliver(notification)
-        end
+        subject.deliver(notification)
+      end
 
-        it 'uses model-specific couriers' do
-          expect(Hertz::Courier::Common).to receive(:deliver_notification)
-            .once
-            .with(notification)
+      it 'uses model-specific couriers' do
+        expect(Hertz::Common).to receive(:deliver_notification)
+          .once
+          .with(notification)
 
-          subject.deliver(notification)
-        end
+        subject.deliver(notification)
       end
     end
   end