This gem provides decoding capablity of yEnc. You can find more documentation about yEnc at http://www.yenc.org. yEnc is used to encode Usenet binary files and convert them to ASCII.
yEnc is a new encoding method which offers efficient and proper transmission for binaries on the Usenet (or by eMail and other applications). Other encodings are BASE64, BinHex, UUencode, Quoted Printable, .....
yEnc is NOT an audio format (as MP3) or a video format (as AVI, MOV,...) or a picture format (as GIF or JPEG).
gem install yEnc
This gem currently only supports decoding a single yEnc file. You can decode your yenc file by doing this.
require 'yEnc'
y = YEnc.new( full_path_to_yenc_text_file, path_to_output_binary_to )
y.decode
This will decode the yEnc ASCII text file to a binary file in the output path directory.
If you want to encode a file. This gem currently does not support multipart encoding. You can initialize the object with the first parameter being the full path of the file you want to encode, and the second parameter as the output directory and call it. The function takes the name of the ASCII output text file and will place it in the PATH specified by the second instantiation parameter.
require 'yEnc'
y = YEnc.new( full_path_to_binary_to_encode, path_to_output_encoded_ascii_file )
y.encode_to_file "encoded.txt"
If you want to check if the generated binary has the expected crc32 signature from the yEnc file.
y.pass_crc32?
You can retrieve internal class data for these attributes
- filepath
- outputpath
- filename
- filesize
- line
- crc32
- 0.0.30 - Added Added "encode" function which provides us with encoded string [tdobrovolskij]
- 0.0.29 - Implemented first encoder to encode from binary to yEnc file
- 0.0.27 - Cleaned up and removed puts calls and added pass_crc32? call
- 0.0.25 - First release with working decoder
- 0.0.20 - Initial commit to ruby gems not even working
tdobrovolskij https://github.com/tdobrovolskij