async-messaging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1f28af4408645fbb76bcbeaab5282db811a477a
+  data.tar.gz: 34a9487a88ce6df074e1acbec08199666dad58a2
+SHA512:
+  metadata.gz: fbada06d88a34b92db309417c6c608efe0358e061d9514bfe29037ee421959ed7865245a36b56ca7e53c4d805d00fd9f93a995ca7561d9abee6aab25134249e2
+  data.tar.gz: ed5e711d3836630c8dbeda7bcee582aa940e5615840b1251bb151d41cd15000ab3e32cd02c2c90ef7a9bbf706abe46754337a53647a3e999d62b9fcc35e10628

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+.rvmrc
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.project
+config/initializers/secret_token.rb
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in async-messaging.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,122 @@
+# Async::Messaging
+
+The Async Messaging gem (Ruby on Rails) aims to simplify User notifications when handling asynchronous calls within your application, via messaging.
+
+*For example: you're using Delayed::Job (https://github.com/collectiveidea/delayed_job) and have completed a 'delayed' action, but want to notify the user about the status after it's completed. A simple flash[:notice] isn't going to work because you're outside User context.*
+
+**NOTE: Currently this gem is under heavy development, function calls will change in the future**
+
+The capabilities of async-messaging are required for a private project, which is MongoDB/ Mongoid backed. Alternate messaging systems are not capable of handing these requirements (https://www.ruby-toolbox.com/categories/User_Messaging_Systems).
+
+## Roadmap
+
+* Version (0.0.1)
+
+  * Functional gem to push User notifications via flash messages
+
+* Future features (subject to change)
+  
+  * Javascript flash message pull
+  * Activerecord support
+  * Email style user messaging
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'async-messaging', github: "dblommesteijn/async-messaging"
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+Generate initialize script for async-messaging
+
+```bash
+$ rails g asyncmessaging:install
+```
+
+**Configure initializer script with your Models** `config/initializer/async-messaging.rb`
+
+```ruby
+# Async::Messaging initializer
+# Use this hook to define your messaging setup
+
+Async::Messaging.setup do |config|
+  # mongoid configuration
+  require 'devise/orm/mongoid'
+  # provide the root user instance (system messaging source)
+  # NOTE: this can/ should be a dummy account!
+  config.model_root = User.find("5333f81244656eccdc020000")
+end
+```
+
+**Add flash handler to your Controller** `app/controllers/application_controller.rb`
+
+```ruby
+# handle flash messaging from Async::Messaging helper
+include Async::Messaging::Controller
+```
+NOTE: Async::Messaging::Controller adds `before_filter :help_async_messaging` that collects all user flash messages from the database and creates flashes.
+
+
+**Cancel flash message behaviour (skip before_filter)**
+
+```ruby
+skip_before_filter :help_async_messaging
+```
+
+**Prepare your flash notification view**
+
+Below is an example of flash view (in slimlang) and Bootstrap. The example will not show any values other than Strings, now we need to expand on this by switching `if key == :async_messaging`
+
+```haml
+div.row
+  div.col-xs-12
+    - flash.each do |key, value|
+      - if key == :async_messaging
+        / async_messaging flash
+        - value.each do |notification|
+          - next if notification.empty?
+          div{class="alert alert-info fade in"}
+            a.href{data-dismiss="alert" class="close"}
+              li.fa.fa-times
+            / prettify the message
+            p
+              strong
+                = notification[:subject]
+                = " ".html_safe
+              = notification[:content]
+      - else
+        / default flash
+        div{class="alert alert-info fade in"}
+          a.href{data-dismiss="alert" class="close"}
+            li.fa.fa-times
+          = value if value.is_a? String
+```
+
+
+## Generating Messages
+
+Notify a user, send a system message. 
+*NOTE: These messages are consumed upon retreival.*
+
+```ruby
+# sends a system message to a user as flash message
+Async::Messaging::Notify.notify_user(User.first, subject: "System Notice", content: "How are you?", category: :flash, flags: [:notice])
+```
+
+NOTE: on page reload the flash message is collected in the `ApplicationController` via the `before_filter` in `Async::Messaging::Controller`. 
+
+
+
+## Contributing?
+
+1. Fork it ( http://github.com/dblommesteijn/async-messaging/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/async-messaging.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'async-messaging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "async-messaging"
+  spec.version       = Async::Messaging::VERSION
+  spec.authors       = ["Dennis Blommesteijn"]
+  spec.email         = ["dennis@blommesteijn.com"]
+  spec.summary       = %q{User Messaging Async calls, compatible with Mongoid (Ruby on Rails) gem}
+  spec.description   = %q{User Messaging Async calls, compatible with Mongoid (Ruby on Rails) gem}
+  spec.homepage      = "https://github.com/dblommesteijn/async-messaging"
+  spec.license       = "LGPLv3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mongoid', ['>= 3.0', '< 5']
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/async-messaging.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/version")
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/notify")
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/message")
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/setup_config")
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/setup")
+require File.expand_path(File.dirname(__FILE__) + "/async-messaging/controller")
+
+module Async
+  module Messaging
+    # Your code goes here...
+  end
+end

data/lib/async-messaging/controller.rb

@@ -0,0 +1,31 @@
+module Async
+  module Messaging
+    module Controller
+
+      # collect all flash notifications from a given user
+      def notify_flash(user)
+        return if user.nil?
+        rs = Mongoid::Message.where(to: user.id, category: :flash)
+        # collect results (copy)
+        ret = rs.to_a
+        # remove from the database
+        rs.delete_all
+        # return the collected results
+        ret
+      end
+
+      # controller helper
+      def self.included(base)
+        base.before_filter :help_async_messaging
+      end
+      # before filter that creates flash messages
+      def help_async_messaging
+        # push flash_notices to flash.now
+        flash_notices = notify_flash(User.current).flat_map(&:to_h)
+        flash.now[:async_messaging] ||= []
+        flash.now[:async_messaging].concat flash_notices
+      end
+
+    end
+  end
+end

data/lib/async-messaging/message.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Async
+  module Messaging
+    module Mongoid
+      class Message
+
+        include ::Mongoid::Document
+        include ::Mongoid::Timestamps
+
+        field :from, type: String
+        field :to, type: String
+        field :date_read, type: Array
+        field :priority, type: Integer, default: 0
+
+        field :subject, type: String
+        field :content, type: String
+
+        field :category, type: String
+        field :flags, type: Array
+
+        def to_h
+          Hash[self.attributes].symbolize_keys
+        end
+
+      end
+    end
+  end
+end

data/lib/async-messaging/notify.rb

@@ -0,0 +1,29 @@
+module Async
+  module Messaging
+
+    class Notify
+      class << self
+        def notify_user(target_user_instance, options={})
+          options[:subject] ||= ""
+          options[:content] ||= "" 
+          options[:category] ||= :flash
+          options[:flags] ||= [:notice]
+          # collect source user
+          s = Async::Messaging.setup
+          from_user_id = s.model_root.id
+          target_user_id = target_user_instance.id
+          # create document entry
+          Mongoid::Message.create! options.merge({from: from_user_id, to: target_user_id})
+        end
+
+        def clear_all
+          Mongoid::Message.delete_all
+        end
+
+
+
+      end
+    end
+
+  end
+end

data/lib/async-messaging/setup.rb

@@ -0,0 +1,15 @@
+module Async
+  module Messaging
+    @@setup_config ||= SetupConfig.new
+    class << self
+      def setup(&block)
+        if block_given?
+          block.call @@setup_config
+        else
+          @@setup_config
+        end
+        #yield self if block_given?
+      end
+    end
+  end
+end

data/lib/async-messaging/setup_config.rb

@@ -0,0 +1,9 @@
+module Async
+  module Messaging
+    
+    class SetupConfig
+      attr_accessor :model, :model_root
+    end
+
+  end
+end

data/lib/async-messaging/version.rb

@@ -0,0 +1,5 @@
+module Async
+  module Messaging
+    VERSION = "0.0.1"
+  end
+end

data/lib/generators/asyncmessaging/install_generator.rb

@@ -0,0 +1,15 @@
+module Asyncmessaging
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates a Async-messaging initializer in your application."
+
+      def copy_initializer
+        template "async_messaging.rb", "config/initializers/async_messaging.rb"
+      end
+
+    end
+
+  end
+end

data/lib/generators/templates/async_messaging.rb

@@ -0,0 +1,9 @@
+# Async::Messaging initializer
+# Use this hook to define your messaging setup
+
+Async::Messaging.setup do |config|
+  # mongoid configuration
+  require 'devise/orm/mongoid'
+  config.model_root = User.find("5333f81244656eccdc020000")
+  # TODO: other configs here!!
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: async-messaging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Blommesteijn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: User Messaging Async calls, compatible with Mongoid (Ruby on Rails) gem
+email:
+- dennis@blommesteijn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- async-messaging.gemspec
+- lib/async-messaging.rb
+- lib/async-messaging/controller.rb
+- lib/async-messaging/message.rb
+- lib/async-messaging/notify.rb
+- lib/async-messaging/setup.rb
+- lib/async-messaging/setup_config.rb
+- lib/async-messaging/version.rb
+- lib/generators/asyncmessaging/install_generator.rb
+- lib/generators/templates/async_messaging.rb
+homepage: https://github.com/dblommesteijn/async-messaging
+licenses:
+- LGPLv3
+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.2.2
+signing_key: 
+specification_version: 4
+summary: User Messaging Async calls, compatible with Mongoid (Ruby on Rails) gem
+test_files: []