tnetstring 0.3.2 → 0.3.3

data/HISTORY.rdoc

@@ -0,0 +1,25 @@
+== 0.3.2 / 2011-06-21
+* Bug Fix
+  * Parsing Hashes with null values now works
+* Feature Addition
+  * Hash keys may now be symbols
+  * TNetstring.dump method introduced, identical to TNetstring.encode
+* Deprecation
+  * TNetstring.encode deprecated in favor of TNetstring.dump, aligning with other implementations.
+== 0.3.1 / 2011-04-17
+* API Change
+  * Error conditions raise TNetstring::ProcessError
+* Documentation
+  * Add inline documentation and update README
+== 0.3.0 / 2011-04-16
+* New Feature
+  * Can encode primatives according to the tnetstring spec
+* API Change
+  * TNetstring#parse now returns remainder of input
+  * TNetstring#parse_tnetstring removed (effectively, renamed to #parse)
+== 0.2.0 / 2011-04-13
+* Feature Update
+  * Bring parsing inline with tnetstrings.org reference spec, thanks to twopir
+== 0.1.0 / 2011-04-12
+* Initial Release
+  * Pure-Ruby implementation of Zed Shaw's initial example

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Matt Yoho
+
+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,61 @@
+= tnetstring-rb
+
+Tagged netstrings were conceived by Zed Shaw as a convenient text format for
+exchanging small amounts of data over the network, based on
+Dan Bernstein's earlier idea, {netstrings}[http://cr.yp.to/proto/netstrings.txt].
+They are meant as an alternative to JSON that are easier to handle in low-level
+network code and simpler to implement.
+
+The following set of intended characteristics of tagged netstrings is
+excerpted from the {official specification}[http://tnetstrings.org/]:
+
+* Trivial to parse in every language without making errors.
+* Resistant to buffer overflows and other problems.
+* Fast and low resource intensive.
+* Makes no assumptions about string contents and can store binary data without escaping or encoding them.
+* Backward compatible with original netstrings.
+* Transport agnostic, so it works with streams, messages, files, anything that's 8-bit clean.
+
+Tagged netstrings support the following primitives: strings, integers, booleans
+(true or false), null (or nil), lists (arrays), and dictionaries (hashes).
+
+Please see the official spec {tnetstrings.org}[http://tnetstrings.org/] for
+further detail.
+
+== Examples
+
+Given a string in tnetstring format, it can be parsed like so:
+
+    str = '5:12345#'
+    TNetstring.parse(str)
+
+    #=> [12345, '']
+
+This returns a tuple that contains the parsed object and any remaining string
+input.
+
+Encoding an object as a tnetstring is similarly straightforward:
+
+    int = 12345
+    TNetstring.encode(int)
+
+    #=> '5:12345#'
+
+Please see the specs in this project for more examples.
+
+== Installation
+
+It's a gem, so do the usual:
+
+    gem install tnetstring
+
+== Attribution
+
+The initial implementation was a port of Zed's first (pre-standardization)
+tnetstrings {implementation in Python}[http://codepad.org/xct0E5ac].
+
+== The Future
+
+Before going 1.0 the library will be converted to a native gem for performance
+reasons. A native Java/JRuby implementation is planned as well. The current pure
+Ruby gem may be ported to a tnetstring-pure library.

data/lib/tnetstring/version.rb

@@ -1,5 +1,5 @@
 module TNetstring # :nodoc:
   module Version # :nodoc:
-    STRING = '0.3.2'
+    STRING = '0.3.3'
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Matt Yoho
@@ -53,12 +53,17 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- HISTORY.rdoc
+- MIT-LICENSE
+- README.rdoc
 files: 
 - lib/tnetstring/errors.rb
 - lib/tnetstring/version.rb
 - lib/tnetstring.rb
+- HISTORY.rdoc
+- MIT-LICENSE
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/mattyoho/tnetstring-rb
 licenses: []