colossus 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 744e97003be9b4ba97c54fd8877679f042268423
-  data.tar.gz: 831be7283ce1271cf95cb80ea751d62c4ab384e8
+  metadata.gz: c95d76c91b2b37ca49130fc2fbb14ded53d85620
+  data.tar.gz: 123c4860b3864ddfda2d505faca5292f36e9083c
 SHA512:
-  metadata.gz: 0db8010a14269f54288633e7701c6bae7a13a27cd087e8b024faedbc307717fbc185b2e051a653575cd5abfe17ef6a0bb0898e982a5ca9b8a8c1c465ca0df9e2
-  data.tar.gz: 287374b1f76f7b5891f4ebb5ea4a25c66c9cdb9df77d6db0231fe8369a70572238df3a3ab426b7877e019686ccae675e97b855950e4a84815d33afafa4854e85
+  metadata.gz: 2f998058fc924ccb6c760c7e40529a7db2db09a53c50bc4e0c059d7b80225216617347e7d1ed50a096d36671b39dcd232fe8f740bd6c44676415beac25bf5df7
+  data.tar.gz: 071464b4bc8a3bee161f6780b6db462b84f7a98bbcabe3f302b7d2be9075b964fc9131d618f990b30060ed319c20bcc235c6557fe64cfac47261b3266c1c812b

data/lib/colossus.rb

@@ -1,11 +1,13 @@
 require 'faye'
 require 'json'
 require 'openssl'
+require 'monitor'
 require 'faraday'
 require 'faraday_middleware'
 require 'observer'
 require 'em-synchrony'
 require 'securerandom'
+require 'thread_safe'
 
 require 'colossus/configuration'
 require 'colossus/verifier'
@@ -16,6 +18,12 @@ require 'colossus/engines/memory/memory'
 require 'colossus/engines/memory/client_session'
 require 'colossus/engines/memory/client_session_store'
 
+require 'colossus/engines/memory_thread_safe/memory'
+require 'colossus/engines/memory_thread_safe/client_session'
+require 'colossus/engines/memory_thread_safe/client_session_store'
+
+require 'colossus/engines/memory_monitor/memory'
+
 require 'colossus/faye/extension'
 
 # Top Level Class.
@@ -23,6 +31,10 @@ require 'colossus/faye/extension'
 class Colossus
   include Observable
 
+  ACTIVE       = 'active'.freeze
+  AWAY         = 'away'.freeze
+  DISCONNECTED = 'disconnected'.freeze
+
   attr_reader :engine, :verifier
 
   # Initialize Colossus

data/lib/colossus/configuration.rb

@@ -9,7 +9,7 @@ class Colossus
     def initialize
       @ttl = 10
       @seconds_before_ttl_check = 2
-      @engine = Colossus::Engine::Memory
+      @engine = Colossus::Engine::MemoryThreadSafe
       @secret_key = ''
       @writer_token = ''
     end

data/lib/colossus/engines/memory/client_session.rb

@@ -6,7 +6,7 @@ class Colossus
         attr_reader :status, :last_seen
 
         def initialize
-          @status = 'disconnected'
+          @status = DISCONNECTED
           @last_seen = Time.now
         end
 

data/lib/colossus/engines/memory/client_session_store.rb

@@ -11,16 +11,16 @@ class Colossus
           @sessions = Hash.new do |hash, key|
             hash[key] = Colossus::Engine::Memory::ClientSession.new
           end
-          @last_status = 'disconnected'
+          @last_status = DISCONNECTED
         end
 
         def status
-          sessions.values.reduce('disconnected') do |memo, session|
+          sessions.values.reduce(DISCONNECTED) do |memo, session|
             case session.status
-            when 'active'
+            when ACTIVE
               session.status
-            when 'away'
-              memo == 'active' ? memo : session.status
+            when AWAY
+              memo == ACTIVE ? memo : session.status
             else
               memo
             end

data/lib/colossus/engines/memory/memory.rb

@@ -1,20 +1,19 @@
 class Colossus
   module Engine
-    # The Memory Engine is a non-distributed engine.
+    # The Memory Engine is a non-distributed, in process, non-threadsafe engine.
     # Based on EventMachine in order to provide the ttl to
     # disconnect clients.
     class Memory
       include Observable
 
-      attr_reader :client_sessions, :ttl, :mutex
+      attr_reader :client_sessions, :ttl
 
       # @param [Integer/Float] ttl TTL in seconds
       def initialize(ttl)
         @client_sessions = Hash.new do |hash, key|
           hash[key] = Colossus::Engine::Memory::ClientSessionStore.new
         end
-        @ttl       = ttl
-        @mutex     = Mutex.new
+        @ttl     = ttl
       end
 
       def user_changed(user_id, status)
@@ -23,18 +22,16 @@ class Colossus
       end
 
       def set(user_id, client_id, given_status)
-        mutex.synchronize do
-          if given_status == 'disconnected'
-            client_sessions[user_id].delete(client_id)
-          else
-            client_sessions[user_id][client_id] = given_status
-          end
+        if given_status == DISCONNECTED
+          client_sessions[user_id].delete(client_id)
+        else
+          client_sessions[user_id][client_id] = given_status
         end
 
         if client_sessions[user_id].sessions.empty? ||
             client_sessions[user_id].status_changed?
           status = client_sessions[user_id].status
-          delete(user_id) if status == 'disconnected'
+          delete(user_id) if status == DISCONNECTED
           user_changed(user_id, status)
           return true
         end
@@ -46,7 +43,7 @@ class Colossus
         if client_sessions.has_key?(user_id)
           { user_id => client_sessions[user_id].status }
         else
-          { user_id => 'disconnected' }
+          { user_id => DISCONNECTED }
         end
       end
 
@@ -63,16 +60,12 @@ class Colossus
       end
 
       def delete(user_id)
-        mutex.synchronize do
-          client_sessions.delete(user_id)
-        end
+        client_sessions.delete(user_id)
       end
 
       def reset!
-        mutex.synchronize do
-          @client_sessions = Hash.new do |hash, key|
-            hash[key] = Colossus::Engine::Memory::ClientSessionStore.new
-          end
+        @client_sessions = Hash.new do |hash, key|
+          hash[key] = Colossus::Engine::Memory::ClientSessionStore.new
         end
       end
 
@@ -85,16 +78,10 @@ class Colossus
         user_ids_to_delete = []
 
         client_sessions.each_pair do |user_id, session_store|
-          sessions_dupped = session_store.sessions.dup
-
-          session_store.sessions.each_pair do |session_id, session|
-            if (session.last_seen + ttl) < Time.now
-              sessions_dupped.delete(session_id)
-            end
+          session_store.sessions.delete_if do |session_id, session|
+            (session.last_seen + ttl) < Time.now
           end
 
-          mutex.synchronize { session_store.sessions = sessions_dupped }
-
           if (session_store.last_seen + ttl) < Time.now
             user_ids_to_delete << user_id
           end
@@ -106,7 +93,7 @@ class Colossus
       def delete_expired_users(user_ids)
         user_ids.each do |user_id|
           delete(user_id)
-          user_changed(user_id, 'disconnected')
+          user_changed(user_id, DISCONNECTED)
         end
       end
     end

data/lib/colossus/engines/memory_monitor/memory.rb

@@ -0,0 +1,118 @@
+class Colossus
+  module Engine
+    # The Memory Engine is a non-distributed, in process, threadsafe engine.
+    # Based on EventMachine in order to provide the ttl to
+    # disconnect clients.
+    class MemoryMonitor
+      include Observable
+
+      attr_reader :client_sessions, :ttl, :monitor
+
+      # @param [Integer/Float] ttl TTL in seconds
+      def initialize(ttl)
+        @client_sessions = Hash.new do |hash, key|
+          hash[key] = Colossus::Engine::Memory::ClientSessionStore.new
+        end
+        @ttl     = ttl
+        @monitor = Monitor.new
+      end
+
+      def user_changed(user_id, status)
+        changed
+        notify_observers(user_id, status)
+      end
+
+      def set(user_id, client_id, given_status)
+        synchronize do
+          if given_status == DISCONNECTED
+            client_sessions[user_id].delete(client_id)
+          else
+            client_sessions[user_id][client_id] = given_status
+          end
+        end
+
+        if client_sessions[user_id].sessions.empty? ||
+            client_sessions[user_id].status_changed?
+          status = client_sessions[user_id].status
+          delete(user_id) if status == DISCONNECTED
+          user_changed(user_id, status)
+          return true
+        end
+
+        false
+      end
+
+      def get(user_id)
+        if client_sessions.has_key?(user_id)
+          { user_id => client_sessions[user_id].status }
+        else
+          { user_id => DISCONNECTED }
+        end
+      end
+
+      def get_multi(*user_ids)
+        user_ids.inject({}) { |memo, user_id| memo.merge!(get(user_id)) }
+      end
+
+      def get_all
+        statuses = {}
+        client_sessions.each_pair do |user_id, session_store|
+          statuses[user_id] = session_store.status
+        end
+        statuses
+      end
+
+      def delete(user_id)
+        synchronize do
+          client_sessions.delete(user_id)
+        end
+      end
+
+      def reset!
+        synchronize do
+          @client_sessions = Hash.new do |hash, key|
+            hash[key] = Colossus::Engine::Memory::ClientSessionStore.new
+          end
+        end
+      end
+
+      def new_periodic_ttl
+        secs_ttl = Colossus.config.seconds_before_ttl_check
+        @periodic_ttl = EM::Synchrony.add_periodic_timer(secs_ttl, &method(:gc_ttl))
+      end
+
+      def gc_ttl
+        user_ids_to_delete = []
+
+        client_sessions.each_pair do |user_id, session_store|
+          sessions_dupped = session_store.sessions.dup
+
+          session_store.sessions.each_pair do |session_id, session|
+            if (session.last_seen + ttl) < Time.now
+              sessions_dupped.delete(session_id)
+            end
+          end
+
+          synchronize { session_store.sessions = sessions_dupped }
+
+          if (session_store.last_seen + ttl) < Time.now
+            user_ids_to_delete << user_id
+          end
+        end
+
+        delete_expired_users(user_ids_to_delete)
+      end
+
+      def delete_expired_users(user_ids)
+        user_ids.each do |user_id|
+          delete(user_id)
+          user_changed(user_id, DISCONNECTED)
+        end
+      end
+
+      def synchronize(&block)
+        monitor.synchronize(&block)
+      end
+    end
+  end
+end

data/lib/colossus/engines/memory_thread_safe/client_session.rb

@@ -0,0 +1,30 @@
+class Colossus
+  module Engine
+    class MemoryThreadSafe
+      # Represent the status and the information of a given user.
+      class ClientSession
+        attr_reader :status, :last_seen
+
+        def initialize
+          @data             = ThreadSafe::Cache.new
+          @data[:status]    = DISCONNECTED
+          @data[:last_seen] = Time.now
+        end
+
+        def status
+          @data[:status]
+        end
+
+        def status=(given_status)
+          @data[:last_seen] = Time.now
+          @data[:status]    = given_status
+        end
+
+        def last_seen
+          @data[:last_seen]
+        end
+      end
+    end
+  end
+end
+

data/lib/colossus/engines/memory_thread_safe/client_session_store.rb

@@ -0,0 +1,65 @@
+class Colossus
+  module Engine
+    class MemoryThreadSafe
+      # Represents all the different sessions of a user. It can find
+      #  the global status of the user given all the different status.
+      class ClientSessionStore
+        attr_reader :last_status, :ttl
+        attr_accessor :sessions
+
+        def initialize(ttl)
+          @sessions = ThreadSafe::Cache.new do |hash, key|
+            hash[key] = Colossus::Engine::MemoryThreadSafe::ClientSession.new
+          end
+          @last_status = DISCONNECTED
+          @ttl         = ttl
+        end
+
+        def status
+          sessions.values.reduce(DISCONNECTED) do |memo, session|
+            case session.status
+            when ACTIVE
+              session.status
+            when AWAY
+              memo == ACTIVE ? memo : session.status
+            else
+              memo
+            end
+          end
+        end
+
+        def last_seen
+          sessions.values.reduce(Time.new(0)) do |memo, session|
+            session.last_seen > memo ? session.last_seen : memo
+          end
+        end
+
+        def status_changed?
+          last_status != status
+        end
+
+        def [](session_id)
+          sessions[session_id]
+        end
+
+        def []=(session_id, session_status)
+          @last_status = status
+          sessions[session_id].status = session_status
+        end
+
+        def delete(session_id)
+          sessions.delete(session_id)
+        end
+
+        def delete_expired_sessions
+          session_keys_to_delete = []
+          sessions.each_pair do |session_id, session|
+            session_keys_to_delete << session_id if (session.last_seen + ttl) < Time.now
+          end
+
+          session_keys_to_delete.each { |session_id| sessions.delete(session_id) }
+        end
+      end
+    end
+  end
+end

data/lib/colossus/engines/memory_thread_safe/memory.rb

@@ -0,0 +1,90 @@
+class Colossus
+  module Engine
+    # Threadsage with ThreadSafe
+    class MemoryThreadSafe
+      include Observable
+
+      attr_reader :client_sessions, :ttl
+
+      # @param [Integer/Float] ttl TTL in seconds
+      def initialize(ttl)
+        @client_sessions = ThreadSafe::Cache.new do |hash, key|
+          hash[key] = Colossus::Engine::MemoryThreadSafe::ClientSessionStore.new(ttl)
+        end
+        @ttl             = ttl
+      end
+
+      def user_changed(user_id, status)
+        changed
+        notify_observers(user_id, status)
+      end
+
+      def set(user_id, client_id, given_status)
+        if given_status == DISCONNECTED
+          client_sessions[user_id].delete(client_id)
+        else
+          client_sessions[user_id][client_id] = given_status
+        end
+
+        if client_sessions[user_id].sessions.empty? ||
+            client_sessions[user_id].status_changed?
+          status = client_sessions[user_id].status
+          delete(user_id) if status == DISCONNECTED
+          user_changed(user_id, status)
+          return true
+        end
+
+        false
+      end
+
+      def get(user_id)
+        if client_sessions.key?(user_id)
+          { user_id => client_sessions[user_id].status }
+        else
+          { user_id => DISCONNECTED }
+        end
+      end
+
+      def get_multi(*user_ids)
+        user_ids.inject({}) { |memo, user_id| memo.merge!(get(user_id)) }
+      end
+
+      def get_all
+        statuses = {}
+        client_sessions.each_pair do |user_id, session_store|
+          statuses[user_id] = session_store.status
+        end
+        statuses
+      end
+
+      def delete(user_id)
+        client_sessions.delete(user_id)
+      end
+
+      def reset!
+        client_sessions.clear
+      end
+
+      def new_periodic_ttl
+        secs_ttl = Colossus.config.seconds_before_ttl_check
+        @periodic_ttl = EM::Synchrony.add_periodic_timer(secs_ttl, &method(:gc_ttl))
+      end
+
+      def gc_ttl
+        delete_expired_users
+        client_sessions.each_pair do |user_id, session_store|
+          session_store.delete_expired_sessions
+        end
+      end
+
+      def delete_expired_users
+        user_ids_to_delete = []
+        client_sessions.each_pair do |user_id, session_store|
+          user_ids_to_delete << user_id if (session_store.last_seen + ttl) < Time.now
+        end
+
+        user_ids_to_delete.each { |user_id| client_sessions.delete(user_id) }
+      end
+    end
+  end
+end

data/lib/colossus/engines/redis/redis.rb

@@ -0,0 +1,12 @@
+class Colossus
+  module Engine
+    # The Redis Engine is a distributed engine.
+    # Colossus server is now stateless.
+    class Redis
+      include Observable
+
+      def initialize(ttl)
+      end
+    end
+  end
+end

data/lib/colossus/faye/extension.rb

@@ -13,7 +13,7 @@ class Colossus
         faye.add_extension(self)
       end
 
-      def incoming(message, _request, callback)
+      def incoming(message, callback)
         if !acceptable?(message)
           handle_invalid_token(message)
           message.delete('data')

data/lib/colossus/version.rb

@@ -1,4 +1,4 @@
 # The Version
 class Colossus
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: colossus
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - antoinelyset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: em-synchrony
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Colossus is a Push and Presence pure Ruby server. It uses Faye internally.
@@ -78,6 +92,11 @@ files:
 - lib/colossus/engines/memory/client_session.rb
 - lib/colossus/engines/memory/client_session_store.rb
 - lib/colossus/engines/memory/memory.rb
+- lib/colossus/engines/memory_monitor/memory.rb
+- lib/colossus/engines/memory_thread_safe/client_session.rb
+- lib/colossus/engines/memory_thread_safe/client_session_store.rb
+- lib/colossus/engines/memory_thread_safe/memory.rb
+- lib/colossus/engines/redis/redis.rb
 - lib/colossus/faye/extension.rb
 - lib/colossus/http_writer_client.rb
 - lib/colossus/simple_writer_server.rb
@@ -93,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Colossus, Web Push & Presence made easy.