online_manager 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e32e1d5904eb6f6501749b2a8482e9c9bdb7cb6
-  data.tar.gz: 6893b5355f2cb040e10303c43e45e71c47fd2e3b
+  metadata.gz: dc1c0b7ad1198c4e4a02cb8b797b647b919571fd
+  data.tar.gz: e1d2a97d952633e0e68023760cd426f6b98c6a3c
 SHA512:
-  metadata.gz: 0412b45abb095758e52abc9119dc63eaba311ea91d3df6316a40bd871ce26a8323a2e475d1adaf8b223026e081bc26d51b561e7470ca6428b972c0fe8e25cbaf
-  data.tar.gz: 942b82fe3985454bcd803e8efcb677055e24996f64288acf97809606364c280b01909e4383f225f55a3d6f362f3d5c2caf973a1df6fb6eb2716067d9e40eabcd
+  metadata.gz: f505a05f4324e4ac45ea09d940ff7e76a4da416e5ebbc91450ecf2e5bb89c53be3145cff0c10078f4c37b1c69bc4dd1791efc54a9b20036b567c0cb233840360
+  data.tar.gz: 278a2c80e9688f6d9df62e263b2a0391f2151ab0eae0f5c94baaa86726e95ca6efa5db1822c8b9268fb68d5a16305c61583f50e83f7f6d688a7be3f112fc38ac

data/README.md

@@ -27,10 +27,14 @@ Or install it yourself as:
 ```ruby
 require 'online_manager'
 
+# You should set all the users offline when it first runs,
+# since otherwise you'll be left with users marked online from when it last quit.
+
 # 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)
+  # How long since a heartbeat was last received until the user is considered offline? (in seconds)
+  c.timeout 5
 
   # All the blocks below will be called inside an eventmachine reactor.
 
@@ -43,7 +47,7 @@ OnlineManager.run do |c|
   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.
+    # This must use asynchronous i/o, otherwise it will block the reactor.
   end
 
   c.offline do |user_id|
@@ -53,10 +57,23 @@ OnlineManager.run do |c|
 end
 ```
 
+If you already are in the context of an eventmachine reactor, or you want to run multiple of these in the same thread,
+you can use `.setup`.
+
+```ruby
+EM.run do
+  OnlineManager.setup do |c|
+    # Configure it
+  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.
+* Consider setting remaining users offline in an ensure block, so it always leaves the statuses in a consistent state.
+  [Could this replace setting users offline on initialization?][2]
 
 ## Contributing
 
@@ -67,4 +84,5 @@ end
 5. Create a new Pull Request
 
 
-[1]: https://github.com/jcoglan/rspec-eventmachine
+[1]: https://github.com/jcoglan/rspec-eventmachine
+[2]: http://stackoverflow.com/questions/25235089/when-will-rubys-ensure-not-run

data/lib/online_manager.rb

@@ -1,13 +1,18 @@
 require 'eventmachine'
 
-class OnlineManager
+require 'online_manager/dsl'
 
+class OnlineManager
   attr_writer :online_callback, :offline_callback, :setup_callback, :timeout
 
   def self.run(*args, &block)
     new(*args, &block).run
   end
 
+  def self.setup(*args, &block)
+    new(*args, &block).setup
+  end
+
   def initialize
     @timeout = nil
     @online_users = {}
@@ -15,18 +20,20 @@ class OnlineManager
     @offline_callback = -> (_) {  }
     @setup_callback = ->(_) { raise 'You must specify a setup callback' }
 
-    yield CallbackDSL.new(self) if block_given?
+    yield DSL.new(self) if block_given?
 
     raise 'Timeout must be specified' unless @timeout
   end
 
   def run
-    EM.run do
-      @setup_callback.call(method(:seen))
-    end
+    EM.run { setup }
   end
 
-  private
+  def setup
+    @setup_callback.call(method(:seen))
+  end
+
+private
 
   def seen(id)
     @online_callback.call(id) unless online?(id)
@@ -49,27 +56,4 @@ class OnlineManager
   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/lib/online_manager/dsl.rb

@@ -0,0 +1,23 @@
+class OnlineManager
+  class DSL
+    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

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'online_manager'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ['Cameron Martin']
   spec.email         = ['cameronmartin123@gmail.com']
   spec.summary       = %q{Manage user's online status.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cameron Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - lib/online_manager.rb
+- lib/online_manager/dsl.rb
 - online_manager.gemspec
 homepage: https://github.com/cameron-martin/online_manager
 licenses: