warchat 0.0.9 → 0.0.10

data/README.rdoc

@@ -25,6 +25,10 @@ This is a simple chat client that will let you talk in guild chat and receive me
   PASSWORD = ''
   CHARACTER_NAME = ''
   CHARACTER_REALM = ''
+  HOST = "m.us.wowarmory.com" 
+  #HOST = "m.eu.wowarmory.com"
+  #HOST = "m.kr.wowarmory.com"
+  PORT = 8780
 
   client = Warchat::Chat::Client.new
 
@@ -35,18 +39,18 @@ This is a simple chat client that will let you talk in guild chat and receive me
   client.on_message = Proc.new do |message|
     case message.type
       when Warchat::Chat::Message::CHAT_MSG_TYPE_GUILD_CHAT
-        puts "[Guild] #{message.character_name}: #{message.body}"
+        puts "[Guild] #{message.character.name}: #{message.body}"
       when Warchat::Chat::Message::CHAT_MSG_TYPE_GUILD_MOTD
         puts "MOTD: #{message.body}"
       when Warchat::Chat::Message::CHAT_MSG_TYPE_OFFICER_CHAT
-        puts "[Officer] #{message.character_name}: #{message.body}"
+        puts "[Officer] #{message.character.name}: #{message.body}"
       when Warchat::Chat::Message::CHAT_MSG_TYPE_WHISPER
-        puts "[Whisper] #{message.character_name}: #{message.body}"
+        puts "[Whisper] #{message.character.name}: #{message.body}"
     end
   end
 
   begin
-    client.start(USERNAME,PASSWORD)
+    client.start(USERNAME,PASSWORD,HOST,PORT)
     loop do 
       msg = gets.chomp 
       client.message msg,Warchat::Chat::Message::CHAT_MSG_TYPE_GUILD_CHAT

data/lib/warchat.rb

@@ -1,7 +1,18 @@
 # encoding: ASCII-8BIT
-require 'active_support/inflector'
+require 'active_support/all'
 
 module Warchat  
+  def self.debug message
+    puts message if self.debug?
+  end
+  
+  def self.debug?
+    @debug and true or false
+  end
+  
+  def self.enable_debug v
+    @debug = v
+  end
 end
 
-[['*.rb'],['network','*.rb'],['srp','*.rb'],['chat','*.rb']].each do |p| Dir.glob(File.join(File.expand_path('../warchat',__FILE__),*p)).each &method(:require) end
+[[],['network'],['srp'],['chat'],['models']].each do |p| Dir.glob(File.join(File.expand_path('../warchat',__FILE__),*(p << '*.rb')),&method(:require)) end

data/lib/warchat/chat/ack.rb

@@ -0,0 +1,7 @@
+module Warchat
+  module Chat
+    class Ack
+      
+    end
+  end
+end

data/lib/warchat/chat/client.rb

@@ -1,23 +1,22 @@
 # encoding: ASCII-8BIT
 module Warchat
   module Chat
-    class Warchat::Chat::Client
-      attr_accessor :on_message,:on_presence,:on_logout,:on_fail,:on_establish
+    class Client
+      attr_accessor :on_message,:on_presence,:on_logout,:on_fail,:on_establish,:on_presence_change,:on_ack
       attr_accessor :on_message_afk,:on_message_dnd,:on_message_guild_chat,:on_message_motd,:on_message_officer_chat,:on_message_whisper,:on_chat_logout
       
-      attr_reader :session,:character_name,:character_realm
+      attr_reader :session,:character_name,:character_realm,:online_characters,:last_whisper
 
       def initialize
         @session = Warchat::Network::Session.new
-
         [:receive,:establish,:error].each do |m| 
           session.send("on_#{m}=".to_sym, method("session_#{m}".to_sym)) 
         end
       end
       
-      def start username, password
+      def start account_name, account_password,host="m.us.wowarmory.com",port=8780
         [username,password].each do |s| s.respond_to? :force_encoding and s.force_encoding(__ENCODING__) end
-        self.session.start(username,password)
+        self.session.start(account_name,account_password,host,port)
       end
 
       def session_error response
@@ -38,7 +37,7 @@ module Warchat
         [character_name,character_realm].each do |s| s.respond_to? :force_encoding and s.force_encoding(__ENCODING__) end
         request = Warchat::Network::Request.new("/chat-login",:options=>{:mature_filter=>'false'},:n=>character_name,:r=>character_realm)
         session.send_request(request)
-        @timer = Warchat::Timer.new(30) do keep_alive end
+        @timer = Warchat::Timer.new(60) do keep_alive end
       end
 
       def logout
@@ -46,28 +45,33 @@ module Warchat
       end
 
       def chat_logout response
-        puts 'Logged out of chat'
+        Warchat.debug 'Logged out of chat'
         @timer and @timer.stop
         on_chat_logout and on_chat_logout.call response
         session.close
       end
 
       def chat_login response
-        puts "Logged into chat"
+        Warchat.debug "Logged into chat"
         @chat_session_id = response["chatSessionId"]
       end
+      
+      def chat_presence presence
+        on_presence and on_presence.call(presence)
+      end
 
       def chat response
         response.extend(Warchat::Chat::ChatResponse)
         if response.ack?
-          
+          on_ack and on_ack.call response
         elsif response.message?
           message = Warchat::Chat::Message.new(response)
+          @last_whisper = message if message.whisper?
           [on_message,send("on_message_#{message.type}".to_sym)].compact.each do |m| m.call(message) end
         elsif response.presence?
-          on_presence and on_presence.call(Presence.new(response))
+          chat_presence Warchat::Chat::Presence.new(response)
         else
-          puts "unhandled chat type: #{response.chat_type}"
+          Warchat.debug "unhandled chat type: #{response.chat_type}"
         end
       end
 
@@ -82,7 +86,7 @@ module Warchat
       end
 
       def keep_alive
-        puts 'keep alive'
+        Warchat.debug 'keep alive'
         request = Warchat::Network::Request.new("/ah-mail",:n=>character_name,:r=>character_realm)
         session.send_request(request)
       end

data/lib/warchat/chat/message.rb

@@ -2,10 +2,6 @@
 module Warchat
   module Chat
     class Message
-      CHAT_ID_TYPE_CHARACTER = "character"
-      CHAT_ID_TYPE_GUILD = "guild"
-      CHAT_ID_TYPE_GUILD_MEMBER = "guild_member"
-
       CHAT_MSG_TYPE_AFK = "afk"
       CHAT_MSG_TYPE_DND = "dnd"
       CHAT_MSG_TYPE_GUILD_CHAT = "guild_chat"
@@ -13,24 +9,31 @@ module Warchat
       CHAT_MSG_TYPE_OFFICER_CHAT = "officer_chat"
       CHAT_MSG_TYPE_WHISPER = "whisper"
 
-      attr_reader :type,:body,:from_type,:character_id,:from
+      attr_reader :type,:body
       
       def initialize response
+        @response = response 
         @type = response["messageType"]
         @body = response['body']
-        @from = response["from"]
-        if @from
-          @from_type = from["chatIdType"]
-          @character_id = from["characterId"]
-        end
+        @from = (response["from"] or {})
       end
-
-      def character_name
-        @character_id and @character_id.split(':')[-2]
+      
+      def guild
+        return @guild if @guild or @from["guildId"].nil?
+        _,name,realm = @response['from']["guildId"].split(':')
+        @guild = Warchat::Models::Guild.find_or_create 'n' => name,'r'=>realm
       end
-
-      def realm_id
-        @character_id and @character_id.split(':').last
+      
+      def character
+        return @character if @character or @from["characterId"].nil?
+        _,name,realm = @from["characterId"].split(':')
+        @character = Warchat::Models::Character.find_or_create 'n' => name,'r'=>realm
+      end
+      
+      constants.select do |c| c[0..13] == 'CHAT_MSG_TYPE_' end.map do |c| "Warchat::Chat::Message::#{c}" end.each do |c|
+        define_method "#{c.constantize}?".to_sym do 
+          type == c.constantize
+        end
       end
     end
   end

data/lib/warchat/chat/presence.rb

@@ -1,23 +1,39 @@
 # encoding: ASCII-8BIT
 module Warchat
   module Chat
-    class Presence    
-      attr_reader :name,:character
-
+    class Presence
+      STATUS_OFFLINE = 'offline'
+      STATUS_ONLINE = 'online'
+      
       def initialize response
-        @type = response["presenceType"];
-        @character = response["character"];
-        @name = character["n"];
+        @response = response
+        @type = response["presenceType"]
+
+        character.respond_to? status.to_sym and character.send status.to_sym
+        
+      end
+      
+      def character
+        @character ||= (@response["character"] and Warchat::Models::Character.find_or_create(@response["character"]) or nil)
       end
 
       def offline?
         @type and @type.include? 'offline'
       end
+      
+      def status 
+        return 'unknown' unless @type
+        @type.split('_').first
+      end
 
-      def type 
+      def client_type 
         return 'unknown' unless @type
         @type.split('_')[1..-1].join '_'
       end
+      
+      def inspect
+        "<#{self.class.name} character:#{character.inspect} status:#{status.inspect} client_type:#{client_type.inspect}>"
+      end
     end
   end
 end

data/lib/warchat/model.rb

@@ -0,0 +1,53 @@
+module Warchat
+  class Model
+    class << self
+      def find_or_create data
+        find(data).tap do |m| m and m.update(data) end or new(data)
+      end
+  
+      def find data
+        realm,name = data['r'],data['n']
+        mutex.synchronize do all[realm] and all[realm][name] or nil end
+      end
+  
+      def mutex
+        @mutex ||= Mutex.new
+      end
+  
+      def all
+        @all ||= {}
+      end
+      
+      private      
+      def add m
+        mutex.synchronize do 
+          all[m.realm] ||= {}
+          all[m.realm][m.name] and all[m.realm][m.name].update(m.data) or all[m.realm][m.name] = m
+        end
+      end
+    end
+    
+    attr_accessor :data
+
+    def initialize data
+      @data = data
+      self.class.send(:add,self)
+    end
+    
+    def id 
+      [self.class.name.underscore,name,realm].join ':'
+    end
+    
+    def update data
+      @data = @data.merge data
+    end
+    
+    def name
+      data['n']
+    end
+    
+    def realm
+      data['r']
+    end
+  end
+end

data/lib/warchat/models/character.rb

@@ -0,0 +1,51 @@
+module Warchat
+  module Models
+    class Character < Warchat::Model
+      CLASSES = {1=>'Warrior',2=>'Paladin',3=>'Hunter',4=>'Rogue',5=>'Priest',6=>'Death Knight',7=>'Shaman',8=>'Mage',9=>'Warlock',11=>'Druid'}
+      RACES = {1=>'Human',2=>'Orc',3=>'Dwarf',4=>'Night Elf',5=>'Forsaken',6=>'Tauren',7=>'Gnome',8=>'Troll',9=>'Goblin',10=>'Blood Elf',11=>'Draenei',22=>'Worgen'}
+      
+      class << self
+        def online
+          all.select &:online?
+        end
+      end
+      
+      def initialize data
+        super
+        @count = 0
+      end
+      
+      def level
+        data['l']
+      end
+      
+      def rank
+        data['grank']
+      end
+      
+      def klass
+        CLASSES[data['c']]
+      end
+      
+      def race
+        RACES[data['ra']]
+      end
+        
+      def online?
+        count > 0 
+      end
+      
+      def online
+        @count += 1
+      end
+      
+      def offline
+        @count -= 1
+      end
+      
+      def inspect
+        "<#{self.class.name} name:#{name.inspect} realm:#{realm.inspect} klass:#{klass.inspect} level:#{level.inspect} race:#{race.inspect}>"
+      end
+    end
+  end
+end

data/lib/warchat/models/guild.rb

@@ -0,0 +1,7 @@
+module Warchat
+  module Models
+    class Guild < Warchat::Model
+      
+    end
+  end
+end

data/lib/warchat/network/binary_reader.rb

@@ -37,11 +37,15 @@ module Warchat
         end.flatten(1)]
       end
 
-      {16=>'n',32=>'N',64=>'L_'}.each do |size,directive| 
+      {16=>'n',32=>'N'}.each do |size,directive| 
         define_method "int_#{size}".to_sym do 
           substream(size/8).unpack(directive).first
         end 
       end
+      
+      def int_64
+        [substream(8).unpack('L_').first.to_s(16)].pack('H*').reverse.unpack('H*').first.hex
+      end
 
       def boolean
         byte == "\001"

data/lib/warchat/network/connection.rb

@@ -6,19 +6,15 @@ module Warchat
   module Network
     class Connection
 
-      attr_accessor :host,:port,:on_send,:on_receive,:on_close
+      attr_accessor :on_send,:on_receive,:on_close
 
-      def initialize *args
-        options = args.pop if args.last.is_a? Hash
-
-        self.host = (args.shift or "m.us.wowarmory.com")
-        self.port = (args.shift or 8780)
+      def initialize
         @closed = true
         @queue = []
         @mutex = Mutex.new
       end
 
-      def start
+      def start host="m.us.wowarmory.com",port=8780
         close
 
         @closed = false;
@@ -59,8 +55,8 @@ module Warchat
           sleep 0.01
         end
       rescue Exception => e
-        puts e.message
-        puts e.backtrace unless e.is_a? IOError
+        Warchat.debug e.message
+        Warchat.debug e.backtrace unless e.is_a? IOError
       end
 
       def handle_requests
@@ -78,8 +74,8 @@ module Warchat
           sleep 0.01
         end
       rescue Exception => e
-        puts e.message
-        puts e.backtrace
+        Warchat.debug e.message
+        Warchat.debug e.backtrace
       end
     end
   end

data/lib/warchat/network/session.rb

@@ -13,11 +13,11 @@ module Warchat
         @connection.on_receive = method(:connection_receive)
       end
 
-      def start account_name, password
+      def start account_name, account_password,host="m.us.wowarmory.com",port=8780
         @account_name = account_name
-        @password = password
+        @account_password = account_password
 
-        @connection.start
+        @connection.start host,port
 
         @srp = Warchat::Srp::Client.new
 
@@ -55,7 +55,7 @@ module Warchat
       end
 
       def stage_1 response
-        proof = @srp.auth1_proof(response["user"], @password[0..15].upcase, response["salt"], response["B"])
+        proof = @srp.auth1_proof(response["user"], @account_password[0..15].upcase, response["salt"], response["B"])
         send_request(Request.new("/authenticate2",:clientProof=>proof))
       end
 
@@ -74,7 +74,7 @@ module Warchat
           respond_to? m and send(m,response) or on_receive and on_receive.call(response)
         else
           error = response["body"]
-          puts("error: " + error)
+          Warchat.debug("error: " + error)
           close(error) if respond_to? m
         end      
       end

data/lib/warchat/timer.rb

@@ -15,8 +15,8 @@ module Warchat
             begin
               handler.call
             rescue Exception => e
-              puts e.message
-              puts e.backtrace
+              Warchat.debug e.message
+              Warchat.debug e.backtrace
             end
           end
         end

data/lib/warchat/version.rb

@@ -1,4 +1,4 @@
 # encoding: ASCII-8BIT
 module Warchat  
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: warchat
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 11
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Zachary Gavin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
+date: 2011-05-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,10 +66,14 @@ files:
 - Rakefile
 - lib/warchat.rb
 - lib/warchat/byte_string.rb
+- lib/warchat/chat/ack.rb
 - lib/warchat/chat/chat_response.rb
 - lib/warchat/chat/client.rb
 - lib/warchat/chat/message.rb
 - lib/warchat/chat/presence.rb
+- lib/warchat/model.rb
+- lib/warchat/models/character.rb
+- lib/warchat/models/guild.rb
 - lib/warchat/network/binary_reader.rb
 - lib/warchat/network/binary_writer.rb
 - lib/warchat/network/connection.rb
@@ -110,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: warchat
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A simple interface to World of Warcraft Remote Guild Chat based off Eike Siewertsen's C# implementation