noticent 0.0.1.pre.pre

data/lib/noticent/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Noticent
+  class Error < StandardError; end
+  class BadConfiguration < Error; end
+  class InvalidPayload < Error; end
+  class InvalidScope < Error; end
+  class InvalidAlert < Error; end
+  class NoCurrentUser < Error; end
+  class ViewNotFound < Error; end
+
+  class MissingConfiguration < Error
+    def initialize
+      super('Configuration for noticent missing. Do you have noticent initializer?')
+    end
+  end
+end

data/lib/noticent/opt_in.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Noticent
+  class OptIn < ActiveRecord::Base
+    # scope: is the type of domain object that opt-in applies to. For example
+    # it could be post or comment
+    # entity_id: is the ID of the scope (post id or comment id)
+    # channel_name: is the name of the channel opted into. email or slack are examples
+    # alert_name: is the name of the alert: new_user or comment_posted
+    # user_id: is the name of the user who's opted into this
+
+    self.table_name = :opt_ins
+
+    validates_presence_of :scope, :entity_id, :channel_name, :alert_name, :recipient_id
+  end
+end

data/lib/noticent/proc_map.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Noticent
+  class ProcMap
+    def initialize(config)
+      @map = {}
+      @config = config
+    end
+
+    def use(symbol, proc)
+      raise Noticent::BadConfiguration, 'should provide a proc' unless proc.is_a?(Proc)
+      raise Noticent::BadConfiguration, "invalid number of parameters for 'use' in '#{symbol}'" if proc.arity != 1
+
+      @map[symbol] = proc
+    end
+
+    def fetch(symbol)
+      raise Noticent::Error, "no map found for '#{symbol}'" if @map[symbol].nil?
+
+      @map[symbol]
+    end
+
+    def count
+      @map.count
+    end
+
+    def values
+      @map
+    end
+
+    protected
+
+    attr_reader :config
+  end
+end

data/lib/noticent/version.rb

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

data/lib/noticent/view.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Noticent
+  class View
+    # these are the attributes we should use in most cases
+    attr_reader :data             # frontmatter in hash form with symbolized keys
+    attr_reader :content          # content rendered
+
+    # these are mostly for debug and testing purposes
+    attr_reader :view_content     # contents of the view itself
+    attr_reader :filename         # view filename
+    attr_reader :template_content # contents of the template
+    attr_reader :raw_content      # content in their raw (pre render) format
+    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:)
+      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?
+
+      @filename = filename
+      @view_content = File.read(filename)
+      @template_content = template_filename != '' ? File.read(template_filename) : '<%= yield %>'
+      @template_filename = template_filename != '' ? template_filename : ''
+      @channel = channel
+    end
+
+    def process
+      parse
+      render_content
+      render_data
+      read_data
+    end
+
+    private
+
+    def render_content
+      @content = @channel.render_within_context(@template_content, @view_content)
+    end
+
+    def render_data
+      if @raw_data.nil?
+        @rendered_data = nil
+        return
+      end
+
+      @rendered_data = @channel.render_within_context(nil, @raw_data)
+    end
+
+    def parse
+      result = {}
+
+      # is there front matter?
+      match = FRONTMATTER.match(@view_content)
+      if !match.nil?
+        result[:frontmatter] = match[1]
+        result[:content] = match[2]
+      else
+        result[:content] = @view_content
+      end
+
+      @raw_data = result[:frontmatter]
+      @raw_content = result[:content]
+    end
+
+    def read_data
+      if @raw_data.nil?
+        @data = nil
+      else
+        raise ArgumentError, 'read_data was called before rendering' if @rendered_data.nil?
+
+        data = ::YAML.safe_load(@rendered_data)
+        @data = data.deep_symbolize_keys
+      end
+    end
+
+    FRONTMATTER = Regexp.new(/([\s\S]*)^---\s*$([\s\S]*)/)
+  end
+end

data/lib/noticent.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+Dir["#{File.dirname(__FILE__)}/noticent/**/*.rb"].each { |f| load(f) }
+load "#{File.dirname(__FILE__)}/generators/noticent/noticent.rb"
+
+module Noticent
+end

data/noticent.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.add_dependency 'activerecord', '~> 5.2'
+  spec.add_dependency 'activesupport', '~> 5.2'
+
+  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'
+end

data/testing/channels/boo.rb

@@ -0,0 +1,15 @@
+module Noticent
+  module Testing
+    class Boo < ::Noticent::Channel
+
+      def foo
+        render
+      end
+
+      def boo
+        render
+      end
+
+    end
+  end
+end

data/testing/channels/email.rb

@@ -0,0 +1,20 @@
+module Noticent
+  module Testing
+    class Email < ::Noticent::Channel
+
+      def new_signup
+        # NOTE: This is only for testing
+        { recipients: recipients, payload: payload }
+      end
+
+      def some_event
+        render
+      end
+
+      def foo
+        render
+      end
+
+    end
+  end
+end

data/testing/channels/foo.rb

@@ -0,0 +1,12 @@
+module Noticent
+  module Testing
+    class Foo < ::Noticent::Channel
+
+      attr_accessor :buzz
+
+      def boo
+        render
+      end
+    end
+  end
+end

data/testing/channels/slack.rb

@@ -0,0 +1,10 @@
+module Noticent
+  module Testing
+    class Slack < ::Noticent::Channel
+
+      def foo
+        render
+      end
+    end
+  end
+end

data/testing/channels/webhook.rb

@@ -0,0 +1,10 @@
+module Noticent
+  module Testing
+    class Webhook < ::Noticent::Channel
+
+      def foo
+        render
+      end
+    end
+  end
+end

data/testing/models/receipient.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Noticent
+  module Testing
+    class Recipient < ActiveRecord::Base
+    end
+  end
+end

data/testing/payloads/comment_payload.rb

@@ -0,0 +1,8 @@
+module Noticent
+  module Testing
+    # this is a example payload for comment as scope
+    class CommentPayload < Noticent::Testing::Payload
+      attr_accessor :comment_id
+    end
+  end
+end

data/testing/payloads/payload.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Noticent
+  module Testing
+    class Payload
+      attr_accessor :current_user
+    end
+  end
+end

data/testing/payloads/post_payload.rb

@@ -0,0 +1,21 @@
+require_relative 'payload'
+
+module Noticent
+  module Testing
+    # this is an example payload for post as scope
+    class PostPayload < Noticent::Testing::Payload
+      attr_accessor :some_attribute
+      attr_accessor :_users
+      attr_accessor :post_id
+
+      def users
+        @_users
+      end
+
+      def owners
+        []
+      end
+
+    end
+  end
+end

data/testing/views/email/some_event.html.erb

@@ -0,0 +1,6 @@
+foo: bar
+fuzz: <%= @payload.some_attribute %>
+---
+This is normal test
+Some non-context stuff <%= 1 + 1 %>
+This comes from <%= @payload.some_attribute %>

data/testing/views/email/some_event.txt.erb

@@ -0,0 +1,6 @@
+foo: bar
+fuzz: <%= @payload.some_attribute %>
+---
+This is normal test
+Some non-context stuff <%= 1 + 1 %>
+This comes from <%= @payload.some_attribute %>

data/testing/views/layouts/layout.html.erb

@@ -0,0 +1,5 @@
+Header
+
+<%= yield %>
+
+Footer

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: noticent
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.pre
+platform: ruby
+authors:
+- Khash Sajadi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- khash@cloud66.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/noticent/noticent.rb
+- lib/generators/noticent/templates/create_opt_ins.rb
+- lib/generators/noticent/templates/noticent_initializer.rb
+- lib/generators/noticent/templates/opt_in.rb
+- lib/noticent.rb
+- lib/noticent/active_record_opt_in_provider.rb
+- lib/noticent/channel.rb
+- lib/noticent/config.rb
+- lib/noticent/definitions/alert.rb
+- lib/noticent/definitions/channel.rb
+- lib/noticent/definitions/hooks.rb
+- lib/noticent/definitions/product.rb
+- lib/noticent/definitions/product_group.rb
+- lib/noticent/definitions/scope.rb
+- lib/noticent/dispatcher.rb
+- lib/noticent/errors.rb
+- lib/noticent/opt_in.rb
+- lib/noticent/proc_map.rb
+- lib/noticent/version.rb
+- lib/noticent/view.rb
+- noticent.gemspec
+- testing/channels/boo.rb
+- testing/channels/email.rb
+- testing/channels/foo.rb
+- testing/channels/slack.rb
+- testing/channels/webhook.rb
+- testing/models/receipient.rb
+- testing/payloads/comment_payload.rb
+- testing/payloads/payload.rb
+- testing/payloads/post_payload.rb
+- testing/views/email/some_event.html.erb
+- testing/views/email/some_event.txt.erb
+- testing/views/layouts/layout.html.erb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Act as Notified is a flexible framework to add notifications to a Rails application
+test_files: []