ucengine 0.4.0 → 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+## MAC OS
+.DS_Store
+
+## $EDITOR's temp files
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    ucengine (0.4.0)
+      daemons (~> 1.1)
+      json (~> 1.5)
+      rest-client (~> 1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    json (1.5.1)
+    mime-types (1.16)
+    rack (1.2.2)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sinatra (1.2.1)
+      rack (~> 1.1)
+      tilt (< 2.0, >= 1.2.2)
+    tilt (1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0)
+  rspec (~> 2.4)
+  sinatra (~> 1.2)
+  ucengine!

data/Rakefile

@@ -1,54 +1,11 @@
-require 'rubygems'
-require 'rake'
-require "rspec/core/rake_task"
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "ucengine"
-    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"]
-    gem.add_dependency "json", "~>1.4"
-    gem.add_dependency "rest-client", "~>1.6"
-    gem.add_dependency "daemons", "~>1.1.0"
-    gem.add_development_dependency "sinatra", "~>1.0"
-    gem.add_development_dependency "rspec", "~>2.4.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/*_spec.rb'
-  spec.rspec_opts = ['--backtrace']
+# Run tests
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
 task :default => :rspec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "ucengine.rb #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/ucengine.rb

@@ -28,26 +28,21 @@ require 'uri'
 #       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
+  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).
 
-  API_ROOT = "/api"
-
-  API_VERSION = "0.4"
+  # HTTP API conf.
+  API_ROOT    = '/api'
+  API_VERSION = '0.5'
 
   attr_reader :sid, :uid, :connected
 
   # Load configuration file (default: config.yaml). The returned configuration
   # is a Hash, as returned by YAML.load_file().
-  def UCEngine.load_config(path = "config.yaml")
+  def self.load_config(path = 'config.yaml')
     YAML.load_file(path)
   end
 
@@ -62,7 +57,7 @@ class UCEngine
   #     end
   #
   #
-  def UCEngine.run(name, &proc)
+  def self.run(name, &proc)
     Daemons.run_proc(name, &proc)
   end
 
@@ -77,7 +72,7 @@ class UCEngine
     @http = Net::HTTP.new(host, port)
     @threads = []
     @debug = debug
-    debug(UCEngine::DEBUG, "Initialisation complete for #{host}:#{port}.")
+    debug "Initialisation complete for #{host}:#{port}."
   end
 
   # Return true if a connection to U.C.Engine has been established, return false otherwise.
@@ -85,7 +80,7 @@ class UCEngine
     @connected
   end
 
-  # Connect to the U.C.Engine server with the User ID 'uid' and the its credential.
+  # Connect to the U.C.Engine server with the User Name 'name' and the its credential.
   #
   #
   #     uce = UCEngine.new("localhost", 4567)
@@ -93,15 +88,15 @@ class UCEngine
   #             ... your code goes here
   #     end
   #
-  def connect(uid, params)
-    @uid = uid
+  def connect(name, params)
     begin
-      response = post("/presence/", {:uid => @uid, :credential => params[:credential]})
+      response = post("/presence/", {:name => name, :credential => params[:credential]})
       @connected = true
-      @sid = response['result']
-      debug(UCEngine::DEBUG, "Authentification complete for #{@uid}/#{@sid}.")
+      @sid = response['result']['sid']
+      @uid = response['result']['uid']
+      debug "Authentification complete for #{@uid}/#{@sid}."
     rescue RestClient::Request::Unauthorized
-      debug(UCEngine::DEBUG, "Authentification error for #{@uid}.")
+      debug "Authentification error for #{name}."
       @connected = false
     end
     yield self if block_given?
@@ -109,7 +104,7 @@ class UCEngine
       begin
         thread.join
       rescue => error
-        debug(UCEngine::WARNING, "Thread aborted: #{error}")
+        warn "Thread aborted: #{error}"
       end
     end
   end
@@ -134,7 +129,7 @@ class UCEngine
   #                             :search => 'HTML5',
   #                             :count => 30, :page => 2)
   def search(location, params = {})
-    debug(UCEngine::DEBUG, "Search to #{location} with #{params}.")
+    debug "Search to #{location} with #{params}."
     get("/event/#{location}", params)['result']
   end
 
@@ -154,23 +149,23 @@ class UCEngine
   #             puts "A new meeting about HTML5 was created"
   #     end
   def subscribe(location, params = {})
-    debug(UCEngine::DEBUG, "Subscribe to #{location} with #{params}.")
+    debug "Subscribe to #{location} with #{params}."
     @threads << Thread.new do
-      Net::HTTP.start(@host, @port) do |http|
-        params[:_async] = "lp"
+      Net::HTTP.start @host, @port do |http|
+        params[:_async] = 'lp'
         params[:start] = 0 if !params[:start]
         while true
           begin
             events = get("/event/#{location}", params, http)['result']
           rescue RestClient::RequestTimeout
-            debug(UCEngine::WARNING, "Subscribe timeout ... retry")
+            warn 'Subscribe timeout ... retry'
             retry
           rescue EOFError
-            debug(UCEngine::WARNING, "Subscribe closed ... retry")
+            warn 'Subscribe closed ... retry'
             sleep 1
             retry
-          rescue => error
-            debug(UCEngine::ERROR, error)
+          rescue => boom
+            error boom
             sleep 1
             retry
           end
@@ -198,7 +193,7 @@ class UCEngine
   #                 :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]}")
+    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]
@@ -207,7 +202,7 @@ class UCEngine
         params["metadata[#{key}]"] = event[:metadata][key]
       end
     end
-    post("/event/#{event[:location]}", params)
+    post "/event/#{event[:location]}", params
   end
 
   # Return the current timestamp from the server. The timestamp is expressed in milliseconds
@@ -218,7 +213,7 @@ class UCEngine
   #
   def time
     time = get("/time", Hash.new)['result'].to_i
-    debug(UCEngine::DEBUG, "Fecth timestamp from UCEngine: #{time}")
+    debug "Fecth timestamp from UCEngine: #{time}"
     return time
   end
 
@@ -228,15 +223,15 @@ class UCEngine
   #     uce.download("demo_meeting", "file_43243243253253.pdf")
   #
   def download(location, id)
-    Net::HTTP.start(@host, @port) do |http|
+    Net::HTTP.start @host, @port do |http|
       params = Hash.new
       params[:uid] = @uid if @uid
       params[:sid] = @sid if @sid
       url = URI.escape("http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{location}/#{id}")
 
-      debug(UCEngine::DEBUG, "Download: #{url}")
+      debug "Download: #{url}"
       result = RestClient.get(url, {:params => params})
-      debug(UCEngine::DEBUG, "Download complete")
+      debug 'Download complete'
       return result
     end
   end
@@ -250,27 +245,31 @@ class UCEngine
   #
   def upload(location, file)
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{location}?uid=#{@uid}&sid=#{@sid}"
-    debug(UCEngine::DEBUG, "Upload: #{file.path} to #{url}")
+    debug "Upload: #{file.path} to #{url}"
     result = JSON.parse(RestClient.post(url, {:upload => file}))
-    debug(UCEngine::DEBUG, "Upload complete")
+    debug 'Upload complete'
     return result
   end
 
   protected
 
   # Print debug messages
-  def debug(level, message)
-    $stderr.write("#{message}\n\n") if level >= @debug
+  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)
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
-    debug(UCEngine::DEBUG, "Request: GET #{url}")
+    debug "Request: GET #{url}"
     result = JSON.parse(RestClient.get(url, {:params => params}))
-    debug(UCEngine::DEBUG, "Result: #{result}")
+    debug "Result: #{result}"
     return result
   end
 
@@ -279,22 +278,22 @@ class UCEngine
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
     url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
-    debug(UCEngine::DEBUG, "Request: POST #{url}")
+    debug "Request: POST #{url}"
     result = JSON.parse(RestClient.post(url, params, :accept => :json))
-    debug(UCEngine::DEBUG, "Result: #{result}")
+    debug "Result: #{result}"
     return result
   end
 
   # Handle PUT requests
   def put(path, params)
-    params['_method'] = "PUT"
-    post(path, params)
+    params['_method'] = 'PUT'
+    post path, params
   end
 
   # Handle DELETE requests
   def delete(path, params)
-    params['_method'] = "DELETE"
-    post(path, params)
+    params['_method'] = 'DELETE'
+    post path, params
   end
 
 end

data/lib/ucengine/version.rb

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

data/spec/ucengine_mock.rb

@@ -6,12 +6,12 @@ require 'spec_helper'
 class UCEngineMock < Sinatra::Base
   use Rack::MethodOverride
 
-  VERSION = '0.4'
+  VERSION = UCEngine::API_VERSION
 
   post "/api/#{VERSION}/presence/" do
-    if params[:uid] == USER && params[:credential] == PASSWORD
+    if params[:name] == USER && params[:credential] == PASSWORD
       status 200
-      {:result => "test_sid"}.to_json
+      {:result => {:sid => "test_sid", :uid => "test_uid"}}.to_json
     else
       status 401
       {:error => "unauthorized"}.to_json

data/spec/ucengine_spec.rb

@@ -17,6 +17,7 @@ describe UCEngine do
   it "connects to the UCEngine server" do
     @uce.connect(USER, :credential => PASSWORD) do |uce|
       uce.sid.should eql("test_sid")
+      uce.uid.should eql("test_uid")
       uce.should be_connected
     end
   end

data/ucengine.gemspec

@@ -1,67 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path("../lib/ucengine/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{ucengine}
-  s.version = "0.4.0"
+  s.name = "ucengine"
+  s.version = UCEngine::VERSION
+  s.platform = Gem::Platform::RUBY
+  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.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["AF83"]
-  s.date = %q{2011-02-21}
-  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",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/ucengine.rb",
-    "spec/spec_helper.rb",
-    "spec/ucengine_mock.rb",
-    "spec/ucengine_spec.rb",
-    "ucengine.gemspec",
-    "ucengine.rb.gemspec"
-  ]
-  s.homepage = %q{http://github.com/AF83/ucengine.rb}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby library for UCEngine}
-  s.test_files = [
-    "spec/spec_helper.rb",
-    "spec/ucengine_mock.rb",
-    "spec/ucengine_spec.rb"
-  ]
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "ucengine"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency "rest-client", "~> 1.6"
+  s.add_dependency "daemons"    , "~> 1.1"
+  s.add_dependency "json"       , "~> 1.5"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, ["~> 1.4"])
-      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6"])
-      s.add_runtime_dependency(%q<daemons>, ["~> 1.1.0"])
-      s.add_development_dependency(%q<sinatra>, ["~> 1.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
-    else
-      s.add_dependency(%q<json>, ["~> 1.4"])
-      s.add_dependency(%q<rest-client>, ["~> 1.6"])
-      s.add_dependency(%q<daemons>, ["~> 1.1.0"])
-      s.add_dependency(%q<sinatra>, ["~> 1.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.4.0"])
-    end
-  else
-    s.add_dependency(%q<json>, ["~> 1.4"])
-    s.add_dependency(%q<rest-client>, ["~> 1.6"])
-    s.add_dependency(%q<daemons>, ["~> 1.1.0"])
-    s.add_dependency(%q<sinatra>, ["~> 1.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.4.0"])
-  end
-end
+  s.add_development_dependency "bundler", ">= 1.0"
+  s.add_development_dependency "rspec"  , "~> 2.4"
+  s.add_development_dependency "sinatra", "~> 1.2"
 
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ucengine
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - AF83
@@ -15,62 +15,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 +01:00
+date: 2011-04-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rest-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 1
-        - 4
-        version: "1.4"
+        - 6
+        version: "1.6"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: daemons
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 13
         segments: 
         - 1
-        - 6
-        version: "1.6"
+        - 1
+        version: "1.1"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: daemons
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 5
         segments: 
         - 1
-        - 1
-        - 0
-        version: 1.1.0
+        - 5
+        version: "1.5"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: bundler
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 15
         segments: 
@@ -87,36 +86,54 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 11
         segments: 
         - 2
         - 4
-        - 0
-        version: 2.4.0
+        version: "2.4"
   type: :development
   version_requirements: *id005
-description: ucengine.rb is a Ruby library to consume the U.C.Engine API
-email: victor.goya@af83.com
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    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
+email: 
+- victor.goya@af83.com
+- arnaud.berthomier@af83.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/ucengine.rb
+- lib/ucengine/version.rb
 - spec/spec_helper.rb
 - spec/ucengine_mock.rb
 - spec/ucengine_spec.rb
 - ucengine.gemspec
 has_rdoc: true
-homepage: http://github.com/AF83/ucengine.rb
+homepage: https://github.com/AF83/ucengine.rb
 licenses: []
 
 post_install_message: 
@@ -138,18 +155,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: ucengine
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby library for U.C.Engine
-test_files: 
-- spec/spec_helper.rb
-- spec/ucengine_mock.rb
-- spec/ucengine_spec.rb
+summary: A ruby library to consume the UCEngine API
+test_files: []
+

data/VERSION

@@ -1 +0,0 @@
-0.4.0