bcodec 0.1.0

data/lib/bcodec/decode.rb

@@ -0,0 +1,95 @@
+#    bcodec - Ruby library to decode/encode bencoded data
+#    Copyright (C) 2006  Thomas <tochiroNO@SPAMrubyforge.org>
+#
+#    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.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module BCodec
+
+  class InvalidInteger < Exception; end
+  class InvalidString < Exception; end
+  class InvalidKey < Exception; end
+  class UnknownData < Exception; end
+  class InvalidDataType < Exception; end
+
+  # Decodes bencoded data from an IO-like object (IO, File, StringIO or similar
+  # that has a .getc method).
+  #
+  # Returns the decoded object which is either of these:
+  # * Array
+  # * Fixnum (or Bignum)
+  # * Hash
+  # * String
+  def BCodec.decode(io)
+    c = io.getc
+
+    case c.chr
+    when 'i'
+      i = ''
+      while c = io.getc
+        if c.chr == 'e'
+          if i.match(/^(0|-?[1-9][0-9]*)$/)
+            return i.to_i
+          else
+            raise InvalidInteger
+          end
+        else
+          i += c.chr
+        end
+      end
+      raise EOFError
+    when '0'..'9'
+      n = c.chr
+      while b = io.getc
+        case b.chr
+        when '0'..'9'
+          n += b.chr
+        when ':'
+          strlen = n.to_i
+          str = io.read(strlen)
+          if str.length == strlen
+            return str
+          else
+            raise EOFError
+          end
+        else
+          raise InvalidString
+        end
+      end
+    when 'l'
+      list = []
+      
+      while item = decode(io)
+        list.push(item)
+      end
+
+      return list
+    when 'd'
+      dict = {}
+
+      while key = decode(io)
+        raise InvalidKey unless key.instance_of?(String)
+        val = decode(io)
+        dict[key] = val
+      end
+
+      return dict
+    when 'e'
+      return false
+    else
+      raise UnknownData
+    end
+  end
+  
+end

data/lib/bcodec/encode.rb

@@ -0,0 +1,56 @@
+# BCodec - Ruby module to decode/encode bencoded data
+# Copyright (C) 2006  Thomas <tochiro@freeshell.org>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module BCodec
+
+  class InvalidKey < Exception; end
+  class InvalidDataType < Exception; end
+
+  # Bencodes a Ruby object which must be either of these:
+  #
+  # * Array
+  # * Fixnum (or Bignum)
+  # * Hash
+  # * String
+  #
+  # Returns the encoded object(s) as a String
+  def BCodec.encode(obj)
+    str = ""
+    if obj.class == String
+      str << "%d:%s" % [ obj.length, obj ]
+    elsif obj.class == Fixnum or obj.class == Integer or obj.class == Bignum
+      str << "i" <<  obj.to_s << "e"
+    elsif obj.class == Array
+      str << "l"
+      obj.each { |i| str += encode(i) }
+      str << "e"
+    elsif obj.class == Hash
+      str << "d"
+      obj.sort.each do |k, v|
+        raise InvalidKey unless k.instance_of?(String)
+        str << encode(k)
+        str << encode(v)
+      end
+      str << "e"
+    else
+      raise InvalidDataType
+    end
+
+    return str
+  end
+  
+end

data/lib/bcodec.rb

@@ -0,0 +1,55 @@
+#    bcodec - Ruby library to decode/encode bencoded data
+#    Copyright (C) 2006  Thomas <tochiroNO@SPAMrubyforge.org>
+#
+#    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.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+#=bcodec
+#
+#==Description
+#bcodec is a Ruby library for encoding and decoding bencoded data used in the
+#BitTorrent protocol (see http://www.bittorrent.org/).
+#
+#
+#==Encoding example:
+#
+# require 'bcodec'
+# BCodec.encode("abcd")             # returns "4:abcd"
+# BCodec.encode(1000)               # returns "i1000e"
+# BCodec.encode([1,2,3])            # returns "li1ei2ei3ee"
+# BCodec.encode({"key" => "value"}) # returns "d3:key5:valuee"
+#
+#
+#==Decoding example:
+#
+# require 'bcodec'
+# BCodec.decode(StringIO.new("4:abcd"))      # returns "abcd"
+# BCodec.decode(StringIO.new("i666e"))       # returns 666
+# BCodec.decode(StringIO.new("l3abci666ee")) # returns [ "abc", 666 ]
+# BCodec.decode(StringIO.new("d3abci666ee")) # returns { "abc" => 666 }
+#
+#To decode a BitTorrent metafile you could do something like:
+#
+# hash = BCodec.decode(open("some.torrent", "r"))
+#
+#The only legal objects are String, Fixnum (or Bignum), Hash and Array which
+#corresponds to String, Integer, Dictionary and List in Python as
+#specified in the BitTorrent protocol specification at: 
+#http://www.bittorrent.org/protocol.html
+
+module BCodec
+  require 'bcodec/decode'
+  require 'bcodec/encode'
+end
+

data/test/test_decoding.rb

@@ -0,0 +1,37 @@
+require 'stringio'
+require 'test/unit'
+require 'lib/bcodec/decode'
+
+class TestDecoding < Test::Unit::TestCase
+
+  def setup
+    @tests = []
+    @tests << [ "4:test", "test" ]
+    @tests << [ "i666e", 666 ]
+    @tests << [ "l4:testi666ee", [ "test", 666 ] ]
+    @tests << [ "d4:testi666ee", { "test" => 666 } ]
+    @tests << [ "d4:testli1ei2ei3ed1:Ai1e1:Bl1:a1:b1:ceeee", 
+                { "test" => [ 1, 2, 3, { "A" => 1, "B" => [ 'a', 'b', 'c' ] } ] } ]
+
+    @etests = []
+    @etests << [ BCodec::InvalidInteger, "i1.0e" ]
+    @etests << [ BCodec::InvalidInteger, "iAe" ]
+    @etests << [ BCodec::UnknownData, "f" ]
+    @etests << [ BCodec::InvalidKey, "di666e:3:keye" ]
+    @etests << [ EOFError, "i1" ]
+    @etests << [ EOFError, "4:ab" ]
+  end
+
+  def test_decoding
+    @tests.each do |test, result|
+      assert_equal BCodec.decode(StringIO.new(test)), result
+    end
+  end
+  
+  def test_decoding_exceptions
+    @etests.each do |exception, test|
+      assert_raise(exception) { BCodec.decode(StringIO.new(test)) }
+    end
+  end
+
+end

data/test/test_encoding.rb

@@ -0,0 +1,37 @@
+require 'stringio'
+require 'test/unit'
+require 'lib/bcodec/encode'
+
+include BCodec
+
+class TestEncoding < Test::Unit::TestCase
+
+  def setup
+    @tests = []
+    @tests << [ "test", "4:test" ]
+    @tests << [ 666, "i666e" ]
+    @tests << [ [ "test", 666 ], "l4:testi666ee" ]
+    @tests << [ { "test" => 666 }, "d4:testi666ee" ]
+    @tests << [ { "test" => [ 1, 2, 3, { "A" => 1, "B" => [ 'a', 'b', 'c' ] } ] }, 
+                "d4:testli1ei2ei3ed1:Ai1e1:Bl1:a1:b1:ceeee" ]
+
+    @etests = []
+    @etests << [ BCodec::InvalidDataType, :symbol ]
+    @etests << [ BCodec::InvalidDataType, [1.0, "float"] ]
+    @etests << [ BCodec::InvalidKey, {1 => "key"} ]
+    @etests << [ BCodec::InvalidDataType, 1..666 ]
+  end
+
+  def test_basic_encoding
+    @tests.each do |test, result|
+      assert_equal(BCodec.encode(test), result)
+    end
+  end
+
+  def test_encoding_exceptions
+    @etests.each do |exception, test|
+      assert_raise(exception) { BCodec.encode(test) }
+    end
+  end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: bcodec
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-11-18 00:00:00 +01:00
+summary: Ruby library for encoding and decoding bencoded data used in the BitTorrent protocol
+require_paths: 
+- lib
+email: 
+homepage: http://bcodec.rubyforge.org/
+rubyforge_project: 
+description: 
+autorequire: bcodec
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: []
+
+files: 
+- lib/bcodec
+- lib/bcodec.rb
+- lib/bcodec/encode.rb
+- lib/bcodec/decode.rb
+- test/test_encoding.rb
+- test/test_decoding.rb
+test_files: 
+- test/test_decoding.rb
+- test/test_encoding.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+