dasch-bencode 0.5.0

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

@@ -0,0 +1,9 @@
+
+# TODO: Write some documentation here.
+module BEncode
+  VERSION = '0.5.0'
+end
+
+glob = File.join(File.dirname(__FILE__), 'bencode/**/*.rb')
+
+Dir[glob].sort.each{|file| require file }

data/lib/bencode/decode.rb

@@ -0,0 +1,83 @@
+
+module BEncode
+  class << self
+    # BEncodes +obj+
+    def dump(obj)
+      obj.bencode
+    end
+
+    # Bdecodes +str+
+    def load(str)
+      require 'strscan'
+
+      scanner = StringScanner.new(str)
+      obj = parse(scanner)
+      raise BEncode::DecodeError unless scanner.eos?
+      return obj
+    end
+
+    # Bdecodes the file located at +path+
+    def load_file(path)
+      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 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 = []
+        # 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"
+        hsh = {}
+        until scanner.peek(1) == "e"
+          key, value = parse(scanner), parse(scanner)
+
+          unless key.is_a? String
+            raise BEncode::DecodeError, "key must be a string"
+          end
+
+          hsh.store(key, value)
+        end
+        scanner.pos += 1
+        return hsh
+      when /\d+:/
+        length = Integer($~.string.chop)
+        str = scanner.peek(length)
+
+        begin
+          scanner.pos += length
+        rescue RangeError
+          raise BEncode::DecodeError, "invalid string length"
+        end
+
+        return str
+      else
+        raise BEncode::DecodeError
+      end
+    end
+
+    private :parse
+  end
+end
+
+class String
+  #
+  # Bdecodes the String object and returns the data serialized
+  # through bencoding.
+  #
+  #   "li1ei2ei3ee".bdecode   #=> [1, 2, 3]
+  #
+  def bdecode
+    BEncode.load(self)
+  end
+end

data/lib/bencode/decode_error.rb

@@ -0,0 +1,4 @@
+
+unless BEncode.const_defined? :DecodeError
+  BEncode::DecodeError = Class.new(StandardError)
+end

data/lib/bencode/encode/array.rb

@@ -0,0 +1,16 @@
+
+class Array
+  #
+  # Bencodes the Array object. Bencoded arrays are represented as
+  # +lxe+, where +x+ is zero or more bencoded objects.
+  #
+  #   [1, "foo"].bencode   #=> "li1e3:fooe"
+  #
+  def bencode
+    begin
+      "l#{map{|obj| obj.bencode }.join('')}e"
+    rescue BEncode::EncodeError
+      raise BEncode::EncodeError, "array items must be encodable"
+    end
+  end
+end

data/lib/bencode/encode/hash.rb

@@ -0,0 +1,15 @@
+
+class Hash
+  #
+  # Bencodes the Hash object. Bencoded hashes are represented as
+  # +dxe+, where +x+ is zero or a power of two bencoded objects. 
+  # each key is immediately followed by its associated value.
+  # All keys must be strings. The keys of the bencoded hash will
+  # be in lexicographical order.
+  def bencode
+    pairs = sort.map{|key, val| [key.to_str.bencode, val.bencode] }
+    "d#{pairs.join('')}e"
+  rescue NoMethodError => error
+    raise BEncode::EncodeError, "dictionary keys must be strings"
+  end
+end

data/lib/bencode/encode/integer.rb

@@ -0,0 +1,13 @@
+
+class Integer
+  #
+  # Bencodes the Integer object. Bencoded integers are represented
+  # as +ixe+, where +x+ is the integer with an optional
+  # hyphen prepended, indicating negativity.
+  #
+  #   42.bencode   #=> "i42e"
+  #   -7.bencode   #=> "i-7e"
+  def bencode
+    "i#{self}e"
+  end
+end

data/lib/bencode/encode/object.rb

@@ -0,0 +1,9 @@
+
+class Object
+  #
+  # Raises an exception. Subclasses of Object must themselves
+  # define meaningful #bencode methods.
+  def bencode
+    raise BEncode::EncodeError, "cannot bencode #{self.class}"
+  end
+end

data/lib/bencode/encode/string.rb

@@ -0,0 +1,14 @@
+
+class String
+  #
+  # Bencodes the String object. Bencoded strings are represented
+  # as <code>x</code>:<code>y</code>, where +y+ is the string and +x+ 
+  # is the length of the string.
+  #   
+  #   "foo".bencode   #=> "3:foo"
+  #   "".bencode      #=> "0:"
+  #
+  def bencode
+    "#{length}:#{self}"
+  end
+end

data/lib/bencode/encode_error.rb

@@ -0,0 +1,4 @@
+
+unless BEncode.const_defined? :EncodeError
+  BEncode::EncodeError = Class.new(StandardError)
+end

data/lib/bencode/io.rb

@@ -0,0 +1,18 @@
+
+class IO
+  def self.bdecode(filename)
+    open(filename, 'r').bdecode
+  end
+
+  def self.bencode(filename)
+    open(filename, 'r').bencode
+  end
+
+  def bdecode
+    read.chomp.bdecode
+  end
+
+  def bencode
+    read.chomp.bencode
+  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

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: dasch-bencode
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07: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/decode.rb
+- lib/bencode/decode_error.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
+- lib/bencode/encode/hash.rb
+- lib/bencode/encode/object.rb
+has_rdoc: true
+homepage: http://github.com/dasch/ruby-bencode-bindings
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby bencode bindings
+test_files: 
+- test/test_decode_utf8.rb
+- test/environment.rb
+- test/fixtures/test.torrent