noticed 1.2.6 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac839e0194ed6ffcb49cdded96384b5e47aeed9dbd407e92b7e18d67d700efcb
-  data.tar.gz: 4f8bea6c1e9b7b7c1d841a4110bce06a6db56aaa36db358d6ed129294268e6a8
+  metadata.gz: f215fc7642db8db6a38ba3354c4d58ad1621c6d6af5c4ee479a519fdab1fae8d
+  data.tar.gz: 874dc986fa682f54eaee86f0e8e638049cb8d4f310a2e4d906e76ba11b5d7405
 SHA512:
-  metadata.gz: 5d5b49fa5aabd5e94ad370938f157e0ee55e28727b1f1da221924c2d5de40e629f29f909e9f77caa2908dad316777e6f7a66be1c6c290f5f013d3e9407781b28
-  data.tar.gz: 5db5ca0a303953ea1b82d6bf2d1ab6948e4bcbde8b6cb56c73e1a286732239cdeeb7d77b677d40ed77fa6d801de1069c3882b2006616f99f288f97c2e0d1a958
+  metadata.gz: '039b85fe5977ecf3d3353ba275f0913f03a325a3affc913a5edc05f07e5555b38deff9fd23b492d16fbdaa58c0c5e3cf281267288c3ff69697d07e0ff840ded8'
+  data.tar.gz: 7a49698a38596e35382fffc86d12857414f9f8ecdbc68f2c66fd24e124e6b893f62f442e736d004c5fad0403aa55eecc30a749843c6a61b5f0fc45d1b9da84c2

data/README.md

@@ -256,7 +256,7 @@ Sends an SMS notification via Twilio.
 
 * `credentials: :get_twilio_credentials` - *Optional*
 
-  Use a custom method to retrieve the credentials for Twilio. Method should return a Hash with `:account_sid`, `:auth_token` and `:phone_	number` keys.
+  Use a custom method to retrieve the credentials for Twilio. Method should return a Hash with `:account_sid`, `:auth_token` and `:phone_number` keys.
 
   Defaults to `Rails.application.credentials.twilio[:account_sid]` and `Rails.application.credentials.twilio[:auth_token]`
 
@@ -401,6 +401,60 @@ Check if read / unread:
 @notification.unread?
 ```
 
+#### Associating Notifications
+
+Adding notification associations to your models makes querying and deleting notifications easy and is a pretty critical feature of most applications.
+
+For example, in most cases, you'll want to delete notifications for records that are destroyed.
+
+##### JSON Columns
+
+If you're using MySQL or Postgresql, the `params` column on the notifications table is in `json` or `jsonb` format and can be queried against directly.
+
+For example,  we can query the notifications and delete them on destroy like so:
+
+```ruby
+class Post < ApplicationRecord
+  def notifications
+    # Exact match
+    @notifications ||= Notification.where(params: { post: self })
+
+    # Or Postgres syntax to query the post key in the JSON column
+    # @notifications ||= Notification.where("params->'post' = ?", Noticed::Coder.dump(self).to_json)
+  end
+
+  before_destroy :destroy_notifications
+
+  def destroy_notifications
+    notifications.destroy_all
+  end
+end
+```
+
+##### Polymorphic Assocation
+
+If your notification is only associated with one model or you're using a `text` column for your params column , then a polymorphic association is what you'll want to use.
+
+1. Add a polymorphic association to the Notification model. `rails g migration AddNotifiableToNotifications notifiable:belongs_to{polymorphic}`
+
+2. Add `has_many :notifications, as: :notifiable, dependent: :destroy` to each model
+
+3. Customize database `format: ` option to write the `notifiable` attribute(s) when saving the notification
+
+   ```ruby
+   class ExampleNotification < Noticed::Base
+     deliver_by :database, format: :format_for_database
+
+     def format_for_database
+       {
+         notifiable: params.delete(:post),
+         type: self.class.name,
+         params: params
+       }
+     end
+   end
+   ```
+
 ## 🙏 Contributing
 
 This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `standardrb` before submitting pull requests.

data/Rakefile

@@ -18,6 +18,10 @@ require "bundler/gem_tasks"
 
 require "rake/testtask"
 
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"

data/lib/generators/noticed/model_generator.rb

@@ -15,7 +15,7 @@ module Noticed
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
       def generate_notification
-        generate :model, name, "recipient:references{polymorphic}", "type", "params:text", "read_at:datetime", *attributes
+        generate :model, name, "recipient:references{polymorphic}", "type", params_column, "read_at:datetime", *attributes
       end
 
       def add_noticed_model
@@ -31,6 +31,17 @@ module Noticed
       def model_path
         @model_path ||= File.join("app", "models", "#{file_path}.rb")
       end
+
+      def params_column
+        case ActiveRecord::Base.configurations.configs_for(spec_name: "primary").config["adapter"]
+        when "mysql"
+          "params:json"
+        when "postgresql"
+          "params:jsonb"
+        else
+          "params:text"
+        end
+      end
     end
   end
 end

data/lib/generators/noticed/notification_generator.rb

@@ -12,7 +12,7 @@ module Noticed
       desc "Generates a notification with the given NAME."
 
       def generate_notification
-        template "notification.rb", "app/notifications/#{singular_name}.rb"
+        template "notification.rb", "app/notifications/#{file_path}.rb"
       end
     end
   end

data/lib/noticed.rb

@@ -6,6 +6,7 @@ module Noticed
   autoload :Base, "noticed/base"
   autoload :Coder, "noticed/coder"
   autoload :Model, "noticed/model"
+  autoload :TextCoder, "noticed/text_coder"
   autoload :Translation, "noticed/translation"
 
   module DeliveryMethods
@@ -33,4 +34,12 @@ module Noticed
 
   class ValidationError < StandardError
   end
+
+  class ResponseUnsuccessful < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
 end

data/lib/noticed/base.rb

@@ -29,9 +29,10 @@ module Noticed
         new(params)
       end
 
-      def param(name)
-        param_names.push(name)
+      def params(*names)
+        param_names.concat Array.wrap(names)
       end
+      alias param params
     end
 
     def initialize(params = {})
@@ -68,6 +69,9 @@ module Noticed
     def run_delivery(recipient, enqueue: true)
       delivery_methods = self.class.delivery_methods.dup
 
+      # Set recipient to instance var so it is available to Notification class
+      @recipient = recipient
+
       # Run database delivery inline first if it exists so other methods have access to the record
       if (index = delivery_methods.find_index { |m| m[:name] == :database })
         delivery_method = delivery_methods.delete_at(index)

data/lib/noticed/coder.rb

@@ -2,12 +2,12 @@ module Noticed
   class Coder
     def self.load(data)
       return if data.nil?
-      ActiveJob::Arguments.send(:deserialize_argument, JSON.parse(data))
+      ActiveJob::Arguments.send(:deserialize_argument, data)
     end
 
     def self.dump(data)
       return if data.nil?
-      ActiveJob::Arguments.send(:serialize_argument, data).to_json
+      ActiveJob::Arguments.send(:serialize_argument, data)
     end
   end
 end

data/lib/noticed/delivery_methods/action_cable.rb

@@ -16,11 +16,19 @@ module Noticed
       end
 
       def channel
-        if (method = options[:channel])
-          notification.send(method)
-        else
-          Noticed::NotificationChannel
-        end
+        @channel ||= begin
+           value = options[:channel]
+           case value
+           when String
+             value.constantize
+           when Symbol
+             notification.send(value)
+           when Class
+             value
+           else
+             Noticed::NotificationChannel
+           end
+         end
       end
     end
   end

data/lib/noticed/delivery_methods/base.rb

@@ -6,15 +6,15 @@ module Noticed
 
       attr_reader :notification, :options, :recipient, :record
 
-      def perform(notification_class:, options:, params:, recipient:, record:)
-        @notification = notification_class.constantize.new(params)
-        @options = options
-        @recipient = recipient
-        @record = record
+      def perform(args)
+        @notification = args[:notification_class].constantize.new(args[:params])
+        @options = args[:options]
+        @recipient = args[:recipient]
+        @record = args[:record]
 
         # Make notification aware of database record and recipient during delivery
-        @notification.record = record
-        @notification.recipient = recipient
+        @notification.record = args[:record]
+        @notification.recipient = args[:recipient]
 
         run_callbacks :deliver do
           deliver
@@ -24,6 +24,36 @@ module Noticed
       def deliver
         raise NotImplementedError, "Delivery methods must implement a deliver method"
       end
+
+      private
+
+      # Helper method for making POST requests from delivery methods
+      #
+      # Usage:
+      #   post("http://example.com", basic_auth: {user:, pass:}, json: {}, form: {})
+      #
+      def post(url, args = {})
+        basic_auth = args.delete(:basic_auth)
+
+        request = if basic_auth
+          HTTP.basic_auth(user: basic_auth[:user], pass: basic_auth[:pass])
+        else
+          HTTP
+        end
+
+        response = request.post(url, args)
+
+        if options[:debug]
+          Rails.logger.debug("POST #{url}")
+          Rails.logger.debug("Response: #{response.code}: #{response}")
+        end
+
+        if !options[:ignore_failure] && !response.status.success?
+          raise ResponseUnsuccessful.new(response)
+        end
+
+        response
+      end
     end
   end
 end

data/lib/noticed/delivery_methods/slack.rb

@@ -2,7 +2,7 @@ module Noticed
   module DeliveryMethods
     class Slack < Base
       def deliver
-        HTTP.post(url, json: format)
+        post(url, json: format)
       end
 
       private

data/lib/noticed/delivery_methods/twilio.rb

@@ -2,7 +2,7 @@ module Noticed
   module DeliveryMethods
     class Twilio < Base
       def deliver
-        HTTP.basic_auth(user: account_sid, pass: auth_token).post(url, json: format)
+        post(url, basic_auth: {user: account_sid, pass: auth_token}, form: format)
       end
 
       private

data/lib/noticed/delivery_methods/vonage.rb

@@ -2,7 +2,11 @@ module Noticed
   module DeliveryMethods
     class Vonage < Base
       def deliver
-        HTTP.post("https://rest.nexmo.com/sms/json", json: format)
+        response = post("https://rest.nexmo.com/sms/json", json: format)
+        status = response.parse.dig("messages", 0, "status")
+        if !options[:ignore_failure] && status != "0"
+          raise ResponseUnsuccessful.new(response)
+        end
       end
 
       private

data/lib/noticed/model.rb

@@ -5,17 +5,28 @@ module Noticed
     included do
       self.inheritance_column = nil
 
-      serialize :params, Noticed::Coder
+      serialize :params, noticed_coder
 
       belongs_to :recipient, polymorphic: true
 
       scope :newest_first, -> { order(created_at: :desc) }
+      scope :unread, -> { where(read_at: nil) }
+      scope :read, -> { where.not(read_at: nil) }
     end
 
     module ClassMethods
       def mark_as_read!
         update_all(read_at: Time.current, updated_at: Time.current)
       end
+
+      def noticed_coder
+        case attribute_types["params"].type
+        when :json, :jsonb
+          Noticed::Coder
+        else
+          Noticed::TextCoder
+        end
+      end
     end
 
     # Rehydrate the database notification into the Notification object for rendering

data/lib/noticed/text_coder.rb

@@ -0,0 +1,16 @@
+module Noticed
+  class TextCoder
+    def self.load(data)
+      return if data.nil?
+
+      # Text columns need JSON parsing
+      data = JSON.parse(data)
+      ActiveJob::Arguments.send(:deserialize_argument, data)
+    end
+
+    def self.dump(data)
+      return if data.nil?
+      ActiveJob::Arguments.send(:serialize_argument, data).to_json
+    end
+  end
+end

data/lib/noticed/translation.rb

@@ -1,21 +1,23 @@
-module Translation
-  extend ActiveSupport::Concern
+module Noticed
+  module Translation
+    extend ActiveSupport::Concern
 
-  # Returns the +i18n_scope+ for the class. Overwrite if you want custom lookup.
-  def i18n_scope
-    :notifications
-  end
+    # Returns the +i18n_scope+ for the class. Overwrite if you want custom lookup.
+    def i18n_scope
+      :notifications
+    end
 
-  def translate(key, **options)
-    I18n.translate(scope_translation_key(key), **options)
-  end
-  alias t translate
+    def translate(key, **options)
+      I18n.translate(scope_translation_key(key), **options)
+    end
+    alias t translate
 
-  def scope_translation_key(key)
-    if key.to_s.start_with?(".")
-      "notifications.#{self.class.name.underscore}#{key}"
-    else
-      key
+    def scope_translation_key(key)
+      if key.to_s.start_with?(".")
+        "#{i18n_scope}.#{self.class.name.underscore}#{key}"
+      else
+        key
+      end
     end
   end
 end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.2.6"
+  VERSION = "1.2.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.11
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,6 +109,7 @@ files:
 - lib/noticed/delivery_methods/vonage.rb
 - lib/noticed/engine.rb
 - lib/noticed/model.rb
+- lib/noticed/text_coder.rb
 - lib/noticed/translation.rb
 - lib/noticed/version.rb
 - lib/tasks/noticed_tasks.rake