cheezmiz 0.0.1

data/README.rdoc

@@ -0,0 +1,41 @@
+= cheezmiz
+
+a ruby library for Chikka
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== TODO
+* Documentation
+* Tests (d'oh!)
+* Inbox functions
+* Other buddy functions
+
+== See Also
+
+http://chikka.com
+http://chix.sf.net
+
+== Copyright
+cheezmiz - a ruby library for Chikka
+Copyright (c) 2010  parasquid. See LICENSE for details.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cheezmiz"
+    gem.summary = 'a ruby library for Chikka'
+    gem.description = 'a ruby library for Chikka'
+    gem.email = "parasquid@gmail.com"
+    gem.homepage = "http://github.com/parasquid/cheezmiz"
+    gem.authors = ["parasquid"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cheezmiz #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/cheezmiz.geany

@@ -0,0 +1,20 @@
+
+[indentation]
+indent_width=2
+indent_type=0
+indent_hard_tab_width=2
+detect_indent=false
+indent_mode=3
+
+[project]
+name=cheezmiz
+base_path=/home/kaliwanagan/projects/cheezmiz/
+make_in_base_path=false
+description=cheezmiz - a ruby library for Chikka
+run_cmd=
+
+[files]
+current_page=0
+FILE_NAME_0=5;Ruby;0;16;0;1;0;/home/kaliwanagan/projects/cheezmiz/lib/cheezmiz.rb;0
+FILE_NAME_1=113;Ruby;0;16;0;1;0;/home/kaliwanagan/projects/cheezmiz/lib/broker.rb;0
+FILE_NAME_2=987;Conf;0;16;0;1;0;/home/kaliwanagan/.config/geany/snippets.conf;0

data/cheezmiz.gemspec

@@ -0,0 +1,68 @@
+# 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{cheezmiz}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["parasquid"]
+  s.date = %q{2010-02-19}
+  s.description = %q{a ruby library for Chikka}
+  s.email = %q{parasquid@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cheezmiz.geany",
+     "cheezmiz.gemspec",
+     "docs/chikka-1.capture",
+     "examples/callbacks.rb",
+     "lib/broker.rb",
+     "lib/cheezmiz.rb",
+     "lib/helper.rb",
+     "lib/protocol.rb",
+     "lib/protocol/buddy.rb",
+     "lib/protocol/client_ready.rb",
+     "lib/protocol/connection_established.rb",
+     "lib/protocol/information.rb",
+     "lib/protocol/keep_alive.rb",
+     "lib/protocol/login.rb",
+     "lib/protocol/message.rb",
+     "lib/protocol/submit.rb",
+     "lib/protocol/system_message.rb",
+     "lib/protocol/unknown_operation.rb",
+     "test/helper.rb",
+     "test/test_cheezmiz.rb"
+  ]
+  s.homepage = %q{http://github.com/parasquid/cheezmiz}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{a ruby library for Chikka}
+  s.test_files = [
+    "test/test_cheezmiz.rb",
+     "test/helper.rb",
+     "examples/callbacks.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/docs/chikka-1.capture

@@ -0,0 +1,37 @@
+CTPv1.2 Kamusta 122.52.247.56:11400 1265980959. Manila, Philippines!
+01:001	005:user@email.com	002:password	003:5	004:8	93
+51:001	004:1	44
+41:000	016:first_name	017:last_name	018:user@email.com	019:0	020:2	031:	022:	005:	024:	025:	026:	027:0	028:0	001:008841587	030:0	007:Chikka	021:0	023:0	006:	051:	029:0	041:	032:	AD
+91:000	3F
+30:002	001:0	002:1	44
+31:004	010:639291234567	015:0	012:alias	008:0	016:	017:	018:	019:0	020:2	031:	022:	005:	024:	025:	026:	027:1	014:0	013:0	029:0	030:0	007:Smart Communications (PH)	023:0	021:0	050:0	032:	21
+39:006	001:0	4B
+89:006	4C
+14:003	001:639191234567	030:1	032:test message	24
+64:003	42
+56:003	010:639191234567	015:1	012:	008:0	016:first_name	017:	018:	019:0	020:0	031:	022:	005:	024:	025:	026:	027:1	014:0	013:0	029:0	030:0	007:Smart Communications (PH)	002:0	021:0	023:0	032:	A9
+23:005	3F
+73:005	44
+30:008	001:4	002:28	87
+47:010	040:Smart Communications (PH)	041:20	042:1	55
+47:012	040:Globe Telecom (PH)	041:30	042:0	39
+47:014	040:Other U.S. Mobile Phones	041:30	042:0	8B
+47:016	040:Cingular Wireless (US)	041:20	042:0	1D
+47:018	040:SUN Cellular (PH)	041:20	042:0	B6
+47:020	040:Guamcell/Saipancell	041:20	042:0	B1
+47:022	040:INDIA Mobile Phones	041:10	042:0	C7
+47:024	040:Verizon Wireless (US)	041:20	042:0	D4
+47:026	040:Sprint (US)	041:20	042:0	FB
+47:028	040:Alltel (US)	041:20	042:0	DB
+47:030	040:Excelcomindo	041:20	042:0	37
+47:032	040:Nextel (US)	041:20	042:0	E8
+47:034	040:Boost (US)	041:20	042:0	81
+47:036	040:UK	041:30	042:0	04
+47:038	040:Spain	041:30	042:0	61
+47:040	040:1528 Smart (HK)	041:30	042:0	5A
+47:042	040:Smart Pinoy (Italy)	041:30	042:0	0B
+39:044	001:4	51
+89:044	4E
+
+
+

data/examples/callbacks.rb

@@ -0,0 +1,84 @@
+#    cheezmiz - a ruby library for Chikka
+#    Copyright (C) 2010  parasquid
+#
+#    This file is part of cheezmiz
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'cheezmiz'
+
+if __FILE__ == $0
+  CHIKKA_USERNAME = 'user@email.com'
+  CHIKKA_PASSWORD = 'password'
+  TEST_MESSAGE = 'a test message'
+
+  socket = TCPSocket.open('ctp-a.chikka.com', 6301)
+  broker = Cheezmiz::Broker.new :socket => socket
+  broker.register_callback(:connection_established) do |msg|
+    puts 'connection has been established'
+    message = Cheezmiz::LoginRequest.new(
+      :username => "#{CHIKKA_USERNAME}",
+      :password => "#{CHIKKA_PASSWORD}"
+    )
+    broker.send(message)
+  end
+
+  broker.register_callback(:login_response) {
+    puts 'login successful'
+  }
+
+  broker.register_callback(:account_information) do
+    puts 'received account information'
+    puts 'sending buddy list request'
+    broker.send(Cheezmiz::BuddyListRequest.new)
+  end
+
+  broker.register_callback(:buddy_information) do
+    puts 'received buddy information'
+  end
+
+  broker.register_callback(:buddy_list_end) do
+    broker.send(Cheezmiz::ClientReady.new)
+  end
+
+  broker.register_callback(:keep_alive_request) do |msg|
+    broker.send(Cheezmiz::KeepAliveResponse.new, :response_to => msg)
+    puts 'sending test message'
+    message = Cheezmiz::SubmitRequest.new(
+      :message => "#{TEST_MESSAGE}",
+      :buddy_number => 0
+    )
+    broker.send(message)
+  end
+
+  broker.register_callback(:submit_response) do
+    puts 'server has acknowledged submit request'
+  end
+
+  broker.register_callback(:incoming) do |msg|
+    if msg.operation == :unknown_operation
+      puts "unknown operation: #{msg.prototype}"
+    else
+      puts "incoming message #{msg.operation} #{msg.data_fields.inspect}"
+    end
+  end
+
+  broker.register_callback(:outgoing) do |msg|
+    puts "outgoing message: #{msg.operation} #{msg.data_fields.inspect}"
+  end
+  
+  broker.start
+  broker.join
+end

data/lib/broker.rb

@@ -0,0 +1,120 @@
+#    cheezmiz - a ruby library for Chikka
+#    Copyright (C) 2010  parasquid
+#
+#    This file is part of cheezmiz
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+$: << File.expand_path(File.dirname(__FILE__))
+require 'socket'
+require 'helper'
+require 'protocol'
+
+module Cheezmiz
+  class Broker
+    STX = "\x02"
+    ETX = "\x03"
+    def initialize(params = {})
+      @socket = params[:socket] || begin
+        params[:host] ||= 'ctp-a.chikka.com'
+        params[:port] ||= 6301
+        TCPSocket.open(params[:host], params[:port])
+      end
+      @sequence_number = 1
+      @callbacks = Hash.new { |hash, key| hash[key] = [] }
+    end
+    
+    def register_callback(operation, &proc)
+      @callbacks[operation] << proc
+    end
+    
+    def register_observer(observer, &proc)
+      @observers[observer] << proc
+    end
+
+    def callbacks
+      @callbacks
+    end
+ 
+    def observers
+      @observers
+    end
+
+   def send(message, params = {})
+      raw = encode({ :message => message }.merge(params))
+      result = @socket.send(raw, 0)
+      process_callbacks(@callbacks[:outgoing], message)
+      return raw, result
+    end
+       
+    def start
+      @thread = Thread.new do
+        @socket.while_reading { |buffer| process_messages(buffer) }
+      end
+    end
+    
+    def join
+      @thread.join
+    end
+
+  private
+
+    def tokenize(stream)
+      #TODO: handle incomplete messages
+      stream.scan(/.*?|^CTPv1\.[123] Kamusta.*/)
+    end
+
+    def checksum(message)
+      checksum = 0
+      message.bytes.each do |b|
+        checksum += b
+        checksum &= 0xFF
+      end
+      checksum
+    end
+    
+    def encode(options)
+      raw = "#{STX}" + options[:message].prototype
+      sequence_number = begin
+        options[:response_to].sequence_number
+      rescue NoMethodError
+        options[:response_to]
+      end || @sequence_number
+      raw.sub! /NNN/, sequence_number.to_s.rjust(3, '0')
+      @sequence_number += 2
+      @sequence_number &= 0xFF
+      raw + sprintf('%2X', checksum(raw)) + "#{ETX}"
+    end
+  
+    def process_messages(buffer)
+      tokenize(buffer).each do |raw|
+        message = Message.parse(raw)
+        process_callbacks(@callbacks[:incoming], message)
+        process_callbacks(@callbacks, message)
+      end
+    end
+    
+    def process_callbacks(callbacks, message)
+      if callbacks.respond_to? :each_pair
+        callbacks[message.operation].each do |callback|
+          callback.call(message) 
+        end
+      else
+        callbacks.each do |callback|
+          callback.call(message)
+        end
+      end
+    end
+  end
+end

data/lib/cheezmiz.rb

@@ -0,0 +1,20 @@
+#    cheezmiz - a ruby library for Chikka
+#    Copyright (C) 2010  parasquid
+#
+#    This file is part of cheezmiz
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+$: << File.expand_path(File.dirname(__FILE__))
+require 'broker'