nodevent 3.0.5 → 3.1.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+script: rspec

data/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in nodevent.gemspec
-gemspec
+#gemspec
 gem 'rspec'
-gem 'nodevent', :path => '.'
 gem 'rails'

data/README.md

@@ -1,24 +1,158 @@
+[![Build Status](https://secure.travis-ci.org/cconstantine/NoDevent-gem.png?branch=master)](http://travis-ci.org/cconstantine/NoDevent-gem)
+
 # Nodevent
 
-TODO: Write a gem description
+Ruby support for sending NoDevent events.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+There is a rubygem named 'nodevent'.  To install simply `gem install nodevent` the in ruby:
+```ruby
+require 'nodevent'
+```
+
+or, add this to your Gemfile
+```ruby
+gem 'nodevent'
+```
+
+## Configuring NoDevent
+
+The NoDevent module comes with a default config that will work if you're using the default appliance config.  NoDevent expects a global $redis redis connection to exist, and it will use that to post events.
+
+You can override that config
+```ruby
+NoDevent::Emitter.config = {:host => "http://myawesomesite", :namespace => "/other_namespace", :secret => 'lajf0q983j4laidsnvqo84jfoqijflkjafds' }
+```
+The namespace must match exactly to your configured namespace in the appliance.  If there is a missmatch nothing will happen in the client and it can be VERY frustrating to debug.  The secret must match also, or you will get errors attempting to join a room.  You are also completely replacing the default config, so you must specify everything.
+
+
+## View helper
+To get the magic javascript include tag in your view there is a rails view helper.  
+```ruby
+javascript_include_nodevent
+```
+That will include the script tag with the configured path. 
+
+## NoDevent::Emitter
+
+This is where the magic happens.  
+
+### Example usage:
+In the controller
+```ruby
+@room = NoDevent::Emitter.room(current_user)
+@roomkey = NoDevent::Emitter.room_key(current_user, Time.zone.now + 1.hour)
+```
+
+In the view
+```erb
+<%= content_for :javascript do %>
+  current_user_room = NoDevent.room('<%=@room%>');
+  current_user_room.setKey('<%=@roomkey%>');
+  current_user_room.join();
+<% end %>
+
+### NoDevent::Emitter.room(obj)
+
+Example usage:
+```ruby
+# Get the name of a room for a class/module
+@roomname = NoDevent::Emitter.room(SomeModel)
+
+# Get the name of a room for a model instance
+@roomname = NoDevent::Emitter.room(SomeModel.first)
+
+# Just returns "the_room"
+@roomname = NoDevent::Emitter.room("the_room")
+```
+This is a helper method to get the name of a room.  You don't really need to use it, but it can convert objects that inherit from ActiveRecord::Base into their unique room name.
+
+### NoDevent::Emitter.room_key(obj, expires)
+
+This is a helper method to generate the key for a room with a given experation time.  
+
+Example usage:
+```ruby
+@roomkey = NoDevent::Emitter.room_key(SomeModel, Time.zone.now + 1.hour)
+@roomkey = NoDevent::Emitter.room_key(SomeModel.first, Time.zone.now + 1.hour)
+@roomkey = NoDevent::Emitter.room_key(@roomname, Time.zone.now + 1.hour)
+@roomkey = NoDevent::Emitter.room_key('the_room', Time.zone.now + 1.hour)
+```
+The above code will generate a key for the room that is valid for the next hour.
+
+### NoDevent::Emitter.emit(room, event, message)
+
+This method emits a named event with a message (any object that responds to .to_json) to the room.
+
+```ruby
+NoDevent::Emitter.emit(NoDevent::Emitter.room(SomeModel.first), 'the_event', 'some_message')
+NoDevent::Emitter.emit('the_room', 'the_event', {:some => :data, :other => :thing})
+```
+
+The event will travel through redis to the NoDevent appliance server, and any browser client room object will emit an event named after the event name.
+```javascript
+var room = Nodevent.room('the_room')
+room.join()
+room.on('the_event', function(message) {});
+```
+
+This method can be called from anywhere, and it will send the event to any browser client listening appropriately.  This means it can be emitted on model creation, or even from a resque job.
+
+## NoDevent mixin.
+To help even further, I've provided the NoDevent::Base module as an include-able thing for models.
+
+```ruby
+class SomeModel < ActiveRecord::Base
+  include NoDevent::Base
+
+  after_create :nodevent_create
+  after_update :nodevent_update
+
+  def as_json(options={})
+    super(options).merge(:nodevent => {:room => room, :key => room_key(Time.zone.now + 1.hour)})
+  end
+
+end
+```
+
+The above example includes NoDevent support directly into a model.
+
+It also provides the following:
+* The class's room will be notified of created instances
+* Instances will include the room name and key for getting updates
+* Updates to a model will notify listeners of the change
+
+
+When using this you can ask SomeModel for its room name
+```ruby
+@roomname = SomeMode.first.room
+```
 
-    gem 'nodevent'
+or the room key
+```ruby
+@roomkey = SomeModel.first.room_key(Time.zone.now + 1.hour)
+```
 
-And then execute:
+or even emit directly to it's room
+```ruby
+# Emit an arbitrary message to the model instance's room
+SomeModel.first.emit('the_event', 'some_message')
 
-    $ bundle
+# Emit a json-ed version of the model
+SomeModel.first.emit('update')
+```
 
-Or install it yourself as:
+## Versioning
 
-    $ gem install nodevent
+I'm using the following versioning scheme:
+```
+x.y.z
+```
 
-## Usage
+A change in the 'x' indictes that there has been a backwards incompatible interface change.  A change in the 'y' indicates some new functionality or significant bug fix, and a change in the 'z' indictes a minor bug fix.  
 
-TODO: Write usage instructions here
+Don't attempt to get a guage on how mature this system is by the version numbers.  I'm following this pattern so that automatic version matching systems like bundler and npm can update developers' packages and protect against backwards incompatible changes. The rubygem and npm package follow each other in version number on the 'x', and 'y', but not 'z'.
 
 ## Contributing
 

data/lib/nodevent/version.rb

@@ -1,3 +1,3 @@
 module Nodevent
-  VERSION = "3.0.5"
+  VERSION = "3.1.0"
 end

data/lib/nodevent.rb

@@ -66,7 +66,7 @@ module NoDevent
 
       def config
         @@config ||= Hash.new({
-                                :host => "http://loadsfcalhost:8080",
+                                :host => "http://localhost:8080",
                                 :namespace => "/nodevent"
                               })
         @@config
@@ -75,7 +75,7 @@ module NoDevent
       def emit(room, name, message)
         room = NoDevent::Emitter.room(room)
 
-        $redis.publish("events", 
+        $redis.publish(@@config[:namespace], 
                        { :room => room,
                          :event => name, 
                          :message => message}.to_json)

data/nodevent.gemspec

@@ -3,10 +3,10 @@ require File.expand_path('../lib/nodevent/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Chris Constantine"]
-  gem.email         = ["cconstan@gmail.com.com"]
+  gem.email         = ["cconstan@gmail.com"]
   gem.description   = %q{Write a gem description}
   gem.summary       = %q{ Write a gem summary}
-  gem.homepage      = "https://github.com/cconstantine/NoDevent"
+  gem.homepage      = "https://github.com/cconstantine/NoDevent-gem"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ if defined?(Bundler)
   # If you want your assets lazily compiled in production, use this line
   # Bundler.require(:default, :assets, Rails.env)
 end
+require 'nodevent'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nodevent
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -29,14 +29,12 @@ dependencies:
         version: 2.0.0
 description: Write a gem description
 email:
-- cconstan@gmail.com.com
+- cconstan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -47,7 +45,7 @@ files:
 - spec/base_spec.rb
 - spec/emitter_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/cconstantine/NoDevent
+homepage: https://github.com/cconstantine/NoDevent-gem
 licenses: []
 post_install_message: 
 rdoc_options: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p194@nodevent"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.14.5 (stable)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi