cztop 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c82a0f35f091e2d464beabb00adaf5ad0f0b35
-  data.tar.gz: aa92e0a78ca5ca7dcc00441d16e004085024a60a
+  metadata.gz: 1797c227b1864ce06f37506793448b449d067778
+  data.tar.gz: 79c7e8d0ac13492a4255edad4e28edf6a06c12b9
 SHA512:
-  metadata.gz: 792e7990a6451bd7f02b638e02c782c95c9d54cbc009aa371de33234ed84b06d88737f830406363e96b44425f643c051948a57aa81719e9059627c48252a308b
-  data.tar.gz: 1af4724a36e2959e1e94f552c9289e51f98aa5565df5bb6c14cc8a99130401fd4713fa3f75090e2dcdc9cc466521d7e2a51bea756df20d34a10767767d3822d8
+  metadata.gz: bd9cfb68026997aaeec79b3f09aebb94070586411e0a79440705637ec2e0f9e91625f82f98d7a8eaf47ad3fd76700197670c3da663ff35b82bd3748733d63095
+  data.tar.gz: 10f4e7752dba82961a22ca38c0e21745581ec48fde1b55f2918ecab4a70e040e24a876dc99b0ee987d34543e5235f5876590746309e3592c28074ac24db9c9fd

data/README.md

@@ -13,38 +13,6 @@ mechanisms (like CURVE).
 [![Coverage Status](https://coveralls.io/repos/paddor/cztop/badge.svg?branch=master&service=github)](https://coveralls.io/github/paddor/cztop?branch=master)
 [![ISC License](https://img.shields.io/badge/license-ISC_License-blue.svg)](LICENSE)
 
-## Reasons
-
-Why another CZMQ Ruby binding? Here is a list of existing projects I found and
-the issues with them, from my point of view:
-
-* [Asmod4n/ruby-ffi-czmq](https://github.com/Asmod4n/ruby-ffi-czmq)
-  * outdated
-  * according to its author, it's an "abomination"
-* [methodmissing/rbczmq](https://github.com/methodmissing/rbczmq)
-  * no support for security features (see [methodmissing/rbczmq#28](https://github.com/methodmissing/rbczmq/issues/28))
-  * no JRuby support (see [methodmissing/rbczmq#48](https://github.com/methodmissing/rbczmq/issues/48))
-  * doesn't feel like Ruby
-* [mtortonesi/ruby-czmq](https://github.com/mtortonesi/ruby-czmq)
-  * no tests
-  * no documentation
-  * outdated
-  * doesn't feel like Ruby
-* [chuckremes/ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
-  * support discontinued
-  * low level ZMQ gem, not CZMQ
-
-Furthermore, I knew about the generated low-level Ruby FFI binding in the
-[zeromq/czmq](https://github.com/zeromq/czmq) repository. I wanted to make use
-of it because I love that it's generated (and thus, most likely correct
-and up-to-date). Unfortunately, it was in pretty bad shape and missing a few
-CZMQ classes.
-
-So I decided to improve the quality and usability of the binding and add the
-missing classes. The result is
-[czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen) which provides a solid
-foundation for CZTop.
-
 ## Goals
 
 Here are some some of the goals I have/had in mind for this library:
@@ -371,6 +339,38 @@ $
   * can be used in a pipeline (limited memory usage)
   * reusable interface: `Z85::Pipe`
 
+## Reasons
+
+Why another CZMQ Ruby binding? Here is a list of existing projects I found and
+the issues with them, from my point of view:
+
+* [Asmod4n/ruby-ffi-czmq](https://github.com/Asmod4n/ruby-ffi-czmq)
+  * outdated
+  * according to its author, it's an "abomination"
+* [methodmissing/rbczmq](https://github.com/methodmissing/rbczmq)
+  * no support for security features (see [methodmissing/rbczmq#28](https://github.com/methodmissing/rbczmq/issues/28))
+  * no JRuby support (see [methodmissing/rbczmq#48](https://github.com/methodmissing/rbczmq/issues/48))
+  * doesn't feel like Ruby
+* [mtortonesi/ruby-czmq](https://github.com/mtortonesi/ruby-czmq)
+  * no tests
+  * no documentation
+  * outdated
+  * doesn't feel like Ruby
+* [chuckremes/ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
+  * support discontinued
+  * low level ZMQ gem, not CZMQ
+
+Furthermore, I knew about the generated low-level Ruby FFI binding in the
+[zeromq/czmq](https://github.com/zeromq/czmq) repository. I wanted to make use
+of it because I love that it's generated (and thus, most likely correct
+and up-to-date). Unfortunately, it was in pretty bad shape and missing a few
+CZMQ classes.
+
+So I decided to improve the quality and usability of the binding and add the
+missing classes. The result is
+[czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen) which provides a solid
+foundation for CZTop.
+
 
 ## Contributing
 

data/lib/cztop/certificate.rb

@@ -20,15 +20,21 @@ module CZTop
       from_ffi_delegate(ptr)
     end
 
-    # Creates a new certificate from the given keys.
-    # @param public_key [String] binary public key (32 bytes)
-    # @param secret_key [String] binary secret key (32 bytes)
+    # Creates a new certificate from the given keys (either binary or in Z85
+    # format).
+    # @param public_key [String] binary public key (32 or 40 bytes)
+    # @param secret_key [String, nil] binary secret key (32 or 40 bytes), or
+    #   nil to initialize a public key only certificate
     # @return [Certificate] the fresh certificate
     # @raise [ArgumentError] if keys passed are invalid
     # @raise [SystemCallError] if this fails
-    def self.new_from(public_key, secret_key)
+    def self.new_from(public_key, secret_key = nil)
       raise ArgumentError, "no public key given" unless public_key
-      raise ArgumentError, "no secret key given" unless secret_key
+      secret_key ||= "\x00" * 32 # no secret key given, provide 32 null bytes
+
+      # convert Z85 => binary
+      public_key = Z85.decode(public_key) if public_key.bytesize == 40
+      secret_key = Z85.decode(secret_key) if secret_key.bytesize == 40
 
       raise ArgumentError, "invalid public key size" if public_key.bytesize != 32
       raise ArgumentError, "invalid secret key size" if secret_key.bytesize != 32

data/lib/cztop/version.rb

@@ -1,3 +1,3 @@
 module CZTop
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Patrik Wenger