cheezmiz 0.0.1

data/lib/helper.rb

@@ -0,0 +1,59 @@
+#    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/>.
+
+class IO
+  def while_reading(data = nil)
+    while buf = readpartial_rescued(1024)
+      data << buf if data
+      yield buf if block_given?
+    end
+    data
+  end
+
+  private
+
+  def readpartial_rescued(size)
+    readpartial(size)
+  rescue EOFError
+    nil
+  end
+end
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+
+  def camelize(first_letter_in_uppercase = true)
+    if first_letter_in_uppercase
+      self.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+    else
+      self.first + camelize(self)[1..-1]
+    end
+  end
+end
+
+class Module
+  def simple_name
+    self.name.split(/::/).last
+  end
+end

data/lib/protocol.rb

@@ -0,0 +1,34 @@
+#    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__))
+
+%w{ message
+    connection_established
+    login
+    information
+    buddy
+    client_ready
+    submit
+    keep_alive
+    system_message
+    unknown_operation
+}.each { |lib| require "protocol/#{lib}" }
+
+module Cheezmiz
+end

data/lib/protocol/buddy.rb

@@ -0,0 +1,49 @@
+#    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 'message'
+
+module Cheezmiz
+  class BuddyListRequest < Message
+    def params_lut
+    end
+    
+    def operation_code
+      '91'
+    end
+  end
+
+  class BuddyListBegin < Message
+    def params_lut
+    end
+
+    def operation_code
+      '30'
+    end
+  end
+
+   class BuddyListEnd < Message
+    def params_lut
+    end
+    
+    def operation_code
+      '39'
+    end
+  end
+end

data/lib/protocol/client_ready.rb

@@ -0,0 +1,28 @@
+#    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 'message'
+
+module Cheezmiz
+  class ClientReady < Message
+    def operation_code
+      '89'
+    end
+  end
+end

data/lib/protocol/connection_established.rb

@@ -0,0 +1,25 @@
+#    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 'message'
+
+module Cheezmiz
+  class ConnectionEstablished < Message
+  end
+end

data/lib/protocol/information.rb

@@ -0,0 +1,74 @@
+#    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 'message'
+
+module Cheezmiz
+  INFORMATION_COMMON_PARAMS =
+  {
+    :account => '001',
+    :manage => '002',
+    :fax => '005',
+    :_006 => '006',
+    :provider => '007',
+    :id => '010',
+    :alias => '012',
+    :alert => '013',
+    :ordinal => '015',
+    :first_name => '016',
+    :last_name => '017',
+    :email => '018',
+    :age => '019',
+    :sex => '020',
+    :_021 => '021',
+    :phone => '022',
+    :status => '023',
+    :city => '024',
+    :state => '025',
+    :country => '026',
+    :forward => '027',
+    :store => '028',
+    :_029 => '029',
+    :listed => '030',
+    :address => '031',
+    :extra => '032',
+    :_041 => '041',
+    :_051 => '051'
+  }
+
+  class AccountInformation < Message
+    def params_lut
+      INFORMATION_COMMON_PARAMS
+    end
+    
+    def operation_code
+      '41'
+    end
+  end
+  
+  class BuddyInformation < Message
+    def params_lut
+      INFORMATION_COMMON_PARAMS
+    end
+    
+    def operation_code
+      '31'
+    end
+  end
+end

data/lib/protocol/keep_alive.rb

@@ -0,0 +1,34 @@
+#    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 'message'
+
+module Cheezmiz
+  class KeepAliveRequest < Message
+    def operation_code
+      '40'
+    end
+  end
+
+  class KeepAliveResponse < Message
+    def operation_code
+      '90'
+    end
+  end
+end

data/lib/protocol/login.rb

@@ -0,0 +1,49 @@
+#    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 'message'
+
+module Cheezmiz
+  class LoginRequest < Message
+    def params_lut
+      {
+        :username => '005',
+        :password => '002',
+        :timezone => '004',
+        :window_size => '003'
+      }
+    end
+    
+    def operation_code
+      '01'
+    end
+
+    def default_params(params)
+      params[:timezone] ||= 8
+      params[:window_size] ||= 5 # 2..13
+      params
+    end
+  end
+
+  class LoginResponse < Message
+    def operation_code
+      '051'
+    end
+  end
+end

data/lib/protocol/message.rb

@@ -0,0 +1,108 @@
+#    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 'protocol'
+require 'helper'
+
+module Cheezmiz
+  class Message
+    def initialize(params = nil)
+      if params.respond_to?(:each_pair)
+        @params = params
+      else
+        @params, @sequence_number = decode(params)
+        @prototype = params
+      end
+      check_params @params if self.respond_to? :check_params
+      @options = populate_from(@params)
+    end
+
+    def self.parse(stream)
+      message = case stream
+        when /^CTPv1\.[123] Kamusta/ then ConnectionEstablished.new stream
+        when /^30:/ then BuddyListBegin.new stream
+        when /^31:/ then BuddyInformation.new stream
+        when /^39:/ then BuddyListEnd.new stream
+        when /^40:/ then KeepAliveRequest.new stream
+        when /^41:/ then AccountInformation.new stream
+        when /^51:/ then LoginResponse.new stream
+        when /^55:/ then SystemMessage.new stream
+        when /^64:/ then SubmitResponse.new stream
+        else                 UnknownOperation.new stream
+        end
+      message
+    end
+
+    def sequence_number
+      @sequence_number
+    end
+
+    def data_fields
+      @params
+    end
+
+    def operation
+      self.class.simple_name.underscore.to_sym
+    end
+    
+    def prototype
+      @prototype || "#{header}#{data}"
+    end
+    
+  private
+
+    def data
+      data = ''
+      @options.each do |key, value|
+        data << "#{key}:#{value}\t"
+      end
+      data
+    end
+
+    def header
+      "#{operation_code}:NNN\t"
+    end
+    
+    def decode(message)
+      params = {}
+      if message && self.respond_to?(:params_lut) && params_lut
+        message[8..-5].split(/\t/).each do |field|
+          field_key, field_data = field.split(/:/)
+          if params_lut.invert[field_key]
+            params[params_lut.invert[field_key]] = field_data
+          end
+        end
+        sequence = message[0..7].split(/:/)[1]
+      end
+      return params, sequence
+    end
+
+   def populate_from(params)
+      params.merge default_params(params) if self.respond_to? :default_params
+      options = {}
+      if self.respond_to? :params_lut
+        params.each do |key, value|
+          raise "Unknown parameter: #{key}" if !params_lut[key]
+          options[params_lut[key]] = value
+        end
+      end
+      options
+    end
+  end
+end