online_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e32e1d5904eb6f6501749b2a8482e9c9bdb7cb6
+  data.tar.gz: 6893b5355f2cb040e10303c43e45e71c47fd2e3b
+SHA512:
+  metadata.gz: 0412b45abb095758e52abc9119dc63eaba311ea91d3df6316a40bd871ce26a8323a2e475d1adaf8b223026e081bc26d51b561e7470ca6428b972c0fe8e25cbaf
+  data.tar.gz: 942b82fe3985454bcd803e8efcb677055e24996f64288acf97809606364c280b01909e4383f225f55a3d6f362f3d5c2caf973a1df6fb6eb2716067d9e40eabcd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cameron Martin
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# OnlineManager
+
+Manage whether users are online when you have a regular heartbeat, coming from a websocket for example.
+It allows you to have frequent heartbeats, but you only update the user's status when they transition between online and offline states.
+I have not run any benchmarks, but this is probably faster than updating your database every few seconds with a last_online timestamp.
+
+It runs in an eventmachine reactor, and defines a simple DSL with callbacks which are executed when a user transitions between online and offline states.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'online_manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install online_manager
+
+## Usage
+
+```ruby
+require 'online_manager'
+
+# This runs an eventmachine reactor, so the call to .run blocks.
+OnlineManager.run do |c|
+
+  c.timeout 5 # How long since a heartbeat was last received until the user is considered offline? (in seconds)
+
+  # All the blocks below will be called inside an eventmachine reactor.
+
+  c.setup do |seen|
+    # Set up any websocket server/connection to pubsub server, etc
+    # This must use eventmachine, otherwise it will block the reactor.
+    # Then call seen.call(user_id) whenever you receive a heartbeat from a user.
+  end
+
+  c.online do |user_id|
+    puts "Booster #{user_id} online"
+    # Update the user to online in the database or whatever
+    # This must be asynchronous i/o, otherwise it will block the reactor.
+  end
+
+  c.offline do |user_id|
+    puts "Booster #{user_id} offline"
+    # Called when a user transitions from online -> offline
+  end
+end
+```
+
+## TODO
+
+* Write tests for this. Its pretty simple (~ 50 lines of code excluding the DSL) and I have it running in production, so it should be fine.
+  Check out [this][1] for testing eventmachine.
+
+## Contributing
+
+1. Fork it ( https://github.com/cameron-martin/online_manager/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 a new Pull Request
+
+
+[1]: https://github.com/jcoglan/rspec-eventmachine

data/Rakefile

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

data/lib/online_manager.rb

@@ -0,0 +1,75 @@
+require 'eventmachine'
+
+class OnlineManager
+
+  attr_writer :online_callback, :offline_callback, :setup_callback, :timeout
+
+  def self.run(*args, &block)
+    new(*args, &block).run
+  end
+
+  def initialize
+    @timeout = nil
+    @online_users = {}
+    @online_callback = -> (_) {  }
+    @offline_callback = -> (_) {  }
+    @setup_callback = ->(_) { raise 'You must specify a setup callback' }
+
+    yield CallbackDSL.new(self) if block_given?
+
+    raise 'Timeout must be specified' unless @timeout
+  end
+
+  def run
+    EM.run do
+      @setup_callback.call(method(:seen))
+    end
+  end
+
+  private
+
+  def seen(id)
+    @online_callback.call(id) unless online?(id)
+
+    time = Time.now
+    @online_users[id] = time
+
+    EM.add_timer(@timeout) do
+      set_offline(id, time)
+    end
+  end
+
+  def set_offline(id, time)
+    if @online_users[id] == time
+      @online_users.delete(id)
+      @offline_callback.call(id)
+    end
+  end
+
+  def online?(id)
+    @online_users.has_key?(id)
+  end
+
+  class CallbackDSL
+    def initialize(target)
+      @target = target
+    end
+
+    def timeout(timeout)
+      @target.timeout = timeout
+    end
+
+    def online(&block)
+      @target.online_callback = block
+    end
+
+    def offline(&block)
+      @target.offline_callback = block
+    end
+
+    def setup(&block)
+      @target.setup_callback = block
+    end
+  end
+
+end

data/online_manager.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'online_manager'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Cameron Martin']
+  spec.email         = ['cameronmartin123@gmail.com']
+  spec.summary       = %q{Manage user's online status.}
+  spec.description   = %q{Manage whether users are online when you have a regular heartbeat, coming from a websocket for example.}
+  spec.homepage      = 'https://github.com/cameron-martin/online_manager'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'eventmachine', '~> 1.0'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: online_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cameron Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  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'
+description: Manage whether users are online when you have a regular heartbeat, coming
+  from a websocket for example.
+email:
+- cameronmartin123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/online_manager.rb
+- online_manager.gemspec
+homepage: https://github.com/cameron-martin/online_manager
+licenses:
+- MIT
+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: Manage user's online status.
+test_files: []
+has_rdoc: