ucengine 0.5.0 → 0.5.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ucengine (0.4.0)
+    ucengine (0.5.3)
       daemons (~> 1.1)
       json (~> 1.5)
       rest-client (~> 1.6)
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    daemons (1.1.0)
+    daemons (1.1.3)
     diff-lcs (1.1.2)
-    json (1.5.1)
+    json (1.5.3)
     mime-types (1.16)
     rack (1.2.2)
-    rest-client (1.6.1)
+    rest-client (1.6.3)
       mime-types (>= 1.16)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)

data/lib/ucengine.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'yaml'
+require 'logger'
 
 require 'rest-client'
 
@@ -28,18 +29,14 @@ require 'uri'
 #       end
 class UCEngine
 
-  DEBUG    = 0 # Print every request and everything above.
-  WARNING  = 1 # Print everything that seems fishy.
-  ERROR    = 2 # Print regular errors, usually HTTP errors.
-  CRITICAL = 3 # Only print critical errors (bad hostname or port, etc).
-  QUIET    = 4 # Don't print anything (default).
-
   # HTTP API conf.
   API_ROOT    = '/api'
   API_VERSION = '0.5'
 
   attr_reader :sid, :uid, :connected
 
+  @@logger = nil
+
   # Load configuration file (default: config.yaml). The returned configuration
   # is a Hash, as returned by YAML.load_file().
   def self.load_config(path = 'config.yaml')
@@ -57,21 +54,26 @@ class UCEngine
   #     end
   #
   #
-  def self.run(name, &proc)
-    Daemons.run_proc(name, &proc)
+  def self.run(name, options = {}, &proc)
+    Daemons.run_proc(name, options, &proc)
+  end
+
+  # Set the default logger.
+  def self.logger=(logger)
+    @@logger = logger
   end
 
   # 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
-  # debug information are written in the error output.
-  def initialize(host, port, debug = UCEngine::QUIET)
+  # a new connection, see the #connect method. An optional parameter 'level' can be
+  # used to set the logging level (default: Logger::UNKNOWN).
+  def initialize(host, port, level = Logger::UNKNOWN)
     @host = host
     @port = port
     @http = Net::HTTP.new(host, port)
     @threads = []
-    @debug = debug
+    @logger = @@logger || Logger.new($stderr)
+    @logger.level = level
     debug "Initialisation complete for #{host}:#{port}."
   end
 
@@ -109,6 +111,16 @@ class UCEngine
     end
   end
 
+  # List users in a meeting room.
+  #
+  #
+  #     uce = UCEngine.new("localhost", 4567)
+  #     users = uce.roster('demo')
+  #
+  def roster(name)
+    get("/meeting/all/#{name}/roster")['result']
+  end
+
   # Search events. The 'location' parameter is where you're expection the events to come:
   # * "meeting": event from a specific meeting.
   # * "": all events.
@@ -243,27 +255,17 @@ class UCEngine
   #
   #     uce.upload(["demo_meeting"], File.new("/path/file_to_upload.pdf"))
   #
-  def upload(location, file)
+  def upload(location, file, metadata={})
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{location}?uid=#{@uid}&sid=#{@sid}"
     debug "Upload: #{file.path} to #{url}"
-    result = JSON.parse(RestClient.post(url, {:upload => file}))
+    result = JSON.parse(RestClient.post(url, { :content => file,
+                                               :metadata => metadata }))
     debug 'Upload complete'
     return result
   end
 
-  protected
-
-  # Print debug messages
-  def log_message(level, message)
-    $stderr.write "#{message}\n\n" if level >= @debug
-  end
-  def debug(message)    ; log_message UCEngine::DEBUG,    message ; end
-  def warn(message)     ; log_message UCEngine::WARNING,  message ; end
-  def error(message)    ; log_message UCEngine::ERROR,    message ; end
-  def critical(message) ; log_message UCEngine::CRITICAL, message ; end
-
   # Handle GET requests
-  def get(path, params, http = @http)
+  def get(path, params = {}, http = @http)
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
@@ -274,7 +276,7 @@ class UCEngine
   end
 
   # Handle POST requests
-  def post(path, params, http = @http)
+  def post(path, params = {}, http = @http)
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
@@ -285,15 +287,21 @@ class UCEngine
   end
 
   # Handle PUT requests
-  def put(path, params)
+  def put(path, params = {})
     params['_method'] = 'PUT'
     post path, params
   end
 
   # Handle DELETE requests
-  def delete(path, params)
+  def delete(path, params = {})
     params['_method'] = 'DELETE'
     post path, params
   end
 
+  protected
+
+  def debug(message)    ; @logger.debug message  ; end
+  def warn(message)     ; @logger.warn  message  ; end
+  def error(message)    ; @logger.error message  ; end
+  def critical(message) ; @logger.fatal message  ; end
 end

data/lib/ucengine/version.rb

@@ -1,3 +1,3 @@
 class UCEngine
-  VERSION = '0.5.0'
+  VERSION = '0.5.3'
 end

data/spec/ucengine_mock.rb

@@ -23,6 +23,25 @@ class UCEngineMock < Sinatra::Base
     {:result => 1234}.to_json
   end
 
+  get "/api/#{VERSION}/meeting/all/:meeting/roster" do
+    status 200
+    users = [{:id => 34334839681323313178318538371527,
+              :name => 'jeffrey.lebowski@bathtub.com',
+              :domain => 'ucengine.org',
+              :auth => 'password',
+              :metadata => {
+                :nickname => "The Dude"
+             }},
+             {:id => 18519526811067452830480557737028,
+              :name => 'walter.sobchak@bowling.org',
+              :domain => 'ucengine.org',
+              :auth => 'password',
+              :metadata => {
+                :nickname => "The Veteran"
+              }}]
+    {:result => users}.to_json
+  end
+
   post "/api/#{VERSION}/event/:meeting" do
     if params[:meeting] == UCE_MEETING
       if params[:type] == "test_type" &&
@@ -76,7 +95,7 @@ class UCEngineMock < Sinatra::Base
   # Upload
   post "/api/#{VERSION}/file/:meeting" do
     if params[:meeting] == UCE_MEETING
-      if params[:upload][:tempfile].read == FILE_CONTENT
+      if params[:content][:tempfile].read == FILE_CONTENT
         status 200
         {:result => "test_upload"}.to_json
       else

data/spec/ucengine_spec.rb

@@ -52,6 +52,15 @@ describe UCEngine do
     end
   end
 
+  it "returns the list of connected users" do
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+      roster = uce.roster('demo')
+      roster.length.should eql(2)
+      roster[0]['name'].should eql('jeffrey.lebowski@bathtub.com')
+      roster[1]['name'].should eql('walter.sobchak@bowling.org')
+    end
+  end
+
   it "publishes an event" do
     @uce.connect(USER, :credential => PASSWORD) do |uce|
       result = uce.publish(:location => UCE_MEETING,
@@ -99,7 +108,7 @@ describe UCEngine do
     @uce.connect(USER, :credential => PASSWORD) do |uce|
       file = Tempfile.open("test_file")
       file.write(FILE_CONTENT)
-      result = uce.upload(UCE_MEETING, file.open)
+      result = uce.upload(UCE_MEETING, file.open, :description => "a file")
       result['result'].should eql("test_upload")
       break
     end

data/ucengine.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors = ['AF83']
   s.email = ['victor.goya@af83.com', 'arnaud.berthomier@af83.com']
   s.homepage = "https://github.com/AF83/ucengine.rb"
-  s.summary = "A ruby library to consume the UCEngine API"
-  s.description = "A ruby library to consume the UCEngine API"
+  s.summary = "A ruby library to consume the U.C.Engine API"
+  s.description = "A ruby library to consume the U.C.Engine API"
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = "ucengine"

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ucengine
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 0
-  version: 0.5.0
+  prerelease: 
+  version: 0.5.3
 platform: ruby
 authors: 
 - AF83
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 +02:00
+date: 2011-07-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
         version: "1.6"
   type: :runtime
   version_requirements: *id001
@@ -41,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 1
         version: "1.1"
   type: :runtime
   version_requirements: *id002
@@ -56,10 +43,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
         version: "1.5"
   type: :runtime
   version_requirements: *id003
@@ -71,10 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
         version: "1.0"
   type: :development
   version_requirements: *id004
@@ -86,10 +65,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 4
         version: "2.4"
   type: :development
   version_requirements: *id005
@@ -101,14 +76,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 2
         version: "1.2"
   type: :development
   version_requirements: *id006
-description: A ruby library to consume the UCEngine API
+description: A ruby library to consume the U.C.Engine API
 email: 
 - victor.goya@af83.com
 - arnaud.berthomier@af83.com
@@ -146,27 +117,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: ucengine
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A ruby library to consume the UCEngine API
+summary: A ruby library to consume the U.C.Engine API
 test_files: []