newque 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5504f3a97aaff17e93f906c869c6e982ee42d60
+  data.tar.gz: 8771b1cbbb8c5a26b9935ee99eabcb0384dbb841
+SHA512:
+  metadata.gz: c03f7dd2f5bf46c77caec96e7cb58d7b148c0a65a3d925d8bd3db01a2e3c6a9bb8582894b95e570167e43428b1ebb5a78eb7586bd09e9db9fc90abd7e2de9791
+  data.tar.gz: fb1bc9900665f40872f67629b81fdaf88063ec4b3bd8ae6bda4c754848f881a36830a083546c967be4db646af8c5b256b7c1b37acb7221f2dbc1ed419517395c

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+test.rb
+.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/README.md

@@ -0,0 +1,340 @@
+# Newque-ruby
+
+Official gem for [Newque](https://github.com/newque/newque). It offers a high level interface that is fully asynchronous and non-blocking.
+
+See the [Newque documentation](https://github.com/newque/newque) for more information about configuring Newque for your use case.
+
+## Install
+Requirements:
+
+- libffi
+- libzmq
+
+Mac:
+```bash
+brew install libffi zeromq
+```
+Linux:
+```bash
+sudo apt-get install libffi-dev libzmq5
+```
+
+Then add `gem 'newque'` to your Gemfile.
+
+## Client
+A Client is the main way to interact with Newque. Clients can send requests to Newque (Write, Read, Count, etc.) and receive responses for those requests. Every operation is *concurrent*, meaning that you can send multiple requests at the same time and wait until they all complete. These requests will be executing in parallel in the background. Read the short [Newque-Ruby Concurrency Guide](#newque-ruby-concurrency-guide) for a refresher on concurrency in Ruby.
+
+```ruby
+Newque::Client.new(protocol, host, port, protocol_options:, timeout:)
+```
+```ruby
+# Example values
+client = Newque::Client.new(:http, '127.0.0.1', 8005, protocol_options:{https: true}, timeout:5000)
+```
+These 3 arguments are required:
+- **protocol**: (`:zmq` or `:http`) Must match the protocol used by the Newque server.
+- **host**: (`String`) Hostname/IP address of the Newque server.
+- **port**: (`Integer`) Port of the Newque server.
+
+Additionally, you can supply these optional named arguments:
+- **protocol_options**: (`Hash`) Optional named argument. The valid options depend on the `protocol` being used. See [ZMQ Options](#zmq-options) and [HTTP Options](#http-options).
+- **timeout** (`Integer`) Optional named argument. Number of milliseconds to wait before cancelling for an operation to receive a response from the server. `10000` by default. At the moment only HTTP uses this value. Since all operations return Threads, it's also possible to use Ruby's `.join(1)` on a response thread to wait for 1 second. [Newque-Ruby Concurrency Guide](#newque-ruby-concurrency-guide)
+
+### Client methods
+
+#### .write
+```ruby
+result = client.write(channel, atomic, messages)
+result.value # => waits until the call completes and returns a Newque::Write_Response
+```
+- **channel** (`String`) Name of the channel.
+- **atomic** (`Bool`) Whether the messages should be treated as one.
+- **messages** (`Array` of `String`s) The messages to send.
+
+Returns a `Thread`. The value returned by the thread will be a [`Newque::Write_Response`](#write_response).
+
+#### .read
+```ruby
+result = client.read(channel, mode, limit)
+result.value # => waits until the call completes and returns a Newque::Read_Response
+```
+- **channel** (`String`) Name of the channel.
+- **mode** (`String`) Newque Reading Mode.
+- **limit** (Optional `Integer`) The maximum number of messages to receive. `nil` by default.
+
+Returns a `Thread`. The value returned by the thread will be a [`Newque::Read_Response`](#read-response).
+
+#### .read_stream
+```ruby
+enumerable = client.read_stream(channel, mode, limit)
+```
+- **channel** (`String`) Name of the channel.
+- **mode** (`String`) Newque Reading Mode.
+- **limit** (Optional `Integer`) The maximum number of messages to receive. `nil` by default.
+
+Not available on `:zmq` clients! It takes the same arguments as `read` and returns a Lazy Enumerable. It'll stream the messages from Newque only when requested, for example by doing `.each` or any other standard method supported by Enumerables. It only holds a small number of messages at a time in memory (configurable on the server), making this a convenient way to iterate through a large dataset without having to make multiple `read` calls. It uses HTTP's `Transfer-Encoding: Chunked`. For obvious reasons it's not possible to know how many messages will be returned until the stream is exhausted by iterating through the entire Enumerable.
+
+#### .count
+```ruby
+result = client.count(channel)
+result.value # => waits until the call completes and returns a Newque::Count_Response
+```
+- **channel** (`String`) Name of the channel.
+
+Returns a `Thread`. The value returned by the thread will be a [`Newque::Count_Response`](#count-response).
+
+#### .delete
+```ruby
+result = client.delete(channel)
+result.value # => waits until the call completes and returns a Newque::Delete_Response
+```
+- **channel** (`String`) Name of the channel.
+
+Returns a `Thread`. The value returned by the thread will be a [`Newque::Delete_Response`](#delete-response).
+
+#### .health
+```ruby
+result = client.health(channel, global)
+result.value # => waits until the call completes and returns a Newque::Health_Response
+```
+- **channel** (`String`) Name of the channel.
+- **global** (`Bool`) Whether this health check should check all the channels on the server or just this one.
+
+Returns a `Thread`. The value returned by the thread will be a [`Newque::Health_Response`](#health-response).
+
+## Pubsub Client
+A Pubsub Client is a special type of client that can listen to requests coming from a Newque Pubsub endpoint. These Pubsub Clients are the subscribers. It's possible to have any number of Pubsub Clients active at any time.
+```ruby
+consumer = Newque::Pubsub_client.new(host, port, protocol_options:, socket_wait:)
+```
+The first 4 arguments are identical to a normal [Client](#client).
+
+**socket_wait**: (`Integer`) Optional named argument. This is the maximum acceptable time it could take to disconnect from the server. `100` (ms) by default.
+
+#### .subscribe
+This is the main operation on a Pubsub Client.
+```ruby
+ready = consumer.subscribe do |input|
+  input.messages # => ['msg1', 'msg2']
+  input.action # => Newque::Write_request or Newque::Read_request, etc.
+end
+
+sub_id = ready.value # Waits until we are connected and returns the sub_id
+```
+Each time a request is sent to the Pubsub endpoint, this block will be invoked. The `input` argument is an [Input_request](#input-request).
+
+`.subscribe` takes a block and returns a Thread that evaluates to a Subscription ID. That Sub ID can then be given to `.unsubscribe` later to deactivate this specific block.
+
+The Thread that was returned by `.subscribe` does not resolve until the block is actively listening, which can take a few milliseconds.
+
+It's possible to call `.subscribe` on the same Pubsub Client many times to register multiple blocks. A Pubsub Client doesn't open a connection to the server until a block is registered.
+
+#### .unsubscribe
+```ruby
+consumer.unsubscribe(sub_id)
+```
+Removes the block passed earlier from the list of subscribers.
+
+#### .add_error_handler
+```ruby
+consumer.add_error_handler do |error|
+  # Do something with error
+end
+```
+`.add_error_handler` takes a single block and can be called multiple times to register multiple blocks. When exceptions are raised inside of a subscribed block they are passed to this error handling block. If no error handler is present when an exception is raised, it'll be printed using `puts`, so register an error handler if you wish to avoid this behavior!
+
+#### .disconnect
+```ruby
+consumer.disconnect
+```
+Disconnects the Pubsub Client within `socket_wait` milliseconds. All subscribed blocks are still present. To reconnect, simply `.subscribe` a new block (you can unsubscribe it later).
+
+## Fifo Client
+A Fifo Client is a special type of client that can listen to requests coming from a Newque Fifo endpoint and send responses back! It's possible to have any number of Fifo Clients active at any time.
+```ruby
+consumer = Newque::Fifo_client.new(host, port, protocol_options:, socket_wait:)
+```
+The first 4 arguments are identical to a normal [Client](#client).
+
+**socket_wait**: (`Integer`) Optional named argument. This is the maximum acceptable time it could take to disconnect from the server. `100` (ms) by default.
+
+#### .connect
+This is the main operation on a Fifo Client.
+```ruby
+ready = consumer.connect do |input|
+  input.channel # => 'my_channel'
+  input.messages # => ['msg1', 'msg2']
+  input.action # => Newque::Write_request or Newque::Read_request, etc.
+
+  # If `input.action` was a Newque::Write_request, then I must return a Newque::Write_response
+  Newque::Write_response.new(5)
+end
+
+ready.join # Only needed if we wish to wait until the Fifo Client is ready
+```
+`.connect` takes a block that receives and processes [Requests](#input-request). That block must return a [Response object](#response-objects) that matches the type of the Request! Calling `input.action.class` is an easy to find out the type of the request.
+
+To return an error to the client that sent the request to Newque, just raise an exception from within the block!
+
+`.connect` returns a Thread that resolves once the Fifo Client is fully connected. Calling `.connect` on a Fifo Client that is already connected will raise an exception.
+
+#### .disconnect
+```ruby
+consumer.disconnect
+```
+Disconnects the Fifo Client within `socket_wait` milliseconds. A Fifo Client can't be reconnected, make a new one instead.
+
+## Newque-Ruby Concurrency Guide
+The [Thread](https://ruby-doc.org/core-2.2.0/Thread.html) is Ruby's basic concurrency primitive. There is never more than one Ruby Thread executing Ruby code at any moment, but native extensions given their own Thread can continue running in the background while executing native (non-Ruby) code.
+
+Newque-Ruby makes heavy use of Threads, since for example, a Pubsub Client waiting for requests should not "take up" your only allowed active Ruby Thread!
+
+If you are familiar with Promises or Futures in other languages, the Future objects returned by Newque-Ruby are very similar.
+
+Most gems simply block and assume the user will wrap those blocking calls in a `Thread.new` if they feel brave. Due to the fact that a Newque::Client with ZMQ uses a single multiplexing connection (unlike HTTP) and that we want operations (writes, reads, etc.) -which can terminate in a different order- to be executed in parallel, Newque-Ruby operations have to return Futures that will *resolve* to the desired result. In order to keep Newque::Clients with HTTP identical to ZMQ ones, those return Futures too.
+
+**What you need to know:**
+
+To get the result of an operation, you have to call `.get` on the Future returned by Newque-Ruby.
+
+- `client.delete('mychannel').get(limit)` will wait for the Future returned by `.delete` to resolve for up to `limit` seconds. If it times out, `.get` will raise `Timeout::Error`.
+- The `limit` argument is optional, it defaults to the `timeout` value passed when creating the Client.
+
+```ruby
+future1 = client.write('channel_a', false, ['msg1'])
+future2 = client.write('channel_b', false, ['msg1'])
+
+result1 = future1.get
+result2 = future1.get
+
+# Do something with the results
+```
+This snippet makes 2 calls in parallel and waits until both have completed to continue.
+
+## Protocol Options
+
+### HTTP Options
+
+| Option | Type | Required | Default | Description |
+|--------|------|----------|---------|-------------|
+| `https` | `Bool` | No | `false` | Whether to use HTTPS or not. |
+| `http_format` | `:json` or `:plaintext` | No | `:json` | Must match the HTTP Format configured in Newque. `json` by default. |
+| `separator` | `String` | No | `"\n"` | Must match the separator string configured in Newque. `"\n"` by default. |
+
+### ZMQ Options
+
+(**IMPORTANT:** Read [the docs](http://api.zeromq.org/4-0:zmq-setsockopt) before changing any defaults!)
+
+| Option | Type | Required | Default | Description |
+|--------|------|----------|---------|-------------|
+| `ZMQ_MAXMSGSIZE` | Integer | No | `-1` | Max message size in bytes, `-1` means unlimited. |
+| `ZMQ_LINGER` | Integer | No | `60000` | How long to keep unaccepted messages after disconnection in milliseconds. |
+| `ZMQ_RECONNECT_IVL` | Integer | No | `100` | Reconnection interval in milliseconds. |
+| `ZMQ_RECONNECT_IVL_MAX` | Integer | No | `60000` | Max exponential backoff reconnection interval in milliseconds. |
+| `ZMQ_BACKLOG` | Integer | No | `100` | The `backlog` argument for the `listen(2)` syscall. |
+| `ZMQ_SNDHWM` | Integer | No | `5000` | Hard limit on the number outbound outstanding messages per connection. |
+| `ZMQ_RCVHWM` | Integer | No | `5000` | Hard limit on the number inbound outstanding messages per connection. |
+
+## Response objects
+
+These objects are returned by method calls on a `Newque::Client`. Additionally, they are what a `Newque::Fifo_client` must return to the server.
+
+#### Write_response
+```ruby
+response = Newque::Write_response.new(5)
+response.saved # => 5
+```
+
+#### Read_response
+```ruby
+response = Newque::Read_response.new(2, 'some-id', 12345678, ['msg1', 'msg2'])
+response.length # => 2
+response.last_id # => 'some-id'
+response.last_timens # => '12345678'
+response.messages # => ['msg1', 'msg2']
+```
+
+#### Count_response
+```ruby
+response = Newque::Count_response.new(8)
+response.count # => 8
+```
+
+#### Delete_response
+```ruby
+response = Newque::Delete_response.new
+```
+
+#### Health_response
+```ruby
+response = Newque::Health_response.new
+```
+
+## Request objects
+
+`Newque::Fifo_client`s and `Newque::Pubsub_client`s receive an `Input_request` when a request is received on a channel with Backend of that type.
+
+#### Input_request
+
+```ruby
+request.channel # => 'my_channel'
+request.messages # => ['msg1', 'msg2']
+request.action # => Newque::Write_request or Newque::Read_request, etc.
+```
+
+#### Write_request
+```ruby
+request = Newque::Write_request.new(false, ['id1', 'id2'])
+request.atomic # => false
+request.ids # => ['id1', 'id2']
+```
+
+#### Read_request
+```ruby
+request = Newque::Read_request.new('after_id some-id', '100')
+request.mode # => 'after_id some-id'
+request.limit # => 100
+```
+
+#### Count_request
+```ruby
+request = Newque::Count_request.new
+```
+
+#### Delete_request
+```ruby
+request = Newque::Delete_request.new
+```
+
+#### Health_request
+```ruby
+request = Newque::Health_request.new(false)
+request.global # => false
+```
+
+## Running the tests
+Make sure the Gem dev dependencies are installed first.
+
+You'll need 2 terminals windows!
+```bash
+# In terminal 1
+docker pull newque/newque:v0.0.5
+
+docker run -it -p 8000:8000 -p 8001:8001 -p 8005:8005 -p 8006:8006 -p 8007:8007 newque/newque:v0.0.5 bash
+cd newque
+rm -r conf
+
+# Switch to terminal 2
+
+# Grab the Container ID:
+docker ps
+
+# Replace the CONTAINER_ID in this command and make sure you're in the newque-ruby/ directory:
+docker cp conf CONTAINER_ID:/newque/conf
+
+# Go back to terminal 1
+./newque
+
+# Switch to terminal 2
+bundle exec rake
+```