em-ucengine 0.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,57 @@
+EventMachine library for U.C.Engine
+===================================
+
+em-ucengine is a Ruby library for [U.C.Engine](http://ucengine.org/) powered
+by [EventMachine](https://github.com/eventmachine/eventmachine). It can
+connect, subscribe and publish events to U.C.Engine.
+
+
+How to use it
+-------------
+
+Install with Rubygems:
+
+    gem install em-ucengine
+
+If you use bundler, add it to your `Gemfile`:
+
+    gem "em-ucengine", "~>0.1"
+
+Then, you can use it in your code:
+
+    require "em-ucengine"
+    EventMachine::UCEngine.run do |uce|
+      uce.connect("participant", "pwd") do |session|
+        EM.add_periodic_timer(1) { session.publish("em-ucengine.example.ping", "demo") }
+        session.subscribe("demo") do |event|
+          puts "Hey, we received an event: #{event.inspect}"
+        end
+      end
+    end
+
+Don't hesitate to look at the specs for more examples ;-)
+
+
+TODO
+----
+
+* Files API
+* ACL or Roles API
+* Better error handling
+* Complete the specs
+* Compatibility with em-synchrony
+* Yard documentation
+
+
+Issues or Suggestions
+---------------------
+
+Found an issue or have a suggestion? Please report it on
+[Github's issue tracker](http://github.com/af83/ucengine.em/issues).
+
+If you wants to make a pull request, please check the specs before:
+
+    ./spec/em-ucengine_spec.rb
+
+
+Copyright (c) 2011 af83, released under the LGPL license

data/lib/em-ucengine.rb

@@ -0,0 +1,188 @@
+require "eventmachine"
+require "em-http-request"
+require "yajl"
+
+
+module EventMachine
+  class UCEngine
+
+    def self.run(*args)
+      EM.run { yield self.new(*args) }
+    end
+
+    def initialize(host="localhost", port=5280, api_root="/api", api_version="0.4")
+      @host = host
+      @port = port
+      @root = api_root
+      @version = api_version
+    end
+
+    def time
+      Session.new(self, nil, nil).time { |time| yield time }
+    end
+
+    def connect(user, password, metadata=nil)
+      body = { "name" => user, "credential" => password }
+      body["metadata"] = metadata if metadata
+      http = EM::HttpRequest.new(url "presence").post :body => body
+      http.errback  { yield nil }
+      http.callback do
+        data = Yajl::Parser.parse(http.response)
+        data = data["result"] if data
+        yield Session.new(self, data["uid"], data["sid"])
+      end
+    end
+
+    def url(path)
+      "http://#{@host}:#{@port}#{@root}/#{@version}/#{path}"
+    end
+
+    class Session < Struct.new(:uce, :uid, :sid)
+
+      ### Time - http://docs.ucengine.org/api.html#time ###
+
+      def time
+        get("/time") { |result| yield result if block_given? }
+      end
+
+      ### Presence - http://docs.ucengine.org/api.html#authentication ###
+
+      def presence(sid)
+        get("/presence/#{sid}") { |result| yield result if block_given? }
+      end
+
+      def disconnect
+        delete("/presence/#{sid}") { |result| yield result if block_given? }
+      end
+
+      ### Users - http://docs.ucengine.org/api.html#user ###
+
+      def users
+        get("/user") { |result| yield result if block_given? }
+      end
+
+      def user(uid)
+        get("/user/#{uid}") { |result| yield result if block_given? }
+      end
+
+      def create_user(data)
+        post("/user", data) { |result| yield result && result.to_i if block_given? }
+      end
+
+      def update_user(uid, data)
+        put("/user/#{uid}", data) { |result| yield result if block_given? }
+      end
+
+      def delete_user(uid)
+        delete("/user/#{uid}") { |result| yield result if block_given? }
+      end
+
+      ### General infos - http://docs.ucengine.org/api.html#infos ###
+
+      def infos
+        get("/infos") { |result| yield result if block_given? }
+      end
+
+      def update_infos(metadata)
+        put("/infos", :metadata => metadata) { |result| yield result if block_given? }
+      end
+
+      ### Meetings - http://docs.ucengine.org/api.html#meeting ###
+
+      def meetings(status=nil)
+        get("/meeting/#{status}") { |result| yield result if block_given? }
+      end
+
+      def meeting(meeting)
+        get("/meeting/all/#{meeting}") { |result| yield result if block_given? }
+      end
+
+      def create_meeting(meeting, body={})
+        body.merge!(:meeting => meeting)
+        post("/meeting/all", body) { |result| yield result if block_given? }
+      end
+
+      def update_meeting(meeting, body={})
+        put("/meeting/all/#{meeting}", body) { |result| yield result if block_given? }
+      end
+
+      def delete_meeting(meeting)
+        delete("/meeting/all/#{meeting}") { |result| yield result if block_given? }
+      end
+
+      ### Rosters - http://docs.ucengine.org/api.html#join-a-meeting ###
+
+      def roster(meeting)
+        get("/meeting/all/#{meeting}/roster") { |result| yield result if block_given? }
+      end
+
+      def join_roster(meeting)
+        post("/meeting/all/#{meeting}/roster") { |result| yield result if block_given? }
+      end
+
+      def quit_roster(meeting, uid=nil)
+        delete("/meeting/all/#{meeting}/roster/#{uid || @uid}") { |result| yield result if block_given? }
+      end
+
+      ### Events - http://docs.ucengine.org/api.html#events ###
+
+      def events(meeting, params={})
+        params[:_async] = "no"
+        get("/event/#{meeting}", params) { |result| yield result if block_given? }
+      end
+
+      def subscribe(meeting, params={}, &blk)
+        params[:_async] = "lp"
+        recurse = Proc.new do |result|
+          next unless result
+          blk.call(result)
+          params[:start] = result.last["datetime"].to_i + 1
+          get("/event/#{meeting}", params, &recurse) if EM.reactor_running?
+        end
+        time do |time|
+          params[:start] = time
+          get("/event/#{meeting}", params, &recurse)
+        end
+      end
+
+      def publish(type, meeting=nil, metadata=nil)
+        body = { :type => type }
+        body[:metadata] = metadata if metadata
+        post("/event/#{meeting}", body) { |result| yield result if block_given? }
+      end
+
+      def search(params)
+        get("/search/event/", params) { |result| yield result if block_given? }
+      end
+
+    protected
+
+      def get(path, params={})
+        http_request(:get, path, :query => params) { |result| yield result }
+      end
+
+      def post(path, body=nil)
+        http_request(:post, path, :body => body) { |result| yield result }
+      end
+
+      def put(path, body=nil)
+        http_request(:put, path, :body => body) { |result| yield result }
+      end
+
+      def delete(path)
+        http_request(:delete, path) { |result| yield result }
+      end
+
+      def http_request(method, path, opts={})
+        opts[:query] ||= {}
+        opts[:query].merge!(:uid => uid, :sid => sid)
+        http = EM::HttpRequest.new(uce.url path).send(method, opts)
+        http.errback  { yield nil }
+        http.callback do
+          data = Yajl::Parser.parse(http.response)
+          yield data && data.has_key?("result") && data["result"]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: em-ucengine
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Bruno Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196357
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
+        - 3
+        version: 1.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196357
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
+        - 3
+        version: 1.0.0.beta3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
+description: A library for U.C.Engine, powered by EventMachine
+email: bruno.michel@af83.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- LICENSE
+- README.md
+- Gemfile
+- lib/em-ucengine.rb
+has_rdoc: true
+homepage: http://github.com/af83/ucengine.em
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A library for U.C.Engine, powered by EventMachine
+test_files: []
+