innowhite_api 1.1.3 → 1.1.7.1

data/README.rdoc

@@ -5,7 +5,8 @@ Install innowhite gem with RubyGems
 
 gem install innowhite
 or add this to your Gemfile if you use Bundler:
-gem "innowhite"
+
+gem innowhite_api
 
 Step 2:
 Place the innowhite.yml file in the config directory.
@@ -23,13 +24,14 @@ Then we could access the available methods from the instance :
 Create new session :
   Create new room and get its room url to access it.
 
-  Arguments (as a Hash) : 
+  Arguments (as a Hash) :
   a. :user => the name of the moderator (ex. "John")
   b. :tags => (optional). Example : (math 101, calculus, integration)
-  c. :desc => (optional) Description of the room. (ex: Definite Integrals by John)	
+  c. :desc => (optional) Description of the room. (ex: Definite Integrals by John)
+  d. :cb => (mandatory) Server name (ex: "innowhite" or "testinnowhite")
 
   Request Command :
-  innowhite.create_room({}). Ex : innowhite.create_room({:user => "bainur", :tags => "testing, room testing", :desc => "This is only testing for the room"})
+  innowhite.create_room({:cb => "innowhite", :user => "bainur"}). Ex : innowhite.create_room({:cb => "innowhite", :user => "bainur", :tags => "testing, room testing", :desc => "This is only testing for the room"})
 
   Return value :
   a. Room Id
@@ -183,3 +185,9 @@ Get Meeting Play back Recording URL :
 
   Return Value :
   a. URL
+
+
+
+Returned data
+
+All results returns as Hash with indifferent access. :data key contains result and :errors contains errors.

data/Rakefile

@@ -4,9 +4,9 @@ require 'echoe'
 
 Echoe.new('innowhite', '0.1.0') do |p|
   p.description    = "Innowhite Api"
-  p.url            = "http://github.com/bainur/innowhite"
-  p.author         = "bainur"
-  p.email          = "inoe.bainur@gmail.com"
+  p.url            = "http://github.com/firemonk9/innowhite"
+  p.author         = "firemonk"
+  p.email          = "dhiraj.peechara@gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
 end

data/innowhite.gemspec

@@ -1,9 +1,8 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{innowhite_api}
-  s.version = "1.1.3"
-
+  s.name = %q{innowhite}
+  s.version = "1.1.7.1"
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{innowhite}]
   s.date = %q{2011-08-11}

data/lib/innowhite.rb

@@ -4,6 +4,16 @@ require 'rest-client'
 
 class Innowhite
 
+  @@errors = {
+    :user_miss =>         [1, "user value missed"],
+    :fetch_fail =>        [2, "failed to fetch, maybe you have entered wrong username"],
+    :room_miss =>         [3, "room not set"],
+    :description_miss =>  [4, "description value not set"],
+    :start_time =>        [5, "startTime value missed"],
+    :end_time =>          [6, "endTime value missed"],
+    :time_zone =>         [7, "timeZone value missed"],
+  }
+
   attr_accessor :mod_name, :org_name, :sub, :server_address, :private_key
 
   def initialize
@@ -11,16 +21,21 @@ class Innowhite
   end
 
   def create_room(params = {})
-    room_id = get_room_id
-    address = join_room_url(@org_name, room_id, params[:user], true)
-    res = create_room_info(room_id, params[:user], params[:tags], params[:desc], @org_name, address)
-    res.include?("Missing") ? {"errors" => "Failed to fetch, maybe you have entered wrong username / organization name .."} : {"room_id" => room_id, "address" => address}
+    return err(*@@errors[:user_miss]) if params[:user].blank?
+    room_id = get_room_id(params[:user])
+    return room_id[:errors] if room_id.has_key?(:errors)
+    res = create_room_info(room_id[:data], params[:user], params[:tags], params[:desc], @org_name)
+    $stdout << res.inspect
+    res[:status] ? data({"room_id" => room_id[:data], "address" => res[:data]}) : res[:errors]
   end
 
   def join_meeting(room_id, user)
+    return err(*@@errors[:user_miss]) if user.nil?
+    return err(*@@errors[:room_miss]) if room_id.nil?
     url = "#{@api_address}exist_session?roomId=#{room_id}"
-    doc = Nokogiri::XML(open(url))
-    doc.text.blank? ? nil : join_room_url(@org_name, room_id, user, false)
+    res = request("post", url)
+    return res[:errors] if res.has_key?(:errors)
+    res[:data].blank? ? err(-1, "Unknow") : data(join_room_url(@org_name, room_id, user, false))
   end
 
   def get_sessions(params = {})
@@ -28,19 +43,22 @@ class Innowhite
     checksum = generating_checksum(URI.escape(temp))
     tmp = "#{temp}&user=#{params[:user]}&tags=#{params[:tags]}"
     url = URI.escape("#{@api_address}list_sessions?#{tmp}&checksum=#{checksum}")
-    JSON::parse(RestClient.get(url, :accept => :json))
+    request("get", url)
 
-    rescue
-      {"errors" => "Error fetching sessions check the organization and private key .."}
+  rescue
+    err(*@@errors[:fetch_fail])
   end
 
   def schedule_meeting(params = {})
-    room_id = get_room_id
-    address = join_room_url(
-        params[:orgName] || @org_name,
-        room_id,
-        params[:user],
-        true)
+    return err(*@@errors[:user_miss]) if !params[:user] || params[:user].blank?
+    return err(*@@errors[:description_miss]) if !params[:description] || params[:description].empty?
+
+    return err(*@@errors[:start_time]) if !params[:startTime] || params[:startTime].blank?
+    return err(*@@errors[:end_time]) if !params[:endTime] || params[:endTime].blank?
+    return err(*@@errors[:time_zone]) if !params[:timeZone] || params[:timeZone].blank?
+
+    room_id = get_room_id(params[:user])
+    return room_id[:errors] if room_id.has_key?(:errors)
 
     create_schedule(
         room_id,
@@ -48,10 +66,9 @@ class Innowhite
         params[:tags],
         params[:description],
         params[:parentOrg] || @parent_org,
-        address,
         params[:startTime],
         params[:endTime],
-        params[:timeZone]) == "true"
+        params[:timeZone])
   end
 
   def past_sessions(params = {})
@@ -60,24 +77,24 @@ class Innowhite
 
     tmp = "#{temp}&user=#{params[:user]}&tags=#{params[:tags]}"
     url = URI.escape("#{@api_address}past_sessions?#{tmp}&checksum=#{checksum}")
-    JSON::parse(RestClient.get(url, :accept => :json))
+    request("get", url)
 
     rescue
-      { "errors" => "Error fetching sessions check the organization and private key .." }
+      err(*@@errors[:fetch_fail])
   end
 
   def get_scheduled_list(params={})
     checksum = main_cheksum(params[:parentOrg] || @parent_org, params[:orgName] || @org_name)
     par = url_generator(params[:parentOrg] || @parent_org, params[:orgName] || @org_name)
-    url = URI.escape("#{@api_address}get_scheduled_sessions?#{par}&checksum=#{checksum}&tags=#{params[:tags]}}")
-    JSON::parse(RestClient.get(url, :accept => :json))
+    url = URI.escape("#{@api_address}get_scheduled_sessions?#{par}&checksum=#{checksum}&tags=#{params[:tags]}&user=#{params[:user]}")
+    request("get", url)
   end
 
   def cancel_meeting(room_id)
     checksum = main_cheksum(@parent_org, @org_name)
     par = url_generator(@parent_org, @org_name)
     url = URI.escape("#{@api_address}cancel_meeting?roomId=#{room_id}&#{par}&checksum=#{checksum}")
-    Nokogiri::XML(open(url)).xpath("//success").text == "true"
+    data(request("get", url))[:status]
   end
 
   def update_schedule(params = {})
@@ -85,71 +102,84 @@ class Innowhite
     params[:startTime] = params[:startTime].to_i  if !params[:startTime].blank? && (params[:startTime].is_a?(DateTime) || params[:startTime].is_a?(Time))
     params[:endTime] = params[:endTime].to_i  if !params[:endTime].blank? && (params[:endTime].is_a?(DateTime) || params[:endTime].is_a?(Time))
 
-    Nokogiri::XML(RestClient.put("#{@api_address}update_schedule",
+    request("put", "#{@api_address}update_schedule",
                              {:roomId => params[:room_id], :tags => params[:tags], :description => params[:description],
                               :parentOrg => @parent_org, :orgName => @org_name,
                               :checksum => checksum, :startTime => params[:startTime],
                               :endTime => params[:endTime], :timeZone => params[:timeZone]
                              }
-        )).xpath("//success").text == "true"
+        )[:status]
   end
 
   def getRecordingURL(room_id)
-    Nokogiri.parse(RestClient.get("#{@server_address}PlayBackServlet?room_id=#{room_id}")).css("webMpath").text.gsub(/.webm$/, "")
+    url = "#{@api_address}api_get_recording_urls?#{{:room_id => room_id}.to_param}"
+    data(request("get", url))
+  end
+
+  def self.gen_checksum(params)
+    key = params.delete(:key)
+    temp = params.to_param
+    temp + "&checksum=#{Digest::SHA1.hexdigest(URI.escape(temp) + key)}"
+  end
+
+  def get_room_id(user)
+    url = "#{@api_address}api_create_room?#{{:parentOrg => @parent_org, :orgName => @org_name, :user => user, :key => @private_key}.to_param}"
+    request("get", url)
   end
 
   protected
+    def err(code, message)
+      {"errors" => {"message" => message, "code" => code}}.with_indifferent_access
+    end
+
+    def data(values)
+      {"data" => values}.with_indifferent_access
+    end
+
     def load_settings
       settings = YAML.load_file('config/innowhite.yml')# if RAILS_ENV == "development"
-      @server_address = settings["innowhite"]["server_address"]
       @api_address = settings["innowhite"]["api_address"]
       @private_key = settings["innowhite"]["private_key"]
       @parent_org = settings["innowhite"]["organization"]
       @org_name = @parent_org
     end
 
-    def create_schedule(room_id, user, tags, desc, parent_org, address, start_time, end_time, time_zone)
+    def create_schedule(room_id, user, tags, desc, parent_org, start_time, end_time, time_zone)
       checksum = generating_checksum(URI.escape(url_generator(parent_org, parent_org)))
-      address = join_room_url(@org_name, room_id, user, true)
-      RestClient.post("#{@api_address}create_schedule_meeting",
+      request("post", "#{@api_address}create_schedule_meeting",
                             {:roomId => room_id, :user => user, :tags => tags, :desc => desc, :startTime => start_time,
                              :endTime => end_time, :timeZone => time_zone,
-                             :parentOrg => parent_org, :address => address, :orgName => parent_org,
-                             :checksum => checksum
+                             :parentOrg => parent_org, :orgName => parent_org,
+                             :checksum => checksum,  :roomLeader => true,
+                             :key => @private_key
                             }
-      )
+      )[:status]
     end
 
-    def create_room_info(room_id, user, tags, desc, parent_org, address)
+    def create_room_info(room_id, user, tags, desc, parent_org)
       checksum = generating_checksum(URI.escape(url_generator(parent_org, parent_org)))
 
-      RestClient.post("#{@api_address}create_room_info",
+      request("post", "#{@api_address}create_room_info",
         {:roomId => room_id, :user => user, :tags => tags, :desc => desc,
-         :parentOrg => parent_org, :address => address, :orgName => parent_org,
-         :checksum => checksum
+         :parentOrg => parent_org, :orgName => parent_org,
+         :checksum => checksum, :key => @private_key
         }
       )
     end
 
-    def get_room_id
-      url = create_room_url
-      doc = Nokogiri::XML(open(url))
-      status = doc.xpath('//returnStatus').text.gsub("\n", "") rescue ""
-
-      if status.include?('SUCCESS')
-        doc.xpath('//roomId').text.gsub("\n", "").to_i
-      elsif status.include?('AUTH_FAILED')
-        "AUTH_FAILED"
-      elsif status.include?('EXPIRED')
-        'EXPIRED'
-      elsif status.include?('OUT_OF_SERVICE')
-        'OUT_OF_SERVICE'
+  private
+
+    def request(method, url, *params)
+      url = url + "?" + params.to_param unless params.blank?
+      k = if method == "get" || method == "delete"
+        RestClient.send(method, url, :accept => :json)
       else
-        "Error With the Server #{url}"
+        RestClient.send(method, url, {}, :accept => :json)
       end
+      $stdout << k.inspect
+      JSON::parse(k).with_indifferent_access
     end
 
-  private
     def main_cheksum(parent_org, org_name)
       checksum_tmp = url_generator(parent_org, org_name)
       generating_checksum(URI.escape(checksum_tmp))
@@ -168,16 +198,11 @@ class Innowhite
     end
 
     def join_room_url(org_name, room_id, user, is_teacher)
-      action = "#{@server_address}JoinRoom?"
-      address = "parentOrg=#{@parent_org}&orgName=#{org_name}&roomId=#{room_id}&user=#{user}&roomLeader=#{is_teacher}"
-      "#{action}#{address}&checksum=#{generating_checksum(address)}"
+      url = "#{@api_address}api_join_room?#{{:parentOrg => @parent_org, :orgName => org_name, :user => user, :roomId => room_id, :roomLeader => is_teacher, :key => @private_key}.to_param}"
+      request("post", url)[:data]
     end
 
     def information_url(parent_org, org_name, user_name)
       "parentOrg=#{parent_org}&orgName=#{org_name}&user=#{user_name}#{@private_key}"
     end
-
-    def create_room_url
-      "#{@server_address}CreateRoom?parentOrg=#{@parent_org}&orgName=#{@org_name}&user=#{@mod_name}&checksum=#{generate_checksum(@parent_org, @org_name, @mod_name)}"
-    end
 end

metadata

@@ -1,124 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: innowhite_api
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.7.1
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 3
-  version: 1.1.3
 platform: ruby
-authors: 
+authors:
 - innowhite
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-11 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 4
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 6
-        - 7
+      - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.3.4
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
 description: Innowhite Api
 email: dhiraj.peechara@innowhite.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - lib/innowhite.rb
-files: 
+files:
 - README.rdoc
 - Rakefile
 - lib/innowhite.rb
 - innowhite.gemspec
-has_rdoc: true
 homepage: http://github.com/firemonk9/innowhite
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Innowhite
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: innowhite_api
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Gem for Innowhite Api
 test_files: []
-