dallal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef7931f202a80463bfca59f1e2d4a32b74cf7114
+  data.tar.gz: 8c243ab925cdab39f98c364b92994bd260244da5
+SHA512:
+  metadata.gz: 283eff9f49bacda0ce3a827515adc71c821b792b6bbd8a3e8c8a5264da389890feae70026fa9ad81f8335538ac59499fbf6b5be6e259bb5539ac6d5539804149
+  data.tar.gz: 4258db0fff6f2ba0a416cbd9cdaec87a7cc0cac597cc8e9f6de030e4258ba985fed2aa713d25e52970cb46ea13354a1518768d79a63d5b159642bfddfe4fc1db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Laertis Pappas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Dallal
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dallal'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec
+

data/app/assets/javascripts/dallal/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/dallal/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/dallal/application_controller.rb

@@ -0,0 +1,5 @@
+module Dallal
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/dallal/application_helper.rb

@@ -0,0 +1,4 @@
+module Dallal
+  module ApplicationHelper
+  end
+end

data/app/jobs/dallal/dallal_job.rb

@@ -0,0 +1,13 @@
+module Dallal
+  class DallalJob < ActiveJob::Base
+    queue_as :default
+
+    # TODO This is tricky. Event is string here. Is transformed in
+    # event_subscriber from sym to string. we transform here egain to
+    # sym. Rethink this
+    # or user.notify....
+    def perform(klass, id, event)
+      "#{klass}_notifier".classify.constantize.create_notification(id: id, event: event.to_sym)
+    end
+  end
+end

data/app/mailers/dallal/mailer.rb

@@ -0,0 +1,36 @@
+module Dallal
+  class Mailer < ActionMailer::Base
+    layout Dallal.configuration.email_layout
+
+    # TODO add mailer specs
+    def notify(notification)
+      @notification = notification
+      mail(mail_attrs)
+    end
+
+    private
+    def mail_attrs
+      {
+        from: address_format(@notification.from_email, @notification.from_name),
+        reply_to: address_format(@notification.from_email, @notification.from_name),
+        to: @notification.user.email,
+        cc: nil,
+        subject: subject,
+        template_name: "#{object_plural_name}/#{@notification.template_name}"
+      }
+    end
+
+    def subject
+      render_to_string(template: "dallal/mailer/#{object_plural_name}/#{@notification.template_name}_subject")
+    end
+
+    def address_format email, name
+      address = Mail::Address.new email
+      address.display_name = name
+      address.format
+    end
+    def object_plural_name
+      @notification._object.class.name.underscore.pluralize
+    end
+  end
+end

data/app/views/layouts/dallal/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dallal</title>
+  <%= stylesheet_link_tag    "dallal/application", media: "all" %>
+  <%= javascript_include_tag "dallal/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/layouts/mailer.html.erb

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Dallal::Engine.routes.draw do
+end

data/lib/dallal/abstract_interface.rb

@@ -0,0 +1,30 @@
+module Dallal
+  module AbstractInterface
+    class InterfaceNotImplementedError < NotImplementedError
+    end
+
+    def self.included(klass)
+      klass.send(:include, AbstractInterface::Methods)
+      klass.send(:extend, AbstractInterface::Methods)
+      klass.send(:extend, AbstractInterface::ClassMethods)
+    end
+
+    module Methods
+      def api_not_implemented(klass)
+        caller.first.match(/in \`(.+)\'/)
+        method_name = $1
+        raise AbstractInterface::InterfaceNotImplementedError.new("#{klass.class.name} needs to implement '#{method_name}' for interface #{self.name}!")
+      end
+    end
+
+    module ClassMethods
+      def needs_implementation(name, *args)
+        self.class_eval do
+          define_method(name) do |*args|
+            raise NotImplemented
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dallal/configuration.rb

@@ -0,0 +1,54 @@
+require 'ostruct'
+
+module Dallal
+  module Configuration
+    CURRENT_ATTRS = [:user_class_name, :dallal_class_name,
+                     :enabled, :email_layout, :from_email, :from_name].freeze
+    DEPRECATED_ATTRS = [].freeze
+    CONFIG_ATTRS = (CURRENT_ATTRS + DEPRECATED_ATTRS).freeze
+
+    def config
+      @config ||= Configuration.new
+    end
+    private :config
+
+    def configure
+      return unless block_given?
+      yield config if block_given?
+    end
+
+    def configuration
+      config
+    end
+
+    def options
+      config.options
+    end
+
+    class Configuration < Struct.new(*CONFIG_ATTRS)
+      def initialize
+        super
+
+        set_default_values
+      end
+
+      def options
+        Hash[ * CONFIG_ATTRS.map { |key| [key, send(key)] }.flatten ] 
+      end
+
+      def enabled?
+        self.enabled
+      end
+
+      private
+      def set_default_values
+        self.user_class_name = 'User'
+        self.dallal_class_name = 'Dallal'
+        self.enabled = true
+        self.email_layout = 'mailer'
+        self.from_email = 'foo@bar.xyz'
+        self.from_name = 'just a name'
+      end
+    end
+  end
+end

data/lib/dallal/engine.rb

@@ -0,0 +1,22 @@
+module Dallal
+  class Engine < ::Rails::Engine
+    isolate_namespace Dallal
+    
+    initializer "Include Dallal after rails boot" do
+      # ...
+      require 'dallal/file_loader'
+
+      # Run before every request in dev and before the first request in production
+      ActionDispatch::Callbacks.to_prepare do
+        Dallal::FileLoader.load_notifiers
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/dallal/events/event_publisher.rb

@@ -0,0 +1,8 @@
+module Dallal
+  module Events
+    class EventPublisher
+      include Dallal::Events::Publisher
+      self.pub_sub_namespace = 'dallals'
+    end
+  end
+end

data/lib/dallal/events/event_subscriber.rb

@@ -0,0 +1,33 @@
+module Dallal
+  module Events
+    class EventSubscriber
+      include Dallal::Events::Subscriber
+
+      #TODO Refactor this
+      ActiveSupport::Notifications.subscribe('dallals') do |_,_,_,_,payload|
+        new(payload).execute
+      end
+
+      def initialize(payload)
+        @payload = payload
+      end
+
+      def execute
+        if should_create_notifications?
+          # Trigger an ActiJob for this notification
+          DallalJob.perform_later payload[:class], payload[:id], payload[:event].to_s
+        end
+      end
+
+      private
+      attr_reader :payload
+
+      # TODO This silently ignores creating a notification
+      # add a warning here or raise exception if not applicable
+      def should_create_notifications?
+        # Are notifications enabled? && is class in Notifiables?
+        Dallal.configuration.enabled? && Observer::NOTIFIABLES.include?(payload[:class])
+      end
+    end
+  end
+end

data/lib/dallal/events/events.rb

@@ -0,0 +1,5 @@
+require 'dallal/events/subscriber'
+require 'dallal/events/publisher'
+require 'dallal/events/event_publisher'
+require 'dallal/events/event_subscriber'
+require 'dallal/events/observer'

data/lib/dallal/events/observer.rb

@@ -0,0 +1,57 @@
+# TODO Move to other module
+module Dallal
+  module Events
+    class Observer
+      NOTIFIABLES = []
+
+      def self.inherited(base)
+        model_name = base.name.gsub('Notifier', '')
+        validate_model_exists!(model_name)
+
+        NOTIFIABLES << model_name
+      end
+
+      def self.callbacks
+        @__notification_callbacks ||= []
+      end
+
+      def self.on *args, &block
+        opts = args.extract_options!
+        callbacks << { on: args, opts: opts, block: block }
+      end
+
+      # TODO Rethink this. Currently one worker executes all notifications
+      # rethink moving to multiple concrete notifications so
+      # we can have one worker per notification.
+      def self.create_notification(id:, event:)
+        # TODO This loops on all callbacks. Rethink this
+        # method and implement it differently. Add listeners?
+        callbacks.each do |callback|
+          next unless callback[:on].include?(event)
+          obj = model_class.constantize.find(id)
+          notification = Dallal::Notification.new(event: event, model_class: model_class, opts: callback[:opts], _object: obj)
+          notification.define_singleton_method(model_class.underscore) do
+            obj
+          end
+          notification.instance_eval(&callback[:block])
+          notification.dispatch!
+        end
+      end
+
+
+      private
+
+      def self.model_class
+        self.name.gsub('Notifier', '')
+      end
+
+      def self.validate_model_exists!(model)
+        unless Object.const_defined?(model)
+          # TODO add more descriptive error
+          # also fix this
+          # raise "Model #{model} is not defined."
+        end
+      end
+    end
+  end
+end

data/lib/dallal/events/publisher.rb

@@ -0,0 +1,44 @@
+module Dallal
+  module Events
+    module Publisher
+      extend ::ActiveSupport::Concern
+
+      included do
+        class_attribute :pub_sub_namespace
+
+        self.pub_sub_namespace = 'dallals'
+      end
+
+      #def broadcast_event(name, payload = {})
+      #  if block_given?
+      #    self.class.broadcast_event(name, payload) do
+      #      yield
+      #    end
+      #  else
+      #    self.class.broadcast_event(name, payload)
+      #  end
+      #end
+
+      def broadcast(info)
+        self.class.broadcast(info)
+      end
+
+      module ClassMethods
+        # Broadcast to dallals
+        def broadcast(info)
+          ActiveSupport::Notifications.instrument(self.pub_sub_namespace, info)
+        end
+
+        def broadcast_event(name, payload = {})
+          if block_given?
+            ActiveSupport::Notifications.instrument(name, payload) do
+              yield
+            end
+          else
+            ActiveSupport::Notifications.instrument(name, payload)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dallal/events/subscriber.rb

@@ -0,0 +1,16 @@
+module Dallal
+  module Events
+    module Subscriber
+
+      # TODO remove dallals from this module. Implement sub chanel on
+      # event_subscriber
+ 
+      #def subscribe(event_name)
+      #  ActiveSupport::Notifications.subscribe(event_name) do |*args|
+      #    event = ActiveSupport::Notifications::Event.new(*args)
+      #    yield(event)
+      #  end
+      #end
+    end
+  end
+end

data/lib/dallal/file_loader.rb

@@ -0,0 +1,15 @@
+module Dallal
+  class FileLoader
+    def self.load_notifiers
+      if directory_exists?
+        Dir[Rails.root.join("app/notifiers/**/*.rb")].each do |file|
+          require_dependency file
+        end
+      end
+    end
+
+    def self.directory_exists?
+      File.directory?(Rails.root.join("app/notifiers"))
+    end
+  end
+end

data/lib/dallal/notification.rb

@@ -0,0 +1,79 @@
+module Dallal
+  class Notification
+    attr_accessor :event, :model_class, :opts, :_object
+    attr_reader :template_name
+
+    def initialize args = {}
+      args.each do |k, v|
+        send("#{k}=", v)
+      end
+
+      @notifiers = {}
+    end
+
+    def notify target, &block
+      @target = Array(target).flatten.compact.uniq
+      instance_eval(&block)
+    end
+
+    def with *args, &block
+      opts = args.extract_options!
+      if should_send?(opts[:if])
+        instance_eval(&block)
+        args.each { |arg| @notifiers[arg] = get_notifier(arg) }
+      end
+    end
+
+    def user
+      @target.first
+    end
+
+    # TODO !!! Watch out same payload for multiple notifers that
+    # require payload
+    def payload payload
+      @payload = payload
+    end
+
+    # Same here as payload
+    def template template
+      @template_name = template
+    end
+
+    def persist?
+      opts[:persist].present?
+    end
+
+    def dispatch!
+      validate!
+      @notifiers.each { |_, n| n.notify! }
+      @notifiers.each { |_, n| n.persist! } if persist?
+    end
+
+    private
+    # TODO Implement this
+    # when target is nil throw error
+    # on email notification when template is nil throw error
+    # on sms notification when payload is nil throw an error
+    # on any other notifiers add a validation logic here
+    def validate!
+      if false
+        raise "You have not defined \'notify\' in \'with\' block for #{class_name} notifier"
+      end
+    end
+
+    def get_notifier(name)
+      # TODO Pass concrete notifications to notifiers. Ex, EmailNotification, JsonPayloadNotification, SmsNotification ...
+      Dallal::Notifiers::Notifier.send(name, self)
+    end
+
+    def should_send?(condition)
+      return true if condition.blank?
+
+      if condition.is_a?(Proc)
+        _object.instance_exec(&condition)
+      else
+        _object.send(condition)
+      end
+    end
+  end
+end

data/lib/dallal/notifiers/email_notifier.rb

@@ -0,0 +1,28 @@
+module Dallal
+  module Notifiers
+    class EmailNotifier < Notifier
+      def notify!
+        # TODO please pass a email notification instead
+        define_email_methods
+        mailer.notify(notification).deliver_now
+      end
+
+      def persist!
+      end
+
+      private
+
+      def define_email_methods
+        [:from_email, :from_name].each do |name|
+          notification.define_singleton_method(name) do
+            Dallal.configuration.send(name)
+          end
+        end
+      end
+
+      def mailer
+        Dallal::Mailer
+      end
+    end
+  end
+end

data/lib/dallal/notifiers/notifier.rb

@@ -0,0 +1,33 @@
+require 'dallal/abstract_interface'
+
+module Dallal
+  module Notifiers
+    class Notifier
+      attr_reader :notification
+
+      include AbstractInterface
+      def initialize(notification)
+        @notification = notification
+      end
+
+      def self.email(notification)
+        Dallal::Notifiers::EmailNotifier.new(notification)
+      end
+  
+      def self.sms(notification)
+        Dallal::Notifiers::SmsNotifier.new(notification)
+      end
+
+      def notify!(*args)
+        Notifier.api_not_implemented(self)
+      end
+
+      def persist!
+        Notifier.api_not_implemented(self)
+      end
+    end
+  end
+end
+
+require 'dallal/notifiers/email_notifier'
+require 'dallal/notifiers/sms_notifier'

data/lib/dallal/notifiers/sms_notifier.rb

@@ -0,0 +1,15 @@
+
+module Dallal
+  module Notifiers
+    class SmsNotifier < Notifier
+
+      def notify!
+      end
+
+
+      def persist!
+
+      end
+    end
+  end
+end

data/lib/dallal/result.rb

@@ -0,0 +1,21 @@
+module Dallal
+  module Result
+    class Success
+      attr_reader :success, :data
+      def initialize(data = nil)
+        @success = true
+        @data = data
+      end
+    end
+
+    class Error
+      attr_reader :success, :message, :data
+
+      def initialize(message, data = nil)
+        @success = false
+        @message = message
+        @data = data
+      end
+    end
+  end
+end

data/lib/dallal/version.rb

@@ -0,0 +1,3 @@
+module Dallal
+  VERSION = "0.0.1"
+end