ucengine 0.1.1 → 0.1.2

data/Rakefile

@@ -10,8 +10,9 @@ begin
     gem.email = "victor.goya@af83.com"
     gem.homepage = "http://github.com/AF83/ucengine.rb"
     gem.authors = ["AF83"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    gem.add_dependency "json", ">=0"
+    gem.add_dependency "json", "~>1.4"
+    gem.add_dependency "rest-client", "~>1.6"
+    gem.add_dependency "daemons", "~>1.1.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -19,13 +20,6 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
@@ -39,7 +33,9 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+task :test => :check_dependencies do
+  sh "rspec spec"
+end
 
 task :default => :test
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ucengine.rb

@@ -1,7 +1,9 @@
 require 'json'
+require 'yaml'
 
-require 'net/http'
-require 'cgi'
+require 'rest-client'
+
+require 'daemons'
 
 # ucengine.rb implements the UCEngine API, it can currently handle
 # publish/subscribe to any event stream.
@@ -36,6 +38,33 @@ class UCEngine
   # Don't print anything (default).
   QUIET = 4
 
+  API_ROOT = "/api"
+
+  API_VERSION = "0.1"
+
+  attr_reader :sid, :uid
+
+  # 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")
+    YAML.load_file(path)
+  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
+  # having to run it in background.
+  # The 'name' parameter is the name you want to give to your brick.
+  #
+  #     UCEngine.run('test') do
+  #             UCEngine.new(...)
+  #             ...
+  #     end
+  #
+  #
+  def UCEngine.run(name, &proc)
+    Daemons.run_proc(name, &proc)
+  end
+
   # 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.
@@ -65,7 +94,11 @@ class UCEngine
     debug(UCEngine::DEBUG, "Authentification complete for #{@uid}/#{@sid}.")
     yield self
     @threads.each do |thread|
-      thread.join
+      begin
+        thread.join
+      rescue => error
+        debug(UCEngine::WARNING, "Thread aborted: #{error}")
+      end
     end
   end
 
@@ -94,14 +127,17 @@ class UCEngine
         while true
           begin
             events = get("/event/#{location.join("/")}", params, http)['result']
-          rescue Timeout::Error
+          rescue RestClient::RequestTimeout
             debug(UCEngine::WARNING, "Subscribe timeout ... retry")
             retry
           rescue EOFError
             debug(UCEngine::WARNING, "Subscribe closed ... retry")
-            sleep 10
+            sleep 1
             retry
           end
+
+          next if events == []
+
           events.each do |event|
             yield event
           end
@@ -146,13 +182,42 @@ class UCEngine
     return time
   end
 
-  protected
+  # Download a file from UCEngine. The 'location' parameter is the couple [organisation, meeting]
+  # where the file sits. The 'id' parameters is the file idenfication number
+  #
+  #     uce.download(["af83", "demo_meeting"], "file_43243243253253.pdf")
+  #
+  def download(location, id)
+    Net::HTTP.start(@host, @port) do |http|
+      params = Hash.new
+      params[:uid] = @uid if @uid
+      params[:sid] = @sid if @sid
+      url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{location.join('/')}/#{id}" 
 
-  # Encode parameters
-  def UCEngine.encode(params)
-    params.collect { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')
+      debug(UCEngine::DEBUG, "Download: #{url}")
+      result = RestClient.get(url, {:params => params})
+      debug(UCEngine::DEBUG, "Download complete")
+      return result
+    end
   end
 
+  # Upload a file to UCEngine. The 'location' parameter is the couple [organisation, meeting] 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 
+  # number of the file.
+  #
+  #     uce.upload(["af83", "demo_meeting"], File.new("/path/file_to_upload.pdf"))
+  #
+  def upload(location, file)
+    url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{location.join('/')}?uid=#{@uid}&sid=#{@sid}"
+    debug(UCEngine::DEBUG, "Upload: #{file.path} to #{url}")
+    result = JSON.parse(RestClient.post(url, {:upload => file}))
+    debug(UCEngine::DEBUG, "Upload complete")
+    return result
+  end
+
+  protected
+
   # Print debug messages
   def debug(level, message)
     $stderr.write("#{message}\n\n") if level >= @debug
@@ -162,8 +227,9 @@ class UCEngine
   def get(path, params, http = @http)
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
-    debug(UCEngine::DEBUG, "Request: GET /api/0.1#{path}?#{UCEngine.encode(params)}")
-    result = JSON.parse(http.get("/api/0.1#{path}?#{UCEngine.encode(params)}").body)
+    url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
+    debug(UCEngine::DEBUG, "Request: GET #{url}")
+    result = JSON.parse(RestClient.get(url, {:params => params}))
     debug(UCEngine::DEBUG, "Result: #{result}")
     return result
   end
@@ -172,8 +238,9 @@ class UCEngine
   def post(path, params, http = @http)
     params[:uid] = @uid if @uid
     params[:sid] = @sid if @sid
-    debug(UCEngine::DEBUG, "Request: POST /api/0.1#{path}?#{UCEngine.encode(params)}")
-    result = JSON.parse(http.post("/api/0.1#{path}", UCEngine.encode(params)).body)
+    url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}#{path}"
+    debug(UCEngine::DEBUG, "Request: POST #{url}")
+    result = JSON.parse(RestClient.post(url, params, :accept => :json))
     debug(UCEngine::DEBUG, "Result: #{result}")
     return result
   end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'ucengine'
+
+UCE_HOST = "localhost"
+UCE_PORT = 5281
+UCE_ORG = "test_org"
+UCE_MEETING = "test_meeting"
+UCE_URL = "http://#{UCE_HOST}#{UCEngine::API_ROOT}/#{UCEngine::API_VERSION}"
+USER = "test_user@#{UCE_HOST}"
+PASSWORD = "test_password"
+FILE_CONTENT="test_content"
+

data/spec/ucengine_mock.rb

@@ -0,0 +1,93 @@
+require 'sinatra'
+require 'json'
+
+require 'spec_helper'
+
+class UCEngineMock < Sinatra::Base
+  use Rack::MethodOverride
+
+  VERSION = '0.1'
+
+  put "/api/#{VERSION}/presence/:uid" do
+    if params[:uid] == USER
+      status 200
+      {:result => "test_sid"}.to_json
+    else
+      status 401
+      {:error => "unauthorized"}.to_json
+    end
+  end
+
+  get "/api/#{VERSION}/time" do
+    status 200
+    {:result => 1234}.to_json
+  end
+
+  put "/api/#{VERSION}/event/:org/:meeting" do
+    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+      if params[:type] == "test_type" &&
+          params[:parent] == "test_parent" &&
+          params[:metadata]["a"] == "b" &&
+          params[:metadata]["c"] == "d"
+        status 200
+        {:result => "test_event_id"}.to_json
+      else
+        status 400
+        {:error => "missing_parameters"}.to_json
+      end
+    else
+      status 404
+      {:error => "not_found"}.to_json
+    end
+  end
+
+  get "/api/#{VERSION}/event/:org/:meeting" do
+    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+      if params[:type] == "test.event"
+        status 200
+        {:result => [{:id => "12345",
+                      :type => "test.event",
+                      :datetime => 1234,
+                      :org => UCE_ORG,
+                      :meeting => UCE_MEETING,
+                      :metadata => {},
+                      :from => "frank"
+                     }]}.to_json
+      else
+        status 400
+        {:error => "missing_parameters"}.to_json
+      end
+    else
+      status 404
+      {:error => "not_found"}.to_json
+    end
+  end
+
+  # Download
+  get "/api/#{VERSION}/file/:org/:meeting/:id" do
+    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING && params[:id] == "test_file"
+      status 200
+      FILE_CONTENT
+    else
+      status 404
+      {:error => "not_found"}.to_json
+    end
+  end
+
+  # Upload
+  post "/api/#{VERSION}/file/:org/:meeting" do
+    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+      if params[:upload][:tempfile].read == FILE_CONTENT
+        status 200
+        {:result => "test_upload"}.to_json
+      else
+        status 500
+        {:error => "bad_file_content"}.to_json
+      end
+    else
+      status 404
+      {:error => "not_found"}.to_json
+    end
+  end
+
+end

data/spec/ucengine_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'ucengine_mock'
+
+describe UCEngine do
+
+  before(:all) do
+    Thread.new do
+      UCEngineMock.run! :host => UCE_HOST, :port => UCE_PORT
+    end
+    sleep 5
+  end
+
+  after do
+  end
+
+  it "connects to the UCEngine server" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      uce.sid.should eql("test_sid")
+    end
+  end
+
+  it "fails to connect to the UCEngine server" do
+    begin
+      did_connect = false
+      uce = UCEngine.new("localhost", 65000)
+      uce.connect(USER, :credential => PASSWORD) do |uce|
+        did_connect = true
+        break
+      end
+    rescue
+    ensure
+      did_connect.should eql(false)
+    end
+  end
+
+  it "returns the current datetime of the server" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      uce.time.should eql(1234)
+    end
+  end  
+
+  it "publishes an event" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      result = uce.publish(:location => [UCE_ORG, UCE_MEETING],
+                           :type => "test_type",
+                           :parent => "test_parent",
+                           :metadata => {"a" => "b", "c" => "d"})
+      result['result'].should eql("test_event_id")
+    end
+  end
+
+  it "subscribes to all events" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      uce.subscribe([UCE_ORG, UCE_MEETING], :type => "test.event") do |event|
+        event['id'].should eql("12345")
+        event['type'].should eql("test.event")
+        event['datetime'].should eql(1234)
+        event['org'].should eql(UCE_ORG)
+        event['meeting'].should eql(UCE_MEETING)
+        event['metadata'].should eql({})
+        event['from'].should eql("frank")
+        break
+      end
+    end
+  end
+
+  it "downloads a file" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      result = uce.download([UCE_ORG, UCE_MEETING], "test_file")
+      result.should eql(FILE_CONTENT)
+    end
+  end
+
+  it "uploads a file" do
+    uce = UCEngine.new(UCE_HOST, UCE_PORT)
+    uce.connect(USER, :credential => PASSWORD) do |uce|
+      file = Tempfile.open("test_file")
+      file.write(FILE_CONTENT)
+      result = uce.upload([UCE_ORG, UCE_MEETING], file.open)
+      result['result'].should eql("test_upload")
+      break
+    end
+  end
+
+end

data/ucengine.gemspec

@@ -0,0 +1,87 @@
+# 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}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["AF83"]
+  s.date = %q{2010-12-01}
+  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",
+     "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"
+  ]
+  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"
+  ]
+
+  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
+

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

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - AF83
@@ -14,35 +14,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 +01:00
+date: 2010-12-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
-  type: :development
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rest-client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 6
+        version: "1.6"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id003
 description: ucengine.rb is a Ruby library to consume the UCEngine API
 email: victor.goya@af83.com
 executables: []
@@ -89,8 +106,11 @@ files:
 - doc/lib/ucengine_rb.html
 - doc/rdoc.css
 - lib/ucengine.rb
-- test/helper.rb
-- test/test_ucengine.rb
+- spec/spec_helper.rb
+- spec/ucengine_mock.rb
+- spec/ucengine_spec.rb
+- ucengine.gemspec
+- ucengine.rb.gemspec
 has_rdoc: true
 homepage: http://github.com/AF83/ucengine.rb
 licenses: []
@@ -124,5 +144,6 @@ signing_key:
 specification_version: 3
 summary: Ruby library for UCEngine
 test_files: 
-- test/helper.rb
-- test/test_ucengine.rb
+- spec/spec_helper.rb
+- spec/ucengine_mock.rb
+- spec/ucengine_spec.rb

data/test/helper.rb

@@ -1,10 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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