rb-skypemac 0.2.1 → 0.3.0

data/README.txt

@@ -1,5 +1,12 @@
 README for rb-skypemac
 ======================
 
+- 0.3.0
+Adds support for:
+ * Conference calling
+ * Checking for incoming calls
+ * Answering incoming calls
+
+- 0.2.0
 Include support for calling, managing calls, and managing users.  Most invocations are made via the Skype class which
 abstracts much of the Skype API, delegating calls to the constituent objects in the official Skype API.

data/lib/rb-skypemac/call.rb

@@ -4,26 +4,31 @@ include Appscript
 
 
 module SkypeMac
-
-  # Represents a Skype call
+  # Represents a Skype call.  Developer is responsible for calling Call#hangup at the end of each call, whether it was placed
+  # by the caller or is an answered call.
   class Call
     @@TOGGLE_FLAGS = [:START, :STOP]
-  
+    
     attr :call_id
   
-    # Creates and initializes a Skype call.  Accepts the handle of the user to call or a User object
-    def initialize(user)
-      user = user.handle if user.is_a? User
-      status = Skype.send_ :command => "call #{user}"
-      if status =~ /CALL (\d+) STATUS/
-        @call_id = $1
-      else
-        raise Error.new("Could not obtain Call ID")
-      end
+    def Call.active_call_ids
+      r = Skype.send_ :command => "SEARCH ACTIVECALLS"
+      r.gsub(/CALLS /, "").split(", ")      
+    end
+
+    def Call.active_calls
+      calls = Call.active_call_ids.collect { |id| Call.new id unless id == "COMMAND_PENDING"}
+      calls
+    end
+
+    # Creates a Call object from a call_id.
+    def initialize(call_id)
+      raise ArgumentError("Cannot pass nil call_id") if call_id.nil?
+      @call_id = call_id
     end
   
-    # Attempts to hang up a call.<br>
-    # <b>Note</b>: If Skype hangs while placing the call, this method could hang indefinitely
+    # Attempts to hang up a call. <b>Note</b>: If Skype hangs while placing the call, this method could hang indefinitely.
+    # <u>Use Skype#Call instead of this method unless you like memory leaks</u>
     def hangup
       Skype.send_ :command => "set call #{@call_id} status finished"
     end
@@ -50,5 +55,9 @@ module SkypeMac
       raise Error.new("Illegal flag: #{toggle_flag}") if not @@TOGGLE_FLAGS.index toggle_flag
       Skype.send_ :command => "alter call #{id} #{toggle_flag.downcase.to_s}_video_receive"
     end
+    
+    def <=>(call)
+      @call_id <=> call.call_id
+    end
   end
 end

data/lib/rb-skypemac/group.rb

@@ -43,6 +43,10 @@ module SkypeMac
       groups
     end
     
+    def <=>(grp)
+      @gtype <=> grp.gtype
+    end
+    
     private 
       def initialize(id, type)
         @gid = id

data/lib/rb-skypemac/skype.rb

@@ -7,12 +7,8 @@ module SkypeMac
   # Singleton for interfacing with Skype
 	class Skype
 	  @@groups = nil
+    @@calls = []
 
-    # Initiates a Skype call
-	  def Skype.call(name_or_num)
-      Call.new name_or_num
-    end
-    
     # The Appscript interface to Skype.  Requires a Hash containing:
     # (1) <i>:command</i> - the Skype API command to pass,
     # (2) <i>:script_name</i> - unknown all though an empty String makes Skype happy.
@@ -21,12 +17,40 @@ module SkypeMac
       params[:script_name] = "" if not params.has_key? :script_name 
       app('Skype').send_ params
     end
+
+    # Initiates a Skype call
+	  def Skype.call(*person)
+      user_handles = person.collect { |u| user_str << ((u.is_a? User) ? u.handle : u) }
+      status = Skype.send_ :command => "call #{user_handles.join(', ')}"
+      if status =~ /CALL (\d+) STATUS/: @@calls << call = Call.new($1)
+      else raise RuntimeError.new("Call failed. Skype returned '#{status}'")
+      end        
+      call
+    end
+
+    # Returns an Array of call IDs if there is an incoming Skype call otherwise nil
+    def Skype.incoming_calls
+      calls = Call.active_calls - @@calls
+      calls
+    end
+    
+    # Answers a call given a skype call ID.  Returns an Array of Call objects.
+    def Skype.answer(call)
+      cmd = "ALTER CALL #{call.call_id} ANSWER"
+      r = Skype.send_ :command => cmd
+      raise RuntimeError("Failed to answer call.  Skype returned '#{r}'") unless r == cmd        
+      @@calls << call
+    end
+    
+    # Use this method to disconnect from a Call whether it was answered or iniiated locally.
+    def Skype.hangup(call)
+      call.hangup
+      @@calls.delete call
+    end
     
-    # Returns an Array of Groups
+    # Returns an Array of Group
     def Skype.groups
-      if not @@groups
-        @@groups = Group.groups
-      end
+      @@groups = Group.groups if not @@groups
       @@groups
     end
     

data/lib/rb-skypemac/user.rb

@@ -11,7 +11,7 @@ module SkypeMac
         r = Skype.send_ :command => "get user \#{@handle} #{attr_sym.to_s}"
         v = r.sub(/^.*#{attr_sym.to_s.upcase} /, "")
         v = true if v == "TRUE"
-        v = nil if v == "FALSE"
+        v = false if v == "FALSE"
         v
       end}
       if accessor
@@ -21,7 +21,7 @@ module SkypeMac
           r = Skype.send_ :command => "set user \#{@handle} #{attr_sym.to_s} \#{value}"
           v = r.sub(/^.*#{attr_sym.to_s.upcase} /, "")
           v = true if v == "TRUE"
-          v = nil if v == "FALSE"
+          v = false if v == "FALSE"
           v
         end}
       end
@@ -42,17 +42,21 @@ module SkypeMac
     attr_reader :handle
     skype_attr_reader :fullname, :birthday, :sex, :language, :country, :province
     skype_attr_reader :city, :phone_home, :phone_office, :phone_mobile, :homepage
-    skype_attr_reader :about, :is_video_capable, :buddystatus, :is_authorized
-    skype_attr_reader :is_blocked, :onlinestatus, :skypeout, :lastonlinetimestamp
-    skype_attr_reader :can_leave_vm, :speeddial, :receivedauthrequest, :mood_text
+    skype_attr_reader :about, :is_video_capable, :is_authorized
+    skype_attr_reader :onlinestatus, :skypeout, :lastonlinetimestamp
+    skype_attr_reader :can_leave_vm, :receivedauthrequest, :mood_text
     skype_attr_reader :rich_mood_text, :is_cf_active, :nrof_authed_buddies
     
     #TODO: attr_reader :aliases, :timezone
     
-    attr_accessor :buddystatus, :isblocked, :isauthorized, :speeddial, :displayname
+    skype_attr_accessor :buddystatus, :isblocked, :isauthorized, :speeddial, :displayname
 
     def initialize(handle)
       @handle = handle
     end
+    
+    def <=>(user)
+      @handle <=> user.handle
+    end
   end
 end

data/lib/rb-skypemac/version.rb

@@ -1,8 +1,8 @@
 module SkypeMac #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
-    TINY  = 1
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_call.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+include SkypeMac
+
+class TestCall< Test::Unit::TestCase
+
+  def test_new
+    assert Call.new 42
+  end
+  
+  def test_active_call_ids
+    assert call_ids = Call.active_call_ids
+    assert call_ids.empty?
+  end
+  
+  def test_active_calls
+    assert calls = Call.active_calls
+    assert calls.empty?
+  end
+end

data/test/test_skype.rb

@@ -12,4 +12,9 @@ class TestSkype < Test::Unit::TestCase
     assert users.empty? == false
     assert users[0].class == User
   end
+  
+  def test_incoming_calls
+    assert inc = Skype.incoming_calls
+    assert inc.empty?
+  end  
 end

data/test/test_user.rb

@@ -23,7 +23,7 @@ class TestUser < Test::Unit::TestCase
   end
   
   def test_isblocked
-    prk166 = User.new prk166
+    prk166 = User.new "prk166"
     prk166.isblocked = true
     assert prk166.isblocked
     prk166.isblocked = false

data/website/index.txt

@@ -25,13 +25,29 @@ call.hangup
 
 sleight42 = Skype.online_friends.find { |u| u.handle == "sleight42" }
 call = Skype.call sleight42
-call.hangup # no one wants to talk to him anyway
+Skype.hangup call # no one wants to talk to him anyway
 
 # Set your user status to away
 Iam.away
 
 # Set your user status to back
 Iam.online
+
+# Attempt to detect and answer a call -- still experimental!  
+# Sporadically crashes Skype 2.6.0.17
+loop do
+  begin
+    if not (calls = Skype.incoming_calls).empty?
+      call = Skype.answer calls.first
+      sleep 10
+      call.hangup
+    end
+  rescue RuntimeError => e
+    puts e.message
+  end
+  puts "sleeping..."
+  sleep 1
+end
 </pre>
 
 h2. Licence
@@ -41,3 +57,5 @@ This code is free to use under the terms of the <a href="http://creativecommons.
 h2. Contact
 
 Comments are welcome. Send an email to "Evan Light":mailto:sleight42@gmail.com.
+
+Copyright 2007, Evan Light

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rb-skypemac
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-04-28 00:00:00 -04:00
+  version: 0.3.0
+date: 2007-05-02 00:00:00 -04:00
 summary: Ruby interface to Skype on Mac OS X
 require_paths: 
 - lib
@@ -50,6 +50,7 @@ files:
 - website/stylesheets/screen.css
 - website/template.rhtml
 test_files: 
+- test/test_call.rb
 - test/test_group.rb
 - test/test_helper.rb
 - test/test_rb-skypemac.rb