Module: ActivityNotification::SubscriptionApi
- Extended by:
- ActiveSupport::Concern
- Included in:
- ORM::ActiveRecord::Subscription, ORM::Mongoid::Subscription
- Defined in:
- lib/activity_notification/apis/subscription_api.rb
Overview
Defines API for subscription included in Subscription model.
Class Method Summary collapse
-
.filtered_by_key ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Selects filtered subscriptions by key.
-
.filtered_by_options ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Selects filtered subscriptions by key with filter options.
-
.to_optional_target_key(optional_target_name) ⇒ Symbol
Returns key of optional_targets hash from symbol class name of the optional target implementation.
-
.to_optional_target_subscribed_at_key(optional_target_name) ⇒ Symbol
Returns subscribed_at parameter key of optional_targets hash from symbol class name of the optional target implementation.
-
.to_optional_target_unsubscribed_at_key(optional_target_name) ⇒ Symbol
Returns unsubscribed_at parameter key of optional_targets hash from symbol class name of the optional target implementation.
Instance Method Summary collapse
-
#earliest_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by earliest (older) first as created_at: :asc.
-
#earliest_subscribed_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by earliest (older) first as subscribed_at: :asc.
-
#key_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by key name as key: :asc.
-
#latest_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by latest (newest) first as created_at: :desc.
-
#latest_subscribed_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by latest (newest) first as subscribed_at: :desc.
-
#optional_target_names ⇒ Array<Symbol>
Returns optional_target names of the subscription from optional_targets field.
-
#subscribe(options = {}) ⇒ Boolean
Subscribes to the notification and notification email.
-
#subscribe_to_email(options = {}) ⇒ Boolean
Subscribes to the notification email.
-
#subscribe_to_optional_target(optional_target_name, options = {}) ⇒ Boolean
Subscribes to the specified optional target.
-
#subscribing_to_optional_target?(optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default) ⇒ Boolean
Returns if the target subscribes to the specified optional target.
-
#unsubscribe(options = {}) ⇒ Boolean
Unsubscribes to the notification and notification email.
-
#unsubscribe_to_email(options = {}) ⇒ Boolean
Unsubscribes to the notification email.
-
#unsubscribe_to_optional_target(optional_target_name, options = {}) ⇒ Boolean
Unsubscribes to the specified optional target.
Class Method Details
.filtered_by_key ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Selects filtered subscriptions by key.
13 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 13 scope :filtered_by_key, ->(key) { where(key: key) } |
.filtered_by_options ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Selects filtered subscriptions by key with filter options.
25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 25 scope :filtered_by_options, ->( = {}) { = ActivityNotification.cast_to_indifferent_hash() filtered_subscriptions = all if .has_key?(:filtered_by_key) filtered_subscriptions = filtered_subscriptions.filtered_by_key([:filtered_by_key]) end if .has_key?(:custom_filter) filtered_subscriptions = filtered_subscriptions.where([:custom_filter]) end filtered_subscriptions } |
.to_optional_target_key(optional_target_name) ⇒ Symbol
Returns key of optional_targets hash from symbol class name of the optional target implementation.
62 63 64 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 62 def to_optional_target_key(optional_target_name) ("subscribing_to_" + optional_target_name.to_s).to_sym end |
.to_optional_target_subscribed_at_key(optional_target_name) ⇒ Symbol
Returns subscribed_at parameter key of optional_targets hash from symbol class name of the optional target implementation.
69 70 71 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 69 def to_optional_target_subscribed_at_key(optional_target_name) ("subscribed_to_" + optional_target_name.to_s + "_at").to_sym end |
.to_optional_target_unsubscribed_at_key(optional_target_name) ⇒ Symbol
Returns unsubscribed_at parameter key of optional_targets hash from symbol class name of the optional target implementation.
76 77 78 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 76 def to_optional_target_unsubscribed_at_key(optional_target_name) ("unsubscribed_to_" + optional_target_name.to_s + "_at").to_sym end |
Instance Method Details
#earliest_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by earliest (older) first as created_at: :asc.
43 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 43 scope :earliest_order, -> { order(created_at: :asc) } |
#earliest_subscribed_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by earliest (older) first as subscribed_at: :asc.
51 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 51 scope :earliest_subscribed_order, -> { order(subscribed_at: :asc) } |
#key_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by key name as key: :asc.
55 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 55 scope :key_order, -> { order(key: :asc) } |
#latest_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by latest (newest) first as created_at: :desc.
39 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 39 scope :latest_order, -> { order(created_at: :desc) } |
#latest_subscribed_order ⇒ ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>
Orders by latest (newest) first as subscribed_at: :desc.
47 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 47 scope :latest_subscribed_order, -> { order(subscribed_at: :desc) } |
#optional_target_names ⇒ Array<Symbol>
Returns optional_target names of the subscription from optional_targets field.
184 185 186 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 184 def optional_target_names optional_targets.keys.select { |key| key.to_s.start_with?("subscribing_to_") }.map { |key| key.slice(15..-1) } end |
#subscribe(options = {}) ⇒ Boolean
Subscribes to the notification and notification email.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 88 def subscribe( = {}) subscribed_at = [:subscribed_at] || Time.current with_email_subscription = .has_key?(:with_email_subscription) ? [:with_email_subscription] : true with_optional_targets = .has_key?(:with_optional_targets) ? [:with_optional_targets] : true new_attributes = { subscribing: true, subscribed_at: subscribed_at, optional_targets: optional_targets } new_attributes = new_attributes.merge(subscribing_to_email: true, subscribed_to_email_at: subscribed_at) if with_email_subscription if with_optional_targets optional_target_names.each do |optional_target_name| new_attributes[:optional_targets] = new_attributes[:optional_targets].merge( Subscription.to_optional_target_key(optional_target_name) => true, Subscription.to_optional_target_subscribed_at_key(optional_target_name) => subscribed_at) end end update(new_attributes) end |
#subscribe_to_email(options = {}) ⇒ Boolean
Subscribes to the notification email.
127 128 129 130 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 127 def subscribe_to_email( = {}) subscribed_to_email_at = [:subscribed_to_email_at] || Time.current update(subscribing_to_email: true, subscribed_to_email_at: subscribed_to_email_at) end |
#subscribe_to_optional_target(optional_target_name, options = {}) ⇒ Boolean
Subscribes to the specified optional target.
160 161 162 163 164 165 166 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 160 def subscribe_to_optional_target(optional_target_name, = {}) subscribed_at = [:subscribed_at] || Time.current update(optional_targets: optional_targets.merge( Subscription.to_optional_target_key(optional_target_name) => true, Subscription.to_optional_target_subscribed_at_key(optional_target_name) => subscribed_at) ) end |
#subscribing_to_optional_target?(optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default) ⇒ Boolean
Returns if the target subscribes to the specified optional target.
147 148 149 150 151 152 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 147 def subscribing_to_optional_target?(optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default) optional_target_key = Subscription.to_optional_target_key(optional_target_name) subscribe_as_default ? !optional_targets.has_key?(optional_target_key) || optional_targets[optional_target_key] : optional_targets.has_key?(optional_target_key) && optional_targets[optional_target_key] end |
#unsubscribe(options = {}) ⇒ Boolean
Unsubscribes to the notification and notification email.
109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 109 def unsubscribe( = {}) unsubscribed_at = [:unsubscribed_at] || Time.current new_attributes = { subscribing: false, unsubscribed_at: unsubscribed_at, subscribing_to_email: false, unsubscribed_to_email_at: unsubscribed_at, optional_targets: optional_targets } optional_target_names.each do |optional_target_name| new_attributes[:optional_targets] = new_attributes[:optional_targets].merge( Subscription.to_optional_target_key(optional_target_name) => false, Subscription.to_optional_target_unsubscribed_at_key(optional_target_name) => subscribed_at) end update(new_attributes) end |
#unsubscribe_to_email(options = {}) ⇒ Boolean
Unsubscribes to the notification email.
137 138 139 140 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 137 def unsubscribe_to_email( = {}) unsubscribed_to_email_at = [:unsubscribed_to_email_at] || Time.current update(subscribing_to_email: false, unsubscribed_to_email_at: unsubscribed_to_email_at) end |
#unsubscribe_to_optional_target(optional_target_name, options = {}) ⇒ Boolean
Unsubscribes to the specified optional target.
174 175 176 177 178 179 180 |
# File 'lib/activity_notification/apis/subscription_api.rb', line 174 def unsubscribe_to_optional_target(optional_target_name, = {}) unsubscribed_at = [:unsubscribed_at] || Time.current update(optional_targets: optional_targets.merge( Subscription.to_optional_target_key(optional_target_name) => false, Subscription.to_optional_target_unsubscribed_at_key(optional_target_name) => unsubscribed_at) ) end |