Ruby4Skype 0.3.1 → 0.4.1

data/README

@@ -1,14 +1,102 @@
-= SkypeAPI
+= Skype
 
+==install
+
+  gem install Ruby4Skype
+
+require swin.so at Windows.
+
+require rubycocoa at Mac.
+Not work at OSX 10.6 Snow Leopard.Because Skype.framework not contains 64bit binary.
+You need copy /Application/Skype/Contnet/Frameworks/Skype.framework to /Library/Frameworks/Skype.framework
+Some methods not work.
+
+##require dbus or rbus at Linux.
+
+Ruby4Skype support Windows and Mac now.
 ==sample
-  require 'skypeapi'
-  
-  SkypeAPI.init
-  SkypeAPI.start_messageloop
-  SkypeAPI::ChatMessage.set_notify do |chatmessage, property, value|
+  require 'rubygems'
+  require 'Skype'
+
+  Skype.init 'application_name'
+  Skype.start_messageloop
+  Skype::ChatMessage.set_notify do |chatmessage, property, value|
     if property == :status and value == 'RECEIVED'
       chatmessage.get_chat.send_message chatmessage.get_body
     end
   end
-  SkypeAPI.attach_wait
+  Skype.attach_wait
   sleep
+
+==method and object
+Ruby4Skype is same Skype API methods and objects.
+
+https://developer.skype.com/Docs/ApiDoc/FrontPage
+
+===method
+ex.
+
+CHAT CREATE [<target>, <target>*] -> Skype::Chat.create *targets
+
+https://developer.skype.com/Docs/ApiDoc/CHAT_CREATE
+
+GET object property
+
+https://developer.skype.com/Docs/ApiDoc/src#PROPERTIES_OBJECT
+
+Skype::User.get_fullname
+
+===Skype Objects
+https://developer.skype.com/Docs/ApiDoc/Objects
+
+USER -> Skype::User
+
+PROFILE -> Skype::Profile
+
+CALL -> Skype::Call
+
+MESSAGE -> Skype::Message (obsolete)
+
+CHAT -> Skype::Chat
+
+CHATMEMBER -> Skype::ChatMember
+
+CHATMESSAGE -> Skype::ChatMessage
+
+VOICEMAIL -> Skype::VoiceMail (none test)
+
+SMS -> Skype::SMS (none test)
+
+APPLICATION -> Skype::Application (none test)
+
+GROUP -> Skype::Group (broken)
+
+FILETRANSFER -> Skype::FileTransfer
+
+==notification
+When Skype change property, callback is called.
+Property is symbol of method name get_xxx.
+===general property
+  Skype.set_notify{|property, value| }
+===objects property
+  Skype::ChatMessage.set_notify{|instance, property, value|}
+===specify property
+  Skype::ChatMessage.set_notify(:status){|instance, value|}
+===specify property and value
+  Skype::ChatMessage.set_notify(:status, 'RECEIVED'){|instance|}
+
+==messageloop
+===messageloop run with new thread.
+
+  Skype.start_messageloop
+
+===or messageloop run with current thread.
+
+  Skype.messageloop
+
+===or message polling
+
+  loop do
+    Skype.messgepolling
+    sleep 0.123
+  end

data/Rakefile

@@ -16,7 +16,7 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'Ruby4Skype'
-  s.version = '0.3.1'
+  s.version = '0.4.1'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README', 'LICENSE']
   s.summary = 'SkypeAPI wrapper'
@@ -41,8 +41,8 @@ Rake::RDocTask.new do |rdoc|
   #files =['README', 'LICENSE', 'lib/**/*.rb']
   #files =['README', 'LICENSE', 'lib/skypeapi/os/windows.rb', 'lib/skypeapi/chat.rb', 'lib/skypeapi/chatmessage.rb','lib/skypeapi/chatmember.rb','lib/skypeapi/user.rb','lib/skypeapi/version.rb', 'lib/skypeapi/call.rb','lib/skypeapi/application.rb']
   files = ['README','LICENSE']
-  files << ['lib/skypeapi.rb']
-  files << ['lib/skypeapi/*.rb']
+  files << ['lib/skype.rb']
+  files << ['lib/skype/*.rb']
   rdoc.rdoc_files.add(files)
   rdoc.main = "README" # page to start on
   rdoc.title = "SkypeAPI Docs"

data/lib/{skypeapi.rb → skype.rb}

@@ -1,26 +1,26 @@
 require "forwardable"
-require 'skypeapi/os/notifier'
-require "skypeapi/object.rb"
-require "skypeapi/version.rb"
-require "skypeapi/user.rb"
-require "skypeapi/profile.rb"
-require "skypeapi/call.rb"
-require "skypeapi/message.rb"
-require "skypeapi/chat.rb"
-require "skypeapi/chatmessage.rb"
-require "skypeapi/chatmember.rb"
-require "skypeapi/voicemail.rb"
-require "skypeapi/sms.rb"
-require "skypeapi/application.rb"
-require "skypeapi/group.rb"
-require "skypeapi/filetransfer.rb"
-require "skypeapi/event.rb"
-require "skypeapi/menuitem.rb"
-require "skypeapi/os/etc.rb"
-require 'skypeapi/error'
-
-
-module SkypeAPI
+require 'skype/os/notifier'
+require "skype/object.rb"
+require "skype/version.rb"
+require "skype/user.rb"
+require "skype/profile.rb"
+require "skype/call.rb"
+require "skype/message.rb"
+require "skype/chat.rb"
+require "skype/chatmessage.rb"
+require "skype/chatmember.rb"
+require "skype/voicemail.rb"
+require "skype/sms.rb"
+require "skype/application.rb"
+require "skype/group.rb"
+require "skype/filetransfer.rb"
+require "skype/event.rb"
+require "skype/menuitem.rb"
+require "skype/os/etc.rb"
+require 'skype/error'
+
+
+module Skype
   extend AbstractObject::Notify
   extend AbstractObject::Get
   extend AbstractObject::Invokers
@@ -34,59 +34,63 @@ module SkypeAPI
   
   class << self
 
-    def init os=RUBY_PLATFORM.downcase
-      unless @inited
-        case os
-        when /(mswin(?!ce))|(mingw)|(cygwin)|(bccwin)/
-          require 'skypeapi/os/windows.rb'
-          @os = SkypeAPI::OS::Windows.new
-        when /(mac)|(darwin)/
-          require 'skypeapi/os/mac.rb'
-          @os = SkypeAPI::OS::Mac.new
-        when /(linux)/
-          require 'skypeapi/os/linux.rb'
-          @os = SkypeAPI::OS::Linux.new
-        else
-          raise SkypeAPI::NotImplementError.new("#{os} is unknown or not support OS")
-        end
-        
-        self.class.extend Forwardable
-        self.class.def_delegators(:@os,
-          :invoke,
-          :add_event,
-          :del_event,
-          :get_event,
-          :exist_event?,
-          :attach,
-          :attach_wait,
-          :polling,
-          :start_messageloop,
-          :messgeloop,
-          :close
-        )
-        class << self
-          alias addEvent add_event
-          alias setEvent add_event
-          alias delEvent del_event
-          alias getEvent get_event
-          alias existEvent? exist_event?
-          alias attachWait attach_wait
-        end
-        
-        @notify = Hash.new
-        #@os.add_notify nil, method(:notified)
-        
-        @notifier = SkypeAPI::OS::Notifier.new
-        @os.set_notify_selector @notifier.method(:fire)
-        @notifier.add nil, method(:notified)
-        objectsInit
-        
-        #@inited = true
+    def init app_name, os=RUBY_PLATFORM.downcase
+      case os
+      when /(mswin(?!ce))|(mingw)|(cygwin)|(bccwin)/
+        require 'skype/os/windows.rb'
+        init_os Skype::OS::Windows, app_name
+      when /(mac)|(darwin)/
+        require 'skype/os/mac.rb'
+        init_os Skype::OS::Mac, app_name
+      when /(linux)/
+        require 'skype/os/linux.rb'
+        init_os Skype::OS::Linux, app_name
       else
-        #raise SkypeAPI::Error('init at onece')
+        raise Skype::NotImplementError.new("#{os} is unknown or not support OS")
+      end
+      @notify = Hash.new
+      init_notifier
+    end
+    
+    def init_os os_class, app_name
+      @os = os_class.new app_name
+      forward_os_methods        
+    end
+    
+    def forward_os_methods
+      self.class.extend Forwardable
+      self.class.def_delegators(:@os,
+      :invoke,
+      :add_event,
+      :del_event,
+      :get_event,
+      :exist_event?,
+      :attach,
+      :attach_wait,
+      :polling,
+      :start_messageloop,
+      :messageloop,
+      :messagepolling,
+      :close
+      )
+      class << self
+        alias addEvent add_event
+        alias setEvent add_event
+        alias delEvent del_event
+        alias getEvent get_event
+        alias existEvent? exist_event?
+        alias attachWait attach_wait
       end
     end
     
+    def init_notifier
+      @notifier = Skype::OS::Notifier.new
+      @os.set_notify_selector @notifier.method(:fire)
+      @notifier.add nil, method(:notified)
+      objectsInit
+    end
+    private :init_os, :forward_os_methods, :init_notifier
+
     def new
       init
       self
@@ -124,41 +128,41 @@ module SkypeAPI
     end
     
     def objectsInit
-      [SkypeAPI::User,SkypeAPI::Profile,SkypeAPI::Call,SkypeAPI::Message,SkypeAPI::Chat,SkypeAPI::ChatMessage,SkypeAPI::ChatMember,SkypeAPI::VoiceMail,SkypeAPI::SMS,SkypeAPI::Application,SkypeAPI::Group,SkypeAPI::FileTransfer,SkypeAPI::Event,SkypeAPI::MenuItem].each do |klass|
+      [Skype::User,Skype::Profile,Skype::Call,Skype::Message,Skype::Chat,Skype::ChatMessage,Skype::ChatMember,Skype::VoiceMail,Skype::SMS,Skype::Application,Skype::Group,Skype::FileTransfer,Skype::Event,Skype::MenuItem].each do |klass|
         #@os.add_notify /^#{klass::OBJECT_NAME} (.+)$/m, klass.method(:notified)
         @notifier.add /^#{klass::OBJECT_NAME} (.+)$/m, klass.method(:notified)
       end
     end
     
-    def user(id) SkypeAPI::User.new(id) ; end
+    def user(id) Skype::User.new(id) ; end
     
-    def call(id) SkypeAPI::Call.new(id) ; end
+    def call(id) Skype::Call.new(id) ; end
     
-    #def Profile() SkypeAPI::Profile.new nil ; end
+    #def Profile() Skype::Profile.new nil ; end
     
-    #def profile() SkypeAPI::Profile.new nil ; end
+    #def profile() Skype::Profile.new nil ; end
     
-    def chat(id) SkypeAPI::Chat.new(id) ; end
+    def chat(id) Skype::Chat.new(id) ; end
     
-    def chatMessage(id) SkypeAPI::ChatMessage.new(id) ; end
+    def chatMessage(id) Skype::ChatMessage.new(id) ; end
     
-    def chatMember(id) SkypeAPI::ChatMember.new(id) ; end
+    def chatMember(id) Skype::ChatMember.new(id) ; end
     
-    #def message(id) SkypeAPI::Message.new(id) ; end
+    #def message(id) Skype::Message.new(id) ; end
     
-    def voiceMail(id) SkypeAPI::VoiceMail.new(id) ; end
+    def voiceMail(id) Skype::VoiceMail.new(id) ; end
     
-    def sms(id) SkypeAPI::SMS.new(id) ; end
+    def sms(id) Skype::SMS.new(id) ; end
     
-    def app(id) SkypeAPI::Application.new(id) ; end
+    def app(id) Skype::Application.new(id) ; end
     
-    def group(id) SkypeAPI::Group.new(id) ; end
+    def group(id) Skype::Group.new(id) ; end
 
-    def fileTransfer(id) SkypeAPI::FileTransfer.new(id) ; end
+    def fileTransfer(id) Skype::FileTransfer.new(id) ; end
     
-    def event(id) SkypeAPI::Event.new(id) ; end
+    def event(id) Skype::Event.new(id) ; end
     
-    def menuItem(id) SkypeAPI::MenuItem.new(id) ; end
+    def menuItem(id) Skype::MenuItem.new(id) ; end
     
   end
 
@@ -281,7 +285,16 @@ module SkypeAPI
     alias resetIdleTimer reset_idle_timer
 
     def get_auto_away() parse :auto_away, invoke_get("AUTOAWAY") end
-    def_parser(:auto_away,"AUTOAWAY"){|str| str._flag}
+    def_parser(:auto_away,"AUTOAWAY"){|str|
+      case str
+      when /ON/
+        true
+      when /OFF/
+        false
+      else
+        str
+      end
+    }
     alias getAutoAway get_auto_away
 
     def set_auto_away(flag) parse :auto_away, invoke_set('AUTOAWAY', flag._swi) end
@@ -431,7 +444,7 @@ module SkypeAPI
     alias btn_released BTNReleased
 
     def get_contacts_focused() parse :contacts_focused, invoke_get("CONTACTS_FOCUSED") end
-    def_parser(:contacts_focused){|str| SkypeAPI::User.new str}
+    def_parser(:contacts_focused){|str| Skype::User.new str}
     alias getContactsFocused get_contacts_focused
   
     def get_ui_language() invoke_get("UI_LANGUAGE") end

data/lib/{skypeapi → skype}/application.rb

@@ -1,10 +1,10 @@
-module SkypeAPI
+module Skype
   class Application < AbstractObject
     class Stream
       def initialize app, streamString
         @app = app
         @id = streamString
-        @user = SkypeAPI.user(@id.split(':')[0])
+        @user = Skype.user(@id.split(':')[0])
       end
 
       def to_s
@@ -35,11 +35,11 @@ module SkypeAPI
     OBJECT_NAME = "APPLICATION"
 
     def get_connectable() parse :connectable, invoke_get("CONNECTABLE") end
-    def_parser(:connectable){|str| str.split(' ').collect{|i| SkypeAPI.user(i)}}
+    def_parser(:connectable){|str| str.split(' ').collect{|i| Skype.user(i)}}
     alias getConnectable get_connectable
 
     def get_connecting() parse :connecting, invoke_get("CONNECTING") end
-    def_parser(:connecting){|str| str.split(' ').collect{|i| SkypeAPI.user(i)}}
+    def_parser(:connecting){|str| str.split(' ').collect{|i| Skype.user(i)}}
     alias getConnecting get_connecting
 
     def get_streams() parse :streams, invoke_get("STREAMS") end
@@ -66,7 +66,7 @@ module SkypeAPI
 
     def_parser(:datagram){|str|
       user,data = str.split(' ',2)
-      [SkypeAPI.user(user), data]
+      [Skype.user(user), data]
     }
 
     def self.create appName

data/lib/{skypeapi → skype}/call.rb

@@ -1,10 +1,10 @@
-module SkypeAPI
+module Skype
   class Call < AbstractObject
     OBJECT_NAME = "CALL"
 
     def self.create *targets
-      res = (SkypeAPI.invoke_one "CALL " + targets.join(", "),"CALL").split(" ")
-      #return SkypeAPI::Call.new(res[0]),res[2]
+      res = (Skype.invoke_one "CALL " + targets.join(", "),"CALL").split(" ")
+      #return Skype::Call.new(res[0]),res[2]
       new res[0]
     end
 
@@ -13,7 +13,7 @@ module SkypeAPI
     alias getTimestamp get_timestamp
 
     def get_partner() parse :partner, invoke_get("PARTNER_HANDLE") end
-    def_parser(:partner,'PARTNER_HANDLE'){|str| SkypeAPI::User.new str}
+    def_parser(:partner,'PARTNER_HANDLE'){|str| Skype::User.new str}
     alias getPartner get_partner
 
     def get_partner_dispname() invoke_get("PARTNER_DISPNAME") end
@@ -74,7 +74,7 @@ module SkypeAPI
     #?CALL 59 CONF_PARTICIPANT 1 echo123 INCOMING_P2P INPROGRESS Echo Test Service .
     def_parser(:conf_participant, 'CONF_PARTICIPANT'){|str|
       res = str.split(' ')
-      res[1] = SkypeAPI::User.new res[1] if res[1]
+      res[1] = Skype::User.new res[1] if res[1]
       res
     }
 
@@ -82,7 +82,7 @@ module SkypeAPI
     def get_conf_participant num
       str = invoke_get "CONF_PARTICIPANT #{num}"
       res = str.split(' ')
-      res[0] = SkypeAPI::User.new res[0]
+      res[0] = Skype::User.new res[0]
       res
     end
     alias getConfParticipant get_conf_participant
@@ -124,7 +124,7 @@ module SkypeAPI
     alias getVAAInputStatus get_vaa_input_status
 
     def get_forwarded_by() parse :forwarded_by, invoke_get("FORWARDED_BY") end
-    def_parser(:forwarded_by){|str| (str.empty? or str == '?') ? nil : SkypeAPI::User.new(str)}
+    def_parser(:forwarded_by){|str| (str.empty? or str == '?') ? nil : Skype::User.new(str)}
     alias getForwardedBy get_forwarded_by
 
     def get_transfer_active?() parse :transfer_active, invoke_get("TRANSFER_ACTIVE") end
@@ -136,11 +136,11 @@ module SkypeAPI
     alias getTransferStatus get_transfer_status
 
     def get_transferred_by() parse :transferred_by, invoke_get("TRANSFERRED_BY") end
-    def_parser(:transferred_by){|str| str.empty? ? nil : SkypeAPI::User.new(str)}
+    def_parser(:transferred_by){|str| str.empty? ? nil : Skype::User.new(str)}
     alias getTransferredBy get_transferred_by
 
     def get_transferred_to() parse :transferred_to, invoke_get("TRANSFERRED_TO") end
-    def_parser(:transferred_to){|str| str.empty? ? nil : SkypeAPI::User.new(str)}
+    def_parser(:transferred_to){|str| str.empty? ? nil : Skype::User.new(str)}
     alias getTransferredTo get_transferred_to
 
     def get_can_transfer user