History

Cody Cutrer 972b3b6ac8 fix Rails 5 deprecation warnings in migrations except for CleanseTheSyckness, where serialized_attributes has been removed without replacement Change-Id: Ie0d81c17effa4b40b285f5d7108fa2586a8ce9ab Reviewed-on: https://gerrit.instructure.com/89330 Tested-by: Jenkins Reviewed-by: Simon Williams <simon@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com> QA-Review: Cody Cutrer <cody@instructure.com>		2016-08-31 22:09:34 +00:00
..
lib	fix Rails 5 deprecation warnings in migrations	2016-08-31 22:09:34 +00:00
spec	fix Rails 5 deprecation warnings in migrations	2016-08-31 22:09:34 +00:00
.rspec-local	gemify broadcast policy	2014-09-24 11:35:33 +00:00
Gemfile	gemify broadcast policy	2014-09-24 11:35:33 +00:00
README.md	Support class reloading with BroadcastPolicy	2016-02-11 11:08:17 -05:00
broadcast_policy.gemspec	determine recipients and queue notifications _after_ transaction commit	2015-08-20 15:26:21 +00:00
test.sh	simplify gem test harnesses	2016-01-19 17:52:58 +00:00

README.md

BroadcastPolicy

This allows us to do something like:

class Model < ActiveRecord::Base has_a_broadcast_policy

set_broadcast_policy do |p| p.dispatch :notification_name p.to { some_endpoints } p.whenever { |record| record.foo_is_true? && record.bar_is_false? } end

end

Usage

In order to use the gem in Rails, you'll need an initializer something like this:

config/initializers/broadcast_policy.rb

require 'broadcast_policy' Rails.configuration.to_prepare do BroadcastPolicy.notifier = lambda { Notifier.new } BroadcastPolicy.notification_finder = lambda { NotificationFinder.new(Notification.all_cached) } end ActiveRecord::Base.send(:extend, BroadcastPolicy::ClassMethods)

The two BroadcastPolicy services are necessary to supply the canvas domain objects for integrating with the notification system License

This file is part of Canvas.

Canvas is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.

Canvas is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.