bencode 0.5.0 → 0.5.1

data/LICENSE

@@ -0,0 +1,20 @@
+
+Copyright (c) 2009 Daniel Schierbeck
+
+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.md

@@ -0,0 +1,40 @@
+
+Ruby bencode binding
+====================
+
+This is a simple library for reading and writing bencoded data.
+
+
+What is bencode?
+----------------
+
+Bencode is a simple data serialization format used by the popular 
+[BitTorrent](http://bittorrent.org/) P2P file sharing system.
+
+It contains only four data types, namely:
+
+- byte strings
+- integers
+- lists
+- dictionaries
+
+
+Examples
+--------
+
+    "foo bar".bencode                   # => "7:foo bar"
+    42.bencode                          # => "i42e"
+    [1, 2, 3].bencode                   # => "li1ei2ei3ee"
+    {"foo" => 1, "bar" => -10}.bencode  # => "d3:bari-10e3:fooi1ee"
+
+
+License
+-------
+
+Released under the MIT license.
+
+
+Contributors
+------------
+
+- Mike Hodgson

data/Rakefile

@@ -0,0 +1,14 @@
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+##
+# Run all unit tests.
+Rake::TestTask.new
+
+
+##
+# Generate RDoc documentation.
+Rake::RDocTask.new :doc do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+end

data/lib/bencode.rb

@@ -1,78 +1,9 @@
-# = bencode.rb - Bencode Library
-# 
-# Bencode is a Ruby implementation of the Bencode data serialization 
-# format used in the BitTorrent protocol.
-#
-# == Synopsis
-#
-# Bencoding (pronounced <i>bee-encode</i>) is a simple protocol, 
-# consisting of only 4 value types.
-#
-# === Integers
-#
-# An integer is encoded as an _i_ followed by the numeral itself, followed 
-# by an _e_. Leading zeros are not allowed. Negative values are prefixed
-# with a minus sign.
-#
-#   42.bencode  #=> "i42e"
-#   -2.bencode  #=> "i-2e"
-#   0.bencode   #=> "i0e"
-#
-# === Strings
-#   
-# Strings are sequences of zero or more bytes. They are encoded as 
-# <i>&lt;length&gt;:&lt;contents&gt;</i>, where _length_ is the 
-# length of _contents_. _length_ must be non-negative.
-#
-#   "".bencode     #=> "0:"
-#   "foo".bencode  #=> "3:foo"
-#
-# === Lists
-#
-# Lists are encoded as _l_ followed by the elements, followed by _e_.
-# There is no element seperator.
-#
-#   [1, 2, 3].bencode  #=> "li1ei2ei3ee"
-#
-# === Dictionaries
-#
-# Dictionaries are encoded as _d_ followed by a sequence of key-value 
-# pairs, followed by _e_. Each value must be immediately preceded by 
-# a key. Keys must be strings, and must appear in lexicographical order.
-#
-#   {"foo" => 3, "bar" => 1, "baz" => 2}.bencode  
-#     #=> "d3:bari1e3:bazi2e3:fooi3ee"
-# 
-# 
-# == Authors
-#
-# * Daniel Schierbeck
-#
-# == Contributors
-#
-# * Daniel Martin
-# * Phrogz
-# * Julien Pervillé
-#
-# == Copyright
-#
-# Bencode 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.
-# 
-# Bencode 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.
 
-
-prefix = File.dirname(__FILE__)
-
-%w[object integer string array hash].each do |type|
-  require prefix + '/bencode/encode/' + type
+# TODO: Write some documentation here.
+module BEncode
+  VERSION = '0.5.0'
 end
 
-%w[decode io encode_error decode_error].each do |file|
-  require prefix + '/bencode/' + file
-end
+glob = File.join(File.dirname(__FILE__), 'bencode/**/*.rb')
+
+Dir[glob].sort.each{|file| require file }

data/lib/bencode/decode.rb

@@ -18,22 +18,23 @@ module BEncode
 
     # Bdecodes the file located at +path+
     def load_file(path)
-      load(File.open(path).read)
+      if RUBY_PLATFORM =~ /(win|w)32$/
+        load(File.open(path, 'rb').read)
+      else
+        load(File.open(path).read)
+      end
     end
 
     def parse(scanner) # :nodoc:
-      case token = scanner.scan(/[ild]|\d+:|\s/)
-      when nil
-        raise BEncode::DecodeError
+      case scanner.scan(/[ild]|\d+:/)
       when "i"
         number = scanner.scan(/0|(?:-?[1-9][0-9]*)/)
         raise BEncode::DecodeError unless number and scanner.scan(/e/)
         return number.to_i
       when "l"
         ary = []
-        until scanner.peek(1) == "e"
-          ary.push(parse(scanner))
-        end
+        # TODO: There must be a smarter way of doing this...
+        ary.push(parse(scanner)) until scanner.peek(1) == "e"
         scanner.pos += 1
         return ary
       when "d"
@@ -50,7 +51,7 @@ module BEncode
         scanner.pos += 1
         return hsh
       when /\d+:/
-        length = token.chop.to_i
+        length = Integer($~.string.chop)
         str = scanner.peek(length)
 
         begin

data/lib/bencode/encode/array.rb

@@ -10,10 +10,7 @@ class Array
     begin
       "l#{map{|obj| obj.bencode }.join('')}e"
     rescue BEncode::EncodeError
-      raise BEncode::EncodeError, "array items must be bencodable"
-    # TODO: This is probably a bad idea...
-    rescue SystemStackError
-      raise BEncode::EncodeError, "cannot encode recursive array"
+      raise BEncode::EncodeError, "array items must be encodable"
     end
   end
 end

data/lib/bencode/encode/hash.rb

@@ -10,10 +10,6 @@ class Hash
     pairs = sort.map{|key, val| [key.to_str.bencode, val.bencode] }
     "d#{pairs.join('')}e"
   rescue NoMethodError => error
-    if error.name == :to_str
-      raise BEncode::EncodeError, "dictionary keys must be strings"
-    else
-      raise
-    end
+    raise BEncode::EncodeError, "dictionary keys must be strings"
   end
 end

data/test/environment.rb

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

data/test/test_decode_utf8.rb

@@ -0,0 +1,13 @@
+
+require 'test/unit'
+require 'test/environment'
+
+class TestDecodeUTF8 < Test::Unit::TestCase
+
+  def test_can_handle_utf8_encoded_data
+    assert_nothing_raised do
+      BEncode.load_file('test/fixtures/test.torrent')
+    end
+  end
+
+end

metadata

@@ -1,80 +1,69 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: bencode
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2007-02-07 00:00:00 +01:00
-summary: A Ruby implementation of the Bencode encoding used by BitTorrent
-require_paths: 
-- lib
-email: 
-homepage: bencode.rubyforge.org
-rubyforge_project: bencode
-description: 
-autorequire: bencode
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.5.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-06 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Ruby bindings for the bencode data serialization format.
+email: daniel.schierbeck@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
+- Rakefile
+- LICENSE
+- README.md
 - lib/bencode.rb
-- lib/bencode/io.rb
-- lib/bencode/encode_error.rb
 - lib/bencode/decode.rb
 - lib/bencode/decode_error.rb
-- lib/bencode/encode/object.rb
-- lib/bencode/encode/integer.rb
-- lib/bencode/encode/hash.rb
+- lib/bencode/encode_error.rb
+- lib/bencode/io.rb
 - lib/bencode/encode/array.rb
+- lib/bencode/encode/integer.rb
 - lib/bencode/encode/string.rb
-- test/test_decode.rb
-- test/test_encode.rb
-- test/suite.rb
-- test/decode/test_invalid.rb
-- test/decode/test_dictionary.rb
-- test/decode/test_integer.rb
-- test/decode/test_string.rb
-- test/decode/test_list.rb
-- test/encode/test_float.rb
-- test/encode/test_hash.rb
-- test/encode/test_integer.rb
-- test/encode/test_string.rb
-- test/encode/test_array.rb
-test_files: 
-- test/test_decode.rb
-- test/test_encode.rb
-- test/suite.rb
-- test/decode/test_invalid.rb
-- test/decode/test_dictionary.rb
-- test/decode/test_integer.rb
-- test/decode/test_string.rb
-- test/decode/test_list.rb
-- test/encode/test_float.rb
-- test/encode/test_hash.rb
-- test/encode/test_integer.rb
-- test/encode/test_string.rb
-- test/encode/test_array.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
+- lib/bencode/encode/hash.rb
+- lib/bencode/encode/object.rb
+has_rdoc: true
+homepage: http://github.com/dasch/ruby-bencode-bindings
+licenses: []
 
-extensions: []
+post_install_message: 
+rdoc_options: []
 
+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: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby bencode bindings
+test_files: 
+- test/test_decode_utf8.rb
+- test/environment.rb
+- test/fixtures/test.torrent

data/test/decode/test_dictionary.rb

@@ -1,18 +0,0 @@
-
-require 'test/unit'
-require File.dirname(__FILE__) + "/../../lib/bencode.rb"
-
-class BdecodeDictionaryTest < Test::Unit::TestCase
-  def test_empty
-    assert_equal Hash.new, "de".bdecode
-  end
-
-  def test_single_pair
-    assert_equal({"a" => 42}, 'd1:ai42ee'.bdecode)
-  end
-
-  def test_multi_pair
-    hsh = {"a" => "monkey", "h" => "elephant", "z" => "zebra"}
-    assert_equal hsh, "d1:a6:monkey1:h8:elephant1:z5:zebrae".bdecode
-  end
-end

data/test/decode/test_integer.rb

@@ -1,32 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BdecodeIntegerTest < Test::Unit::TestCase
-  def test_zero
-    assert_equal 0, 'i0e'.bdecode
-  end
-  
-  def test_single_digit
-    (1..9).each do |digit|
-      assert_equal digit, "i#{digit}e".bdecode
-    end
-  end
-
-  def test_multi_digit
-    (1..10).each do |digit|
-      assert_equal digit * 10, "i#{digit * 10}e".bdecode
-    end
-  end
-
-  def test_negative
-    (-9..-1).each do |digit|
-      assert_equal digit, "i#{digit}e".bdecode
-    end
-  end
-
-  def test_invalid
-    assert_raise(BEncode::DecodeError){ 'i01e'.bdecode }
-    assert_raise(BEncode::DecodeError){ 'i-0e'.bdecode }
-  end
-end

data/test/decode/test_invalid.rb

@@ -1,17 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BdecodeInvalidTest < Test::Unit::TestCase
-  errors = {:empty_string => '',
-            :space_string => ' ',
-            :unencoded_string => 'foobar',
-            :multiple_top_items => 'i1ei2e',
-            :string_length => '4:foo'}
-
-  errors.each do |error, data|
-    define_method("test_#{error}") do
-      assert_raise(BEncode::DecodeError){ data.bdecode }
-    end
-  end
-end

data/test/decode/test_list.rb

@@ -1,24 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BdecodeListTest < Test::Unit::TestCase
-  def test_empty
-    assert_equal [], 'le'.bdecode
-  end
-
-  def test_string_list
-    assert_equal %w[foo], 'l3:fooe'.bdecode
-    assert_equal %w[a b c], 'l1:a1:b1:ce'.bdecode
-  end
-
-  def test_integer_list
-    assert_equal [0], 'li0ee'.bdecode
-    assert_equal [1, 2, 3], 'li1ei2ei3ee'.bdecode
-  end
-
-  def test_list_list
-    assert_equal [[]], 'llee'.bdecode
-    assert_equal [[], [], []], 'llelelee'.bdecode
-  end
-end

data/test/decode/test_string.rb

@@ -1,23 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BdecodeStringTest < Test::Unit::TestCase
-  def test_empty
-    assert_equal '', '0:'.bdecode
-  end
-
-  def test_single_line
-    assert_equal 'foo', '3:foo'.bdecode
-  end
-
-  def test_multi_line
-    assert_equal "a\nb", "3:a\nb".bdecode
-  end
-
-  def test_whitespace
-    [" ", "\t", "\n", "\r"].each do |char|
-      assert_equal char, "1:#{char}".bdecode
-    end
-  end
-end

data/test/encode/test_array.rb

@@ -1,55 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BencodeListTest < Test::Unit::TestCase
-  # Asserts that an empty array is encoded correctly.
-  def test_empty
-    assert_equal 'le', [].bencode
-  end
-
-  # Asserts that arrays of integers are encoded correctly.
-  def test_integer_list
-    assert_equal 'li1ee', [1].bencode
-    assert_equal 'li1ei2ei3ei4ee', [1, 2, 3, 4].bencode
-  end
-
-  # Asserts that trying to encode a list containing a
-  # floating point number raises a +BEncode::EncodeError+.
-  def test_float_list
-    assert_raise BEncode::EncodeError do
-      [13.37].bencode
-    end
-  end
-
-  def test_string_list
-    assert_equal 'l3:fooe', %w[foo].bencode
-    assert_equal 'l1:a1:b1:ce', %w[a b c].bencode
-  end
-
-  def test_list_list
-    assert_equal 'llee', [[]].bencode
-    assert_equal 'llleee', [[[]]].bencode
-    assert_equal 'llelelee', [[], [], []].bencode
-  end
-
-  # Asserts that a recursive array is not bencoded.
-  # TODO: Uses waaaaay too much time. What to do?
-  def _test_recursive_list
-    assert_raise BEncode::EncodeError do
-      list = []
-      list << list
-      list.bencode
-    end
-
-    assert_raise BEncode::EncodeError do
-      list = [[]]
-      list.first << list
-      list.bencode
-    end
-  end
-
-  def test_dict_list
-    assert_equal 'ldee', [{}].bencode
-  end
-end

data/test/encode/test_float.rb

@@ -1,11 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BencodeFloatTest < Test::Unit::TestCase
-  def test_illegal_number
-    assert_raise BEncode::EncodeError do
-      13.37.bencode
-    end
-  end
-end

data/test/encode/test_hash.rb

@@ -1,27 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BencodeDictionaryTest < Test::Unit::TestCase
-  def test_empty
-    assert_equal 'de', {}.bencode
-  end
-
-  def test_integer_hash
-    assert_equal 'd1:ai1ee', {'a' => 1}.bencode
-    assert_equal 'd1:ai1e1:bi2e1:ci3ee', 
-                 {'a' => 1, 'b' => 2, 'c' => 3}.bencode
-  end
-
-  def test_illegal_keys
-    assert_raise BEncode::EncodeError do
-      {1 => 'foo'}.bencode
-    end
-  end
-
-  # Thank you, Julien
-  def test_key_order
-    assert_equal 'd1:ai1e2:bbi3e1:ci2ee', 
-                 {'a' => 1, 'c' => 2, 'bb' => 3}.bencode
-  end
-end

data/test/encode/test_integer.rb

@@ -1,27 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BencodeIntegerTest < Test::Unit::TestCase
-  def test_zero
-    assert_equal 'i0e', 0.bencode
-  end
-
-  def test_single_digit
-    (1..9).each do |digit|
-      assert_equal "i#{digit}e", digit.bencode
-    end
-  end
-
-  def test_multi_digit
-    (1..10).each do |digit|
-      assert_equal "i#{digit * 10}e", (digit * 10).bencode
-    end
-  end
-
-  def test_negative
-    (-9..-1).each do |digit|
-      assert_equal "i#{digit}e", digit.bencode
-    end
-  end
-end

data/test/encode/test_string.rb

@@ -1,32 +0,0 @@
-
-require 'test/unit'
-require "#{File.dirname(__FILE__)}/../../lib/bencode.rb"
-
-class BencodeStringTest < Test::Unit::TestCase
-  def test_empty
-    assert_equal '0:', ''.bencode
-  end
-
-  def test_single_char
-    ('a'..'z').each do |char|
-      assert_equal '1:' + char, char.bencode
-    end
-  end
-
-  def test_single_line
-    assert_equal '2:ab', 'ab'.bencode
-    assert_equal '3:abc', 'abc'.bencode
-    assert_equal '4:abcd', 'abcd'.bencode
-  end
-
-  def test_whitespace
-    [" ", "\t", "\n", "\r"].each do |char|
-      assert_equal '1:' + char, char.bencode
-      assert_equal '2:' + char * 2, (char * 2).bencode
-    end
-  end
-
-  def test_multi_line
-    assert_equal "3:a\nb", "a\nb".bencode
-  end
-end

data/test/suite.rb

@@ -1,5 +0,0 @@
-
-prefix = File.dirname(__FILE__)
-
-require prefix + '/test_encode'
-require prefix + '/test_decode'

data/test/test_decode.rb

@@ -1,4 +0,0 @@
-
-%w[string integer list dictionary invalid].each do |str|
-  require File.dirname(__FILE__) + "/decode/test_#{str}"
-end

data/test/test_encode.rb

@@ -1,4 +0,0 @@
-
-%w[string integer float array hash].each do |str|
-  require File.dirname(__FILE__) + "/encode/test_#{str}"
-end