rails-alerter 0.0.5

data/spec/models/mailbox_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Alerter::Mailbox do
+
+  before do
+    @entity1 = FactoryGirl.create(:user)
+    @entity2 = FactoryGirl.create(:user)
+
+    @receipt1 =  @entity1.send_message("short","long","normal")
+    @receipt2 =  @entity2.send_message("short","long","normal")
+    @receipt3 =  @entity1.send_message("short","long","normal")
+
+    @msg1 = @receipt1.message
+    @msg2 = @receipt2.message
+    @msg3 = @receipt3.message
+  end
+
+  it "should return all mail" do
+    expect(@entity1.mailbox.all_messages).to match_array([@msg1, @msg3])
+    expect(@entity2.mailbox.all_messages).to match_array([@msg2])
+  end
+
+
+  it "should return inbox" do
+    expect(@entity1.mailbox.inbox).to match_array([@msg1, @msg3])
+  end
+
+  it "should return trash and ensure deleted messages are not shown in inbox" do
+    expect(@entity1.mailbox.inbox).to match_array([@msg1, @msg3])
+    @msg1.mark_as_deleted(@entity1)
+    expect(@entity1.mailbox.trash).to match_array([@msg1])
+  end
+
+  it "should understand the read option for all messages" do
+    expect(@entity1.mailbox.all_messages.read).to match_array([])
+    expect(@entity1.mailbox.all_messages.unread).to match_array([@msg1, @msg3])
+    @msg1.mark_as_read(@entity1)
+    expect(@entity1.mailbox.all_messages.read).to match_array([@msg1])
+  end
+
+  it "should understand the read option" do
+    expect(@entity1.mailbox.inbox.read).to match_array([])
+    expect(@entity1.mailbox.inbox.unread).to match_array([@msg1, @msg3])
+    @msg1.mark_as_read(@entity1)
+    expect(@entity1.mailbox.inbox.read).to match_array([@msg1])
+  end
+
+  it "should understand the unread option" do
+    expect(@entity1.mailbox.inbox.unread).to match_array([@msg1, @msg3])
+    expect(@entity1.mailbox.inbox.read).to match_array([])
+    @msg3.mark_as_read(@entity1)
+    expect(@entity1.mailbox.inbox.read).to match_array([@msg3])
+  end
+
+end

data/spec/models/message_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Alerter::Message do
+
+  before do
+    @entity1 = FactoryGirl.create(:user)
+    message_disp = double('MessageDispatcher')
+    expect(Alerter::MessageDispatcher).to receive(:new).with(instance_of(Alerter::Message), [@entity1]).and_return message_disp
+    expect(message_disp).to receive(:call)
+    @receipt1 = @entity1.send_message("Short","Long","MyType")
+    @message1 = @receipt1.message
+  end
+
+  it "should have right recipients" do
+  	expect(@receipt1.message.recipients.count).to eq 1
+  end
+
+  it "should be able to be marked as deleted" do
+    expect(@receipt1.deleted).to be_falsey
+    @message1.mark_as_deleted(@entity1)
+    expect(@message1.is_deleted?(@entity1)).to be_truthy
+  end
+
+  it "should be able to be marked as read" do
+    expect(@message1.is_unread?(@entity1)).to be_truthy
+    @message1.mark_as_read(@entity1)
+    expect(@message1.is_read?(@entity1)).to be_truthy
+  end
+
+  it "should not be expired" do
+    expect(@message1.expired?).to be_falsey
+  end
+
+  it "should include message in unexpired list" do
+    expect(Alerter::Message.unexpired).to include @message1
+  end
+
+  it "should expire message" do
+    @message1.expire!
+    expect(@message1.expired?).to be_truthy
+  end
+
+  it "should include message in expired list" do
+    @message1.expire!
+    expect(Alerter::Message.expired).to include @message1
+  end
+
+  it "should not be global" do
+    expect(Alerter::Message.global).to eq []
+  end
+end

data/spec/models/preference_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Alerter::Preference do
+
+  before do
+    @user = FactoryGirl.create(:user)
+    @notification_type = FactoryGirl.create(:notification_type)
+  end
+
+  it "should return methods as an array" do
+    expect(@user.notification_methods(@notification_type).is_a?(Array)).to be_truthy
+  end
+
+  it "should allow methods to set to nil" do
+    @user.configure_notification_methods(@notification_type, nil)
+    expect(@user.notification_methods(@notification_type)).to match_array([])
+  end
+
+  it "should allow a single method to be set" do
+    @user.configure_notification_methods(@notification_type, nil)
+    method = Alerter::available_notification_methods.sample
+    @user.configure_notification_methods(@notification_type, method)
+    expect(@user.notification_methods(@notification_type)).to match_array([ method ])
+  end
+
+  it "should allow multiple methods to be set" do
+    @user.configure_notification_methods(@notification_type, nil)
+    methods = Alerter::available_notification_methods
+    @user.configure_notification_methods(@notification_type, methods)
+    expect(@user.notification_methods(@notification_type)).to match_array( methods )
+  end
+
+
+
+end

data/spec/models/receipt_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Alerter::Receipt do
+
+  before do
+    @entity1 = FactoryGirl.create(:user)
+    @mail1 = @entity1.send_message("short","long","info")
+  end
+
+  it "should belong to a message" do
+    assert @mail1.message
+  end
+
+  it "should be able to be marked as unread" do
+    @mail1.mark_as_read
+    expect(@mail1.is_read).to be true
+    @mail1.mark_as_unread
+    expect(@mail1.is_read).to be false
+  end
+
+  it "should be included in unread search" do
+    @mail1.mark_as_read
+    expect(Alerter::Receipt.is_read).to include @mail1
+  end
+
+  it "should be able to be marked as read" do
+    @mail1.mark_as_read
+    expect(@mail1.is_read).to be true
+    @mail1.mark_as_unread
+    @mail1.mark_as_read
+    expect(@mail1.is_read).to be true
+  end
+
+  it "should be included in read search" do
+    expect(Alerter::Receipt.is_unread).to include @mail1
+  end
+
+  it "should be able to be marked as deleted" do
+    expect(@mail1.deleted).to be false
+    @mail1.mark_as_deleted
+    expect(@mail1.deleted).to be true
+  end
+
+  it "should be able to be marked as not deleted" do
+    @mail1.mark_as_deleted
+    expect(@mail1.deleted).to be true
+    @mail1.mark_as_not_deleted
+    expect(@mail1.deleted).to be false
+  end
+
+  context "STI models" do
+    before do
+      @entity2 = FactoryGirl.create(:user)
+      @mail2 = @entity2.send_message("short","long","info")
+    end
+
+    it "should refer to the correct base class" do
+      expect(@mail2.receiver_type).to eq @entity2.class.base_class.to_s
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+require 'simplecov'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rspec/rails"
+
+require 'rspec/its'
+require 'rspec/collection_matchers'
+require 'pry'
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+require "capybara/rails"
+Capybara.default_driver   = :rack_test
+Capybara.default_selector = :css
+
+# Run any available migration
+
+# Dummy app migrations
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Engine migrations
+ActiveRecord::Migrator.migrate File.expand_path("../../db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load Factories
+require 'factory_girl'
+Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| require f}
+
+# Shoulda Matchers
+require 'shoulda/matchers'
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+
+  # Rspec only clears out ActionMailer::Base#deliveries for mailers specs
+  config.after(:each, type: :integration){ ActionMailer::Base.deliveries.clear }
+
+  config.infer_spec_type_from_file_location!
+end

metadata

@@ -0,0 +1,330 @@
+--- !ruby/object:Gem::Specification
+name: rails-alerter
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Michael Kazmier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreigner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !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: pry-rails
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: forgery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+- !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: Many apps need to send basic notifications to users, often using multiple
+  delivery methods (like email, push notifications, SMS, twitter, etc).  This gem
+  is designed to make that process easy and track the state of the notification in
+  a centralized fashion.
+email:
+- dakazmier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Appraisals
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- alerter.gemspec
+- app/builders/alerter/base_builder.rb
+- app/builders/alerter/message_builder.rb
+- app/builders/alerter/receipt_builder.rb
+- app/mailers/alerter/base_mailer.rb
+- app/mailers/alerter/message_mailer.rb
+- app/models/alerter/mailbox.rb
+- app/models/alerter/message.rb
+- app/models/alerter/notification_type.rb
+- app/models/alerter/preference.rb
+- app/models/alerter/receipt.rb
+- app/views/alerter/message_mailer/new_message_email.html.erb
+- app/views/alerter/message_mailer/new_message_email.text.erb
+- db/migrate/20150821000000_create_alerter.rb
+- lib/alerter/cleaner.rb
+- lib/alerter/engine.rb
+- lib/alerter/message_dispatcher.rb
+- lib/alerter/models/notifiable.rb
+- lib/alerter/version.rb
+- lib/generators/alerter/install_generator.rb
+- lib/generators/alerter/namespacing_compatibility_generator.rb
+- lib/generators/alerter/templates/initializer.rb
+- lib/generators/alerter/views_generator.rb
+- lib/rails-alerter.rb
+- spec/alerter/message_dispatcher_spec.rb
+- spec/alerter_spec.rb
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/cylon.rb
+- spec/dummy/app/models/duck.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/home/index.html.haml
+- spec/dummy/app/views/layouts/application.html.haml
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/alerter.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/sunspot.yml
+- spec/dummy/db/migrate/20110228120600_create_users.rb
+- spec/dummy/db/migrate/20110306002940_create_ducks.rb
+- spec/dummy/db/migrate/20110306015107_create_cylons.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/index.html
+- spec/dummy/public/robots.txt
+- spec/dummy/public/uploads/testfile.txt
+- spec/dummy/script/rails
+- spec/factories/general.rb
+- spec/integration/message_and_receipt_spec.rb
+- spec/integration/navigation_spec.rb
+- spec/mailers/message_mailer_spec.rb
+- spec/models/alerter_models_messageable_spec.rb
+- spec/models/mailbox_spec.rb
+- spec/models/message_spec.rb
+- spec/models/preference_spec.rb
+- spec/models/receipt_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DaKaZ/alerter
+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: Messaging system for rails apps.
+test_files: []