noticent 0.0.1.pre.pre → 0.0.5

data/lib/noticent/definitions/alert.rb

@@ -8,12 +8,15 @@ module Noticent
       attr_reader :notifiers
       attr_reader :config
       attr_reader :products
+      attr_reader :constructor_name
 
-      def initialize(config, name:, scope:)
+      def initialize(config, name:, scope:, constructor_name:)
         @config = config
         @name = name
         @scope = scope
+        @constructor_name = constructor_name
         @products = Noticent::Definitions::ProductGroup.new(@config)
+        @defaults = { _any_: Noticent::Definitions::Alert::DefaultValue.new(self, :_any_, config.default_value) }
       end
 
       def notify(recipient, template: '')
@@ -27,21 +30,54 @@ module Noticent
         alert_notifier
       end
 
+      def default_for(channel)
+        raise ArgumentError, "no channel named '#{channel}' found" if @config.channels[channel].nil?
+
+        @defaults[channel].nil? ? @defaults[:_any_].value : @defaults[channel].value
+      end
+
+      def default_value
+        @defaults[:_any_].value
+      end
+
+      def default(value, &block)
+        defaults = @defaults
+
+        if block_given?
+          default = Noticent::Definitions::Alert::DefaultValue.new(self, :_any_, value)
+          default.instance_eval(&block)
+
+          defaults[default.channel] = default
+        else
+          defaults[:_any_].value = value
+        end
+
+        @defaults = defaults
+
+        default
+      end
+
       def applies
         @products
       end
 
       def validate!
         channels = @config.alert_channels(@name)
+        raise BadConfiguration, "no notifiers are assigned to alert '#{@name}'" if @notifiers.nil? || @notifiers.empty?
+
         channels.each do |channel|
           raise BadConfiguration, "channel #{channel.name} (#{channel.klass}) has no method called #{@name}" unless channel.klass.method_defined? @name
         end
+
+        # if a payload class is available, we can make sure it has a constructor with the name of the event
+        raise Noticent::BadConfiguration, "payload #{@scope.payload_class} doesn't have a class method called #{name}" if @scope.check_constructor && !@scope.payload_class.respond_to?(@constructor_name)
       end
 
       # holds a list of recipient + channel
       class Notifier
         attr_reader :recipient
-        attr_reader :channel_group
+        attr_reader :channel_group # group to be notified
+        attr_reader :channel # channel to be notified
         attr_reader :template
 
         def initialize(alert, recipient, template: '')
@@ -50,13 +86,51 @@ module Noticent
           @config = alert.config
           @template = template
           @channel_group = :default
+          @channel = nil
+        end
+
+        def on(channel_group_or_name)
+          # is it a group or a channel name?
+          if @config.channel_groups.include? channel_group_or_name
+            # it's a group
+            @channel_group = channel_group_or_name
+            @channel = nil
+          elsif !@config.channels[channel_group_or_name].nil?
+            @channel_group = :_none_
+            @channel = @config.channels[channel_group_or_name]
+          else
+            # not a group and not a channel
+            raise ArgumentError, "no channel or channel group found named '#{channel_group_or_name}'"
+          end
+        end
+
+        # returns an array of all channels this notifier should send to
+        def applicable_channels
+          if @channel_group == :_none_
+            # it's a single channel
+            [@channel]
+          else
+            @config.channels_by_group(@channel_group)
+          end
         end
+      end
+
+      class DefaultValue
+        attr_reader :channel
+        attr_accessor :value
+
+        def initialize(alert, channel, value)
+          @alert = alert
+          @channel = channel
+          @value = value
+        end
+
+        def on(channel)
+          raise BadConfiguration, "no channel named '#{channel}'" if @alert.config.channels[channel].nil?
 
-        def on(channel_group)
-          # validate the group name
-          raise ArgumentError, "no channel group found named '#{channel_group}'" if @config.channels_by_group(channel_group).empty?
+          @channel = channel
 
-          @channel_group = channel_group
+          self
         end
       end
     end

data/lib/noticent/definitions/channel.rb

@@ -9,11 +9,17 @@ module Noticent
       attr_reader :options
 
       def initialize(config, name, group: :default, klass: nil)
+        raise BadConfiguration, 'name should be a symbol' unless name.is_a? Symbol
+        raise BadConfiguration, '\'_any_\' is a reserved channel name' if name == :_any_
+        raise BadConfiguration, '\'_none_\' is a reserved channel name' if name == :_none_
+
         @name = name
         @group = group
         @config = config
 
-        suggested_class_name = @config.base_module_name + '::' + name.to_s.camelize
+        sub_module = @config.use_sub_modules ? '::Channels::' : '::'
+        suggested_class_name = @config.base_module_name + sub_module + name.to_s.camelize
+
         @klass = klass.nil? ? suggested_class_name.camelize.constantize : klass
       rescue NameError
         raise Noticent::BadConfiguration, "no class found for #{suggested_class_name}"
@@ -37,7 +43,6 @@ module Noticent
       rescue ArgumentError
         raise Noticent::BadConfiguration, "channel #{@klass} initializer arguments are mismatching."
       end
-
     end
   end
 end

data/lib/noticent/definitions/scope.rb

@@ -5,22 +5,26 @@ module Noticent
     class Scope
       attr_reader :name
       attr_reader :payload_class
+      attr_reader :check_constructor
 
-      def initialize(config, name, payload_class: nil)
+      def initialize(config, name, payload_class: nil, check_constructor: true)
         @config = config
         @name = name
-        suggeste_name = config.base_module_name + "::#{name.capitalize}Payload"
-        @payload_class = payload_class.nil? ? suggeste_name.constantize : payload_class
+        @check_constructor = check_constructor
+
+        sub_module = @config.use_sub_modules ? '::Payloads::' : '::'
+        suggested_name = config.base_module_name + sub_module + "#{name.capitalize}Payload"
+        @payload_class = payload_class.nil? ? suggested_name.constantize : payload_class
       rescue NameError
-        raise BadConfiguration, "scope #{suggeste_name} class not found"
+        raise BadConfiguration, "scope #{suggested_name} class not found"
       end
 
-      def alert(name, &block)
+      def alert(name, constructor_name: nil, &block)
         alerts = @config.instance_variable_get(:@alerts) || {}
 
         raise BadConfiguration, "alert '#{name}' already defined" if alerts.include? name
 
-        alert = Noticent::Definitions::Alert.new(@config, name: name, scope: self)
+        alert = Noticent::Definitions::Alert.new(@config, name: name, scope: self, constructor_name: constructor_name.nil? ? name : constructor_name)
         @config.hooks&.run(:pre_alert_registration, alert)
         alert.instance_eval(&block) if block_given?
         @config.hooks&.run(:post_alert_registration, alert)

data/lib/noticent/dispatcher.rb

@@ -2,11 +2,11 @@
 
 module Noticent
   class Dispatcher
-    def initialize(config, alert_name, payload, context = {})
+    def initialize(config, alert_name, payload, configuration = {})
       @config = config
       @alert_name = alert_name
       @payload = payload
-      @context = context
+      @configuration = configuration
 
       validate!
 
@@ -34,8 +34,8 @@ module Noticent
 
     # only returns recipients that have opted-in for this channel
     def filter_recipients(recipients, channel)
-      raise ArgumentError, 'channel should be a string or symbol' unless channel.is_a?(String) || channel.is_a?(Symbol)
-      raise ArgumentError, 'recipients is nil' if recipients.nil?
+      raise ArgumentError, "channel should be a string or symbol" unless channel.is_a?(String) || channel.is_a?(Symbol)
+      raise ArgumentError, "recipients is nil" if recipients.nil?
 
       recipients.select { |recipient| @config.opt_in_provider.opted_in?(recipient_id: recipient.id, scope: scope.name, entity_id: @entity_id, alert_name: alert.name, channel_name: channel) }
     end
@@ -43,9 +43,15 @@ module Noticent
     def dispatch
       notifiers.values.each do |notifier|
         recs = recipients(notifier.recipient)
-        @config.channels_by_group(notifier.channel_group).each do |channel|
+        notifier.applicable_channels.each do |channel|
           to_send = filter_recipients(recs, channel.name)
-          channel_instance = channel.instance(@config, to_send, @payload, @context)
+
+          if to_send.count == 0 && @config.skip_alert_with_no_subscribers
+            Noticent.configuration.logger.info "Skipping notification of alert #{alert.name} on channel #{channel.name} as there are no subscribers"
+            next
+          end
+
+          channel_instance = channel.instance(@config, to_send, @payload, @configuration)
           begin
             raise Noticent::BadConfiguration, "channel #{channel.name} (#{channel.klass}) doesn't have a method called #{alert.name}" unless channel_instance.respond_to? alert.name
 
@@ -54,7 +60,7 @@ module Noticent
             # log and move on
             raise if @config.halt_on_error
 
-            Noticent.logger.error e
+            Noticent.configuration.logger.error e
           end
         end
       end
@@ -63,12 +69,12 @@ module Noticent
     private
 
     def validate!
-      raise Noticent::BadConfiguration, 'no base_dir defined' if @config.base_dir.nil?
+      raise Noticent::BadConfiguration, "no base_dir defined" if @config.base_dir.nil?
       raise Noticent::MissingConfiguration if @config.nil?
       raise Noticent::BadConfiguration if @config.alerts.nil?
       raise Noticent::InvalidAlert, "no alert #{@alert_name} found" if @config.alerts[@alert_name].nil?
-      raise ::ArgumentError, 'payload is nil' if @payload.nil?
-      raise ::ArgumentError, 'alert is not a symbol' unless @alert_name.is_a?(Symbol)
+      raise ::ArgumentError, "payload is nil" if @payload.nil?
+      raise ::ArgumentError, "alert is not a symbol" unless @alert_name.is_a?(Symbol)
       raise Noticent::BadConfiguration, "payload (#{@payload.class}) doesn't belong to this scope (#{scope.name}) as it requires #{scope.payload_class}" unless !scope.payload_class.nil? && @payload.is_a?(scope.payload_class)
       raise Noticent::BadConfiguration, "payload doesn't have a #{scope.name}_id method" unless @payload.respond_to?("#{scope.name}_id")
     end

data/lib/noticent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Noticent
-  VERSION ||= '0.0.1-pre'
+  VERSION ||= "0.0.5"
 end

data/lib/noticent/view.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Noticent
   class View
@@ -16,38 +16,40 @@ module Noticent
     attr_reader :raw_data         # frontmatter in their raw (pre render) format
     attr_reader :rendered_data    # frontmatter rendered in string format
 
-    def initialize(filename, template_filename: '', channel:)
+    def initialize(filename, template_filename: "", channel:)
       raise ViewNotFound, "view #{filename} not found" unless File.exist?(filename)
-      raise ViewNotFound, "template #{template_filename} not found" if template_filename != '' && !File.exist?(template_filename)
-      raise ArgumentError, 'channel is nil' if channel.nil?
+      raise ViewNotFound, "template #{template_filename} not found" if template_filename != "" && !File.exist?(template_filename)
+      raise ArgumentError, "channel is nil" if channel.nil?
 
       @filename = filename
       @view_content = File.read(filename)
-      @template_content = template_filename != '' ? File.read(template_filename) : '<%= yield %>'
-      @template_filename = template_filename != '' ? template_filename : ''
+      @template_content = template_filename != "" ? File.read(template_filename) : "<%= @content %>"
+      @template_filename = template_filename != "" ? template_filename : ""
       @channel = channel
     end
 
-    def process
+    def process(context)
       parse
-      render_content
-      render_data
+      render_data(context)
       read_data
+      # TODO this is nasty. we need to refactor to have an independent render context which somehow merges the binding with the channel.
+      @channel.data = @data
+      render_content(context)
     end
 
     private
 
-    def render_content
-      @content = @channel.render_within_context(@template_content, @view_content)
+    def render_content(context)
+      @content = @channel.render_within_context(template: @template_content, content: @raw_content, context: context)
     end
 
-    def render_data
+    def render_data(context)
       if @raw_data.nil?
         @rendered_data = nil
         return
       end
 
-      @rendered_data = @channel.render_within_context(nil, @raw_data)
+      @rendered_data = @channel.render_within_context(template: nil, content: @raw_data, context: context)
     end
 
     def parse
@@ -70,7 +72,7 @@ module Noticent
       if @raw_data.nil?
         @data = nil
       else
-        raise ArgumentError, 'read_data was called before rendering' if @rendered_data.nil?
+        raise ArgumentError, "read_data was called before rendering" if @rendered_data.nil?
 
         data = ::YAML.safe_load(@rendered_data)
         @data = data.deep_symbolize_keys

data/noticent.gemspec

@@ -1,36 +1,42 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'noticent/version'
+require "noticent/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'noticent'
-  spec.version       = Noticent::VERSION
-  spec.authors       = ['Khash Sajadi']
-  spec.email         = ['khash@cloud66.com']
+  spec.name = "noticent"
+  spec.version = Noticent::VERSION
+  spec.authors = ["Khash Sajadi"]
+  spec.email = ["khash@cloud66.com"]
+  spec.license = "Apache-2.0"
+  spec.homepage = "https://github.com/cloud66-oss/noticent"
 
-  spec.summary       = 'Act as Notified is a flexible framework to add notifications to a Rails application'
+  spec.summary = "Act as Notified is a flexible framework to add notifications to a Rails application"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord', '~> 5.2'
-  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency "activerecord", "~> 6.0"
+  spec.add_dependency "activesupport", "~> 6.0"
+  spec.add_dependency "actionpack", "~> 6.0"
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'factory_bot', '~> 5.0'
-  spec.add_development_dependency 'generator_spec', '~> 0.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.69'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.3'
-  spec.add_development_dependency 'rufo', '~> 0.7'
-  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency "combustion", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "factory_bot", "~> 6.1"
+  spec.add_development_dependency "generator_spec", "~> 0.9"
+  spec.add_development_dependency "rails", "~> 6.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rubocop", "~> 1.4"
+  spec.add_development_dependency "rubocop-performance", "~> 1.9"
+  spec.add_development_dependency "rufo", "~> 0.12"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
+  spec.add_development_dependency "byebug", "~> 11.1"
 end

data/testing/channels/email.rb

@@ -8,6 +8,7 @@ module Noticent
       end
 
       def some_event
+        @some_value = 1
         render
       end
 

data/testing/channels/exclusive.rb

@@ -0,0 +1,9 @@
+module Noticent
+  module Testing
+    class Exclusive < ::Noticent::Channel
+      def only_here
+        render
+      end
+    end
+  end
+end

data/testing/channels/simple.rb

@@ -0,0 +1,9 @@
+module Noticent
+  module Testing
+    class Simple < ::Noticent::Channel
+      def some_event
+        render
+      end
+    end
+  end
+end

data/testing/payloads/comment_payload.rb

@@ -3,6 +3,16 @@ module Noticent
     # this is a example payload for comment as scope
     class CommentPayload < Noticent::Testing::Payload
       attr_accessor :comment_id
+      attr_reader :users
+
+      def self.three
+        # nop
+      end
+
+      def self.new_signup
+        # nop
+      end
+
     end
   end
 end

data/testing/payloads/post_payload.rb

@@ -16,6 +16,50 @@ module Noticent
         []
       end
 
+      def self.some_event(some_value)
+        # nop
+      end
+
+      def self.foo(options)
+        # nop
+      end
+
+      def self.boo
+        # nop
+      end
+
+      def self.one
+        # nop
+	  end
+	  
+	  def self.only_here
+		# nop
+	  end
+
+      def self.two
+        # nop
+      end
+
+      def self.tfa_enabled
+        # nop
+      end
+
+      def self.sign_up
+        # nop
+      end
+
+      def self.new_signup
+        # nop
+      end
+
+      def self.fuzz
+        # nop
+      end
+
+      def self.buzz
+        # nop
+      end
+
     end
   end
 end