z85rb 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in z85rb.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,4 @@
+Permission to use, copy, modify, and/or distribute this software
+for any purpose with or without fee is hereby granted.
+
+This software is provided "as is" without express or implied warranty.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jakukyo Friel
+
+MIT License
+
+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.md

@@ -0,0 +1,68 @@
+z85rb - pure Ruby implementation of Z85 encoding
+================================================
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'z85rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install z85rb
+
+## Usage
+
+```rb
+encode("\x86\x4f\xd2\x6f\xb5\x59\xf7\x5b") # => 'HelloWorld'
+decode('nm=QNzY&b1A+]nf') # => 'Hello World!'
+```
+
+Encoding data not padded to a multiple of 4 will raise `ArgumentError`.
+
+## Difference to reference implementation in C:
+
+When input binary form in encoding is not bounded to 4 bytes, or input string
+frame in decoding is not bounded to 5 bytes, the [reference implementation][c]
+returns `NULL`.
+
+Instead of returning `nil`, we raise an `ArgumentError`.
+
+Raising an exception conforms the [specification][rfc]. We guess that the reference
+implementation returns `NULL` is because C does not have native support for
+exceptions.
+
+## Difference to z85 C extension for ruby
+
+This gem is a drop-in replace for [z85 C extension][z85].
+API is the same.
+
+There is only one difference:
+
+When input is invalid (not bounded to 4 or 5 bytes),  this gem raises an
+`ArgumentError` while z85 C extension raises `RuntimeError`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## References
+
+- [Z85 - ZeroMQ Base-85 Encoding Algorithm][rfc]
+- [A reference implementation in C][c]
+
+[rfc]: http://rfc.zeromq.org/spec:32
+[c]: https://github.com/zeromq/rfc/blob/master/src/spec_32.c
+[z85]: https://github.com/fpesce/z85/
+
+## License
+
+0BSD

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/doctest_helper.rb

@@ -0,0 +1,15 @@
+require 'lib/z85rb'
+
+open('lib/z85rb.rb') do |f|
+  module_lines = f.find_all { |line| line[0..5] == 'module' }
+  modules = module_lines.map { |s| s.strip.tr(' ', '')[6..-1] }
+  modules.each do |mod|
+    mod = Object.const_get(mod)
+    include mod
+    YARD::Doctest.configure do |doctest|
+      mod.private_instance_methods.each do |m|
+        doctest.skip "#{mod}.#{m}"
+      end
+    end
+  end
+end

data/lib/z85rb.rb

@@ -0,0 +1,107 @@
+require_relative 'z85rb/version'
+
+module Z85rb
+  module_function
+
+  # Encode binary data into Z85.
+  #
+  # @param data [String] binary
+  # @return [String] Z85 encoded
+  #
+  # @example HelloWorld
+  #   # Encode to 'HelloWorld' is an example from Z85 RFC.
+  #   encode("\x86\x4f\xd2\x6f\xb5\x59\xf7\x5b") #=> 'HelloWorld'
+  #   encode('Hello World!') #=> 'nm=QNzY&b1A+]nf'
+  #
+  # @example Not padded to a multiple of 4
+  #   assert_raise(ArgumentError) { encode('HelloWorld') } #=> true
+  #
+  # @example longer data
+  #   # Borrowed from Z85 reference implementation in C.
+  #   test_data_2 = "\x8E\v\xDDiv(\xB9\x1D\x8F$U\x87\xEE\x95\xC5\xB0MH\x96?y%\x98w\xB4\x9C\xD9\x06:\xEA\xD3\xB7"
+  #   encode(test_data_2) #=> 'JTKVSB%%)wK0E.X)V>+}o?pNmC{O&4W4b!Ni{Lh6'
+  def encode(data)
+    if data.length % 4 != 0
+		  raise ArgumentError, 'The input binary frame should have a length that is divisible by 4 with no remainder.'
+    end
+
+    encoder = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#'
+		str = ''
+		byte_nbr = 0
+		size = data.length
+		value = 0
+    while byte_nbr < size
+      value = (value * 256) + data[byte_nbr].ord
+      byte_nbr += 1
+      if byte_nbr % 4 == 0
+        divisor = 85 * 85 * 85 * 85
+        while divisor >= 1
+          idx = (value / divisor).floor % 85
+          str += encoder[idx]
+          divisor /= 85
+        end
+        value = 0
+      end
+    end
+	  str
+  end
+
+  # Decode Z85 to binary string.
+  #
+  # @param string [String] Z85 encoded
+  # @return [String] binary
+  #
+  # @example HelloWorld
+  #   decode('HelloWorld') #=> "\x86\x4f\xd2\x6f\xb5\x59\xf7\x5b"
+  #   decode('nm=QNzY&b1A+]nf') #=> 'Hello World!'
+  #
+  # @example Not padded to a multiple of 5
+  #   assert_raise(ArgumentError) { decode('hello_world') } #=> true
+  #
+  # @example longer data
+  #   decode('JTKVSB%%)wK0E.X)V>+}o?pNmC{O&4W4b!Ni{Lh6')
+  #   #=> "\x8E\v\xDDiv(\xB9\x1D\x8F$U\x87\xEE\x95\xC5\xB0MH\x96?y%\x98w\xB4\x9C\xD9\x06:\xEA\xD3\xB7"
+  def decode(string)
+    if string.length % 5 != 0
+       raise ArgumentError, 'The input string frame should have a length that is divisible by 5 with no remainder.'
+    end
+
+    decoder = [
+    0x00, 0x44, 0x00, 0x54, 0x53, 0x52, 0x48, 0x00,
+    0x4B, 0x4C, 0x46, 0x41, 0x00, 0x3F, 0x3E, 0x45,
+    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+    0x08, 0x09, 0x40, 0x00, 0x49, 0x42, 0x4A, 0x47,
+    0x51, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A,
+    0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32,
+    0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A,
+    0x3B, 0x3C, 0x3D, 0x4D, 0x00, 0x4E, 0x43, 0x00,
+    0x00, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10,
+    0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,
+    0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20,
+    0x21, 0x22, 0x23, 0x4F, 0x00, 0x50, 0x00, 0x00,
+    ]
+	  dest = []
+		byte_nbr = 0
+		char_nbr = 0
+		string_len = string.length
+		value = 0
+    while char_nbr < string_len
+      idx = string[char_nbr].ord - 32
+      value = (value * 85) + decoder[idx]
+      char_nbr += 1
+      if char_nbr % 5 == 0
+        divisor = 256 * 256 * 256
+        while divisor >= 1
+          dest[byte_nbr] = (value / divisor) % 256
+          byte_nbr += 1
+          divisor /= 256
+        end
+        value = 0
+      end
+    end
+    # We think `C*` and `c*` is equivalent in this case.
+    # We use `C*` merely because reference implement in C uses `unsigned char`.
+    # https://github.com/zeromq/rfc/blob/master/src/spec_32.c#
+    dest.pack 'C*'
+  end
+end

data/lib/z85rb/version.rb

@@ -0,0 +1,3 @@
+module Z85rb
+  VERSION = "0.0.0"
+end

data/z85rb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'z85rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "z85rb"
+  spec.version       = Z85rb::VERSION
+  spec.authors       = ["Jakukyo Friel"]
+  spec.email         = ["weakish@gmail.com"]
+  spec.description   = %q{Pure Ruby implementiation of Z85 encoding.
+                          A drop-in replace for Z85 C extension for Ruby.}
+  spec.summary       = %q{Pure Ruby implementiation of Z85 encoding.}
+  spec.homepage      = "https://github.com/weakish/z85rb"
+  spec.license       = "0BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard-doctest'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: z85rb
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jakukyo Friel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Pure Ruby implementiation of Z85 encoding.\n                          A
+  drop-in replace for Z85 C extension for Ruby."
+email:
+- weakish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- doctest_helper.rb
+- lib/z85rb.rb
+- lib/z85rb/version.rb
+- z85rb.gemspec
+homepage: https://github.com/weakish/z85rb
+licenses:
+- 0BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pure Ruby implementiation of Z85 encoding.
+test_files: []
+has_rdoc: