anthill_ruby 0.5.2

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Artem Rufanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README

@@ -0,0 +1,22 @@
+Introduction:
+The AntHill is a powerful networking library which implements network fail-over and scaling functionality for any user applications.
+
+Report a bug:
+Try to search for similar issues in our bug database (http:://www.majoron.com/support/) before report a bug.
+If you did not find anything similar then please submit the new bug. Please use following tips to report a bug:
+	The basics: what you did, what you wanted to happen, and what actually happened.
+	If you don't understand the error message - please ask for help in forum.
+	Be brief, but don't leave any important details out.
+	Use plain English describing the problem.
+	Please describe one problem in each separate bug report.
+	Please do not report bugs for old versions.
+
+Release Notes:
+
+ Version 0.5
+ -----------
+-Implemented binary encoder/decoder. Support primitive datatypes
+-Implemented a lot of unit tests to verify coding and decoding
+
+Copyright (c) 2011 arufanov, released under the MIT license.
+

data/anthill_ruby.gemspec

@@ -0,0 +1,17 @@
+require 'date'
+Gem::Specification.new do |s|
+  s.name = %q{anthill_ruby}
+  s.version = "0.5.2"
+  s.date = Date.today.to_s
+  s.summary = %q{The AntHill is a powerful networking library which implements network fail-over and scaling functionality for any user applications.}
+  s.description = %q{The AntHill is a powerful networking library which implements network fail-over and scaling functionality for any user applications.}
+  s.author = %q{Artem Rufanov}
+  s.email = %q{developers@majoron.com}
+  s.homepage = %q{http://www.majoron.com/project/anthill/ruby}
+  s.files = Dir.glob('**/*') - Dir.glob('distrib/**/*') - Dir.glob('lib/api/**/*') - Dir.glob('doc/*.xpr')
+  s.bindir = 'bin'
+  s.executables = Dir.glob('bin/*').collect {|f| File.basename(f)}
+  s.require_paths << 'doc' << 'examples' << 'lib' << 'test'
+  s.has_rdoc = true
+  s.required_ruby_version = '>= 1.8.6'
+end

data/changelog

@@ -0,0 +1,21 @@
+Introduction:
+To see the latest list of the change log please visit the Change Log page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+
+ Version 0.5
+ -----------
+0.5 { Feature Request } [ AntHill Core ] / X / Support two types: 0B 05 04 and 0B0504
+0.5 { Feature Request } [ AntHill Core ] / X / Make single namespace AntHill
+0.5 { Feature Request } [ AntHill Core ] / X / Ruby 1.9.x support has been added
+0.5 { Feature Request } [ AntHill Core ] / 774 / Write to readme.txt files how to report a bug.

data/examples/data_converter.rb

@@ -0,0 +1 @@
+#1

data/knownbugs

@@ -0,0 +1,19 @@
+Introduction:
+To see the latest list of the known bugs please visit the Known bugs page at www.majoron.com. 
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version, 
+then follow category of the bug inside {}. It can be bug report, feature request and etc. 
+Then follow component inside []. After follow bug number at bug tracking system between // signs. 
+And then follow a short description of the bug. 
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means 
+that bug was created for 1.0 version of the AntHill component, bug is feature request with 
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+
+ Version 0.5
+ -----------
+0.5 { --- } [ AntHill Core ] / 782 / Codec tests, puts test from AntHill SMPP Cpp
+0.5 { Bug Report } [ AntHill Core ] / 771 / Good message for unparsable dump

data/lib/anthill_constants.rb

@@ -0,0 +1,44 @@
+#
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+
+module Majoron
+  module AntHill
+    # Module contains encoder and decoder errors
+    module CodecErrors
+      DECODER_INV_SKIPPING = "Unable to padding. Offset is: %d."
+      DECODER_INV_PADDING = "Unable to padding. Offset is: %d."
+      DECODER_INV_CHAR = "Unable to decode char. Offset is: %d."
+      DECODER_INV_UNSIGNED_CHAR = "Unable to decode unsigned char. Offset is: %d."
+
+      DECODER_INV_INTEGER32 = "Unable to decode integer32. Offset is: %d."
+      DECODER_INV_INTEGER24 = "Unable to decode integer24. Offset is: %d."
+      DECODER_INV_INTEGER16 = "Unable to decode integer16. Offset is: %d."
+
+      DECODER_INV_UNSIGNED32 = "Unable to decode integer32. Offset is: %d."
+      DECODER_INV_UNSIGNED24 = "Unable to decode integer24. Offset is: %d."
+      DECODER_INV_UNSIGNED16 = "Unable to decode integer16. Offset is: %d."
+
+      DECODER_INV_CSTRING = "Unable to decode cstring. Offset is: %d."
+      DECODER_OVERFLOW_CSTRING = "Unable to decode cstring due to overflow. Offset is: %d."
+      DECODER_INV_BINARY = "Unable to decode cstring. Offset is: %d."
+
+      DECODER_INV_OFFSET = "Unable to decode package. Offset after decoding is not equal to length. Offset is: %d. Lenght is: %d"
+      DECODER_DUE_TO_LIMIT = "Unable to decode package. Offset after decoding is greater than length. Offset is: %d. Lenght is: %d"
+    end
+  end
+end

data/lib/anthill_ruby.rb

@@ -0,0 +1,36 @@
+#
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+$:.unshift(File.dirname(__FILE__))
+
+# Include all files from anthill library
+require "anthill_constants"
+require "byte_buffer"
+require "encoder_base"
+require "decoder_base"
+require "validator_base"
+require "binary_encoder"
+require "binary_decoder"
+require "outputter_base"
+require "txt_outputter"
+require "xml_outputter"
+
+module Majoron
+  module AntHill
+  end
+end
+

data/lib/binary_decoder.rb

@@ -0,0 +1,227 @@
+#
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+
+module Majoron
+  module AntHill
+    class BinaryDecoder < DecoderBase
+      # Constructor.
+      def initialize()
+        super()
+        @offset = 0
+        @buffer = ""
+
+      end
+
+      # Method to skip n bytes
+      def skip_n_bytes(bytes, limit = nil)
+        return if bytes == 0
+        if @offset <= @buffer.size() - bytes
+          @offset += bytes
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+        else
+          raise sprintf(CodecErrors::DECODER_INV_CHAR, @offset)
+        end
+      end
+
+
+      # Methods to align on n bytes
+      def padding_n_bytes(bytes, limit = nil)
+        raise "not implemented"
+      end
+
+      # Decode methods
+      def decode_char(limit = nil)
+        sizeof = 1
+        if @offset <= @buffer.size() - sizeof
+          if RUBY_VERSION >= "1.9.0"
+            value = @buffer[@offset].ord
+          else
+            value = @buffer[@offset]
+          end
+          # value = @buffer[@offset]
+          @offset += sizeof
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf(CodecErrors::DECODER_INV_CHAR, @offset)
+        end
+      end
+
+      # Decode methods
+      def decode_uchar(limit = nil)
+        sizeof = 1
+        if @offset <= @buffer.size() - sizeof
+          if RUBY_VERSION >= "1.9.0"
+            value = @buffer[@offset].ord
+          else
+            value = @buffer[@offset]
+          end
+          # value = @buffer[@offset]
+          @offset += sizeof
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf(CodecErrors::DECODER_INV_CHAR, @offset)
+        end
+      end
+
+      # Decode methods
+      def decode_integer32(value, limit = nil)
+        raise "not implemented"
+      end
+
+      # Decode methods
+      def decode_integer24(value, limit = nil)
+        raise "not implemented"
+      end
+
+      # Decode methods
+      def decode_integer16(value, limit = nil)
+        raise "not implemented"
+      end
+
+      # Decode methods
+      def decode_unsigned32(limit = nil)
+        sizeof = 4
+        if @offset <= @buffer.size() - sizeof
+          value = @buffer[@offset..@offset+(sizeof-1)].unpack('N').first
+          @offset += sizeof
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf(CodecErrors::DECODER_INV_CHAR, @offset)
+        end
+      end
+
+      # Decode methods
+      def decode_unsigned16(limit = nil)
+        sizeof = 2
+        if @offset <= @buffer.size() - sizeof
+          value = @buffer[@offset..@offset+(sizeof-1)].unpack('n').first
+          @offset += sizeof
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf(CodecErrors::DECODER_INV_CHAR, @offset)
+        end
+      end
+
+      # Decode methods
+      def decode_cstring(value, limit = nil)
+        raise "not implemented"
+      end
+
+      # Decode methods
+      def decode_cstring_max(maxlen, limit = nil)
+        if @offset <= @buffer.size
+          value = ""
+          if RUBY_VERSION >= "1.9.0"
+            while @offset < @buffer.size() && @buffer[@offset].ord != 0
+              value << @buffer [ @offset ]
+              @offset += 1
+
+              # Check max limitation
+              overmax = value.size() + 1 > maxlen
+              raise sprintf(CodecErrors::DECODER_OVERFLOW_CSTRING, @offset) if overmax
+            end
+          else
+            while @offset < @buffer.size() && @buffer[@offset] != 0
+              value << @buffer [ @offset ]
+              @offset += 1
+
+              # Check max limitation
+              overmax = value.size() + 1 > maxlen
+              raise sprintf(CodecErrors::DECODER_OVERFLOW_CSTRING, @offset) if overmax
+            end
+          end
+          @offset += 1
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf( CodecErrors::DECODER_INV_CSTRING, @offset)
+        end
+      end
+
+      # Decode methods
+      def decode_binary(size, limit = nil)
+        if @offset <= @buffer.size
+          pos = 0
+          value = ""
+          while @offset < @buffer.size() && pos < size
+            value << @buffer [ @offset ]
+            @offset += 1
+            pos += 1
+          end
+
+          # Check overflow
+          overflow = !limit.nil? && @offset > limit
+          raise sprintf(CodecErrors::DECODER_DUE_TO_LIMIT, @offset, limit) if overflow
+          value
+        else
+          raise sprintf( CodecErrors::DECODER_INV_BINARY, @offset)
+        end
+      end
+
+
+      #
+      def reset_buffer()
+        @offset = 0
+        @buffer = ""
+      end
+
+      #
+      def get_buffer()
+        @buffer
+      end
+
+      #
+      def append_buffer(buf)
+        @buffer << buf
+      end
+
+      #
+      def validate_offset(len)
+        return if @offset == len
+        raise sprintf(CodecErrors::DECODER_INV_OFFSET, @offset, len)
+      end
+
+    private
+      attr_accessor :buffer
+      attr_accessor :offset
+
+    end
+  end
+end

data/lib/binary_encoder.rb

@@ -0,0 +1,131 @@
+#
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+
+module Majoron
+  module AntHill
+  	class BinaryEncoder < EncoderBase
+  		# Constructor.
+  		def initialize()
+  			super()
+  			@offset = 0
+  			@buffer = ""
+
+  		end
+
+  		# Method to skip n bytes
+  		def skip_n_bytes(bytes)
+  			# TODO:  implement
+  			raise "skip_n_bytes is not implemented"
+  		end
+
+
+  		# Padding function to align on n bytes
+  		def padding_n_bytes(bytes)
+  			# TODO:  implement
+  			raise "padding_n_bytes is not implemented"
+  		end
+
+  		# Encode functions
+  		def encode_char(value)
+  			sizeof = 1
+  			@buffer << value
+  			@offset += sizeof
+  		end
+
+  		def encode_uchar(value)
+  			sizeof = 1
+  			@buffer << value
+  			@offset += sizeof
+  		end
+
+  		def encode_integer32(value)
+  			# TODO:  implement
+  			raise "encode_integer32 is not implemented"
+  		end
+
+  		def encode_integer24(value)
+  			# TODO:  implement
+  			raise "encode_integer24 is not implemented"
+  		end
+
+  		def encode_integer16(value)
+  			# TODO:  implement
+  			raise "encode_integer16 is not implemented"
+  		end
+
+  		def encode_unsigned32(value)
+  			sizeof = 4
+  			# @buffer << sprintf("%c%c%c%c", value >> 24, value >> 16, value >> 8, value & 0xff)
+        @buffer << sprintf("%c%c%c%c", value >> 24, value >> 16 & 0xff, value >> 8 & 0xff, value & 0xff)
+  			@offset += sizeof
+  		end
+
+  		def encode_unsigned16(value)
+  			sizeof = 2
+  			@buffer << sprintf("%c%c", value >> 8, value & 0xff)
+  			@offset += sizeof
+  		end
+
+  		def encode_cstring(value, limit = nil)
+        # Encoding::CompatibilityError: incompatible character encodings: US-ASCII and ASCII-8BIT
+        # ASCII-8BIT is a binary data, I am not able to find how to set encoding in constructor
+        if RUBY_VERSION >= "1.9.0"
+          @buffer.force_encoding("ASCII-8BIT")
+        end
+
+  			sizeof = value.size() + 1			# 1 = NULL terminator
+  			@buffer << value << 0				# 0 = NULL terminator
+  			@offset += sizeof
+  		end
+
+  		def encode_binary(value)
+        # Encoding::CompatibilityError: incompatible character encodings: US-ASCII and ASCII-8BIT
+        # ASCII-8BIT is a binary data, I am not able to find how to set encoding in constructor
+        if RUBY_VERSION >= "1.9.0"
+          @buffer.force_encoding("ASCII-8BIT")
+        end
+
+  			sizeof = value.size()
+  			@buffer << value
+  			@offset += sizeof
+  		end
+
+
+  		#
+  		def reset_buffer()
+  			@offset = 0
+  			@buffer = ""
+  		end
+
+  		#
+  		def get_buffer()
+  			@buffer
+  		end
+
+  		#
+  		def append_buffer(buf)
+  			@buffer << buf
+  		end
+
+
+  	private
+  		attr_accessor :buffer
+  		attr_accessor :offset
+  	end
+  end
+end