noticed 2.4.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e3f12e1bfdc3fee47e90917d632fc707c0379f3851aa95debcbcd944e0841f0
-  data.tar.gz: c4dbd8f7cb9f789e45aad0498f1847a2a7cc9941605b0435af63a8ed53b2a663
+  metadata.gz: 5d93cc608d5422344ca6aff8b4941508dc76b3192e9052c853677f2bc222a98e
+  data.tar.gz: 7932559c8b60c97b0798815872f8146588bfb7bb3b82cb5a3a60e53fbe49bf14
 SHA512:
-  metadata.gz: 2df23c79cb20b81a5512ba595d123fa234068699045e08a53bbd37415ae71b926b9a40201e0a85c7d93e7fff373e8cf30dce088f2640d4fed24b8d4f2251d5bd
-  data.tar.gz: daae0697cd21ac8f1099a08e442cfc48ed637677333a29c61dc79bc8746bf6e8c056f137ce26cacd2ab3f75406fe8dbaa7b319d9bddc387fa7d452592b61b0c2
+  metadata.gz: 223e40cacfffb9da94953284319f5fb865161996daf39d0c7b3c5697cd41e1923fc394e3d3ee782d1eba8513adcb91006ef6bc962fb1908672181eb024de880c
+  data.tar.gz: aac70f09103d1737c5cef2cbfdf87275cc5f595dc84ffd38500561585c4f89574e427448fc8011cbc0bb16b9b06f191cecbadc9831ed8c60a857b0cf9e2d330b

data/README.md

@@ -41,6 +41,7 @@ Delivery methods we officially support:
 
 Bulk delivery methods we support:
 
+* [Bluesky](docs/bulk_delivery_methods/bluesky.md)
 * [Discord](docs/bulk_delivery_methods/discord.md)
 * [Slack](docs/bulk_delivery_methods/slack.md)
 * [Webhook](docs/bulk_delivery_methods/webhook.md)
@@ -107,7 +108,7 @@ class NewCommentNotifier < Noticed::Event
 
   deliver_by :email do |config|
     config.mailer = "CommentMailer"
-    config.if = ->(recipient) { !!recipient.preferences[:email] }
+    config.if = -> { !!recipient.preferences[:email] }
   end
 
   bulk_deliver_by :discord do |config|
@@ -374,9 +375,29 @@ Each of these options are available for every delivery method (individual or bul
 
 * `config.if` — Intended for a lambda or method; runs after the `wait` if configured; cancels the delivery method if returns falsey
 * `config.unless`  — Intended for a lambda or method; runs after the `wait` if configured; cancels the delivery method if returns truthy
+
+The following are evaluated in the context of the Notification so it can be customize to the recipient:
+
 * `config.wait` — (Should yield an `ActiveSupport::Duration`) Delays the job that runs this delivery method for the given duration of time
 * `config.wait_until` — (Should yield a specific time object) Delays the job that runs this delivery method until the specific time specified
-* `config.queue` — Sets the ActiveJob queue name to be used for the job that runs this delivery method
+* `config.queue` — Sets the ActiveJob queue name to be used for the job that runs this delivery method.
+
+When using a symbol, the matching method must be defined inside the `notification_methods` block:
+
+```ruby
+# app/notifiers/message_notifier.rb
+class MessageNotifier < Noticed::Event
+  deliver_by :delivery_method do |config|
+    config.queue = :queue
+  end
+
+  notification_methods do
+    def queue
+      "high_priority"
+    end
+  end
+end
+```
 
 ### 📨 Sending Notifications
 
@@ -407,8 +428,8 @@ Recipients can also be computed inside a notifier:
 class NewCommentNotifier < ApplicationNotifier
   recipients ->{ params[:record].thread.all_authors }
 
-  # or 
-  recipients do 
+  # or
+  recipients do
     params[:record].thread.all_authors
   end
 
@@ -465,8 +486,8 @@ module MyApp
     # ...
 
     config.to_prepare do
-      Noticed::Event.include Noticed::EventExtensions
-      Noticed::Notification.include Noticed::NotificationExtensions
+      Noticed::Event.include EventExtensions
+      Noticed::Notification.include NotificationExtensions
     end
   end
 end
@@ -506,6 +527,7 @@ Individual delivery methods:
 
 Bulk delivery methods:
 
+* [Bluesky](docs/bulk_delivery_methods/bluesky.md)
 * [Discord](docs/bulk_delivery_methods/discord.md)
 * [Slack](docs/bulk_delivery_methods/slack.md)
 * [Webhook](docs/bulk_delivery_methods/webhook.md)
@@ -580,7 +602,7 @@ end
 
 A common custom delivery method in the Rails world might be to Delivery to the web via turbo stream.
 
-Note: This example users custom methods that extend the `Noticed::Notification` class.
+Note: This example uses custom methods that extend the `Noticed::Notification` class.
 
 See the [Custom Noticed Model Methods](#custom-noticed-model-methods) section for more information.
 

data/app/models/concerns/noticed/notification_methods.rb

@@ -6,7 +6,7 @@ module Noticed
       # Generate a Notification class each time a Notifier is defined
       def inherited(notifier)
         super
-        notifier.const_set :Notification, Class.new(Noticed::Notification)
+        notifier.const_set :Notification, Class.new(const_defined?(:Notification) ? const_get(:Notification) : Noticed::Notification)
       end
 
       def notification_methods(&block)

data/app/models/noticed/ephemeral.rb

@@ -37,8 +37,10 @@ module Noticed
       const_get(:Notification).class_eval(&block)
     end
 
-    def deliver(recipients)
+    def deliver(recipients = nil)
+      recipients ||= evaluate_recipients
       recipients = Array.wrap(recipients)
+
       bulk_delivery_methods.each do |_, deliver_by|
         deliver_by.ephemeral_perform_later(self.class.name, recipients, params)
       end
@@ -48,6 +50,8 @@ module Noticed
           deliver_by.ephemeral_perform_later(self.class.name, recipient, params)
         end
       end
+
+      self
     end
 
     def record

data/lib/noticed/bulk_delivery_method.rb

@@ -3,14 +3,17 @@ module Noticed
     include ApiClient
     include RequiredOptions
 
+    extend ActiveModel::Callbacks
+    define_model_callbacks :deliver
+
     class_attribute :logger, default: Rails.logger
 
     attr_reader :config, :event
 
-    def perform(delivery_method_name, event, recipients: nil, params: {}, overrides: {})
+    def perform(delivery_method_name, event, recipient: nil, params: {}, overrides: {})
       # Ephemeral notifications
       if event.is_a? String
-        @event = @notification.event
+        @event = event.constantize.new_with_params(recipient, params)
         @config = overrides
       else
         @event = event
@@ -20,7 +23,9 @@ module Noticed
       return false if config.has_key?(:if) && !evaluate_option(:if)
       return false if config.has_key?(:unless) && evaluate_option(:unless)
 
-      deliver
+      run_callbacks :deliver do
+        deliver
+      end
     end
 
     def deliver

data/lib/noticed/bulk_delivery_methods/bluesky.rb

@@ -0,0 +1,49 @@
+module Noticed
+  module BulkDeliveryMethods
+    class Bluesky < BulkDeliveryMethod
+      required_options :identifier, :password, :json
+
+      # bulk_deliver_by :bluesky do |config|
+      #   config.identifier = ENV["BLUESKY_ID"]
+      #   config.password = ENV["BLUESKY_PASSWORD"]
+      #   config.json = {text: "...", createdAt: "..."}
+      # end
+
+      def deliver
+        Rails.logger.debug(evaluate_option(:json))
+        post_request(
+          "https://#{host}/xrpc/com.atproto.repo.createRecord",
+          headers: {"Authorization" => "Bearer #{token}"},
+          json: {
+            repo: identifier,
+            collection: "app.bsky.feed.post",
+            record: evaluate_option(:json)
+          }
+        )
+      end
+
+      def token
+        start_session.dig("accessJwt")
+      end
+
+      def start_session
+        response = post_request(
+          "https://#{host}/xrpc/com.atproto.server.createSession",
+          json: {
+            identifier: identifier,
+            password: evaluate_option(:password)
+          }
+        )
+        JSON.parse(response.body)
+      end
+
+      def host
+        @host ||= evaluate_option(:host) || "bsky.social"
+      end
+
+      def identifier
+        @identifier ||= evaluate_option(:identifier)
+      end
+    end
+  end
+end

data/lib/noticed/bulk_delivery_methods/test.rb

@@ -1,10 +1,10 @@
 module Noticed
   module BulkDeliveryMethods
-    class Test < DeliveryMethod
+    class Test < BulkDeliveryMethod
       class_attribute :delivered, default: []
 
       def deliver
-        delivered << notification
+        delivered << event
       end
     end
   end

data/lib/noticed/delivery_methods/ios.rb

@@ -16,6 +16,7 @@ module Noticed
           connection_pool.with do |connection|
             response = connection.push(apn)
             raise "Timeout sending iOS push notification" unless response
+            connection.close
 
             if bad_token?(response) && config[:invalid_token]
               # Allow notification to cleanup invalid iOS device tokens
@@ -62,6 +63,9 @@ module Noticed
         handler = proc do |connection|
           connection.on(:error) do |exception|
             Rails.logger.info "Apnotic exception raised: #{exception}"
+            if config[:error_handler].respond_to?(:call)
+              notification.instance_exec(exception, &config[:error_handler])
+            end
           end
         end
 

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "2.4.3"
+  VERSION = "2.5.0"
 end

data/lib/noticed.rb

@@ -20,6 +20,7 @@ module Noticed
   autoload :Translation, "noticed/translation"
 
   module BulkDeliveryMethods
+    autoload :Bluesky, "noticed/bulk_delivery_methods/bluesky"
     autoload :Discord, "noticed/bulk_delivery_methods/discord"
     autoload :Slack, "noticed/bulk_delivery_methods/slack"
     autoload :Test, "noticed/bulk_delivery_methods/test"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,7 @@ files:
 - lib/noticed.rb
 - lib/noticed/api_client.rb
 - lib/noticed/bulk_delivery_method.rb
+- lib/noticed/bulk_delivery_methods/bluesky.rb
 - lib/noticed/bulk_delivery_methods/discord.rb
 - lib/noticed/bulk_delivery_methods/slack.rb
 - lib/noticed/bulk_delivery_methods/test.rb
@@ -85,7 +86,7 @@ homepage: https://github.com/excid3/noticed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications
 test_files: []