ucengine 0.1.2 → 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -1,6 +1,6 @@
 = ucengine.rb
 
-ucengine.rb can connect, subscribe, and publish events to UCEngine.
+ucengine.rb can connect, subscribe, and publish events to UC Engine.
 
 == Copyright
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require "rspec/core/rake_task"
 
 begin
   require 'jeweler'
@@ -33,11 +34,12 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies do
-  sh "rspec spec"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
 end
 
-task :default => :test
+task :default => :rspec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/ucengine.rb

@@ -17,12 +17,12 @@ require 'daemons'
 # 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"})
+#       uce.connect("uce@example.com", :password => 'pwd') do |uce|
+#               uce.subscribe([], :type => 'chat.message.new', :search => 'HTML5') do |event|
+#                      uce.publish(:location => [event['meeting']]
+#                                  :from => 'bot',
+#                                  :type => 'chat.message.new',
+#                                  :metadata => {"text" => "Hey, you were talking about HTML5"})
 #               end
 #       end
 class UCEngine
@@ -40,9 +40,9 @@ class UCEngine
 
   API_ROOT = "/api"
 
-  API_VERSION = "0.1"
+  API_VERSION = "0.2"
 
-  attr_reader :sid, :uid
+  attr_reader :sid, :uid, :connected
 
   # Load configuration file (default: config.yaml). The returned configuration
   # is a Hash, as returned by YAML.load_file().
@@ -79,6 +79,10 @@ class UCEngine
     debug(UCEngine::DEBUG, "Initialisation complete for #{host}:#{port}.")
   end
 
+  def connected?
+    @connected
+  end
+
   # Connect to the UCEngine server with the User ID 'uid' and the its credential.
   #
   # 
@@ -89,10 +93,16 @@ class UCEngine
   #
   def connect(uid, params)
     @uid = uid
-    response = put("/presence/#{@uid}", {:credential => params[:credential]})
-    @sid = response['result']
-    debug(UCEngine::DEBUG, "Authentification complete for #{@uid}/#{@sid}.")
-    yield self
+    begin
+      response = put("/presence/#{@uid}", {:credential => params[:credential]})
+      @connected = true
+      @sid = response['result']
+      debug(UCEngine::DEBUG, "Authentification complete for #{@uid}/#{@sid}.")
+    rescue RestClient::Request::Unauthorized
+      debug(UCEngine::DEBUG, "Authentification error for #{@uid}.")
+      @connected = false
+    end
+    yield self if block_given?
     @threads.each do |thread|
       begin
         thread.join
@@ -104,8 +114,7 @@ class UCEngine
 
   # 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.
+  # * ["meeting"]: events from a specific meeting.
   # * []: all events.
   #
   # The function takes extra parameters:
@@ -148,12 +157,12 @@ class UCEngine
   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.
+  # [:location] As described in the subscribe method: ["meeting"] publish the event in a specific meeting or []: 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"],
+  #     uce.publish(:location => ["WebWorkersCamp"],
   #                 :type => 'presentation.slide.add'
   #                 :metadata => {:url => 'http://myserver/slides/03.png',
   #                               :index => 3})
@@ -182,17 +191,17 @@ class UCEngine
     return time
   end
 
-  # Download a file from UCEngine. The 'location' parameter is the couple [organisation, meeting]
+  # Download a file from UCEngine. The meeting parameter is
   # where the file sits. The 'id' parameters is the file idenfication number
   #
-  #     uce.download(["af83", "demo_meeting"], "file_43243243253253.pdf")
+  #     uce.download(["demo_meeting"], "file_43243243253253.pdf")
   #
-  def download(location, id)
+  def download(meeting, 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}" 
+      url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{meeting}/#{id}" 
 
       debug(UCEngine::DEBUG, "Download: #{url}")
       result = RestClient.get(url, {:params => params})
@@ -201,15 +210,15 @@ class UCEngine
     end
   end
 
-  # Upload a file to UCEngine. The 'location' parameter is the couple [organisation, meeting] where
+  # Upload a file to UCEngine. The meeting is 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"))
+  #     uce.upload(["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}"
+  def upload(meeting, file)
+    url = "http://#{@host}:#{@port}#{API_ROOT}/#{API_VERSION}/file/#{meeting}?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")

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ 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}"

data/spec/ucengine_mock.rb

@@ -6,10 +6,10 @@ require 'spec_helper'
 class UCEngineMock < Sinatra::Base
   use Rack::MethodOverride
 
-  VERSION = '0.1'
+  VERSION = '0.2'
 
   put "/api/#{VERSION}/presence/:uid" do
-    if params[:uid] == USER
+    if params[:uid] == USER && params[:credential] == PASSWORD
       status 200
       {:result => "test_sid"}.to_json
     else
@@ -23,8 +23,8 @@ class UCEngineMock < Sinatra::Base
     {:result => 1234}.to_json
   end
 
-  put "/api/#{VERSION}/event/:org/:meeting" do
-    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+  put "/api/#{VERSION}/event/:meeting" do
+    if params[:meeting] == UCE_MEETING
       if params[:type] == "test_type" &&
           params[:parent] == "test_parent" &&
           params[:metadata]["a"] == "b" &&
@@ -41,14 +41,13 @@ class UCEngineMock < Sinatra::Base
     end
   end
 
-  get "/api/#{VERSION}/event/:org/:meeting" do
-    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+  get "/api/#{VERSION}/event/:meeting" do
+    if 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"
@@ -64,8 +63,8 @@ class UCEngineMock < Sinatra::Base
   end
 
   # Download
-  get "/api/#{VERSION}/file/:org/:meeting/:id" do
-    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING && params[:id] == "test_file"
+  get "/api/#{VERSION}/file/:meeting/:id" do
+    if params[:meeting] == UCE_MEETING && params[:id] == "test_file"
       status 200
       FILE_CONTENT
     else
@@ -75,8 +74,8 @@ class UCEngineMock < Sinatra::Base
   end
 
   # Upload
-  post "/api/#{VERSION}/file/:org/:meeting" do
-    if params[:org] == UCE_ORG && params[:meeting] == UCE_MEETING
+  post "/api/#{VERSION}/file/:meeting" do
+    if params[:meeting] == UCE_MEETING
       if params[:upload][:tempfile].read == FILE_CONTENT
         status 200
         {:result => "test_upload"}.to_json

data/spec/ucengine_spec.rb

@@ -3,6 +3,10 @@ require 'ucengine_mock'
 
 describe UCEngine do
 
+  before do
+    @uce = UCEngine.new(UCE_HOST, UCE_PORT)
+  end
+
   before(:all) do
     Thread.new do
       UCEngineMock.run! :host => UCE_HOST, :port => UCE_PORT
@@ -10,41 +14,46 @@ describe UCEngine do
     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.connect(USER, :credential => PASSWORD) do |uce|
       uce.sid.should eql("test_sid")
+      uce.should be_connected
+    end
+  end
+
+  it "connect with bad credential" do
+    @uce.connect(USER, :credential => PASSWORD + "toto") do |uce|
+      uce.should_not be_connected
+    end
+  end
+
+  it "should respond to connected?" do
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+        uce.respond_to?(:connected?).should eql true
     end
   end
 
   it "fails to connect to the UCEngine server" do
     begin
-      did_connect = false
-      uce = UCEngine.new("localhost", 65000)
+      uce = UCEngine.new("localhost", UCE_PORT + 1)
       uce.connect(USER, :credential => PASSWORD) do |uce|
-        did_connect = true
         break
       end
     rescue
     ensure
-      did_connect.should eql(false)
+      uce.should_not be_connected
     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)
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+      uce.time.should eql 1234
     end
-  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],
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+      result = uce.publish(:location => [UCE_MEETING],
                            :type => "test_type",
                            :parent => "test_parent",
                            :metadata => {"a" => "b", "c" => "d"})
@@ -53,13 +62,11 @@ describe UCEngine do
   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|
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+      uce.subscribe([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")
@@ -69,19 +76,17 @@ describe UCEngine do
   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")
+    @uce.connect(USER, :credential => PASSWORD) do |uce|
+      result = uce.download(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|
+    @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 = uce.upload(UCE_MEETING, file.open)
       result['result'].should eql("test_upload")
       break
     end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - AF83
@@ -14,52 +14,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-31 00:00:00 +01:00
+date: 2010-12-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 4
-        version: "1.4"
-  type: :runtime
+        - 0
+        version: "0"
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 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
+        version: "0"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 description: ucengine.rb is a Ruby library to consume the UCEngine API
 email: victor.goya@af83.com
 executables: []
@@ -71,6 +54,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -109,15 +93,14 @@ files:
 - 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: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/ucengine.gemspec

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