innowhite_api 1.1.3

data/README.rdoc

@@ -0,0 +1,185 @@
+Getting Started
+
+Step 1:
+Install innowhite gem with RubyGems
+
+gem install innowhite
+or add this to your Gemfile if you use Bundler:
+gem "innowhite"
+
+Step 2:
+Place the innowhite.yml file in the config directory.
+This file will be sent to you by email.
+
+
+In the code :
+we need to initialize the Innowhite class
+innowhite = Innowhite.new
+
+
+Available Command Requests
+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) : 
+  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)	
+
+  Request Command :
+  innowhite.create_room({}). Ex : innowhite.create_room({:user => "bainur", :tags => "testing, room testing", :desc => "This is only testing for the room"})
+
+  Return value :
+  a. Room Id
+  b. URL  (this URL will be passed to user so that he needs to be redirected to open in new page.)
+
+
+
+
+Join an existing session
+  Joining the existing room and get its room url to access it.
+
+  Arguments :
+  a. room_id => (mandatory) The room id which want to join.
+  b. username => (mandatory) Username of the user who want to join the room.
+
+  Request Command :
+    innowhite.join_meeting(room_id, username). Ex : innowhite.join_meeting(12345, "bainur")
+  
+   Return value :
+  a. URL  (this URL will be passed to the user, the user needs to be redirected to open in new page.)   
+   
+
+
+
+
+Get the live sessions
+  Get the list of existing sessions.
+
+  Arguments (as a Hash) :
+  a. :tags (optional)
+  b. :user (optional)
+
+  Request Command :
+    innowhite.get_sessions({})
+
+  Return value :
+  a. RoomId
+  b. Room Description
+  c. All tags associated with this room.
+  d. Room Created by.
+  e. Room start time.
+
+
+
+
+
+Schedule a session :
+  Scheduling new session.
+  
+  Arguments (as a Hash) :
+  a. :tags   (optional) 
+  b. :startTime (format should be in seconds)
+  c. :timeZone (GMT time zone )  (ex : +1, +2) 
+  d. :endTime (format should be in seconds)
+  e. :user
+  f. :description
+  
+  Request Command :
+    innowhite.schedule_meeting({})
+
+  Return Value :
+  a. True or False
+
+
+
+
+
+
+
+Get the past sessions
+  Get the list of past sessions.
+
+  Arguments (as a Hash) :
+  a. :tags (optional)
+  b. :user (optional)
+
+  Request Command :
+    innowhite.past_sessions({})
+  
+
+  Return Value :
+  a. tags   (optional)
+  b. orgName  (optional)
+  c. Moderator Name
+  d. Room Description
+  e. Link to play the video.
+
+
+
+
+Get the scheduled sessions
+  Get the list of scheduled sessions.
+
+  Arguments (as a Hash) :
+  a. :tags (optional)
+  b. :user (optional)
+
+  Request Command :
+    innowhite.get_scheduled_list({})
+
+  Return Value:
+  a. Tags   (optional)
+  b. orgName  (optional)
+  c. Start time (format should be in seconds)
+  d. Time zone (GMT time zone )  (ex : +1, +2)
+  e. End time (format should be in seconds)
+  f. Room Description
+  g. Moderator name
+
+
+Cancel scheduled session
+  Cancel the scheduled session.
+
+  Arguments :
+  a. room_id (mandatory)
+
+  Request Command :
+    innowhite.cancel_meeting(room_id)
+
+  Return Value:
+  a. True or False
+
+
+
+Update a scheduled session :
+  Updating the exist scheduled session.
+  
+  Arguments (as a Hash) :
+  a. :room_id   (mandatory)
+  b. :startTime (format should be in milliseconds)  (optional)
+  c. :timeZone (optional)
+  d. :endTime (format should be in milliseconds) (optional)
+  e. :description (optional)
+  f. :tags (optional)
+  
+  Request Command :
+    innowhite.update_schedule({})
+
+  Return Value :
+  a. True or False
+
+
+
+Get Meeting Play back Recording URL :
+  Returns the video playback URL.
+
+  a.  :room_id  (mandatory)
+ 
+  Request Command :
+    innowhite.getRecordingURL({})
+
+  Return Value :
+  a. URL

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+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.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/innowhite.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{innowhite_api}
+  s.version = "1.1.3"
+
+  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}
+  s.description = %q{Innowhite Api}
+  s.email = %q{dhiraj.peechara@innowhite.com}
+  s.extra_rdoc_files = [%q{README.rdoc}, %q{lib/innowhite.rb}]
+  s.files = [%q{README.rdoc}, %q{Rakefile}, %q{lib/innowhite.rb}, %q{innowhite.gemspec}]
+  s.homepage = %q{http://github.com/firemonk9/innowhite}
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Innowhite}, %q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubyforge_project = %q{innowhite_api}
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Gem for Innowhite Api}
+  s.add_dependency 'nokogiri', '~> 1.4.4'
+  s.add_dependency 'rest-client', '~> 1.6.7'
+  s.add_development_dependency "rspec", "~> 1.3.4"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/innowhite.rb

@@ -0,0 +1,183 @@
+require 'open-uri'
+require 'nokogiri'
+require 'rest-client'
+
+class Innowhite
+
+  attr_accessor :mod_name, :org_name, :sub, :server_address, :private_key
+
+  def initialize
+    load_settings
+  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}
+  end
+
+  def join_meeting(room_id, user)
+    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)
+  end
+
+  def get_sessions(params = {})
+    temp = url_generator(params[:parentOrg] || @parent_org, params[:orgName] || @org_name)
+    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))
+
+    rescue
+      {"errors" => "Error fetching sessions check the organization and private key .."}
+  end
+
+  def schedule_meeting(params = {})
+    room_id = get_room_id
+    address = join_room_url(
+        params[:orgName] || @org_name,
+        room_id,
+        params[:user],
+        true)
+
+    create_schedule(
+        room_id,
+        params[:user],
+        params[:tags],
+        params[:description],
+        params[:parentOrg] || @parent_org,
+        address,
+        params[:startTime],
+        params[:endTime],
+        params[:timeZone]) == "true"
+  end
+
+  def past_sessions(params = {})
+    temp = url_generator(params[:parentOrg] || @parent_org, params[:orgName] || @org_name)
+    checksum = generating_checksum(URI.escape(temp))
+
+    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))
+
+    rescue
+      { "errors" => "Error fetching sessions check the organization and private key .." }
+  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))
+  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"
+  end
+
+  def update_schedule(params = {})
+    checksum = main_cheksum(@parent_org, @org_name)
+    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",
+                             {: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"
+  end
+
+  def getRecordingURL(room_id)
+    Nokogiri.parse(RestClient.get("#{@server_address}PlayBackServlet?room_id=#{room_id}")).css("webMpath").text.gsub(/.webm$/, "")
+  end
+
+  protected
+    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)
+      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",
+                            {: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
+                            }
+      )
+    end
+
+    def create_room_info(room_id, user, tags, desc, parent_org, address)
+      checksum = generating_checksum(URI.escape(url_generator(parent_org, parent_org)))
+
+      RestClient.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
+        }
+      )
+    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'
+      else
+        "Error With the Server #{url}"
+      end
+    end
+
+  private
+    def main_cheksum(parent_org, org_name)
+      checksum_tmp = url_generator(parent_org, org_name)
+      generating_checksum(URI.escape(checksum_tmp))
+    end
+
+    def generating_checksum(params)
+      Digest::SHA1.hexdigest(params + @private_key)
+    end
+
+    def generate_checksum(parent_org, org_name, user_name)
+      Digest::SHA1.hexdigest(information_url(parent_org, org_name, user_name))
+    end
+
+    def url_generator(parent_org, org_name)
+      "parentOrg=#{parent_org}&orgName=#{org_name}"
+    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)}"
+    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

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