bencode_ext 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 naquad
+
+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.rdoc

@@ -0,0 +1,19 @@
+= bencode_ext
+
+BEncodeExt is implementation of Bencode reader/writer (BitTorent encoding) in C. See BEncode module for details.
+This module was tested with ruby 1.9.2. It definitely doesn't work with ruby 1.8.x.
+
+== Contributing to bencode_ext
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 naquad. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bencode_ext"
+  gem.homepage = "http://github.com/naquad/bencode_ext"
+  gem.license = "MIT"
+  gem.summary = %Q{BitTorrent encoding parser/writer}
+  gem.description = %Q{BEncodeExt is implementation of Bencode reader/writer (BitTorent encoding) in C.}
+  gem.email = "naquad@gmail.com"
+  gem.authors = ["naquad"]
+  gem.required_ruby_version = '~>1.9.2'
+  gem.add_dependency 'rake-compiler', '~>0.7.5'
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.extensions << "ext/bencode_ext/extconf.rb"
+end
+Jeweler::RubygemsDotOrgTasks.new
+Jeweler::GemcutterTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bencode_ext #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('ext/**/*.c')
+end
+
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('bencode_ext')

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ext/bencode_ext/bencode.c

@@ -0,0 +1,285 @@
+/*
+ * Document-module: BEncode
+ *
+ * BEncode module provides functionality for encoding/decoding Ruby objects
+ * in BitTorrent loosly structured data format - <i>bencode</i>. To decode data you sould use one of the following:
+ *   'string'.bdecode
+ *   BEncode.decode('string')
+ * Where string contains bencoded data (i.e. some torrent file)
+ * To encode your objects into bencode format:
+ *   object.bencode
+ *   # or
+ *   BEncode.encode(object)
+ * bencode format has only following datatypes:
+ *   Integer
+ *   String
+ *   List
+ *   Dictionary (Hash)
+ * No other types allowed. Only symbols are converted to string for convenience
+ * (<b>but they're decoded as strings</b>).
+ *
+ * <b>BEncode is included into Object on load.</b>
+ */
+
+#include "bencode.h"
+
+#define NEXT_CHAR ++*str; --*len;
+#define END_CHECK_SKIP(t) {if(!*len)\
+                            rb_raise(DecodeError, "Unpexpected " #t " end!");\
+                           if(**str != 'e')\
+                            rb_raise(DecodeError, "Mailformed " #t " at %d byte: %c", rlen - *len, **str);\
+                           NEXT_CHAR;}
+
+static long parse_num(char** str, long* len){
+  long t = 1, ret = 0;
+
+  if(**str == '-'){
+    t = -1;
+    NEXT_CHAR;
+  }
+
+  while(*len && **str >= '0' && **str <= '9'){
+    ret = ret * 10 + (**str - '0');
+    NEXT_CHAR;
+  }
+
+  return ret * t;
+}
+
+static VALUE _decode(char** str, long* len, long rlen){
+  if(!*len)
+    return Qnil;
+
+  switch(**str){
+    case 'l':{
+      VALUE ret = rb_ary_new();
+      NEXT_CHAR;
+
+      while(**str != 'e' && *len)
+        rb_ary_push(ret, _decode(str, len, rlen));
+
+      END_CHECK_SKIP(list);
+      return ret;
+    }
+    case 'd':{
+      VALUE ret = rb_hash_new();
+      NEXT_CHAR;
+
+      while(**str != 'e' && *len){
+        long t = rlen - *len;
+        VALUE k = _decode(str, len, rlen);
+
+        if(NIL_P(k))
+          rb_raise(DecodeError, "Unpexpected dictionary end!");
+        else if(TYPE(k) != T_STRING)
+          rb_raise(DecodeError, "Dictionary key is not a string at %d!", t);
+
+        rb_hash_aset(ret, k, _decode(str, len, rlen));
+      }
+
+      END_CHECK_SKIP(dictionary);
+      return ret;
+    }
+    case 'i':{
+      long t;
+      NEXT_CHAR;
+      t = parse_num(str, len);
+      END_CHECK_SKIP(integer);
+      return LONG2FIX(t);
+    }
+    case '0'...'9':{
+      VALUE ret;
+      long slen = parse_num(str, len);
+
+      if(slen < 0 || (*len && **str != ':'))
+        rb_raise(DecodeError, "Invalid string length specification at %d: %c", rlen - *len, **str);
+
+      if(!*len || *len < slen + 1)
+        rb_raise(DecodeError, "Unexpected string end!");
+
+      ret = rb_str_new(++*str, slen);
+      *str += slen;
+      *len -= slen + 1;
+      return ret;
+    }
+    default:
+      rb_raise(DecodeError, "Unknown element type at %d byte: %c", rlen - *len, **str);
+      return Qnil;
+  }
+}
+
+/*
+ * Document-method: BEncode.decode
+ * call-seq:
+ *     BEncode.decode(string)
+ *
+ * Returns data structure from parsed _string_.
+ * String must be valid bencoded data, or
+ * BEncode::DecodeError will be raised with description
+ * of error.
+ *
+ * Examples:
+ *
+ *    'i1e' => 1
+ *    'i-1e' => -1
+ *    '6:string' => 'string'
+ */
+
+static VALUE decode(VALUE self, VALUE str){
+  long rlen, len;
+  char* ptr;
+  VALUE ret;
+
+  if(!rb_obj_is_kind_of(str, rb_cString))
+    rb_raise(rb_eTypeError, "String expected");
+
+  rlen = len = RSTRING_LEN(str);
+  ptr = RSTRING_PTR(str);
+  ret = _decode(&ptr, &len, len);
+
+  if(len)
+    rb_raise(DecodeError, "String has garbage on the end (starts at %d).", rlen - len);
+
+  return ret;
+}
+
+static VALUE _decode_file(VALUE fp){
+  return decode(BEncode, rb_funcall(fp, readId, 0));
+}
+
+/*
+ * Document-method: BEncode.decode_file
+ * call-seq:
+ *    BEncode.decode_file(file)
+ *
+ * Load content of _file_ and decodes it.
+ * _file_ may be either IO instance or
+ * String path to file.
+ *
+ * Examples:
+ *
+ *   BEncode.decode_file('/path/to/file.torrent')
+ *
+ *   open('/path/to/file.torrent', 'rb') do |f|
+ *     BEncode.decode_file(f)
+ *   end
+ */
+
+static VALUE decode_file(VALUE self, VALUE path){
+  if(rb_obj_is_kind_of(path, rb_cIO)){
+    return _decode_file(path);
+  }else{
+    VALUE fp = rb_file_open_str(path, "rb");
+    return rb_ensure(_decode_file, fp, rb_io_close, fp);
+  }
+}
+
+/*
+ * Document-method: BEncode#bencode
+ * call-seq:
+ *    object.bencode
+ *
+ * Returns a string representing _object_ in
+ * bencoded format. _object_ must be one of:
+ *   Integer
+ *   String
+ *   Symbol (will be converter to String)
+ *   Array
+ *   Hash
+ * If _object_ does not belong to these types
+ * or their derivates BEncode::EncodeError exception will
+ * be raised.
+ *
+ * Because BEncode is included into Object
+ * This method is avilable for all objects.
+ *
+ * Examples:
+ *
+ *   1.bencode => 'i1e'
+ *   -1.bencode => 'i-1e'
+ *   'string'.bencode => '6:string'
+ */
+
+static VALUE encode(VALUE self){
+  if(TYPE(self) == T_SYMBOL){
+    return encode(rb_id2str(SYM2ID(self)));
+  }if(rb_obj_is_kind_of(self, rb_cString)){
+    long len = RSTRING_LEN(self);
+    return rb_sprintf("%d:%.*s", len, len, RSTRING_PTR(self));
+  }else if(rb_obj_is_kind_of(self, rb_cInteger)){
+    return rb_sprintf("i%de", NUM2LONG(self));
+  }else if(rb_obj_is_kind_of(self, rb_cHash)){
+    VALUE ret = rb_str_new2("d");
+    rb_hash_foreach(self, hash_traverse, ret);
+    rb_str_cat2(ret, "e");
+    return ret;
+  }else if(rb_obj_is_kind_of(self, rb_cArray)){
+    long i, c;
+    VALUE *ptr, ret = rb_str_new2("l");
+
+    for(i = 0, c = RARRAY_LEN(self), ptr = RARRAY_PTR(self); i < c; ++i)
+      rb_str_concat(ret, encode(ptr[i]));
+
+    rb_str_cat2(ret, "e");
+    return ret;
+  }else
+    rb_raise(EncodeError, "Don't know how to encode %s!", rb_class2name(CLASS_OF(self)));
+}
+
+static int hash_traverse(VALUE key, VALUE val, VALUE str){
+  if(!rb_obj_is_kind_of(key, rb_cString) && TYPE(key) != T_SYMBOL)
+    rb_raise(EncodeError, "Keys must be strings, not %s!", rb_class2name(CLASS_OF(key)));
+
+  rb_str_concat(str, encode(key));
+  rb_str_concat(str, encode(val));
+  return ST_CONTINUE;
+}
+
+/*
+ * Document-method: String#bdecode
+ * call-seq:
+ *    string.bdecode
+ *
+ * Shortcut to BEncode.encode(_string_)
+ */
+
+static VALUE str_bdecode(VALUE self){
+  return decode(BEncode, self);
+}
+
+/*
+ * Document-method: encode
+ * call-seq:
+ *    BEncode.encode(object)
+ *
+ * Shortcut to _object_.bencode
+ */
+
+static VALUE mod_encode(VALUE self, VALUE x){
+  return encode(x);
+}
+
+void Init_bencode_ext(){
+  readId = rb_intern("read");
+  BEncode = rb_define_module("BEncode");
+  /*
+   * Document-class: BEncode::DecodeError
+   * Exception for indicating decoding errors.
+   */
+  DecodeError = rb_define_class_under(BEncode, "DecodeError", rb_eRuntimeError);
+
+  /*
+   * Document-class: BEncode::EncodeError
+   * Exception for indicating encoding errors.
+   */
+  EncodeError = rb_define_class_under(BEncode, "EncodeError", rb_eRuntimeError);
+
+  rb_define_singleton_method(BEncode, "decode", decode, 1);
+  rb_define_singleton_method(BEncode, "encode", mod_encode, 1);
+  rb_define_singleton_method(BEncode, "decode_file", decode_file, 1);
+
+  rb_define_method(BEncode, "bencode", encode, 0);
+  rb_define_method(rb_cString, "bdecode", str_bdecode, 0);
+
+  rb_include_module(rb_cObject, BEncode);
+}

data/ext/bencode_ext/bencode.h

@@ -0,0 +1,22 @@
+#ifndef __BENCODE_H__
+#define __BENCODE_H__
+
+#include "ruby.h"
+
+static VALUE BEncode;
+static VALUE DecodeError;
+static VALUE EncodeError;
+static VALUE readId;
+
+static long parse_num(char**, long*);
+static VALUE _decode(char**, long*, long);
+static VALUE decode(VALUE, VALUE);
+static VALUE encode(VALUE);
+static int hash_traverse(VALUE, VALUE, VALUE);
+static VALUE str_bdecode(VALUE);
+static VALUE mod_encode(VALUE, VALUE);
+static VALUE _decode_file(VALUE);
+static VALUE decode_file(VALUE, VALUE);
+void Init_bencode_ext();
+
+#endif

data/ext/bencode_ext/extconf.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby -w
+
+require 'mkmf'
+create_makefile('bencode_ext')

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'ext'))
+require 'bencode_ext'
+
+class Test::Unit::TestCase
+end

data/test/test_bencode_ext.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestBencodeExt < Test::Unit::TestCase
+  def test_encoding
+    assert_equal('i1e', 1.bencode)
+    assert_equal('i-1e', -1.bencode)
+    assert_equal('6:symbol', :symbol.bencode)
+    assert_equal('6:string', 'string'.bencode)
+    assert_equal('li1ei2ee', [1, 2].bencode)
+    assert_equal('d3:keyi10ee', {:key => 10}.bencode)
+    assert_equal('ld1:ki1eed1:ki2eed1:kd1:v3:123eee', [{:k => 1}, {:k => 2}, {:k => {:v => '123'}}].bencode)
+
+    assert_raises(BEncode::EncodeError) { STDERR.bencode }
+  end
+
+  def test_decoding
+    assert_equal(1, 'i1e'.bdecode)
+    assert_equal(-1, 'i-1e'.bdecode)
+    assert_equal('string', '6:string'.bdecode)
+    assert_equal([1, 2], 'li1ei2ee'.bdecode)
+    assert_equal({'key' => 10}, 'd3:keyi10ee'.bdecode)
+    assert_equal([{'k' => 1}, {'k' => 2}, {'k' => {'v' => '123'}}], 'ld1:ki1eed1:ki2eed1:kd1:v3:123eee'.bdecode)
+
+    assert_raises(BEncode::DecodeError) {'33:unpexpected_end'.bdecode }
+    assert_raises(BEncode::DecodeError) { 'i1x'.bdecode }
+    assert_nil(''.bdecode)
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: bencode_ext
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- naquad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 5
+        version: 0.7.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id002
+description: BEncodeExt is implementation of Bencode reader/writer (BitTorent encoding) in C.
+email: naquad@gmail.com
+executables: []
+
+extensions: 
+- ext/bencode_ext/extconf.rb
+- ext/bencode_ext/extconf.rb
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/bencode_ext/bencode.c
+- ext/bencode_ext/bencode.h
+- ext/bencode_ext/extconf.rb
+- test/helper.rb
+- test/test_bencode_ext.rb
+has_rdoc: true
+homepage: http://github.com/naquad/bencode_ext
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BitTorrent encoding parser/writer
+test_files: 
+- test/helper.rb
+- test/test_bencode_ext.rb