ws_chatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f7ad3f543bb9a07ea5672267a0dc411f295d4d1
+  data.tar.gz: f7fa59445c51c6e466be3624344177b7da5de280
+SHA512:
+  metadata.gz: 75154305e8ddcd8218371a4515acc4406ece1526a592ce3cd2a9b8e44c5a770ab1c950b49c3917a141ea9f34f708b333052141a50a2495fce4c1abbfaa7130b7
+  data.tar.gz: 9299f042e729e7761d633f6a980830ea88625f00d8409e5f08b8ac680a787293ae1dfb17feabd7b99312e29134aba9e13e17b7492f7164c3b9f767cad43879e5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 codebaker95
+
+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,34 @@
+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    = 'WsChatter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/assets/javascripts/ws_chatter.js.coffee

@@ -0,0 +1,23 @@
+class @WsChatter
+  constructor: (onmessage, onconnection) ->
+    @ws = new WebSocket "ws://#{location.host}"
+    @ws.onmessage = (event) ->
+      data = JSON.parse(event.data)
+      if data.type is "message"
+        onmessage data.user_id, data.message, data.time
+      else if data.type is "connection"
+        onconnection data.user_id, data.online
+
+  send: (user_id, message) ->
+    @ws.send JSON.stringify
+      type: "message"
+      user_id: user_id
+      message: message
+
+  read: (user_id) ->
+    @ws.send JSON.stringify
+      type: "read"
+      user_id: user_id
+
+  close: ->
+    @ws.close()

data/lib/rails/generators/ws_chatter/install_generator.rb

@@ -0,0 +1,79 @@
+require 'rails/generators/active_record/migration'
+
+module WsChatter
+  class InstallGenerator < Rails::Generators::Base
+    include ActiveRecord::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Installs ws_chatter in the rails app"
+
+    class_option :scope, type: :string, default: "user", desc: "Name of the (existing) model for users"
+    class_option :status_column, type: :string, default: "online", desc: "Name of the status column for the user model"
+    class_option :messages, type: :string, default: "message", desc: "Name of the messages model"
+
+    def inject_ws_chatter
+      if File.exist?(manifest)
+        comment_prefix = File.extname(manifest) == ".coffee" ? "#" : "//"
+        require_ws_chatter = "#{comment_prefix}= require ws_chatter\n"
+
+        manifest_contents = File.read(manifest)
+
+        if manifest_contents.include? 'require turbolinks'
+          inject_into_file manifest, require_ws_chatter, after: "#{comment_prefix}= require turbolinks\n"
+        elsif manifest_contents.include? 'require_tree'
+          inject_into_file manifest, require_ws_chatter, before: "#{comment_prefix}= require_tree"
+        end
+      end
+    end
+
+    def copy_initializer
+      template "ws_chatter.rb", "config/initializers/ws_chatter.rb"
+    end
+
+    def copy_users_migration
+      migration_template "users_migration.rb", "db/migrate/add_#{status_column}_to_#{table_name}.rb"
+    end
+
+    def copy_messages_migration
+      migration_template "messages_migration.rb", "db/migrate/create_#{messages_table}.rb"
+    end
+
+    def copy_messages_model
+      template "message.rb", "app/models/#{messages}.rb"
+    end
+
+    private
+      def scope
+        @scope ||= options[:scope].underscore
+      end
+
+      def table_name
+        @table_name ||= scope.pluralize
+      end
+
+      def model_name
+        @model_name ||= scope.camelize
+      end
+
+      def status_column
+        @status_column ||= options[:status_column].underscore
+      end
+
+      def messages
+        @messages ||= options[:messages].underscore
+      end
+
+      def messages_table
+        @messages_table ||= messages.pluralize
+      end
+
+      def messages_model
+        @messages_model ||= messages.camelize
+      end
+
+      def manifest
+        Dir[File.join(destination_root, "app/assets/javascripts/application.*")][0]
+      end
+  end
+end

data/lib/rails/generators/ws_chatter/templates/message.rb

@@ -0,0 +1,6 @@
+class <%= messages_model %> < ActiveRecord::Base
+  belongs_to :sender, class_name: "<%= model_name %>"
+  belongs_to :recipient, class_name: "<%= model_name %>"
+
+  validates :body, presence: true
+end

data/lib/rails/generators/ws_chatter/templates/messages_migration.rb

@@ -0,0 +1,14 @@
+class Create<%= messages_table.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= messages_table %> do |t|
+      t.integer :sender_id
+      t.integer :recipient_id
+      t.text :body
+      t.boolean :unread, default: true
+
+      t.timestamps null: false
+    end
+    add_index :<%= messages_table %>, :sender_id
+    add_index :<%= messages_table %>, :recipient_id
+  end
+end

data/lib/rails/generators/ws_chatter/templates/users_migration.rb

@@ -0,0 +1,5 @@
+class Add<%= status_column.camelize %>To<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :<%= status_column %>, :boolean, default: false
+  end
+end

data/lib/rails/generators/ws_chatter/templates/ws_chatter.rb

@@ -0,0 +1,5 @@
+WsChatter.setup do |config|
+  config.scope = :<%= scope %>
+  config.status_column = :<%= status_column %>
+  config.messages_model = "<%= messages_model %>"
+end

data/lib/tasks/ws_chatter_tasks.rake

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

data/lib/ws_chatter.rb

@@ -0,0 +1,18 @@
+require "configurations"
+require "ws_chatter/engine"
+require "ws_chatter/ws_chatter_middleware"
+
+module WsChatter
+  include Configurations
+
+  class << self
+    alias_method :setup, :configure
+    alias_method :config, :configuration
+  end
+
+  configuration_defaults do |config|
+    config.scope = :user
+    config.status_column = :online
+    config.messages_model = "Messages"
+  end
+end

data/lib/ws_chatter/engine.rb

@@ -0,0 +1,7 @@
+module WsChatter
+  class Engine < Rails::Engine
+    initializer "ws_chatter.add_middleware" do |app|
+      app.middleware.use WsChatter::WsChatterMiddleware
+    end
+  end
+end

data/lib/ws_chatter/version.rb

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

data/lib/ws_chatter/ws_chatter_middleware.rb

@@ -0,0 +1,114 @@
+require "erb"
+require "json"
+require "faye/websocket"
+
+module WsChatter
+  class WsChatterMiddleware
+    KEEPALIVE_TIME = 15
+
+    def initialize(app)
+      @app = app
+      @clients = []
+      @scope = WsChatter.config.scope
+      @status_column = WsChatter.config.status_column
+      @messages_model = WsChatter.config.messages_model.constantize
+      @users_model = @scope.to_s.camelize.constantize
+    end
+
+    def call(env)
+      if Faye::WebSocket.websocket?(env)
+        ws = Faye::WebSocket.new(env, nil, ping: KEEPALIVE_TIME)
+
+        user = authenticate(env)
+        if !user
+          ws.close
+          return ws.rack_response
+        end
+
+        ws.on :open do
+          puts "  WsChatter: New connection from user: \e[1m#{user.username}\e[22m"
+          add_client(user, ws)
+        end
+
+        ws.on :message do |event|
+          data = parse_message(event.data)
+          case data["type"]
+            when "read" then read_messages(data["user_id"], user)
+            when "message" then send_message(data, user)
+          end
+        end
+
+        ws.on :close do |event|
+          puts "  WsChatter: Closed connection with user: \e[1m#{user.username}\e[22m (code: #{event.code})"
+          remove_client(user, ws)
+        end
+
+        ws.rack_response
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+      def authenticate(env)
+        env["warden"].authenticate(scope: @scope) if env["warden"]
+      end
+
+      def parse_message(message)
+        data = JSON.parse(message)
+        data.each {|key, value| data[key] = ERB::Util.html_escape(value)}
+        data
+      end
+
+      def send_to(user_id, message)
+        @clients.each do |client|
+          if client.id == user_id
+            client.send(message)
+          end
+        end
+      end
+
+      def send_to_all(message)
+        @clients.each { |client| client.send(message)}
+      end
+
+      def add_client(user, ws)
+        @clients << Client.new(user, ws)
+        set_status(user, true)
+      end
+
+      def remove_client(user, ws)
+        @clients.delete_if { |client| client.connection == ws }
+        set_status(user, false) if @clients.none? { |client| client.id == user.id }
+      end
+
+      def set_status(user, status)
+        user.update(@status_column => status)
+        send_to_all(type: "connection", user_id: user.id, online: status)
+      end
+
+      def send_message(data, user)
+        data["user_id"] = data["user_id"].to_i
+        msg = @messages_model.create(sender: user, recipient_id: data["user_id"], body: data["message"])
+        send_to(data["user_id"], type: "message", user_id: user.id, message: data["message"], time: msg.created_at)
+      end
+
+      def read_messages(user_id, user)
+        Message.where(recipient: user, sender_id: user_id, unread: true).update_all(unread: false)
+      end
+
+      class Client
+        attr_reader :id, :user, :connection
+
+        def initialize(user, connection)
+          @id = user.id
+          @connection = connection
+          @user = user
+        end
+
+        def send(message)
+          @connection.send(message.to_json)
+        end
+      end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/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/test/dummy/app/assets/stylesheets/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/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>