gruby 0.2.1

data/.gitignore

@@ -0,0 +1,6 @@
+# svn propset svn:ignore -F .svnignore .
+# svn propedit svn:ignore .
+doc
+pkg
+.rake_tasks
+*.gem

data/CHANGELOG.rdoc

@@ -0,0 +1,11 @@
+== 0.2.1 / 2007-08-11
+  * added gruby.rb file
+
+== 0.2.0 / 2007-08-05
+  * uri-open instead of socket in connection_params method
+  * few callback added
+  * readme files
+  * new rake file
+
+== 0.1.0 / 2007-04-15
+  * initial version

data/README.rdoc

@@ -0,0 +1,52 @@
+== GRuby
+    http://gruby.rubyforge.org 
+    http://fazibear.prv.pl
+
+== DESCRIPTION:
+  
+Gadu-Gadu protocol implementation in Ruby language
+
+== FEATURES/PROBLEMS:
+  
+* loggin
+* set status
+* set status messages
+* send messages
+* recive messages
+
+== SYNOPSIS:
+
+  require File.dirname(__FILE__) + '/../lib/GRuby'
+
+  gg_uin  = ''
+  gg_pass = ''
+
+  gg = GG::new_session :uin => gg_uin, :password => gg_pass
+  gg.on_recive_message do |m|
+    gg.set_status :status => GG::STATUS_AVAIL_DESCR, :description => m.message
+    gg.send_message :uin => m.sender, :message => "Status '#{m.message}' was set"
+  end
+  gg.set_status :status => GG::STATUS_AVAIL_DESCR, :description => "Send me new status :)"
+
+  gets
+
+== REQUIREMENTS:
+
+* ruby
+* gadu-gadu account
+
+== INSTALL:
+
+* sudo gem install gruby
+
+== LICENSE:
+
+GRuby - Gadu-Gadu protocol implementation in Ruby language
+
+Copyright (C) 2007 Michal Kalbarczyk
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gruby"
+    gemspec.summary = "Gadu-Gadu protocol implementation in Ruby language"
+    gemspec.email = "fazibear@gmail.com"
+    gemspec.homepage = "http://github.com/fazibear/gruby"
+    gemspec.description = "Gadu-Gadu protocol implementation in Ruby language"
+    gemspec.authors = ["fazibear"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/examples/status.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/GRuby'
+
+gg_uin  = ''
+gg_pass = ''
+
+gg = GG::new_session :uin => gg_uin, :password => gg_pass
+gg.on_recive_message do |m|
+	gg.set_status :status => GG::STATUS_AVAIL_DESCR, :description => m.message
+	gg.send_message :uin => m.sender, :message => "Status '#{m.message}' was set"
+end
+gg.set_status :status => GG::STATUS_AVAIL_DESCR, :description => "Send me new status :)"
+
+gets

data/gruby.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gruby}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["fazibear"]
+  s.date = %q{2009-11-23}
+  s.description = %q{Gadu-Gadu protocol implementation in Ruby language}
+  s.email = %q{fazibear@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.rdoc",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/status.rb",
+     "gruby.gemspec",
+     "lib/GRuby/GG.rb",
+     "lib/GRuby/GG_constants.rb",
+     "lib/GRuby/GG_packets.rb",
+     "lib/GRuby/GG_utils.rb",
+     "lib/gruby.rb",
+     "test/test_GRuby.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/fazibear/gruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gadu-Gadu protocol implementation in Ruby language}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_GRuby.rb",
+     "examples/status.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/GRuby/GG.rb

@@ -0,0 +1,145 @@
+module GG
+
+  #
+  # Return new GG session
+  #
+  def self.new_session( params )
+    Session.new( params )
+  end 
+
+  class Session
+
+    attr_reader :connected
+
+    def initialize( params )
+      @uin = params[:uin]
+      @password = params[:password]
+	  @message_seq = 0
+      @connected = true
+      @logged = false
+      @socket = nil
+      @wait4login = true 
+      @wait4login = params[:async] unless params[:async].nil?
+      
+	  # callbacks
+	  @revice_msg_callback = nil
+	  @login_failed_callback = lambda do exit end
+	  @disconnecting_callback = lambda do exit end
+	  
+	  socket_thread = Thread.new do
+        begin
+          params = GG::connection_params
+          @socket = TCPSocket.new( params['host'] , params['port'] )
+          while @connected do
+            begin
+              r_packet = PACKET.new
+              puts ":: Wait for data ..." if $DEBUG
+              r_packet.header = @socket.read r_packet.header_length
+              r_packet.data   = @socket.read r_packet.length
+            rescue => e
+              @logged = false
+              @connected = false
+            end
+            case r_packet.type
+            when WELCOME
+              r_packet.type   = PACKET_WELCOME
+              s_packet        = PACKET.new
+              s_packet.type   = PACKET_LOGIN60
+              s_packet.uin    = @uin.to_i
+              s_packet.hash   = GG::login_hash( @password, r_packet.seed )
+
+              @socket.write s_packet.packed
+              puts "++ #{s_packet} send" if $DEBUG
+              s_packet = s_packet.destroy
+            when LOGIN_OK
+              @logged = true
+              @wait4login = false
+            when RECV_MSG
+              r_packet.type   = PACKET_RECV_MSG
+              @recive_msg_callback.call r_packet if @recive_msg_callback
+            when SEND_MSG_ACK
+              r_packet.type =   PACKET_SEND_MSG_ACK
+			when LOGIN_FAILED
+			  puts "!! Login failed" if $DEBUG
+			  @login_failed_callback.call if @login_failed_callback
+			when DISCONNECTING
+			  puts "!! Disconecting" if $DEBUG
+			  @disconnecting_callback.call if @disconnecting_callback
+			else
+              puts "?? Unknown packet" if $DEBUG 
+            end
+            r_packet = r_packet.destroy
+          end
+          puts ":: Disconected" if $DEBUG
+        rescue => e
+          puts "!! Exception: #{e}" if $DEBUG
+          puts "Something went wrong :)" unless $DEBUG
+          exit 0
+        end
+      end
+      while @wait4login do
+        sleep 1
+      end
+    end
+
+
+    #
+    # Recive message callback
+    #
+	def on_recive_message( &block )
+      @recive_msg_callback = block;
+    end
+
+    #
+    # Login failed callback
+    #
+    def on_login_failed( &block )
+      @login_failed = block;
+    end
+    
+    #
+    # Disconnecting callback
+    #
+    def on_diconnect( &block )
+      @disconnecting_callback = block;
+    end
+	
+	#
+    # Send message
+    #   :uin => GG reciver number 
+    #   :message => message text
+    #
+    def send_message( params )
+      if @logged
+        s_packet           = PACKET.new
+        s_packet.type      = PACKET_SEND_MSG
+        s_packet.recipient = params[:uin]
+        s_packet.message   = params[:message]
+
+        @socket.write s_packet.packed
+        puts "++ #{s_packet} send" if $DEBUG
+        s_packet = s_packet.destroy
+      end
+    end
+    
+    #
+    # Set new status.
+    #   :status => new status, see constans.
+    #   :description => new description
+    #
+    def set_status( params )
+      if @logged
+        s_packet = PACKET.new
+        s_packet.type = PACKET_NEW_STATUS
+        s_packet.status = params[:status]
+        s_packet.description = params[:description]
+
+        @socket.write s_packet.packed
+        puts "++ #{s_packet} send" if $DEBUG
+        s_packet = s_packet.destroy
+      end
+    end
+
+  end
+end
+

data/lib/GRuby/GG_constants.rb

@@ -0,0 +1,42 @@
+module GG
+  HEADER             = 0x0000
+  NEW_STATUS         = 0x0002
+  PONG               = 0x0007
+  PING               = 0x0008
+  SEND_MSG           = 0x000b
+  LOGIN              = 0x000c
+  ADD_NOTIFY         = 0x000d
+  REMOVE_NOTIFY      = 0x000e
+  NOTIFY_FIRST       = 0x000f
+  NOTIFY_LAST        = 0x0010
+  LIST_EMPTY         = 0x0012
+  LOGIN_EXT          = 0x0013
+  PUBDIR50_REQUEST   = 0x0014
+  LOGIN60            = 0x0015
+  USERLIST_REQUEST   = 0x0016
+
+  WELCOME            = 0x0001
+  STATUS             = 0x0002
+  LOGIN_OK           = 0x0003
+  SEND_MSG_ACK       = 0x0005
+  LOGIN_FAILED       = 0x0009
+  RECV_MSG           = 0x000a
+  DISCONNECTING      = 0x000b
+  NOTIFY_REPLY       = 0x000c
+  PUBDIR50_REPLY     = 0x000e
+  STATUS60           = 0x000f
+  USERLIST_REPLY     = 0x0010
+  NOTIFY_REPLY60     = 0x0011
+  NEED_EMAIL         = 0x0014
+
+  STATUS_NOT_AVAIL        = 0x0001
+  STATUS_NOT_AVAIL_DESCR  = 0x0015
+  STATUS_AVAIL            = 0x0002
+  STATUS_AVAIL_DESCR      = 0x0004
+  STATUS_BUSY             = 0x0003
+  STATUS_BUSY_DESCR       = 0x0005
+  STATUS_INVISIBLE        = 0x0014
+  STATUS_INVISIBLE_DESCR  = 0x0016
+  STATUS_BLOCKED          = 0x0006
+  STATUS_FRIENDS_MASK     = 0x8000
+end

data/lib/GRuby/GG_packets.rb

@@ -0,0 +1,241 @@
+module GG
+  
+  #
+  # GG Packet class
+  #
+  class PACKET
+    def initialize
+      puts "++ #{self} created" if $DEBUG
+    end
+
+    def destroy
+      puts "++ #{self} destroyed" if $DEBUG
+      nil
+    end
+
+    def header=(data)
+      unpacked = data.unpack 'II'
+      @type, @length = unpacked
+      puts "++ #{self} recived header ... type:#{@type} length:#{@length}" if $DEBUG
+    end
+
+    def header_length
+      8
+    end
+
+    def type
+      @type
+    end
+
+    def length
+      @length
+    end
+
+    def type=(type)
+      begin
+        self.extend	type
+        puts "++ #{self} extend to #{type}" if $DEBUG
+        fields @data if @data
+      rescue => e
+        raise "class extend ... #{e}"
+      end
+    end
+
+    def data=(data)
+      @data = data
+      puts "++ #{self} recived data" if $DEBUG
+    end
+
+    def pack(pattern)
+      begin
+        puts "++ #{self} data packed" if $DEBUG
+        packet.pack pattern
+      rescue => e
+        raise "packet pack ... #{e}"
+      end
+    end
+  end
+
+  # RECV PACKETS #
+
+  module PACKET_WELCOME
+    attr_reader :seed
+
+    def type
+      WELCOME
+    end
+
+    def fields(data)
+      unpacked = data.unpack 'I'
+      @seed = unpacked[0]
+    end
+  end
+
+  module PACKET_RECV_MSG
+    attr_reader :sender		# numer nadawcy
+    attr_reader :seq		  # numer sekwencyjny
+    attr_reader :time			# czas nadania
+    attr_reader :class		# klasa wiadomości
+    attr_reader :message	# treść wiadomości
+
+    def type
+      RECV_MSG
+    end
+
+    def fields(data)
+      unpacked = data.unpack 'IIIIZ*'
+      @sender,
+      @seq,
+      @time,
+      @class,
+      @message = unpacked
+    end
+
+  end
+
+  module PACKET_SEND_MSG_ACK
+    attr_reader :status	   # stan wiadomości */
+    attr_reader :recipient # numer odbiorcy */
+    attr_reader :seq 	     # numer sekwencyjny */
+
+    def type
+      SEND_MSG_ACK
+    end
+
+    def fields(data)
+      unpacked = data.unpack 'III'
+      @status,
+      @recipient,
+      @seq = unpacked
+    end
+  end
+
+  # SEND PACKECTS #
+
+  module PACKET_LOGIN60
+    attr_writer :uin           # mój numerek
+    attr_writer :hash          # hash hasła */
+    attr_writer :status        # status na dzień dobry */
+    attr_writer :version       # moja wersja klienta */
+    attr_writer :unknown1      # 0x00 */
+    attr_writer :local_ip      # mój adres ip */
+    attr_writer :local_port    # port, na którym słucham */
+    attr_writer :external_ip   # zewnętrzny adres ip */
+    attr_writer :external_port # zewnętrzny port */
+    attr_writer :image_size    # maksymalny rozmiar grafiki w KB */
+    attr_writer :unknown2      # 0xbe */
+    attr_writer :description   # opis, nie musi wystąpić */
+    attr_writer :time          # czas, nie musi wystąpić */
+
+    def type
+      LOGIN60
+    end
+
+    def packet
+      [
+        type,
+        length,
+        @uin           ? @uin              : 0,
+        @hash          ? @hash             : 0,
+        @status        ? @status           : 0,
+        @version       ? @version          : 0x22,
+        @unknown1      ? @unknown1         : 0,
+        @local_ip      ? @local_ip         : 0,
+        @local_port    ? @local_port       : 0,
+        @external_ip   ? @external_ip      : 0,
+        @external_port ? @external_port    : 0,
+        @image_size    ? @image_size       : 0,
+        @unknown2      ? @unknown2         : 0xBE,
+        @description   ? "#{@description}" : "\0",
+        @time          ? @time             : 0
+      ]
+    end
+
+    def length
+      4+4+4+4+1+4+2+4+2+1+1+(@description ? @description.length : 1)+4
+    end
+
+    def packed
+      pack 'II IIIIcIsIsccA*I'
+    end
+
+  end
+
+  module PACKET_NEW_STATUS
+    attr_writer :status				# na jaki zmienić? */
+    attr_writer :description		# opis, nie musi wystąpić */
+    attr_writer :time				# czas, nie musi wystąpić */
+
+    def type
+      NEW_STATUS
+    end
+
+    def packet
+      [
+        type,
+        length,
+        @status      ? @status           : 0,
+        @description ? "#{@description}" : "\0",
+        @time        ? @time             : 0
+      ]
+    end
+
+    def length
+      4+(@description ? @description.length : 1)+4
+    end
+
+    def packed
+      pack 'II IA*I'
+    end
+  end
+
+  module PACKET_LIST_EMPTY
+    def type
+      LIST_EMPTY
+    end
+    def packet
+      [
+        type,
+        length
+      ]
+    end
+
+    def length
+      0
+    end
+
+    def packed
+      pack 'II'
+    end
+  end
+
+  module PACKET_SEND_MSG
+    attr_writer :recipient		# numer odbiorcy */
+    attr_writer :seq		      # numer sekwencyjny */
+    attr_writer :class 				# klasa wiadomości */
+    attr_writer :message		  # treść */
+
+    def type
+      SEND_MSG
+    end
+
+    def packet
+      [
+        type,
+        length,
+        @recipient ? @recipient     : 0,
+        @seq       ? @seq           : 0,
+        @class     ? @class         : 0x0008,
+        @message   ? "#{@message}"  : "\0"
+      ]
+    end
+
+    def length
+      4+4+4+@message.length
+    end
+
+    def packed
+      pack 'II IIIA*'
+    end
+  end
+end

data/lib/GRuby/GG_utils.rb

@@ -0,0 +1,50 @@
+module GG
+  
+  #
+  # Return calculated password hash.
+  #
+  def self.login_hash ( password, seed )
+    x = 0;
+    y = seed;
+    z = 0;
+
+    password.each_byte do |char|
+      x = ( x & 0xffffff00 ) | char.to_i
+      y ^= x;
+      y &= 0xffffffff
+      y += x;
+      y &= 0xffffffff
+      x <<= 8;
+      x &= 0xffffffff
+      y ^= x;
+      y &= 0xffffffff
+      x <<= 8;
+      x &= 0xffffffff
+      y -= x;
+      y &= 0xffffffff
+      x <<= 8;
+      x &= 0xffffffff
+      y ^= x;
+      y &= 0xffffffff
+      z = y & 0x1f;
+      z &= 0xffffffff
+      y = (y << z) | (y >> (32 - z))
+      y &= 0xffffffff
+    end
+    return y;
+  end
+
+  # 
+  # Return connection params returned from gg server.
+  #
+  def self.connection_params
+    require 'open-uri'
+	gg_connection = open("http://appmsg.gadu-gadu.pl/appsvc/appmsg4.asp?fmnumber=").readlines[0].split(/\s/)[2].split(':')
+	gg_connection_param = { 
+    	'host' => gg_connection[0],
+    	'port' => gg_connection[1]
+    }
+    puts ":: Connection params ... host:#{gg_connection_param['host']} port:#{gg_connection_param['port']}" if $DEBUG
+    return gg_connection_param
+  end
+end

data/lib/gruby.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'GRuby/*.rb')].each { |lib| require lib }

data/test/test_GRuby.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGRuby < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_hash
+    hash_t = GG::login_hash('GG_HASH_TEST', 12345)
+    hash_e = 2990357796
+    assert_equal( hash_t, hash_e )
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/GRuby'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: gruby
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- fazibear
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Gadu-Gadu protocol implementation in Ruby language
+email: fazibear@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/status.rb
+- gruby.gemspec
+- lib/GRuby/GG.rb
+- lib/GRuby/GG_constants.rb
+- lib/GRuby/GG_packets.rb
+- lib/GRuby/GG_utils.rb
+- lib/gruby.rb
+- test/test_GRuby.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fazibear/gruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gadu-Gadu protocol implementation in Ruby language
+test_files: 
+- test/test_helper.rb
+- test/test_GRuby.rb
+- examples/status.rb