ucengine 0.1.0

data/lib/ucengine.rb

@@ -0,0 +1,192 @@
+require 'json'
+
+require 'net/http'
+require 'cgi'
+
+# ucengine.rb implements the UCEngine API, it can currently handle
+# publish/subscribe to any event stream.
+#
+# Author::      Victor Goya (victor.goya@af83.com)
+# Copyright::   Copyright (c) 2010 AF83
+# License::     LGPL
+# Website::     http://ucengine.org/
+
+# This class is the main and only class in ucengine.rb, it handles
+# connections and request to the UCEngine server.
+#
+#       uce = UCEngine.new("localhost", 4567)
+#       uce.connect("bibi", :password => 'abcd') do |uce|
+#               uce.subscribe(["af83"], :type => 'chat.message.new', :search => 'HTML5') do |event|
+#                      uce.push(:location => [event['org'], event['meeting']]
+#                               :from => 'bot',
+#                               :type => 'chat.message.new',
+#                               :metadata => {"text" => "Hey, you were talking about HTML5"})
+#               end
+#       end
+class UCEngine
+
+  # Print every request and everything above.
+  DEBUG = 0
+  # Print everything that seems fishy.
+  WARNING = 1
+  # Print regular errors, usually HTTP errors.
+  ERROR = 2
+  # Only print critical errors (bad hostname or port, etc).
+  CRITICAL = 3
+  # Don't print anything (default).
+  QUIET = 4
+
+  # Create a new UCEngine object. 'host' is the hostname of the UCEngine 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
+  # debug information are written in the error output.
+  def initialize(host, port, debug = UCEngine::QUIET)
+    @host = host
+    @port = port
+    @http = Net::HTTP.new(host, port)
+    @threads = []
+    @debug = debug
+    debug(UCEngine::DEBUG, "Initialisation complete for #{host}:#{port}.")
+  end
+
+  # Connect to the UCEngine server with the User ID 'uid' and the its credential.
+  #
+  # 
+  #     uce = UCEngine.new("localhost", 4567)
+  #     uce.connect("bibi", :password => 'abcd') do |uce|
+  #             ... your code goes here
+  #     end
+  #
+  # It is currently possible to use :token or :password as authentification method.
+  def connect(uid, credential)
+    @uid = uid
+    response = put("/presence/#{@uid}", {:auth => 'token', :credential => credential[:token]})
+    @sid = response['result']
+    debug(UCEngine::DEBUG, "Authentification complete for #{@uid}/#{@sid}.")
+    yield self
+    @threads.each do |thread|
+      thread.join
+    end
+  end
+
+  # Subscribe to an event stream. The 'location' parameter is where you're expecting
+  # the events to come:
+  # * ["organisation", "meeting"]: events from a specific meeting.
+  # * ["organisation"]: events from all meetings of the organisation and for the organisation itself.
+  # * []: all events.
+  #
+  # The function takes extra parameters:
+  # :type => the type of event (ex. 'chat.message.new', 'internal.user.add', etc).
+  # :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
+  #
+  #
+  #     uce.subscribe(["af83"], :type => 'internal.meeting.add', :search => 'HTML5') do |event|
+  #             puts "A new meeting about HTML5 was created"
+  #     end
+  def subscribe(location, params = {})
+    debug(UCEngine::DEBUG, "Subscribe to #{location} with #{params}.")
+    @threads << Thread.new do
+      Net::HTTP.start(@host, @port) do |http|
+        params[:_async] = "lp"
+        params[:start] = 0 if !params[:start]
+        while true
+          begin
+            events = get("/event/#{location.join("/")}", params, http)['result']
+          rescue Timeout::Error
+            debug(UCEngine::WARNING, "Subscribe timeout ... retry")
+            retry
+          rescue EOFError
+            debug(UCEngine::WARNING, "Subscribe closed ... retry")
+            sleep 10
+            retry
+          end
+          events.each do |event|
+            yield event
+          end
+          params[:start] = events[-1]['datetime'] + 1
+        end
+      end
+    end
+  end
+
+  # Publish an event. Publishing an event require a few mandatories parameters:
+  # [:location] As described in the subscribe method: ["organisation", "meeting"] publish the event in a specific meeting, ["organisation"] publish the event in the organisation and []: 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'
+  # [: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.
+  #
+  #     uce.publish(:location => ["af83", "WebWorkersCamp"],
+  #                 :type => 'presentation.slide.add'
+  #                 :metadata => {:url => 'http://myserver/slides/03.png',
+  #                               :index => 3})
+  def publish(event)
+    debug(UCEngine::DEBUG, "Publish to #{event[:location]}, type: #{event[:type]}, parent: #{event[:parent]}, metadata: #{event[:metadata]}")
+    params = Hash.new
+    params[:type] = event[:type]
+    params[:parent] = event[:parent] if event[:parent]
+    if event[:metadata]
+      event[:metadata].each_key do |key|
+        params["metadata[#{key}]"] = event[:metadata][key]
+      end
+    end
+    put("/event/#{event[:location].join("/")}", params)
+  end
+
+  # Return the current timestamp from the server. The timestamp is expressed in milliseconds
+  # from Epoch (january 1st 1970).
+  # 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}")
+    return time
+  end
+
+  protected
+
+  # Encode parameters
+  def UCEngine.encode(params)
+    params.collect { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')
+  end
+
+  # Print debug messages
+  def debug(level, message)
+    $stderr.write("#{message}\n\n") if level >= @debug
+  end
+
+  # Handle GET requests
+  def get(path, params, http = @http)
+    params[:uid] = @uid if @uid
+    params[:sid] = @sid if @sid
+    result = JSON.parse(http.get("/api/0.1/#{path}?#{UCEngine.encode(params)}").body)
+    debug(UCEngine::DEBUG, "Request: GET /api/0.1/#{path}?#{UCEngine.encode(params)}\nResult: #{result}")
+    return result
+  end
+
+  # Handle POST requests
+  def post(path, params, http = @http)
+    params[:uid] = @uid if @uid
+    params[:sid] = @sid if @sid
+    result = JSON.parse(http.post("/api/0.1/#{path}", UCEngine.encode(params)).body)
+    debug(UCEngine::DEBUG, "Request: POST /api/0.1/#{path}?#{UCEngine.encode(params)}\nResult: #{result}")
+    return result
+  end
+
+  # Handle PUT requests
+  def put(path, params)
+    params['_method'] = "PUT"
+    post(path, params)
+  end
+
+  # Handle DELETE requests
+  def delete(path, params)
+    params['_method'] = "DELETE"
+    post(path, params)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ucengine.rb'
+
+class Test::Unit::TestCase
+end

data/test/test_ucengine.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestUcengine < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/ucengine.rb.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ucengine.rb}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["AF83"]
+  s.date = %q{2010-11-23}
+  s.description = %q{ucengine.rb is a Ruby library to consume the UCEngine API}
+  s.email = %q{victor.goya@af83.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/ucengine.rb",
+     "test/helper.rb",
+     "test/test_ucengine.rb.rb",
+     "ucengine.rb.gemspec"
+  ]
+  s.homepage = %q{http://github.com/AF83/ucengine.rb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby library for UCEngine}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_ucengine.rb.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: ucengine
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- AF83
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: ucengine.rb is a Ruby library to consume the UCEngine API
+email: victor.goya@af83.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- 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
+- test/helper.rb
+- test/test_ucengine.rb
+- ucengine.rb.gemspec
+has_rdoc: true
+homepage: http://github.com/AF83/ucengine.rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby library for UCEngine
+test_files: 
+- test/helper.rb
+- test/test_ucengine.rb