message_train 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 209640603bb9942cbeb56f784f7cb82f17ea8c4b
+  data.tar.gz: 3c4b3d6c2d08e57af22547f86f16028d79167224
+SHA512:
+  metadata.gz: 9b8a44f1f76ab067a81d1eb1405476237acebf8482ed9abd4dd12b108ccd466bc32a9fc7107ea1097373560b8ef3b3ffd590bff8b73731bbab2e81099f7db112
+  data.tar.gz: 4f8da23ca07078ffa1093cd03186a25f450f10012c026bc9e06ecbcf5779d65957ec448a5f2e881f69edbbd54b724e62ff3687a61619b8578a231238e498c8e4

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+message_train

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - ruby-2.2.1
+  - 2.2.2
+before_script:
+ - export DISPLAY=:99.0
+ - sh -e /etc/init.d/xvfb start

data/Gemfile

@@ -0,0 +1,51 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'rails', '~> 4'
+gem 'paperclip', '~> 4.3'
+gem 'rails-i18n', '~> 4'
+gem 'haml-rails', '~> 0.9'
+gem 'jquery-rails', '~> 4'
+gem 'uglifier', '~> 2.7'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.0.1'
+
+gem 'sass-rails', '~> 5'
+gem 'bootstrap-sass', '~> 3.3'
+gem 'bootstrap_leather', '~> 0.8'
+gem 'bootstrap_pager', '~> 0.10'
+gem 'bootstrap_form', '~> 2.3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end
+
+group :development, :test do
+  gem 'sqlite3', '~> 1.3'
+  gem 'devise', '~> 3.5'
+  gem 'rolify', '~> 4'
+  gem 'faker', '~> 1.4'
+  gem 'rspec-rails', '~> 3.2'
+  gem 'rspec-its', '~> 1.2'
+  gem 'factory_girl_rails', '~> 4.5'
+  gem 'seedbank', '~> 0.3'
+  gem 'friendly_id', '~> 5'
+  gem 'byebug', '~> 5'
+end
+
+group :test do
+  gem 'capybara', '~> 2.4'
+  gem 'database_cleaner', '~> 1.4'
+  gem 'rspec-collection_matchers', '~> 1.1'
+  gem 'shoulda-matchers', '~> 2.8'
+  gem "launchy", "~> 2.1.2", require: false
+  gem 'coveralls', '~> 0.8', require: false
+  gem 'rspec-html-matchers', '~> 0.7'
+  gem 'selenium-webdriver', '~> 2'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Gem Vein
+
+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,83 @@
+= MessageTrain
+{<img src="https://travis-ci.org/gemvein/message_train.svg" alt="Build Status" />}[https://travis-ci.org/gemvein/message_train]
+{<img src="https://coveralls.io/repos/gemvein/message_train/badge.svg?branch=master&service=github" alt="Coverage Status" />}[https://coveralls.io/github/gemvein/message_train?branch=master]
+{<img src="https://badge.fury.io/rb/message_train.svg" alt="Gem Version" />}[http://badge.fury.io/rb/message_train]
+
+
+Rails 4 Private Messaging Gem
+
+== Installation
+
+First, install the gem:
+
+    gem 'message_train'
+
+Then, run the install generator:
+
+    rails g message_train:install
+
+Next, add to your models, each of which will need some kind of display name column and some kind of slug (could be the same):
+
+# in /app/models/user.rb
+    message_train
+
+OR to set the name and slug columns:
+
+    message_train slug_column: :short_name, name_column: :display_name
+
+Add to your application.css.scss:
+
+    @import "message_train";
+
+And in your application.js:
+
+    //= require message_train
+
+In your layout, supposing you use haml:
+
+    #alert_area
+      = alert_flash_messages
+
+=== Required helper methods
+
+If you don't use devise with its `current_user` method, you will need to configure MessageTrain to use whatever method you use:
+
+    message_train name_column: :current_subscriber
+
+=== Mixin options
+
+The `message_train` mixin takes the following options:
+
+[:only] A symbol or array of symbols to be the only relationships used, which can include: [:sender, :recipient]
+[:except] A symbol or array of symbols not to create relationships for, which can include: [:sender, :recipient]
+[:valid_senders] A method name to call for a list of valid senders for this model
+[:name_column]   The column by which to name and find this model. default: :name
+[:slug_column]   The column with the short, typeable form of the name. default: :slug
+
+=== Smaller address book
+
+By default, the address book will contain all objects of the current_user_method object's model type. To change this behavior, define an address book method on your user model, something like this:
+
+    def address_book
+        friends
+    end
+
+And in your initializer:
+
+    self.address_book_method = :address_book
+
+== Contributing to MessageTrain
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2015 Gem Vein. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "message_train"
+  gem.homepage = "http://www.gemvein.com/museum/cases/message_train"
+  gem.license = "MIT"
+  gem.summary = %Q{Messaging for any object}
+  gem.description = %Q{Private/public messaging for any object, such as Users or Groups}
+  gem.email = "karen.e.lundgren@gmail.com"
+  gem.authors = ["Karen Lundgren"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "message_train #{version}"
+  rdoc.rdoc_files.include('README*')
+  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'
+
+namespace :message_train do
+  desc "Clean out development system files"
+  task files: :environment do
+    FileUtils.rm_rf(Dir["#{Rails.root}/public/system/development/*/*"])
+  end
+  desc "Recreate database from seeds and clean out all system files"
+  task clean: :environment do
+    Rake::Task["message_train:files"].invoke
+    Rake::Task["app:db:drop"].invoke
+    Rake::Task["app:db:create"].invoke
+    Rake::Task["app:db:migrate"].invoke
+    Rake::Task["app:db:seed"].invoke
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/assets/javascripts/message_train.js

@@ -0,0 +1,138 @@
+//= require bootstrap-tags
+
+function create_alert(level, message) {
+    $('#alert_area').append('<div class="alert alert-' + level + ' alert-dismissible fade in" role="alert"><button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">×</span></button>' + message + ' </div>');
+}
+
+function set_and_change(selector, value) {
+    $(selector).prop('checked', value).trigger("change");
+}
+
+function flicker(selector, count) {
+    $(selector).addClass('flicker')
+        .delay(100)
+        .queue(function() {
+            $(this).removeClass('flicker');
+            $(this).dequeue();
+        })
+        .delay(100)
+        .queue(function() {
+            if(count > 1) {
+                flicker(selector, count - 1);
+            } else {
+                flick_out(selector);
+            }
+            $(this).dequeue();
+        });
+}
+
+function flick_out(selector) {
+    $(selector).addClass('flicker')
+        .delay(100)
+        .queue(function() {
+            $(this).addClass('flicker-out');
+            $(this).dequeue();
+        }).delay(1000)
+        .queue(function() {
+            $(this).removeClass('flicker').removeClass('flicker-out');
+            $(this).dequeue();
+        })
+}
+
+function replace_via_ajax(selector, path) {
+    $.getJSON( path, function( data ) {
+        $(selector).replaceWith(data.html);
+        flicker(selector, 3);
+    });
+}
+
+function process_results(data) {
+    if(typeof data.results === 'undefined' || data.results.length == 0) {
+        create_alert('warning', data.message);
+    } else {
+        create_alert('info', data.message);
+        for(var key in data.results) {
+            var item = data.results[key];
+            replace_via_ajax('#' + item.css_id, item.path);
+        }
+    }
+}
+
+function add_tag_magic(node) {
+    div = $(node);
+    $.getJSON('/box/in/participants.json', function(data){
+        input = div.children('input');
+        form = div.parents('form');
+        var suggestions = [];
+        $.each(data.participants, function (i, participant) {
+            suggestions.push(participant.slug);
+        });
+        tags = div.tags({
+            suggestions: suggestions,
+            tagSize: 'lg',
+            promptText: 'Comma separated list'
+        });
+        form.submit(function(e) {
+            field_template = '<input name="' + div.data('field-name') + '" value="' + tags.getTags() + '" type="hidden">';
+            form.append(field_template);
+            return true;
+        });
+    });
+}
+
+$(document).ready(function(){
+
+    $('.message_train_conversation input[type="checkbox"]').change(function(event) {
+        if (event.target.checked) {
+            //Checkbox has been checked
+            $(this).parents('.message_train_conversation').addClass('selected');
+        } else {
+            //Checkbox has been unchecked
+            $(this).parents('.message_train_conversation').removeClass('selected');
+        }
+    });
+    $('#check_all').change(function(event) {
+        if (event.target.checked) {
+            set_and_change( '.message_train_conversation input[type="checkbox"]', true);
+        } else {
+            set_and_change( '.message_train_conversation input[type="checkbox"]', false);
+        }
+    });
+    $('#box-actions .check').click(function(event) {
+        event.preventDefault();
+        selector = $(this).data('selector');
+        set_and_change( '.message_train_conversation input[type="checkbox"]', false);
+        if(selector == '.message_train_conversation') {
+            $('#check_all').prop('checked', true);
+        } else {
+            $('#check_all').prop('checked', false);
+        }
+        if(selector != '') {
+            set_and_change( selector + ' input[type="checkbox"]', true);
+        }
+    });
+    $('#box-actions .mark').click(function(event) {
+        event.preventDefault();
+        $('#spinner').removeClass('hide');
+        mark_to_set = $(this).data('mark');
+        if(mark_to_set == 'ignore' || mark_to_set == 'unignore') {
+            $('input[name="_method"]').val('delete');
+        } else {
+            $('input[name="_method"]').val('put');
+        }
+        $('input[name="mark_to_set"]').val(mark_to_set);
+        $('#box').submit();
+    });
+    $('#box')
+        .on('ajax:success', function (e, data, status, xhr) {
+            $('#spinner').addClass('hide');
+            process_results(data);
+        }).on('ajax:error', function (e, data, status, xhr) {
+            create_alert('danger', data.responseJSON.message);
+        });
+    $('#box #message_train_messages .read').each(function(e){
+        $(this).find('.collapse').collapse('hide');
+    });
+
+    add_tag_magic(".recipient-input");
+});

data/app/assets/stylesheets/message_train.scss

@@ -0,0 +1,107 @@
+@import 'bootstrap-tags';
+
+#message_train_conversations {
+  a, a:link, a:visited {
+    color: $text-color;
+  }
+
+  a:hover {
+    text-decoration: none;
+  }
+
+  input[type='checkbox'] {
+    margin-right: 1em;
+  }
+  .unread {
+    font-weight: bold;
+  }
+
+  .read {
+    background-color: rgba($list-group-disabled-bg, 0.75);
+  }
+
+  .draft {
+    font-style: italic;
+  }
+
+  .selected, .read.selected {
+    a {
+      color: $state-warning-text;
+    }
+    background-color: $state-warning-bg;
+  }
+
+  .flicker, .read.flicker, .selected.flicker {
+    background-color: $state-info-bg;
+    transition: background-color 0.1s ease-in;
+  }
+
+  .flicker.flicker-out, .unread.flicker.flicker-out {
+    background-color: $list-group-bg;
+    transition: background-color 1s ease-out;
+  }
+
+  .read.flicker.flicker-out {
+     background-color: $list-group-disabled-bg;
+     transition: background-color 1s ease-out;
+   }
+}
+
+#box-actions {
+  margin: 2em 0 1em 0;
+  .check-all button {
+    min-height: 2.5em;
+  }
+}
+
+#conversation-actions {
+  margin: 1em 0 1em 0;
+}
+
+.conversation-actions {
+  a {
+    visibility: hidden;
+  }
+  white-space: nowrap;
+}
+
+tr:hover .conversation-actions a {
+  visibility: visible;
+}
+
+.glyphicon.spinning {
+  animation: spin 1s infinite linear;
+  -webkit-animation: spin2 1s infinite linear;
+}
+
+@keyframes spin {
+  from { transform: scale(1) rotate(0deg);}
+  to { transform: scale(1) rotate(360deg);}
+}
+
+@-webkit-keyframes spin2 {
+  from { -webkit-transform: rotate(0deg);}
+  to { -webkit-transform: rotate(360deg);}
+}
+
+.clear-left {
+  clear: left;
+}
+
+.clear-right {
+  clear: right;
+}
+
+.clear-both {
+  clear: both;
+}
+
+.btn-compose {
+  margin: 0 auto 10px auto;
+  width: 100%;
+}
+
+.tags-input {
+  border-radius: 4px;
+  padding-left: 12px;
+}

data/app/controllers/message_train/application_controller.rb

@@ -0,0 +1,64 @@
+module MessageTrain
+  class ApplicationController < ::ApplicationController
+    helper BoxesHelper
+    helper ConversationsHelper
+    helper MessagesHelper
+    before_filter :load_box
+    before_filter :load_objects
+    before_action :set_locale
+
+    rescue_from ActiveRecord::RecordNotFound do
+      render '404', status: :not_found
+    end
+
+    rescue_from ActionController::RoutingError do
+      redirect_to url_for(MessageTrain.configuration.user_sign_in_path), flash: { notice: :you_must_sign_in_or_sign_up_to_continue.l }
+    end
+
+    private
+      def set_locale
+        I18n.locale = params[:locale] || I18n.default_locale
+      end
+
+      def load_box
+        @box = send(MessageTrain.configuration.current_user_method).box(params[:box_division].to_sym)
+      end
+
+      def load_objects
+        @objects = {}
+        @objects['conversations'] = {}
+        @objects['messages'] = {}
+        if params[:objects].present?
+          params[:objects].each do |type, list|
+            list.each do |key, list_item|
+              @objects[type][key.to_s] = list_item.to_i
+            end
+          end
+        end
+      end
+
+      def respond_to_marking
+        if !@box.errors.all.empty?
+          respond_to do |format|
+            format.html {
+              flash[:error] = @box.message
+              show
+            }
+            format.json { render :results, status: :unprocessable_entity }
+          end
+        else
+          respond_to do |format|
+            format.html {
+              if @box.results.all.empty?
+                flash[:alert] = @box.message
+              else
+                flash[:notice] = @box.message
+              end
+              show
+            }
+            format.json { render :results, status: :accepted }
+          end
+        end
+      end
+  end
+end

data/app/controllers/message_train/boxes_controller.rb

@@ -0,0 +1,37 @@
+module MessageTrain
+  class BoxesController < MessageTrain::ApplicationController
+    before_filter :load_conversations
+
+    # GET /box/in
+    def show
+      @conversations = @conversations.page(params[:page])
+      render :show
+    end
+
+    # PATCH/PUT /box/in
+    def update
+      if params[:mark_to_set].present? && @objects.present?
+        @box.mark(params[:mark_to_set], @objects)
+      end
+      respond_to_marking
+    end
+
+    # DELETE /box/in
+    def destroy
+      if ['ignore', 'unignore'].include? params[:mark_to_set]
+        @box.send(params[:mark_to_set], @objects)
+      end
+      respond_to_marking
+    end
+
+    private
+
+      def load_conversations
+        @conversations = @box.conversations
+      end
+
+      def load_box
+        @box = send(MessageTrain.configuration.current_user_method).box(params[:division].to_sym)
+      end
+  end
+end

data/app/controllers/message_train/conversations_controller.rb

@@ -0,0 +1,38 @@
+module MessageTrain
+  class ConversationsController < MessageTrain::ApplicationController
+    before_filter :load_conversation
+    after_filter :mark_as_read
+
+    # GET /box/in/conversations/1
+    def show
+      @messages = @conversation.messages.page(params[:page])
+      render :show
+    end
+
+    # PATCH/PUT /box/in/conversations/1
+    def update
+      if params[:mark_to_set].present? && @objects.present?
+        @box.mark params[:mark_to_set], @objects
+      end
+      respond_to_marking
+    end
+
+    # DELETE /box/in/conversations/1
+    def destroy
+      if ['ignore', 'unignore'].include? params[:mark_to_set]
+        @box.send(params[:mark_to_set], @conversation)
+      end
+      respond_to_marking
+    end
+
+    private
+
+      def load_conversation
+        @conversation = @box.find_conversation(params[:id])
+      end
+
+      def mark_as_read
+        @box.mark :read, conversations: @conversation
+      end
+  end
+end