colossus 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f7334b062d47a5404c341687249116596adef40
-  data.tar.gz: 4b97e49786e4e8575f29947f033f3f91cf642460
+  metadata.gz: 7a1798af6e47665a55ac7d9140b00f2317c7cf9f
+  data.tar.gz: 1943594c8954d3cd1255f2b5626b6eee6d08fde1
 SHA512:
-  metadata.gz: c97c78fb9c7fe9b5c5b9bc044b61295ea64c1fbffc4d2a18c3415e37578dfc65de9e82920988e64f48826ff253ba8e94032d0e9bfa7d0e137280fd607ffeea65
-  data.tar.gz: 7cfc83075809b1a1ffdb6015760e58903703087087d05727771c421029cee681c0a9d872514d540ecbac90346b2ad90b9905a704f400b8737afc2be07985720b
+  metadata.gz: f08853ae51aa21a4526b33955717b903030ac681df09a3d86eb44a5b6a0c39ac92ca9711195450eced0c8918fc94dce7330e9c767581189542cac1a3558e8bda
+  data.tar.gz: 5e39feee2464f72cdbb66a4f2e8fc2d1bc860fae862d9b2b1600069c7b73b6a4a33796ae97d5182a2a1a6e8433f553323de86ccde79cec54650fb0f3c79321d5

data/lib/colossus.rb

@@ -2,14 +2,15 @@ require 'faye'
 require 'json'
 require 'openssl'
 require 'faraday'
+require 'faraday_middleware'
 require 'observer'
 require 'em-synchrony'
 require 'securerandom'
 
 require 'colossus/configuration'
 require 'colossus/verifier'
-require 'colossus/writer_client'
-require 'colossus/simple_presence_getter'
+require 'colossus/http_writer_client'
+require 'colossus/simple_writer_server'
 
 require 'colossus/engines/memory/memory'
 require 'colossus/engines/memory/client_session'
@@ -65,7 +66,7 @@ class Colossus
   #
   # @param user_id [#to_s] The unique identifier of a user
   #
-  # @return status [String]
+  # @return Hash{String => String} User_id key, status value
   def get(user_id)
     engine.get(user_id.to_s)
   end
@@ -76,7 +77,7 @@ class Colossus
     engine.get_multi(user_ids.map(&:to_s))
   end
 
-  # @return Hash{String => String} User_id keys, statuses values
+  # (see #get)
   def get_all
     engine.get_all
   end

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

@@ -41,11 +41,17 @@ class Colossus
       end
 
       def get(user_id)
-        client_sessions[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.map { |user_id| get(user_id) }
+        statuses = {}
+        user_ids.each { |user_id| statuses[user_id] = get(user_id) }
+        statuses
       end
 
       def get_all

data/lib/colossus/faye/extension.rb

@@ -3,18 +3,14 @@ class Colossus
     # Faye extension implementing all the presence, authorization,
     # authentification and push logic.
     class Extension
-      attr_reader :colossus, :faye, :faye_client
+      attr_reader :faye, :colossus
 
       VALID_STATUSES = %w(disconnected away active).freeze
 
       def initialize(faye, colossus = Colossus.new)
-        @colossus = colossus
         @faye     = faye
+        @colossus = colossus
         faye.add_extension(self)
-        @faye_client = faye.get_client
-        colossus_faye_extension = Colossus::WriterClient::FayeExtension.
-          new(colossus.verifier.writer_token)
-        faye_client.add_extension(colossus_faye_extension)
       end
 
       def incoming(message, _request, callback)
@@ -26,18 +22,13 @@ class Colossus
           handle_user_action(message)
           message.delete('data')
           message.delete('ext')
-        elsif message['ext']['writer_token']
-          handle_server_action(message)
-          message.delete('ext')
         end
 
         callback.call(message)
       end
 
       def acceptable?(message)
-        message['ext'] &&
-          (message['ext']['user_token'] ||
-           message['ext']['writer_token'])
+        message['ext'] && message['ext']['user_token']
       end
 
       def handle_user_action(message)
@@ -54,60 +45,6 @@ class Colossus
         message
       end
 
-      def handle_server_action(message)
-        token = message['ext'] && message['ext']['writer_token']
-
-        unless token && colossus.verifier.verify_writer_token(token)
-          message['error'] = 'Invalid Token'
-          message.delete('data')
-          return message
-        end
-
-        if message['channel'].start_with?('/meta/')
-          message.delete('data')
-          message
-        elsif message['channel'].start_with?('/presences/request/')
-          handle_presence_request(message)
-        elsif message['channel'].start_with?('/presences/response/')
-          handle_presence_response(message)
-        elsif message['channel'].start_with?('/users/')
-          handle_publish(message)
-        else
-          message['error'] = 'Unknown Action'
-          message.delete('data')
-        end
-
-        message
-      end
-
-      def handle_presence_request(message)
-        user_ids    = message['data'] && message['data']['user_ids']
-        presence_id = message['channel'].partition('/presences/request/').last
-
-        if user_ids && user_ids.is_a?(Array)
-          statuses = colossus.get_multi(user_ids)
-          message['data'].delete('user_ids')
-          faye_client.publish("/presences/response/#{presence_id}", { 'statuses' => Hash[user_ids.zip(statuses)] })
-          message
-        elsif user_ids == nil
-          statuses = colossus.get_all
-          faye_client.publish("/presences/response/#{presence_id}", { 'statuses' => statuses })
-          message
-        else
-          message.delete('data')
-          message['error'] = 'Invalid user_ids data'
-          message
-        end
-      end
-
-      def handle_presence_response(message)
-        message
-      end
-
-      def handle_publish(message)
-        message
-      end
-
       def handle_invalid_token(message)
         message['error'] = 'Invalid Token'
         message

data/lib/colossus/http_writer_client.rb

@@ -0,0 +1,46 @@
+class Colossus
+  class HTTPWriterClient
+    attr_reader :url, :writer_token, :time_out
+
+    def initialize(url,
+                   writer_token = Colossus.config.writer_token,
+                   time_out     = 2)
+      @url          = url
+      @writer_token = writer_token
+      @time_out     = time_out
+    end
+
+    def presence(optional_user_ids = nil)
+      user_ids = Array(optional_user_ids) if optional_user_ids
+      connection.post('/presence_request') do |req|
+        req.body = { user_ids: user_ids, writer_token: writer_token }
+      end.body
+    end
+
+    def push(user_ids, message)
+      user_ids = Array(user_ids)
+      connection.post('/message') do |req|
+        req.body = { user_ids: user_ids, message: message, writer_token: writer_token}
+      end.body
+    end
+
+    private
+
+    def connection
+      Faraday.new(url, connection_options) do |conf|
+        conf.request  :json
+        conf.response :json
+        conf.response :raise_error
+        conf.adapter  Faraday.default_adapter
+      end
+    end
+
+    def connection_options
+      {request: {timeout: 2, open_timeout: 2}}
+    end
+
+    def base_url
+      @base_url ||= URI.parse(url).tap{ |u| u.path=('/') }
+    end
+  end
+end

data/lib/colossus/simple_writer_server.rb

@@ -0,0 +1,51 @@
+class Colossus
+  class SimpleWriterServer
+    attr_reader :faye_extension
+
+    def initialize(faye_extension)
+      @faye_extension = faye_extension
+    end
+
+    def presence(writer_token, optional_user_ids = nil)
+      raise 'Invalid token' unless valid?(writer_token)
+
+      case optional_user_ids
+      when Array
+        colossus.get_multi(*optional_user_ids)
+      when String
+        colossus.get(optional_user_ids)
+      when NilClass
+        colossus.get_all
+      else
+        raise 'Invalid user_ids data'
+      end
+    end
+
+    def push(writer_token, user_ids, message)
+      raise 'Invalid token' unless valid?(writer_token)
+
+      case user_ids
+      when Array
+        user_ids.each do |user_id|
+          faye_client.publish("/users/#{user_id}", message)
+        end
+      when String
+        faye_client.publish("/users/#{user_ids}", message)
+      else
+        raise 'Invalid user_ids data'
+      end
+    end
+
+    def valid?(writer_token)
+      colossus.verifier.verify_writer_token(writer_token)
+    end
+
+    def faye_client
+      faye_extension.faye.get_client
+    end
+
+    def colossus
+      faye_extension.colossus
+    end
+  end
+end

data/lib/colossus/version.rb

@@ -1,4 +1,4 @@
 # The Version
 class Colossus
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: colossus
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - antoinelyset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-04 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'
 description: Colossus is a Push and Presence pure Ruby server. It uses Faye internally.
@@ -65,10 +79,10 @@ files:
 - lib/colossus/engines/memory/client_session_store.rb
 - lib/colossus/engines/memory/memory.rb
 - lib/colossus/faye/extension.rb
-- lib/colossus/simple_presence_getter.rb
+- lib/colossus/http_writer_client.rb
+- lib/colossus/simple_writer_server.rb
 - lib/colossus/verifier.rb
 - lib/colossus/version.rb
-- lib/colossus/writer_client.rb
 homepage: https://github.com/antoinelyset/colossus
 licenses:
 - MIT
@@ -79,17 +93,17 @@ 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.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Colossus, Web Push & Presence made easy.

data/lib/colossus/simple_presence_getter.rb

@@ -1,25 +0,0 @@
-class Colossus
-  class SimplePresenceGetter
-    attr_reader :colossus
-
-    def initialize(colossus)
-      @colossus = colossus
-    end
-
-    def get_presences(writer_token, optional_user_ids = nil)
-      raise 'Invalid token' unless valid?(writer_token)
-      user_ids = Array(optional_user_ids) if optional_user_ids
-      if user_ids && user_ids.is_a?(Array)
-        Hash[user_ids.zip(colossus.get_multi(user_ids))]
-      elsif user_ids == nil
-        colossus.get_all
-      else
-        raise 'Invalid user_ids data'
-      end
-    end
-
-    def valid?(writer_token)
-      colossus.verifier.verify_writer_token(writer_token)
-    end
-  end
-end

data/lib/colossus/writer_client.rb

@@ -1,82 +0,0 @@
-class Colossus
-  class WriterClient
-    attr_reader :url, :writer_token, :time_out
-
-    def initialize(url,
-                   writer_token = Colossus.config.writer_token,
-                   time_out = 2)
-      @url          = url
-      @writer_token = writer_token
-      @time_out     = time_out
-    end
-
-    def get_presences(optional_user_ids = nil)
-      user_ids = Array(optional_user_ids) if optional_user_ids
-      unique_token = generate_unique_token
-      EM.synchrony do
-        EM::Synchrony.add_timer(time_out) { raise 'Presence request timed out' }
-        EM::Synchrony.sync(faye_client.subscribe("/presences/response/#{unique_token}") { |message| return message['statuses'] })
-        EM::Synchrony.sync(faye_client.publish("/presences/request/#{unique_token}", user_ids))
-      end
-    end
-
-    def get_presences_by_http(optional_user_ids = nil)
-      user_ids = Array(optional_user_ids) if optional_user_ids
-      # Custom Content-Type to indicate to the server
-      # this is a simple http request
-      conn = Faraday.new(url, headers: {'Content-Type' => 'application/vnd.http.json'}) do |conf|
-        conf.adapter  Faraday.default_adapter
-        conf.response :raise_error
-      end
-
-      body = conn.post do |req|
-        req.body = JSON.dump({ user_ids: user_ids, writer_token: writer_token})
-      end.body
-
-      response = JSON.parse(body)
-      response['statuses']
-    end
-
-    def push_message(user_ids, message)
-      user_ids = Array(user_ids)
-      EM.synchrony do
-        EM::Synchrony.add_timer(time_out) { raise 'Push message timed out' }
-        user_ids.each do |user_id|
-          EM::Synchrony.sync(faye_client.publish("/users/#{user_id}", message))
-        end
-        EM.stop
-      end
-    end
-
-    private
-
-    def faye_client
-      faye_client = ::Faye::Client.new(url)
-      faye_client.add_extension(FayeExtension.new(writer_token))
-      faye_client
-    end
-
-    def generate_unique_token
-      SecureRandom.hex(8)
-    end
-
-    class FayeExtension
-      attr_reader :token
-
-      def initialize(token)
-        @token = token
-      end
-
-      def incoming(message, callback)
-        callback.call(message)
-      end
-
-      def outgoing(message, callback)
-        message['ext'] ||= {}
-        message['ext']['writer_token'] = token
-
-        callback.call(message)
-      end
-    end
-  end
-end