gossiper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3cee602077f8193490a6c88820bfb282bc91e4d
+  data.tar.gz: f8880ec0eba28ba87c3b813632868918170c250b
+SHA512:
+  metadata.gz: 597cc48ab2c7454143814fe67b1c83ac9b8d63ce0c8a99c2ff70cf468391e747c8cfbac106d42508c1cdae4d81493df2cc5f41250267503a65000c0fc8e0d32e
+  data.tar.gz: a5c247cb2bcc91f797fd1776088e98baf30a84065156e3ce5f7bed32cae3bec5c7356021927582f07b9a5bd3cd83cefa5bc8fa1887bc8a7e994a42db1b7c9922

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Marcelo Guilherme Jacobus Jr
+
+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/Rakefile

@@ -0,0 +1,23 @@
+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    = 'Gossiper'
+  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'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/gossiper/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/gossiper/application_controller.rb

@@ -0,0 +1,4 @@
+module Gossiper
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/gossiper/application_helper.rb

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

data/app/models/gossiper/notification.rb

@@ -0,0 +1,60 @@
+module Gossiper
+  class Notification < ActiveRecord::Base
+    STATUSES = %w(pending delivered)
+
+    validates :kind, presence: true
+
+    def user=(user)
+      @user           = user
+      self.user_class = user.class.to_s
+      self.user_id    = user.id
+    end
+
+    def user
+      @user ||= user_class.constantize.find(user_id)
+    end
+
+    def user_class
+      read_attribute(:user_class).presence || Gossiper.configuration.default_notification_user_class
+    end
+
+    def status
+      read_attribute(:status).presence || STATUSES.first
+    end
+
+    def deliver
+      mail.deliver
+      update_delivered_at!
+    end
+
+    def deliver!
+      mail.deliver!
+      update_delivered_at!
+    end
+
+    def kind=(value)
+      value = value.present? ? value.parameterize.underscore : nil
+      write_attribute(:kind, value)
+    end
+
+    def method_missing(method, *args, &block)
+      STATUSES.each do |status|
+        if method.to_s == "#{status}?"
+          return self.status == status
+        end
+      end
+      super(method, *args, &block)
+    end
+
+    protected
+      def mail
+        Gossiper::Mailer.mail_for(self)
+      end
+
+      def update_delivered_at!
+        self.delivered_at = Time.now
+        save!
+      end
+
+  end
+end

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

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

data/config/routes.rb

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

data/db/migrate/20131206162038_create_gossiper_notifications.rb

@@ -0,0 +1,14 @@
+class CreateGossiperNotifications < ActiveRecord::Migration
+  def change
+    create_table :gossiper_notifications do |t|
+      t.integer :user_id
+      t.string :user_class
+      t.string :kind
+      t.string :status
+      t.datetime :delivered_at
+      t.boolean :read
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/gossiper/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Install the configuration files
+
+Example:
+    rails generate gossiper:install
+
+    This will create:
+        config/initializers/gossiper.rb
+        config/locales/gossiper.en.yml

data/lib/generators/gossiper/install/install_generator.rb

@@ -0,0 +1,11 @@
+class Gossiper::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer
+    template "initializer.rb", "config/initializer/gossiper.rb"
+  end
+
+  def copy_locale
+    template "locale.en.yml", "config/locale/gossiper.en.yml"
+  end
+end

data/lib/generators/gossiper/install/templates/initializer.rb

@@ -0,0 +1,22 @@
+<%- test_folder = defined?(RSpec) ? 'rspec' : 'test' -%>
+Gossiper.configure do |config|
+  # Change the default user class
+  configure.default_user_class = 'User'
+
+  # change the default class of the configurations
+  config.default_notification_base_class = 'Gossiper::EmailConfig'
+
+  # change the path where the notifications should be placed
+  config.notification_root_folder = Rails.root.join('app/models')
+
+  # the notifications test folder
+  config.notification_test_folder = Rails.root.join("<%= test_folder %>", "models")
+
+  config.authorize_with do |controller|
+    # Example:
+
+    # unless current_user.is_admin?
+    #   redirect_to root_path, notice: 'Get out!'
+    # end
+  end
+end

data/lib/generators/gossiper/install/templates/locale.en.yml

@@ -0,0 +1,6 @@
+en:
+  gossiper:
+    notifications:
+      # Example
+      user_welcome:
+        subject: Welcome!

data/lib/generators/gossiper/notification_type/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a notification type configuration
+
+Example:
+    rails generate notification_type user_welcome
+
+    This will create:
+        app/models/notifications/user_welcome_notification

data/lib/generators/gossiper/notification_type/notification_type_generator.rb

@@ -0,0 +1,23 @@
+class Gossiper::NotificationTypeGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_class_file
+    template 'notification_type.rb', File.join(
+      Gossiper.configuration.notifications_root_folder.to_s,
+      'notifications',
+      class_path,
+      "#{singular_name}_notification.rb"
+    )
+  end
+
+  def create_test_file
+    test_sufix = defined?(RSpec) ? 'spec' : 'test'
+
+    template 'notification_type_test.rb', File.join(
+      Gossiper.configuration.notifications_test_folder.to_s,
+      'notifications',
+      class_path,
+      "#{singular_name}_notification_#{test_sufix}.rb"
+    )
+  end
+end

data/lib/generators/gossiper/notification_type/templates/notification_type.rb

@@ -0,0 +1,32 @@
+module Notifications
+  class <%= class_name %>Notification < Gossiper::EmailConfig
+
+    # def to
+    # end
+
+    # def bcc
+    # end
+
+    # def from
+    # end
+
+    # def cc
+    # end
+
+    # def template_name
+    # end
+
+    # def template_path
+    # end
+
+    # def subject
+    # end
+
+    # def attachments
+    # end
+
+    # def instance_variables
+    # end
+
+  end
+end

data/lib/generators/gossiper/notification_type/templates/notification_type_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Notifications::<%= class_name %>Notification do
+end

data/lib/generators/gossiper/notification_type/templates/notification_type_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module Notifications
+  class <%= class_name %>NotificationTest < ActiveSupport::TestCase
+  end
+end

data/lib/gossiper/configuration.rb

@@ -0,0 +1,28 @@
+module Gossiper
+  class Configuration
+
+    class << self
+      def attribute(name, default_value = nil)
+        define_method name do
+          instance_variable_get("@#{name}") || default_value
+        end
+
+        define_method "#{name}=" do |value|
+          instance_variable_set("@#{name}", value.to_s)
+        end
+      end
+    end
+
+    attribute :default_notification_user_class
+    attribute :default_notification_config_class
+    attribute :notifications_root_folder
+    attribute :notifications_test_folder
+
+    def authorize_with(&block)
+      if block_given?
+        @authorize_with = block
+      end
+      @authorize_with ||= Proc.new {}
+    end
+  end
+end

data/lib/gossiper/email_config.rb

@@ -0,0 +1,52 @@
+module Gossiper
+  class EmailConfig
+    attr_reader :notification, :user
+
+    def initialize(notification)
+      @notification = notification
+      @user         = notification.user
+    end
+
+    def to
+      if user.respond_to?(:name)
+        ["#{user.name} <#{user.email}>"]
+      else
+        [user.email]
+      end
+    end
+
+    # TODO: Make configuration for default bcc
+    def bcc
+      []
+    end
+
+    # TODO: Make configuration for default from
+    def from
+    end
+
+    # TODO: Make configuration for default cc
+    def cc
+      []
+    end
+
+    def template_name
+      "#{notification.kind}_notification"
+    end
+
+    def template_path
+      'notifications'
+    end
+
+    def subject
+      I18n.t("gossiper.notifications.#{notification.kind}.subject")
+    end
+
+    def attachments
+      {}
+    end
+
+    def instance_variables
+      {}
+    end
+  end
+end

data/lib/gossiper/engine.rb

@@ -0,0 +1,10 @@
+module Gossiper
+  class Engine < ::Rails::Engine
+    isolate_namespace Gossiper
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.integration_tool :rspec
+    end
+  end
+end

data/lib/gossiper/mailer.rb

@@ -0,0 +1,34 @@
+module Gossiper
+  class Mailer < ActionMailer::Base
+
+    def mail_for(notification)
+      config = config_for(notification)
+
+      config.attachments.each do |filename, file|
+        attachments[filename] = file
+      end
+
+      config.instance_variables.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      mail(
+        to:      config.to,
+        cc:      config.cc,
+        bcc:     config.bcc,
+        subject: config.subject,
+        template_name: config.template_name,
+        template_path: config.template_path
+      )
+    end
+
+    def config_for(notification)
+      begin
+        klass = "Notifications::#{notification.kind.classify}Notification"
+        klass.constantize.new(notification)
+      rescue NameError
+        Gossiper::EmailConfig.new(notification)
+      end
+    end
+  end
+end

data/lib/gossiper/version.rb

@@ -0,0 +1,3 @@
+module Gossiper
+  VERSION = "0.1.0"
+end

data/lib/gossiper.rb

@@ -0,0 +1,17 @@
+require "gossiper/engine"
+require "gossiper/email_config"
+require "gossiper/mailer"
+require "gossiper/configuration"
+
+module Gossiper
+
+  class << self
+    def configuration
+      @@_config ||= Configuration.new
+    end
+
+    def config
+      yield configuration
+    end
+  end
+end

data/lib/tasks/gossiper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :gossiper do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: gossiper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Eases the creation of email messages as well as user notification systems
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/gossiper/application.js
+- app/assets/stylesheets/gossiper/application.css
+- app/helpers/gossiper/application_helper.rb
+- app/models/gossiper/notification.rb
+- app/views/layouts/gossiper/application.html.erb
+- app/controllers/gossiper/application_controller.rb
+- config/routes.rb
+- db/migrate/20131206162038_create_gossiper_notifications.rb
+- lib/generators/gossiper/notification_type/USAGE
+- lib/generators/gossiper/notification_type/notification_type_generator.rb
+- lib/generators/gossiper/notification_type/templates/notification_type_spec.rb
+- lib/generators/gossiper/notification_type/templates/notification_type_test.rb
+- lib/generators/gossiper/notification_type/templates/notification_type.rb
+- lib/generators/gossiper/install/USAGE
+- lib/generators/gossiper/install/install_generator.rb
+- lib/generators/gossiper/install/templates/initializer.rb
+- lib/generators/gossiper/install/templates/locale.en.yml
+- lib/gossiper.rb
+- lib/tasks/gossiper_tasks.rake
+- lib/gossiper/email_config.rb
+- lib/gossiper/engine.rb
+- lib/gossiper/mailer.rb
+- lib/gossiper/configuration.rb
+- lib/gossiper/version.rb
+- MIT-LICENSE
+- Rakefile
+homepage: https://github.com/mjacobus/gossiper
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: It eases the creation of messages for the users
+test_files: []