noticed 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aab5129001fd96625a6a4141dfcf8aa93263b691fb663faa25e66153c5df9244
-  data.tar.gz: 22d30af822563d150c933bc5aeb2116386db73bcb114d82cf46059ae53c9407e
+  metadata.gz: 49ea4996a79f9bb4b9070ebe4801c0927e8dddd357c9a4f8a7812fe6609a9eb5
+  data.tar.gz: aa5852613e11f73c2c263c961b49f1b54f7d77b414df59ed282703aa77757057
 SHA512:
-  metadata.gz: 1ecf9ce4e2be01cbb171a86f1fe10feb2931e2035c8f857f2b98951c5f8e299b9eadef7b0b1086f53b971f5fa5a31f266491c57f5715cf615b7acc7cf828f518
-  data.tar.gz: 8f896e1e98893d611697c10ebb30e6359a5cafefc9b54d6eff7a434b05eef90d055ed82e9e1d3ed61fcb76dbc2c0be4b5845ebdff799527e745507c919070585
+  metadata.gz: 561f2719087ff38f45ad8230e1f5a7f7bc9adb6f192f39d1217c7b5df5acde0606103a015f5c87523b438baf5be6f79a07153b5b0ef5bb6037445fa2bd94a382
+  data.tar.gz: 57c32c69975a7584f2e44dd41ef4c431fb8b33e629e92494a2988aabdde10feda18ce0224f08855b9118704f3ea7199a752732eb1306ef781ee51ea410b23a04

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]`
 

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.connection.instance_values["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/coder.rb

@@ -2,18 +2,12 @@ module Noticed
   class Coder
     def self.load(data)
       return if data.nil?
-
-      # Text columns need JSON parsing
-      if data.is_a?(String)
-        data = JSON.parse(data)
-      end
-
       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/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, form: 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?(".")
-      "#{i18n_scope}.#{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.9"
+  VERSION = "1.2.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-08-17 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