bencodr 1.0.1 → 1.1.0

data/README.rdoc

@@ -12,7 +12,7 @@ This gem provides a way to encode and parse bencodings used by the Bit Torrent p
 == Installation
 
     # install the gem
-    > gem install bencodr
+    > [sudo] gem install bencodr
     Successfully installed bencodr
     1 gem installed
     Installing ri documentation for bencodr...
@@ -80,12 +80,20 @@ followed by an 'e'. Keys appear in sorted order (sorted as raw strings, not alph
     # Note: keys are sorted as raw strings.
     {:a => 1, "A" => 1, 1=> 1}.bencode  #=> "d1:1i1e1:Ai1e1:ai1ee"
 
-=== Encoding and Decoding
+=== Decoding
+You can decode a bencoding by calling bdecode on the string.
+
+    "6:string".bdecode  #=> "string"
+    "i1e".bdecode       #=> 1
+    "le".bdecode        #=> []
+    "de".bdecode        #=> {}
+
+=== Encoding and Decoding with BEncodr
 
     # encoding is just like calling bencode on the object
     BEncodr.encode("string")    #=> "6:string"
 
-    # decoding takes a string and return either a String, Integer, Array, or Hash
+    # decoding is just like calling bdecode on a bencoding
     BEncodr.decode("6:string")  #=> "string"
     BEncodr.decode("i1e")       #=> 1
     BEncodr.decode("le")        #=> []

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/{bencode_blatyo.gemspec → bencodr.gemspec}

@@ -4,13 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{bencode_blatyo}
-  s.version = "1.0.1"
+  s.name = %q{bencodr}
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Allen Madsen"]
-  s.date = %q{2010-02-02}
-  s.description = %q{This gem has been renamed to bencodr. Use that one instead.}
+  s.date = %q{2010-02-04}
+  s.description = %q{This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.}
   s.email = %q{blatyo@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -25,21 +25,21 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "autotest/discover.rb",
-     "bencode_blatyo.gemspec",
+     "bencodr.gemspec",
      "lib/bencodr.rb",
      "lib/bencodr/dictionary.rb",
      "lib/bencodr/integer.rb",
      "lib/bencodr/list.rb",
      "lib/bencodr/parser.rb",
      "lib/bencodr/string.rb",
+     "spec/bencode_spec.rb",
      "spec/bencodr/dictionary_spec.rb",
      "spec/bencodr/integer_spec.rb",
      "spec/bencodr/list_spec.rb",
      "spec/bencodr/parser_spec.rb",
      "spec/bencodr/string_spec.rb",
-     "spec/bencode_spec.rb",
-     "spec/samples/bencodr.rb.torrent",
-     "spec/samples/mini.bencodr",
+     "spec/samples/bencode.rb.torrent",
+     "spec/samples/mini.bencode",
      "spec/samples/python.torrent",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -48,14 +48,14 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{This gem has been renamed to bencodr. Use that one instead.}
+  s.summary = %q{This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.}
   s.test_files = [
-    "spec/bencodr/dictionary_spec.rb",
+    "spec/bencode_spec.rb",
+     "spec/bencodr/dictionary_spec.rb",
      "spec/bencodr/integer_spec.rb",
      "spec/bencodr/list_spec.rb",
      "spec/bencodr/parser_spec.rb",
      "spec/bencodr/string_spec.rb",
-     "spec/bencode_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/bencodr/parser.rb

@@ -110,4 +110,18 @@ module BEncodr
       private :parse_key_value
     end
   end
+end
+
+class String
+  # This method decodes a bencoded string into a ruby object.
+  #
+  #   "6:string".bdecode  #=> "string"
+  #   "i-1e".bdecode      #=> -1
+  #   "le".bdecode        #=> []
+  #   "de".bdecode        #=> {}
+  #
+  # @return [::String, ::Integer, ::Array, ::Hash] the decoded object
+  def bdecode
+    BEncodr::Parser.parse_object(StringScanner.new self) or raise BEncodr::BEncodeError, "Invalid bencoding"
+  end
 end

data/lib/bencodr.rb

@@ -19,8 +19,7 @@ module BEncodr
     # @param [::String] string the bencoded string to decode
     # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
     def decode(string)
-      scanner = StringScanner.new(string)
-      Parser.parse_object(scanner) or raise BEncodeError, "Invalid bencoding"
+      string.bdecode
     end
 
     # This method decodes a bencoded file.
@@ -29,8 +28,8 @@ module BEncodr
     #
     # @param [::String] file the file to decode
     # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
-    def decode_file(file)
-      decode(File.open(file, 'rb') {|f| f.read})
+    def decode_file(name)
+      decode(File.open(name, 'rb') {|file| file.read})
     end
 
     # This method encodes a bencoded object.
@@ -49,8 +48,8 @@ module BEncodr
     #
     # @param [::String] file the file to write the bencoded object to
     # @param [#bencodr] object the object to encode
-    def encode_file(file, object)
-      File.open(file, 'wb') {|f| f.write encode(object)}
+    def encode_file(name, object)
+      File.open(name, 'wb') {|file| file.write encode(object)}
     end
   end
 end

data/spec/bencodr/parser_spec.rb

@@ -173,4 +173,24 @@ describe BEncodr::Parser do
       lambda{BEncodr::Parser.parse_dictionary(scanner)}.should raise_error BEncodr::BEncodeError
     end
   end
+end
+
+describe String do
+  describe "#bdecode" do
+    it "should decode a bencoded string into a ruby string" do
+      "6:string".bdecode.should == "string"
+    end
+
+    it "should decode a bencoded integer into a ruby integer" do
+      "i-1e".bdecode.should == -1
+    end
+
+    it "should decode a bencoded list into a ruby array" do
+      "le".bdecode.should == []
+    end
+
+    it "should decode a bencoded dictionary into a ruby hash" do
+      "de".bdecode.should == {}
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bencodr
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Allen Madsen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -05:00
+date: 2010-02-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ files:
 - Rakefile
 - VERSION
 - autotest/discover.rb
-- bencode_blatyo.gemspec
+- bencodr.gemspec
 - lib/bencodr.rb
 - lib/bencodr/dictionary.rb
 - lib/bencodr/integer.rb