bencoder 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfca12e927ab3e29a541dc509d5bc787ee62b732
-  data.tar.gz: d74de695a016dea7000cb8118e1f54ec6889a8d8
+  metadata.gz: 5112fd1ec7dec234a855cf2a997e3ffe733f0ecb
+  data.tar.gz: 11393fc29fec7354b685cddea158df8f878e0a46
 SHA512:
-  metadata.gz: 957254eaf5930e4c8898a62a8616c760732db91f508e9af20759388419ee88f006afaf7f0402a0cbd225fd5c3a6b443bcecdff4d2f63f25b756297ca907dbe05
-  data.tar.gz: 338dd693748fbd2c36788798c3cfc896abbd1d5d52456ef074f90ecff0a0bcd370552daa6c4cfc98b971e262ea92bf4376da7b51a3aeae206f9efa37bbcae879
+  metadata.gz: b0dff892b6d46411990a480a3a4d91db34e8ebe099d52317d7ffa94d38a043013ac78eedf7d0ee9d5c5010a26c1f56893905e330045e8730e7db059000f9b616
+  data.tar.gz: 42f0060c74935ab46d58419d3f9f6f50eb50b4d20b62765f4d538784679fe3f8099eb522308586b9edeb0c4d6263e4c17ecc08314edd30e7ffe0a011f80938ee

data/README.md

@@ -36,4 +36,10 @@ BEncoder.encode ['what', 'strange', { data: 'I', have: 'here' }, 666]
 BEncoder.decode 'l4:what7:stranged4:data1:I4:have4:hereei666ee'
 => ['what', 'strange', { 'data' => 'I', 'have' => 'here' }, 666]
 ```
-Intentionally minimalistic.
+
+Since .torrent files are bencode dicts, you can parse them out of the box
+
+```ruby
+BEncoder.decode File.read('sample.torrent')
+=> {"announce"=>"udp://tracker.openbittorrent.com:80", "creation date"=>1327049827, "info"=>{"length"=>20, "name"=>"sample.txt", "piece length"=>65536, "pieces"=>"\\\xC5\xE6R\xBE\r\xE6\xF2x\x05\xB3\x04d\xFF\x9B\x00\xF4\x89\xF0\xC9", "private"=>1}}
+```

data/lib/bencoder.rb

@@ -1,4 +1,8 @@
 require 'stringio'
+
+class InvalidEncodingError < StandardError; end
+class UnencodableTypeError < StandardError; end
+
 class BEncoder
   class << self
     def encode(object)
@@ -13,6 +17,8 @@ class BEncoder
         encode_array object
       when Hash
         encode_hash object
+      else
+        raise UnencodableTypeError, "Cannot encode instance of type #{object.class}"
       end
     end
 
@@ -24,8 +30,6 @@ class BEncoder
 
     private
 
-    class InvalidEncodingError < StandardError; end
-
     def parse(string)
       case string[0]
       when 'i'
@@ -46,7 +50,7 @@ class BEncoder
       elsif string[0] == 'l' && string[-1] == 'e'
         str = StringIO.new string[1..-2]
       else 
-        raise InvalidEncodingError
+        raise InvalidEncodingError, 'List does not have a closing e'
       end
       parse_io_list str
     end
@@ -56,9 +60,9 @@ class BEncoder
         string.getc if peek(string) == 'd'
         list_of_keys_and_values = parse_list(string)
       elsif string[0] == 'd' && string[-1] == 'e'
-        list_of_keys_and_values = parse_list("l#{string[1..-2]}e")
+        list_of_keys_and_values = parse_list("l#{ string[1..-2] }e")
       else
-        raise InvalidEncodingError
+        raise InvalidEncodingError, 'Dict does not have a closing e'
       end
       make_hash_from_array list_of_keys_and_values
     end
@@ -77,7 +81,7 @@ class BEncoder
           length = io.gets(sep=':').to_i
           list << io.gets(length)
         else
-          raise InvalidEncodingError
+          raise InvalidEncodingError, "Encountered unexpected identifier #{ peek io }"
         end
       end
       io.getc
@@ -96,7 +100,7 @@ class BEncoder
       if string[0] == 'i' && string[-1] == 'e'
         string[1..-2].to_i
       else
-        raise InvalidEncodingError
+        raise InvalidEncodingError, 'Integer does not have closing e'
       end
     end
 
@@ -105,16 +109,16 @@ class BEncoder
       if content.length == length.to_i
         content
       else
-        raise InvalidEncodingError
+        raise InvalidEncodingError, "String length declared as #{length.to_i}, but was #{content.length} " 
       end
     end
 
     def encode_string(string)
-      "#{string.length}:#{string}"
+      "#{ string.length }:#{ string }"
     end
 
     def encode_int(int)
-      "i#{int}e"
+      "i#{ int }e"
     end
 
     def encode_array(array)
@@ -122,7 +126,7 @@ class BEncoder
     end
 
     def encode_hash(hash)
-      hash.inject("d") { |result, (k,v)| result += "#{encode(k.to_s)}#{encode(v)}" } + 'e'
+      hash.inject("d") { |result, (k,v)| result += "#{ encode(k.to_s) }#{ encode(v) }" } + 'e'
     end
 
     def peek(io)

data/test/test_bencoder.rb

@@ -13,6 +13,10 @@ class TestBencoder < Minitest::Test
 
   #encoding
 
+  def test_symbol_encoding
+    assert_equal '6:hellou', @be.encode(:hellou)
+  end
+
   def test_string_encoding
     assert_equal '7:Someday', @be.encode('Someday')
   end
@@ -33,6 +37,12 @@ class TestBencoder < Minitest::Test
     assert_equal 'ld4:somel5:times3:youe5:gotta3:let2:go1:!ei2e5:wooooli1e1:21:3ee', @be.encode([{'some' => ['times', 'you'], gotta: 'let', go: '!'}, 2, "woooo", [1, '2', "3"]])
   end
 
+  def test_should_not_encode_strange_types
+    assert_raises UnencodableTypeError do
+      @be.encode 5.6
+    end
+  end
+
   #decoding
 
   def test_string_decoding
@@ -54,4 +64,34 @@ class TestBencoder < Minitest::Test
   def test_nested_decoding
     assert_equal [{'some' => ['times', 'you'], 'gotta' => 'let', 'go' => '!'}, 2, "woooo", [1, '2', "3"]], @be.decode('ld4:somel5:times3:youe5:gotta3:let2:go1:!ei2e5:wooooli1e1:21:3ee')
   end
+
+  def test_throws_error_on_wrong_list_encoding
+    assert_raises InvalidEncodingError do
+      @be.decode 'li4ed'
+    end
+  end
+
+  def test_throws_error_on_wrong_dict_encoding
+    assert_raises InvalidEncodingError do
+      @be.decode 'd3:abc'
+    end
+  end
+
+  def test_throws_error_on_wrong_int_encoding
+    assert_raises InvalidEncodingError do
+      @be.decode 'i14'
+    end
+  end
+
+  def test_throws_error_on_wrong_string_encoding
+    assert_raises InvalidEncodingError do
+      @be.decode '4:cat'
+    end
+  end
+
+  def test_throws_error_on_unknown_encoding_identifier
+    assert_raises InvalidEncodingError do
+      @be.decode 'li3ej5e'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bencoder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Kasper Holbek Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -72,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Bittorrent encoding