rb-skypemac 0.1.0 → 0.2.0

data/Manifest.txt

@@ -3,6 +3,11 @@ Manifest.txt
 README.txt
 Rakefile
 lib/rb-skypemac.rb
+lib/rb-skypemac/call.rb
+lib/rb-skypemac/group.rb
+lib/rb-skypemac/iam.rb
+lib/rb-skypemac/skype.rb
+lib/rb-skypemac/user.rb
 lib/rb-skypemac/version.rb
 scripts/txt2html
 setup.rb

data/README.txt

@@ -1,3 +1,5 @@
 README for rb-skypemac
 ======================
 
+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

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'appscript'
+include Appscript
+
+
+module SkypeMac
+
+  # Represents a Skype call
+  class Call
+    @@TOGGLE_FLAGS = [:START, :STOP]
+  
+    attr :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/
+        @id = $1
+      else
+        raise Error.new("Could not obtain Call ID")
+      end
+    end
+  
+    # Attempts to hang up a call.<br>
+    # <b>Note</b>: If Skype hangs while placing the call, this method could hang indefinitely
+    def hangup
+      Skype.send_ :command => "set call #{@id} status finished"
+    end
+  
+    # Retrieves the status of the current call.<br>
+    # <b>Untested</b>
+    def status
+      Skype.send_ :command => "get call #{@id} status"
+    end
+  
+    # Returns one of: VIDEO_NONE, VIDEO_SEND_ENABLED, VIDEO_RECV_ENABLED, VIDEO_BOTH_ENABLED
+    def get_video_status
+      Skype.send_ :command => "get call #{id} video_status"
+    end
+  
+    # Accepts <i>:START</i> or <em>:STOP</em>
+    def send_video(toggle_flag)
+      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_send"
+    end
+  
+    # Accepts <em>:START</em> or <em>:STOP</em>
+    def rcv_video(toggle_flag)
+      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
+  end
+end

data/lib/rb-skypemac/group.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'appscript'
+include Appscript
+
+module SkypeMac  
+
+  # Represents Skype internal grouping of contacts; https://developer.skype.com/Docs/ApiDoc/GROUP_object
+  class Group
+    attr_reader :gtype, :gid
+    
+    # Gets the type of a group by id
+    def Group.get_type(id)
+      r = Skype.send_ :command => "get group #{id} type"
+      r.sub(/.*TYPE\b/, "").strip
+    end
+
+    # Returns an array of your Skype instance's supported group types
+    def Group.types
+      groups = Group.groups
+      groups.map { |g| g.gtype }
+    end  
+  
+    # Returns array of skype names of users in this group
+    def member_user_names
+      r = Skype.send_ :command => "get group #{@gid} users"
+      r.sub(/^.*USERS /, "").split(", ")
+    end
+
+    # Returns array of Users in this Group
+    def users
+      member_user_names.map { |h| User.new h }
+    end
+
+    # Returns hash of symols (group types) => Group objects
+    def Group.groups
+      r = Skype.send_ :command => "search groups hardwired", :script_name => ""
+      r.gsub!(/^\D+/, "")
+      group_ids = r.split ", "
+      groups = []
+      group_ids.each do |id|
+        groups <<  Group.new(id, Group.get_type(id))
+      end
+      groups
+    end
+    
+    private 
+      def initialize(id, type)
+        @gid = id
+        @gtype = type
+      end
+  end  
+end

data/lib/rb-skypemac/iam.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'appscript'
+include Appscript
+
+module SkypeMac  
+
+  # Singleton for managing Skype user status
+  class Iam
+    @@STATUSES = [:ONLINE, :OFFLINE, :SKYPEME, :AWAY, :NA, :DND, :INVISIBLE]
+  
+    def Iam.set_user_status(status)
+      raise NoMethodError.new("#{status} in #{Iam.to_s}") if not @@STATUSES.index status.upcase.to_sym
+      Skype.send_ :command => "SET USERSTATUS #{status}"
+    end
+
+    # Handles all of the user status permutations accepted by Skype otherwise Errors.
+    # For example, <i>Iam.away</i> is legal.
+    def Iam.method_missing(id)
+      Iam.set_user_status(id.id2name)
+    end    
+  end
+end

data/lib/rb-skypemac/skype.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'appscript'
+include Appscript
+
+module SkypeMac  
+
+  # Singleton for interfacing with Skype
+	class Skype
+	  @@groups = nil
+
+    # 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.
+    # Impl adds <i>:script_name</i> to Hash and warns if it is not provided
+    def Skype.send_(params)
+      params[:script_name] = "" if not params.has_key? :script_name 
+      app('Skype').send_ params
+    end
+    
+    # Returns an Array of Groups
+    def Skype.groups
+      if not @@groups
+        @@groups = Group.groups
+      end
+      @@groups
+    end
+    
+    # Returns Array of all users in Group.  Accepts types as defined by Group.types
+    def Skype.find_users_of_type(group_type)
+      Skype.groups.find { |g| g.gtype == group_type}.users
+    end
+
+    # Returns an array of users online friends as User objects
+    def Skype.online_friends
+      Skype.find_users_of_type "ONLINE_FRIENDS"
+    end
+    
+    # Array of all Users that are friends of the current user
+    def Skype.all_friends
+      Skype.find_users_of_type "ALL_FRIENDS"
+    end
+    
+    # Array of all Users defined as Skype Out users
+    def Skype.skypeout_friends
+      Skype.find_users_of_type "SKYPEOUT_FRIENDS"
+    end
+    
+    # Array of all Users that the user knows
+    def Skype.all_users
+      Skype.find_users_of_type "ALL_USERS"
+    end
+    
+    # Array of Users recently contacted by the user, friends or not
+    def Skype.recently_contacted_users
+      Skype.find_users_of_type "RECENTLY_CONTACTED_USERS"
+    end
+    
+    # Array of Users waiting for authorization
+    def Skype.users_waiting_for_authorization
+      Skype.find_users_of_type "USERS_WAITING_MY_AUTHORIZATION"
+    end
+    
+    # Array of Users blocked
+    def Skype.blocked_users
+      Skype.find_users_of_type "USERS_BLOCKED_BY_ME"
+    end
+  end
+end

data/lib/rb-skypemac/user.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'appscript'
+include Appscript
+
+module SkypeMac  
+
+  # Represents Skype internal grouping of contacts; https://developer.skype.com/Docs/ApiDoc/GROUP_object
+  class User
+    def User.skype_attr(attr_sym, accessor=false)
+      module_eval %{def #{attr_sym.to_s}
+        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
+      end}
+      if accessor
+        module_eval %{def #{attr_sym.to_s}=(value)
+          value = "true" if value == true
+          value = "False" if value == false
+          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
+        end}
+      end
+    end
+
+    def User.skype_attr_reader(*attr_sym)
+      attr_sym.each do |a|
+        User.skype_attr a, false
+      end
+    end
+    
+    def User.skype_attr_accessor(*attr_sym)
+      attr_sym.each do |a|
+        User.skype_attr a, true
+      end
+    end
+
+    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 :rich_mood_text, :is_cf_active, :nrof_authed_buddies
+    
+    #TODO: attr_reader :aliases, :timezone
+    
+    attr_accessor :buddystatus, :isblocked, :isauthorized, :speeddial, :displayname
+
+    def initialize(handle)
+      @handle = handle
+    end
+  end
+end

data/lib/rb-skypemac/version.rb

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

data/lib/rb-skypemac.rb

@@ -1,95 +1 @@
-Dir[File.join(File.dirname(__FILE__), 'rb-skypemac/**/*.rb')].sort.each { |lib| require lib }
-
-require 'rubygems'
-require 'appscript'
-include Appscript
-
-module SkypeMac  
-  # Singleton for interfacing with Skype
-	class Skype
-	  def Skype.call(name_or_num)
-      Call.new name_or_num
-    end
-    
-    # The Appscript interface to Skype.  Requires a Hash containing:
-    # <li><i>:command</i> - the <a href="https://developer.skype.com/Docs/ApiDoc">Skype API command to pass</a>
-    # <li><i>:script_name</i> - unknown all though an empty String makes Skype happy
-    # Impl adds :script_name to Hash and warns if it is not provided
-    def Skype.send_(params)
-      if not params.has_key? :script_name and not @suppress_warnings
-        puts "Warning: Skype Applescript API require 'script_name' key (even with an empty String value).  Adding..."
-        params[:script_name] = ""
-      end
-      app('Skype').send_ params
-    end
-    
-    def Skype.suppress_warnings
-      @suppress_warnings = 1
-    end
-  end
-  
-  class Call
-    @@TOGGLE_FLAGS = [:START, :STOP]
-    
-    attr :id
-    
-    # Creates and initializes a Skype call
-    def initialize(name_or_num)
-      status = Skype.send_ :command => "call #{name_or_num}"
-      if status =~ /CALL (\d+) STATUS/
-        @id = $1
-      else
-        raise Error.new("Could not obtain Call ID")
-      end
-    end
-    
-    # Attempts to hang up a call.<br>
-    # <b>Note</b>: If Skype hangs while placing the call, this method could hang indefinitely
-    def hangup
-      Skype.send_ :command => "set call #{@id} status finished"
-    end
-    
-    # Retrieves the status of the current call.<br>
-    # <b>Untested</b>
-    def status
-      Skype.send_ :command => "get call #{@id} status"
-    end
-    
-    # Returns one of:<br>
-    # <li>VIDEO_NONE
-    # <li>VIDEO_SEND_ENABLED
-    # <li>VIDEO_RECV_ENABLED
-    # <li>VIDEO_BOTH_ENABLED
-    def get_video_status
-      Skype.send_ :command => "get call #{id} video_status"
-    end
-    
-    # Accepts :START or :STOP
-    def send_video(toggle_flag)
-      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_send"
-    end
-    
-    # Accepts :START or :STOP
-    def rcv_video(toggle_flag)
-      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
-  end
-  
-  # Singleton for managing Skype user status
-  class Iam
-    @@STATUSES = [:ONLINE, :OFFLINE, :SKYPEME, :AWAY, :NA, :DND, :INVISIBLE]
-  
-    def Iam.set_user_status(status)
-      raise NoMethodError.new("#{status} in #{Iam.to_s}") if not @@STATUSES.index status.upcase.to_sym
-      Skype.send_ :command => "SET USERSTATUS #{status}"
-    end
-
-    # Handles all of the user status permutations accepted by Skype otherwise Errors.
-    # For example, <i>Iam.away</i> is legal.
-    def Iam.method_missing(id)
-      Iam.set_user_status(id.id2name)
-    end    
-  end
-end
+Dir[File.join(File.dirname(__FILE__), 'rb-skypemac/**/*.rb')].sort.each { |lib| require lib }

data/test/test_group.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+include SkypeMac
+
+class TestGroup < Test::Unit::TestCase
+
+  def setup
+    @gs = Group.groups
+  end
+
+  def test_group_types
+    gtypes = Group.types
+    assert gtypes
+    assert gtypes.class == Array
+    assert !gtypes.empty?
+  end
+
+  def test_groups
+    assert @gs
+    assert @gs.class == Array
+    assert !@gs.empty?
+  end
+  
+  def test_get_type
+    type = Group.get_type @gs[0].gid
+    assert type
+    assert type.class == String
+    assert type.match(/^\w+$/)
+  end
+  
+  def test_gtype
+    assert @gs[0].gtype
+    assert @gs[0].gtype.class == String
+    assert @gs[0].gtype.match(/^\w+$/)
+  end
+  
+  def test_gid
+    assert @gs[0].gid
+    assert @gs[0].gid.class == String
+    assert @gs[0].gid.match(/^\d+$/)
+  end
+  
+  def test_member_user_names
+    user_names = @gs[0].member_user_names
+    assert user_names
+    assert user_names.class == Array
+    assert !user_names.empty?
+    user_names.each { |n| assert n.index(" ").nil? }
+  end
+  
+  def test_users
+    assert users = @gs[0].users
+    assert users.empty? == false
+    assert users[0].class == User
+  end
+end

data/test/test_skype.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestSkype < Test::Unit::TestCase
+
+  def test_groups
+    gs = Skype.groups
+  end
+
+  def test_online_friends
+    assert users = Skype.online_friends
+    assert users.empty? == false
+    assert users[0].class == User
+  end
+end

data/test/test_user.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+include SkypeMac
+
+class TestUser < Test::Unit::TestCase
+
+  def setup
+    @user = User.new "sleight42"
+  end
+
+  def test_handle
+    assert @user.handle
+    assert @user.handle == "sleight42"
+  end
+  
+  def test_fullname
+    assert @user.fullname
+    assert @user.fullname == "Evan"
+  end
+  
+  def test_city
+    assert @user.city
+    assert @user.city == "Vienna"
+  end
+  
+  def test_isblocked
+    prk166 = User.new prk166
+    prk166.isblocked = true
+    assert prk166.isblocked
+    prk166.isblocked = false
+    assert prk166.isblocked == false
+  end
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>rb skypemac</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rb-skypemac"; return false'>
       Get Version
-      <a href="http://rubyforge.org/projects/rb-skypemac" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/rb-skypemac" class="numbers">0.2.0</a>
     </div>
     <h1>&#x2192; &#8216;rb-skypemac&#8217;</h1>
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rb-skypemac
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-04-22 00:00:00 -04:00
+  version: 0.2.0
+date: 2007-04-26 00:00:00 -04:00
 summary: Ruby interface to Skype on Mac OS X
 require_paths: 
 - lib
@@ -34,6 +34,11 @@ files:
 - README.txt
 - Rakefile
 - lib/rb-skypemac.rb
+- lib/rb-skypemac/call.rb
+- lib/rb-skypemac/group.rb
+- lib/rb-skypemac/iam.rb
+- lib/rb-skypemac/skype.rb
+- lib/rb-skypemac/user.rb
 - lib/rb-skypemac/version.rb
 - scripts/txt2html
 - setup.rb
@@ -45,8 +50,11 @@ files:
 - website/stylesheets/screen.css
 - website/template.rhtml
 test_files: 
+- test/test_group.rb
 - test/test_helper.rb
 - test/test_rb-skypemac.rb
+- test/test_skype.rb
+- test/test_user.rb
 rdoc_options: []
 
 extra_rdoc_files: []