ucengine 0.3.2 → 0.4.0

data/README.rdoc

@@ -1,7 +1,9 @@
 = ucengine.rb
 
-ucengine.rb can connect, subscribe, and publish events to UC Engine.
+ucengine.rb can connect, subscribe, and publish events to U.C.Engine.
+
+http://docs.ucengine.org/
 
 == Copyright
 
-Copyright (c) 2010 AF83. See LICENSE for details.
+Copyright (c) 2010-2011 AF83. See LICENSE for details.

data/Rakefile

@@ -6,8 +6,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "ucengine"
-    gem.summary = %Q{Ruby library for UCEngine}
-    gem.description = %Q{ucengine.rb is a Ruby library to consume the UCEngine API}
+    gem.summary = %Q{Ruby library for U.C.Engine}
+    gem.description = %Q{ucengine.rb is a Ruby library to consume the U.C.Engine API}
     gem.email = "victor.goya@af83.com"
     gem.homepage = "http://github.com/AF83/ucengine.rb"
     gem.authors = ["AF83"]

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/ucengine.rb

@@ -6,7 +6,7 @@ require 'rest-client'
 require 'daemons'
 require 'uri'
 
-# ucengine.rb implements the UCEngine API, it can currently handle
+# ucengine.rb implements the U.C.Engine API, it can currently handle
 # publish/subscribe to any event stream.
 #
 # Author::      Victor Goya (victor.goya@af83.com)
@@ -15,12 +15,12 @@ require 'uri'
 # Website::     http://ucengine.org/
 
 # This class is the main and only class in ucengine.rb, it handles
-# connections and request to the UCEngine server.
+# connections and request to the U.C.Engine server.
 #
 #       uce = UCEngine.new("localhost", 4567)
-#       uce.connect("uce@example.com", :password => 'pwd') do |uce|
-#               uce.subscribe([], :type => 'chat.message.new', :search => 'HTML5') do |event|
-#                      uce.publish(:location => event['location']
+#       uce.connect("uce@example.com", :credential => 'pwd') do |uce|
+#               uce.subscribe("", :type => 'chat.message.new', :search => 'HTML5') do |event|
+#                      uce.publish(:location => event['location'],
 #                                  :from => 'bot',
 #                                  :type => 'chat.message.new',
 #                                  :metadata => {"text" => "Hey, you were talking about HTML5"})
@@ -41,7 +41,7 @@ class UCEngine
 
   API_ROOT = "/api"
 
-  API_VERSION = "0.3"
+  API_VERSION = "0.4"
 
   attr_reader :sid, :uid, :connected
 
@@ -52,7 +52,7 @@ class UCEngine
   end
 
   # Run the ucengine server with all the options from the 'daemons' gem. This
-  # function is not mandatory and it is possible to run a UCEngine client without
+  # function is not mandatory and it is possible to run a U.C.Engine client without
   # having to run it in background.
   # The 'name' parameter is the name you want to give to your brick.
   #
@@ -66,7 +66,7 @@ class UCEngine
     Daemons.run_proc(name, &proc)
   end
 
-  # Create a new UCEngine object. 'host' is the hostname of the UCEngine server
+  # Create a new U.C.Engine object. 'host' is the hostname of the U.C.Engine server
   # and 'port' is to TCP port to connect to. Note that this method doesn't create
   # a new connection, see the #connect method.
   # An additional 'debug' parameter set the debug level of the library, all the
@@ -80,13 +80,14 @@ class UCEngine
     debug(UCEngine::DEBUG, "Initialisation complete for #{host}:#{port}.")
   end
 
+  # Return true if a connection to U.C.Engine has been established, return false otherwise.
   def connected?
     @connected
   end
 
-  # Connect to the UCEngine server with the User ID 'uid' and the its credential.
+  # Connect to the U.C.Engine server with the User ID 'uid' and the its credential.
+  #
   #
-  # 
   #     uce = UCEngine.new("localhost", 4567)
   #     uce.connect("bibi", :credential => 'abcd') do |uce|
   #             ... your code goes here
@@ -124,6 +125,7 @@ class UCEngine
   # :from => the origin of the message, the value is an uid.
   # :parent => the id of the the parent event.
   # :search => list of keywords that match the metadata of the returned events
+  # :order => "asc" or "desc" datetimes
   #
   #
   #     # Returns 30 events, starting from the 31th events, containing the keyword "HTML5"
@@ -187,6 +189,7 @@ class UCEngine
   # Publish an event. Publishing an event require a few mandatories parameters:
   # [:location] As described in the subscribe method: "meeting" publish the event in a specific meeting or "": publish the event in the server root.
   # [:type] The type of event to send, the format of this type is usually 'namespace.object.action', for example: 'chat.message.new', 'twitter.tweet.new', 'internal.user.update'
+  # Optional parameters:
   # [:parent] The id of the parent, this parameter is useful to build event hierarchy.
   # [:metadata] A hash of freely defined values to append to the event.
   #
@@ -212,7 +215,7 @@ class UCEngine
   # This function can be useful if you need to search for events from _now_.
   #
   #     uce.time -> 1240394032
-  # 
+  #
   def time
     time = get("/time", Hash.new)['result'].to_i
     debug(UCEngine::DEBUG, "Fecth timestamp from UCEngine: #{time}")
@@ -240,7 +243,7 @@ class UCEngine
 
   # Upload a file to UCEngine. The location is where
   # you want the file to be uploaded. The 'file' parameter is a File object.
-  # This function returns a JSON structure {'result': file_id} where 'file_id' is the identification 
+  # This function returns a JSON structure {'result': file_id} where 'file_id' is the identification
   # number of the file.
   #
   #     uce.upload(["demo_meeting"], File.new("/path/file_to_upload.pdf"))

data/spec/ucengine_mock.rb

@@ -6,7 +6,7 @@ require 'spec_helper'
 class UCEngineMock < Sinatra::Base
   use Rack::MethodOverride
 
-  VERSION = '0.3'
+  VERSION = '0.4'
 
   post "/api/#{VERSION}/presence/" do
     if params[:uid] == USER && params[:credential] == PASSWORD

data/ucengine.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ucengine}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["AF83"]
@@ -22,36 +22,6 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "doc/UCEngine.html",
-    "doc/UCEngine/Debug.html",
-    "doc/created.rid",
-    "doc/images/brick.png",
-    "doc/images/brick_link.png",
-    "doc/images/bug.png",
-    "doc/images/bullet_black.png",
-    "doc/images/bullet_toggle_minus.png",
-    "doc/images/bullet_toggle_plus.png",
-    "doc/images/date.png",
-    "doc/images/find.png",
-    "doc/images/loadingAnimation.gif",
-    "doc/images/macFFBgHack.png",
-    "doc/images/package.png",
-    "doc/images/page_green.png",
-    "doc/images/page_white_text.png",
-    "doc/images/page_white_width.png",
-    "doc/images/plugin.png",
-    "doc/images/ruby.png",
-    "doc/images/tag_green.png",
-    "doc/images/wrench.png",
-    "doc/images/wrench_orange.png",
-    "doc/images/zoom.png",
-    "doc/index.html",
-    "doc/js/darkfish.js",
-    "doc/js/jquery.js",
-    "doc/js/quicksearch.js",
-    "doc/js/thickbox-compressed.js",
-    "doc/lib/ucengine_rb.html",
-    "doc/rdoc.css",
     "lib/ucengine.rb",
     "spec/spec_helper.rb",
     "spec/ucengine_mock.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ucengine
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - AF83
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-21 00:00:00 +01:00
+date: 2011-03-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,7 +95,7 @@ dependencies:
         version: 2.4.0
   type: :development
   version_requirements: *id005
-description: ucengine.rb is a Ruby library to consume the UCEngine API
+description: ucengine.rb is a Ruby library to consume the U.C.Engine API
 email: victor.goya@af83.com
 executables: []
 
@@ -110,36 +110,6 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- doc/UCEngine.html
-- doc/UCEngine/Debug.html
-- doc/created.rid
-- doc/images/brick.png
-- doc/images/brick_link.png
-- doc/images/bug.png
-- doc/images/bullet_black.png
-- doc/images/bullet_toggle_minus.png
-- doc/images/bullet_toggle_plus.png
-- doc/images/date.png
-- doc/images/find.png
-- doc/images/loadingAnimation.gif
-- doc/images/macFFBgHack.png
-- doc/images/package.png
-- doc/images/page_green.png
-- doc/images/page_white_text.png
-- doc/images/page_white_width.png
-- doc/images/plugin.png
-- doc/images/ruby.png
-- doc/images/tag_green.png
-- doc/images/wrench.png
-- doc/images/wrench_orange.png
-- doc/images/zoom.png
-- doc/index.html
-- doc/js/darkfish.js
-- doc/js/jquery.js
-- doc/js/quicksearch.js
-- doc/js/thickbox-compressed.js
-- doc/lib/ucengine_rb.html
-- doc/rdoc.css
 - lib/ucengine.rb
 - spec/spec_helper.rb
 - spec/ucengine_mock.rb
@@ -178,7 +148,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby library for UCEngine
+summary: Ruby library for U.C.Engine
 test_files: 
 - spec/spec_helper.rb
 - spec/ucengine_mock.rb

data/doc/UCEngine/Debug.html

@@ -1,179 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
-
-	<title>Class: UCEngine::Debug</title>
-
-	<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
-
-	<script src="../js/jquery.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="../js/thickbox-compressed.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="../js/quicksearch.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="../js/darkfish.js" type="text/javascript"
-		charset="utf-8"></script>
-
-</head>
-<body class="class">
-
-	<div id="metadata">
-		<div id="home-metadata">
-			<div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="../index.html">Home</a>
-          <a href="../index.html#classes">Classes</a>
-          <a href="../index.html#methods">Methods</a>
-        </h3>
-			</div>
-		</div>
-
-		<div id="file-metadata">
-			<div id="file-list-section" class="section">
-				<h3 class="section-header">In Files</h3>
-				<div class="section-body">
-					<ul>
-					
-						<li><a href="../lib/ucengine_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
-							class="thickbox" title="lib/ucengine.rb">lib/ucengine.rb</a></li>
-					
-					</ul>
-				</div>
-			</div>
-
-			
-		</div>
-
-		<div id="class-metadata">
-
-			<!-- Parent Class -->
-			
-			<div id="parent-class-section" class="section">
-				<h3 class="section-header">Parent</h3>
-				
-				<p class="link">Object</p>
-				
-			</div>
-			
-
-			<!-- Namespace Contents -->
-			
-
-			<!-- Method Quickref -->
-			
-
-			<!-- Included Modules -->
-			
-		</div>
-
-		<div id="project-metadata">
-			
-			
-
-			<div id="classindex-section" class="section project-section">
-				<h3 class="section-header">Class Index
-					<span class="search-toggle"><img src="../images/find.png"
-						height="16" width="16" alt="[+]"
-						title="show/hide quicksearch" /></span></h3>
-				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-				<fieldset>
-					<legend>Quicksearch</legend>
-					<input type="text" name="quicksearch" value=""
-						class="quicksearch-field" />
-				</fieldset>
-				</form>
-
-				<ul class="link-list">
-				
-					<li><a href="../UCEngine.html">UCEngine</a></li>
-				
-					<li><a href="../UCEngine/Debug.html">UCEngine::Debug</a></li>
-				
-				</ul>
-				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
-			</div>
-
-			
-		</div>
-	</div>
-
-	<div id="documentation">
-		<h1 class="class">UCEngine::Debug</h1>
-
-		<div id="description">
-			
-		</div>
-
-		<!-- Constants -->
-		
-		<div id="constants-list" class="section">
-			<h3 class="section-header">Constants</h3>
-			<dl>
-			
-				<dt><a name="DEBUG">DEBUG</a></dt>
-				
-				<dd class="description"><p>
-Print every request and everything above.
-</p></dd>
-				
-			
-				<dt><a name="WARNING">WARNING</a></dt>
-				
-				<dd class="description"><p>
-Print everything that seems fishy.
-</p></dd>
-				
-			
-				<dt><a name="ERROR">ERROR</a></dt>
-				
-				<dd class="description"><p>
-Print regular errors, usually HTTP errors.
-</p></dd>
-				
-			
-				<dt><a name="CRITICAL">CRITICAL</a></dt>
-				
-				<dd class="description"><p>
-Only print critical errors (bad hostname or port, etc).
-</p></dd>
-				
-			
-				<dt><a name="QUIET">QUIET</a></dt>
-				
-				<dd class="description"><p>
-Don&#8217;t print anything (default).
-</p></dd>
-				
-			
-			</dl>
-		</div>
-		
-
-		<!-- Attributes -->
-		
-
-		<!-- Methods -->
-		
-
-	</div>
-
-
-	<div id="rdoc-debugging-section-dump" class="debugging-section">
-	
-		<p>Disabled; run with --debug to generate this.</p>
-	
-	</div>
-
-	<div id="validator-badges">
-		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-			Rdoc Generator</a> 1.1.6</small>.</p>
-	</div>
-
-</body>
-</html>
-