6d14259077
Change-Id: Ifb661509145c16937c9f1c28803687b7cec4b3a4 Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/261815 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Rob Orton <rob@instructure.com> QA-Review: Rob Orton <rob@instructure.com> Product-Review: Rob Orton <rob@instructure.com> |
||
|---|---|---|
| .. | ||
| lib | ||
| spec | ||
| .rspec-local | ||
| Gemfile | ||
| README.md | ||
| broadcast_policy.gemspec | ||
| test.sh | ||
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? } p.data { course_id: course_id, root_account_id: root_account_id} 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
Copyright (C) 2014 - present Instructure, Inc.
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/.