tokboxer 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,7 @@
+== 0.1.1 2008-11-26
+
+* Fixed config problem causing missing files in the gem
+
 == 0.1.0 2008-11-13
 
 * First gem release

data/Manifest.txt

@@ -5,6 +5,10 @@ README.rdoc
 Rakefile
 config/website.yml.sample
 lib/TokBoxer.rb
+lib/TokBoxer/Api.rb
+lib/TokBoxer/Call.rb
+lib/TokBoxer/User.rb
+lib/TokBoxer/VMail.rb
 script/console
 script/destroy
 script/generate

data/lib/TokBoxer.rb

@@ -11,7 +11,7 @@ require 'xmlsimple'
 require 'pp' # just for debugging purposes
 
 module TokBoxer
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   
   API_SERVER_LOGIN_URL       = "view/oauth&"
   API_SERVER_METHODS_URL     = "a/v0"

data/lib/TokBoxer/Api.rb

@@ -0,0 +1,290 @@
+module TokBoxer
+
+  class Api
+
+    attr_reader :api_server_url, :api_key
+
+    # Call API actions =================================================================================
+
+    def create_call(callerJabberId, callerName, persistent=false, features="")
+      method = "POST"
+      call = "/calls/create"
+      params = { :callerJabberId => callerJabberId, :callerName => callerName, :persistent => persistent, :features => features }
+      result = request(method, call, params)
+    end
+
+    def create_invite(callerJabberId, calleeJabberId, call_id)
+      method = "POST"
+      call = "/calls/invite"
+      params = { :callerJabberId => callerJabberId, :calleeJabberId => calleeJabberId, :call_id => call_id }
+      result = request(method, call, params)
+    end
+
+    def join_call(invite_id)
+      method = "POST"
+      call = "/calls/join"
+      params = { :invite_id => invite_id }
+      result = request(method, call, params)
+    end
+
+    # Contacts API Actions =============================================================================
+
+    def add_contact(jabberId, remoteJabberId)
+      method = "POST"
+      call = "/contacts/request"
+      params = { :jabberId => jabberId, :remoteJabberId => remoteJabberId }
+      result = request(method, call, params)
+    end
+
+    def is_friend(jabberId, remoteJabberId)
+      method = "POST"
+      call = "/contacts/getRelation"
+      params = { :jabberId => jabberId, :remoteJabberId => remoteJabberId }
+      result = request(method, call, params)
+    end
+
+    def remove_contact(jabberId, remoteJabberId)
+      method = "POST"
+      call = "/contacts/remove"
+      params = { :jabberId => jabberId, :remoteJabberId => remoteJabberId }
+      result = request(method, call, params)
+    end
+
+    def reject_contact(jabberId, remoteJabberId)
+      method = "POST"
+      call = "/contacts/reject"
+      params = { :jabberId => jabberId, :remoteJabberId => remoteJabberId }
+      result = request(method, call, params)
+    end
+
+    # Feed API actions =================================================================================
+
+    def add_comment(posterjabberId, vmailmessageid, commenttext, vmailcontentid)
+      method = "POST"
+      call = "/vmail/addcomment"
+      params = { :posterjabberId => posterjabberId, :vmailmessageid => vmailmessageid, :commenttext => commenttext, :vmailcontentid => vmailcontentid }
+      result = request(method, call, params)
+    end
+
+    def delete_missed_call_from_feed(jabberId, invite_id)
+      method = "POST"
+      call = "/callevent/delete"
+      params = { :jabberId => jabberId, :invite_id => invite_id }
+      result = request(method, call, params)
+    end
+
+    def delete_vmail_from_feed(message_id, type)
+      method = "POST"
+      call = "/vmail/delete"
+      params = { :message_id => message_id, :type => type }
+      result = request(method, call, params)
+    end
+
+    def get_all_of_the_comments_on_a_post(message_id, start = nil, count = nil)
+      method = "POST"
+      call = "/vmail/getcomments"
+      params = { :message_id => message_id, :start => start, :count => count }
+      result = request(method, call, params)
+    end
+
+    def get_feed(jabberId, filter=nil, start=nil, count=nil, sort=nil, dateRange=nil)
+      method = "POST"
+      call = "/feed/getFeed"
+      params = { :jabberId => jabberId, :filter => filter, :start => start, :count => count, :sort => sort, :dateRange => nil }
+      result = request(method, call, params)
+    end
+
+    def get_feed_unread_count(jabberId)
+      method = "POST"
+      call = "/feed/unreadCount"
+      params = { :jabberId => jabberId }
+      result = request(method, call, params)
+    end
+
+    def mark_missed_call_as_read_in_feed(jabberId, invite_id)
+      method = "POST"
+      call = "/callevent/markasviewed"
+      params = { :jabberId => jabberId, :invite_id => invite_id }
+      result = request(method, call, params)
+    end
+
+    def mark_vmail_as_read(message_id)
+      method = "POST"
+      call = "/vmail/markasviewed"
+      params = { :message_id => message_id }
+      result = request(method, call, params)
+    end
+
+    # Token API actions ================================================================================
+
+    def get_access_token(jabberId, password)
+      method = "POST"
+      call = "/auth/getAccessToken"
+      params = { :jabberId => jabberId, :password => password }
+      result = request(method, call, params, @api_secret)
+    end
+
+    def get_request_token(callbackUrl)
+      method = "POST"
+      call = "/auth/getRequestToken"
+      params = { :callbackUrl => callbackUrl }
+      result = request(method, call, params, @api_secret)
+    end
+
+    def validate_access_token(jabberId, accessSecret)
+      method = "POST"
+      call = "/auth/validateAccessToken"
+      params = { :jabberId => jabberId, :accessSecret => accessSecret }
+      result = request(method, call, params, @api_secret)
+    end
+
+    # User API actions =================================================================================
+
+    def login_user(jabberId, secret)
+      @jabberId = jabberId
+      @secret = secret
+    end
+    
+    def create_user(jabberId, secret)
+      TokBoxer::User.new(jabberId, secret, self)
+    end
+
+    def create_guest_user
+      method = "POST"
+      call = "/users/createGuest"
+      params = { :partnerKey => @api_key }
+      result = request(method, call, params, @api_secret)
+      if result['error']
+        return nil # error
+      else
+        return create_user(result["createGuest"].first["jabberId"].first, result["createGuest"].first["secret"].first)
+      end
+    end
+
+    def register_user(firstname,lastname,email)
+      method = "POST"
+      call = "/users/register"
+      params = { :firstname => firstname, :lastname => lastname, :email => email }
+      result = request(method, call, params, @api_secret)
+      if result['error']
+        return nil # error
+      else
+        return create_user(result["registerUser"].first["jabberId"].first, result["registerUser"].first["secret"].first)
+      end
+    end
+
+    def get_user_profile(jabberId)
+      @jabberId = jabberId
+      method = "POST"
+      call = "/users/getProfile"
+      params = { :jabberId => jabberId }
+      result = request(method, call, params)
+    end
+
+    # VMail API actions ================================================================================
+
+    def forward_vmail(vmail_id, senderJabberId, text="", tokboxRecipients="", emailRecipients="")
+      method = "POST"
+      call = "/vmail/forward"
+      params = { :vmail_id => vmail_id, :senderJabberId => senderJabberId, :text => text, :tokboxRecipients => tokboxRecipients, :emailRecipients => emailRecipients }
+      result = request(method, call, params)
+    end
+
+    def forward_vmail_to_all_friends(vmail_id, senderJabberId, text="")
+      method = "POST"
+      call = "/vmail/forwardToFriends"
+      params = { :vmail_id => vmail_id, :senderJabberId => senderJabberId, :text => text }
+      result = request(method, call, params)
+    end
+
+    def get_vmail(message_id)
+      method = "POST"
+      call = "/vmail/getVmail"
+      params = { :message_id => message_id }
+      result = request(method, call, params)
+    end
+
+    def post_public_vmail(vmail_id, scope, senderJabberId, text)
+      method = "POST"
+      call = "/vmail/postPublic"
+      params = { :vmail_id => vmail_id, :scope => scope, :senderJabberId => senderJabberId, :text => text }
+      result = request(method, call, params)
+    end
+
+    def send_vmail(vmail_id, senderJabberId, text="", tokboxRecipients="", emailRecipients="")
+      method = "POST"
+      call = "/vmail/send"
+      params = { :vmail_id => vmail_id, :senderJabberId => senderJabberId, :text => text, :tokboxRecipients => tokboxRecipients, :emailRecipients => emailRecipients }
+      result = request(method, call, params)
+    end
+
+    def send_vmail_to_alL_friends(vmail_id, senderJabberId, text="")
+      method = "POST"
+      call = "/vmail/sendToFriends"
+      params = { :vmail_id => vmail_id, :senderJabberId => senderJabberId, :text => text }
+      result = request(method, call, params)
+    end
+
+    private # ==========================================================================================
+
+    def initialize(api_key, api_secret, api_server_url = 'http://sandbox.tokbox.com/')
+        @api_key = api_key
+        @api_secret = api_secret
+        @api_server_url = api_server_url
+    end
+
+    def generate_nonce
+      (0...16).map { "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"[rand(62)] }.join
+    end
+
+    def generate_request_string(hash)
+      hash.reject{ |k,v| k=~/^_/ or v.nil? or v.to_s == "" }.
+               map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}".gsub("+","%20")}.sort.join("&")
+    end
+
+    def build_signed_request(method, uri, nonce, timestamp, paramList, secret)
+      signed_auth_fields = { 'oauth_partner_key'      => @api_key,
+                             'oauth_signature_method' => API_SIGNATURE_METHOD,
+                             'oauth_timestamp'        => timestamp,
+                             'oauth_version'          => API_VERSION,
+                             'oauth_nonce'            => nonce,
+                             'tokbox_jabberid'        => @jabberId }.merge(paramList)
+      request_string = method + "&" + uri + "&" + generate_request_string(signed_auth_fields)
+      Digest::MD5.hexdigest(request_string + secret)
+    end
+
+    def request(method, apiURL, paramList, secret = nil)
+      nonce = generate_nonce
+      timestamp = Time.now.to_i
+      request_url = @api_server_url + API_SERVER_METHODS_URL + apiURL
+      authfields = { 'oauth_partner_key'      => @api_key,
+                     'oauth_signature_method' => API_SIGNATURE_METHOD,
+                     'oauth_timestamp'        => timestamp,
+                     'oauth_version'          => API_VERSION,
+                     'oauth_nonce'            => nonce,
+                     'oauth_signature'        => build_signed_request(method,request_url,nonce,timestamp,paramList, secret || @secret),
+                     'tokbox_jabberid'        => @jabberId }
+      datastring = generate_request_string(paramList)+"&"+generate_request_string(authfields)
+      datastring += '&_AUTHORIZATION='
+      datastring += authfields.map{|k,v|"#{CGI.escape(k.to_s)}=\"#{CGI.escape(v.to_s)}\""}.join(",").gsub("+","%20")
+      if @debug
+        puts "=========================v"
+        puts "Call   : #{method} #{request_url}"
+        puts "Params : #{paramList.inspect}"
+        puts "-------------------------"
+      end
+      url        = URI.parse(request_url)
+      request    = Net::HTTP.new(url.host,url.port)
+      response   = request.post(url.path,datastring)
+      result     = response.body
+      xml_result = XmlSimple.xml_in(result)
+      if @debug
+        pp xml_result
+        puts "=========================^"  
+      end
+      xml_result
+    end
+
+  end
+
+end

data/lib/TokBoxer/Call.rb

@@ -0,0 +1,42 @@
+module TokBoxer
+  
+  class Call
+    
+    attr_reader :callerName, :callId, :callerJabberId, :persistent, :server
+    alias       :id :callId
+    
+    def initialize(callerName, callId, callerJabberId, persistent, server, api)
+      @callerName     = callerName
+      @callId         = callId
+      @callerJabberId = callerJabberId
+      @persistent     = persistent
+      @server         = server
+      @api            = api
+    end
+    
+    def embed_code(width="322", height="321")
+      <<-END
+      <object width="#{width}" height="#{height}">
+          <param name="movie" value="#{@api.api_server_url}#{API_SERVER_CALL_WIDGET}#{id}" />
+          <param name="allowFullScreen" value="true" />
+          <param name="allowScriptAccess" value="true" />
+          <param name="flashVars" value="textChat=true&guestList=false&inviteButton=false" />
+          <embed src="#{@api.api_server_url}#{API_SERVER_CALL_WIDGET}#{id}"
+                 type="application/x-shockwave-flash"
+                 allowfullscreen="true"
+                 allowScriptAccess="always"
+                 width="#{width}"
+                 height="#{height}"
+                 flashvars="textChat=true&guestList=false&inviteButton=false" >
+          </embed>
+      </object>
+      END
+    end
+    
+    def to_s
+      id
+    end
+    
+  end
+  
+end

data/lib/TokBoxer/User.rb

@@ -0,0 +1,137 @@
+module TokBoxer
+  
+  class User
+    
+    attr_reader :jabberId, :secret
+    alias       :id :jabberId
+    
+    def initialize(jabberId, secret, api)
+      @jabberId = jabberId
+      @secret = secret
+      @api = api
+      self.login
+    end
+    
+    # TODO add a method which calls get_request_token from the API
+    # to get the jabberId and secret from the email and password
+    
+    def login
+      @api.login_user(self.jabberId,self.secret)
+    end
+    
+    def create_call(full_name,persistent=false)
+      result = @api.create_call(@jabberId, full_name, persistent)
+      if result['createCall'] and (createCall=result['createCall'].first)
+        Call.new createCall['callerName'],
+                 createCall['callId'].first,
+                 createCall['callerJabberId'],
+                 createCall['persistent'],
+                 createCall['server'].first,
+                 @api
+      else
+        nil
+      end
+    end
+    
+    def access_token_valid?
+      result = @api.validate_access_token(@jabberId, @secret)
+      result['validateAccessToken'].first["isValid"].first == "true"
+    end
+    
+    # Feeds ============================================================================================
+    
+    def vmails
+      @api.get_feed(@jabberId,"all")["feed"].first["item"].map do |m|
+        VMail.new m["videoMail"].first["content"]["messageId"].first
+      end
+    end
+    
+    def sent_vmails
+      @api.get_feed(@jabberId,"vmailSent")["feed"].first["item"].map do |m|
+        VMail.new m["videoMail"].first["content"]["messageId"].first
+      end
+    end
+    
+    def received_vmails
+      @api.get_feed(@jabberId,"vmailRecv")["feed"].first["item"].map do |m|
+        VMail.new m["videoMail"].first["content"]["messageId"].first
+      end
+    end
+    
+    def recorder_embed_code(width="322", height="321",vmailToEmail="")
+      # TODO: this comes from the PHP api. Not yet implemented here
+      # if($isGuest) {
+      #   $apiObj = new TokBoxApi(API_Config::PARTNER_KEY, API_Config::PARTNER_SECRET);
+      #   $apiObj->updateToken($apiObj->getRequestToken(API_Config::CALLBACK_URL));
+      # 
+      #   $htmlCode .= "<script language=\"javascript\" src=\"SDK/js/TokBoxScript.js\"></script>\n";
+      #   $htmlCode .= "<body onclick=\"setToken('".$apiObj->getAuthToken()."');\">\n";     
+      # }
+      <<-END
+      <object width="#{width}" height="#{height}">
+        <param name="movie" value="#{@api.api_server_url}#{API_SERVER_RECORDER_WIDGET}"></param>
+        <param name="allowFullScreen" value="true"></param>
+        <param name="allowScriptAccess" value="true"></param>
+        <param name="FlashVars" value="tokboxPartnerKey=#{@api.api_key}&tokboxJid=#{jabberId}&tokboxAccessSecret=#{secret}&offsiteAuth=true&vmailToEmail=#{vmailToEmail}"></param>
+        <embed id="tbx_recorder" src="#{@api.api_server_url}#{API_SERVER_RECORDER_WIDGET}"
+          type="application/x-shockwave-flash"
+          allowfullscreen="true"
+          allowScriptAccess="always"
+          width="#{width}"
+          height="#{height}"
+          FlashVars="tokboxPartnerKey=#{@api.api_key}&tokboxJid=#{jabberId}&tokboxAccessSecret=#{secret}&offsiteAuth=true&vmailToEmail=#{vmailToEmail}"
+        >
+        </embed>
+      </object>
+      END
+    end
+
+    def player_embed_code(messageId, width="425", height="344")
+      <<-END
+      <object width="#{width}" height="#{height}">
+
+        <param name="movie" value="#{@api.api_server_url}#{API_SERVER_PLAYER_WIDGET}"></param>
+        <param name="allowFullScreen" value="true"></param>
+        <param name="allowScriptAccess" value="true"></param>
+        <embed id="tbx_player" src="#{@api.api_server_url}#{API_SERVER_PLAYER_WIDGET}"
+          type="application/x-shockwave-flash"
+          allowfullscreen="true"
+          allowScriptAccess="always"
+          flashvars="targetVmail=#{messageId}"
+          width="#{width}" 
+          height="#{height}"
+        >
+        </embed>
+      </object>
+      END
+    end
+    
+    def is_online?
+      info["isOnline"].first == "true"
+    end
+    
+    def display_name
+      info["displayName"].first
+    end
+    
+    def username
+      info["username"].first
+    end
+    
+    def userid
+      info["userid"].first
+    end
+    
+    def show
+      info["show"].first
+    end
+    
+    protected
+    
+    def info
+      @info ||= @api.get_user_profile(self.jabberId)["getUserProfile"].first
+    end
+    
+  end
+  
+end

data/lib/TokBoxer/VMail.rb

@@ -0,0 +1,17 @@
+module TokBoxer
+  
+  class VMail
+    
+    attr_reader :id
+    
+    def initialize(id)
+      @id = id
+    end
+
+    def to_s
+      id
+    end
+    
+  end
+  
+end

data/website/index.html

@@ -1,11 +1,84 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>TokBoxer</title>
-		
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>TokBoxer</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      TokBoxer
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>TokBoxer</h1>
+    <div class="sidebar">
+      <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/tokboxer"; return false'>
+        <p>Get Version</p>
+        <a href="http://rubyforge.org/projects/tokboxer" class="numbers">0.1.0</a>
+      </div>
+    </div>
+    <h2>What</h2>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="constant">TokBoxer</span></pre></p>
+<h2>The basics</h2>
+<h2>Demonstration of usage</h2>
+<h2>Forum</h2>
+<p><a href="http://groups.google.com/group/TokBoxer">http://groups.google.com/group/TokBoxer</a></p>
+<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; TokBoxer</p>
+<h2>How to submit patches</h2>
+<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+<p>The trunk repository is <code>svn://rubyforge.org/var/svn/TokBoxer/trunk</code> for anonymous access.</p>
+<p><span class="caps">OOOORRRR</span></p>
+<p>You can fetch the source from either:</p>
+<ul>
+	<li>rubyforge: <a href="http://rubyforge.org/scm/?group_id=7264">http://rubyforge.org/scm/?group_id=7264</a></li>
+</ul>
+<pre>git clone git://rubyforge.org/TokBoxer.git</pre>
+<ul>
+	<li>github: <a href="http://github.com/GITHUB_USERNAME/TokBoxer/tree/master">http://github.com/GITHUB_USERNAME/TokBoxer/tree/master</a></li>
+</ul>
+<pre>git clone git://github.com/GITHUB_USERNAME/TokBoxer.git</pre>
+<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+<ul>
+	<li>gitorious: <a href="git://gitorious.org/TokBoxer/mainline.git">git://gitorious.org/TokBoxer/mainline.git</a></li>
+</ul>
+<pre>git clone git://gitorious.org/TokBoxer/mainline.git</pre>
+<h3>Build and test instructions</h3>
+<pre>cd TokBoxer
+rake test
+rake install_gem</pre>
+<h2>License</h2>
+<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+<h2>Contact</h2>
+<p>Comments are welcome. Send an email to <a href="mailto:nj@belighted.com">Nicolas Jacobeus</a> via the <a href="http://groups.google.com/group/TokBoxer">forum</a></p>
+    <p class="coda">
+      <a href="nj@belighted.com">Nicolas Jacobeus</a>, 3rd November 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tokboxer
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nicolas Jacobeus
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-13 00:00:00 +01:00
+date: 2008-11-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,10 @@ files:
 - Rakefile
 - config/website.yml.sample
 - lib/TokBoxer.rb
+- lib/TokBoxer/Api.rb
+- lib/TokBoxer/Call.rb
+- lib/TokBoxer/User.rb
+- lib/TokBoxer/VMail.rb
 - script/console
 - script/destroy
 - script/generate