pebblebed 0.3.20 → 0.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8310ad73ddbc179d054ac75fdf33890d51e3fa61
-  data.tar.gz: d60bca28ff3cce1676d00655f04a9717bcd65092
+  metadata.gz: 65f960100fa8f06519e6d5322a3e94a3387beb27
+  data.tar.gz: c6135f4cf37b105aa16ef063f707ce8661b7c439
 SHA512:
-  metadata.gz: 2edd27c829d0567756bb27ff2d9e66401db37baad0c9ee35a5334ebcd8c2d740759137ea6e41812fbe5f8cef095d196eaeec39db071cbdf8b19a16309692c1d8
-  data.tar.gz: e75bbaef43db033a865b5e9965b818994bae9bf01ce379c8102143b83d74a13458a5645d84a05f494d93fa0f95e4b9cd50f3d7a8f1d352bb597d02c0c6df098d
+  metadata.gz: a5a203b1048b041abb697811f1084a7384ea30ed101f601d17fddaa3978f871b65afa53309de299e94eb7dfccceb818a43dd28cb27e158b6374acc4fb32fae60
+  data.tar.gz: e15a17c6a78643194245573635a0155adffd8af97677483f7cb71b642066afacd837fcc9e5ec423ae3c0aa3952c356a596dcaf308fe22f32a2123a8a3c4a783e

data/lib/pebblebed/clients/generic_client.rb

@@ -1,4 +1,5 @@
 require 'deepstruct'
+require_relative '../ndjson'
 
 module Pebblebed
   class GenericClient < AbstractClient
@@ -22,10 +23,20 @@ module Pebblebed
       end
     end
 
-    def stream(method, url = '', params = {}, options = {})
-      on_data = options[:on_data] or raise "Option :on_data must be specified"
+    def stream(method, url = '', params = {}, on_data:, accept: nil)
       method_name = "stream_#{method.to_s.downcase}"
       raise "Method not supported for streaming" unless Pebblebed::Http.respond_to?(method_name)
+
+      if accept == 'application/x-ndjson'
+        buffer = NdjsonBuffer.new(on_data)
+        response = Pebblebed::Http.send(method_name, service_url(url), service_params(params),
+          on_data: ->(data) {
+            buffer << data
+          })
+        buffer.check_end!
+        return response
+      end
+
       return Pebblebed::Http.send(method_name, service_url(url), service_params(params),
         on_data: on_data)
     end

data/lib/pebblebed/ndjson.rb

@@ -0,0 +1,51 @@
+module Pebblebed
+
+  # Helper class which buffers an NDJSON input stream, parsing each
+  # complete line into a handler as JSON.
+  class NdjsonBuffer
+
+    # Initializes with handler. The handler must provide a method 'call'
+    # which will be called with each JSON payload.
+    def initialize(handler)
+      @handler = handler
+      @buf = ''
+      @end = false
+    end
+
+    # Returns true if the end of the stream has been reached.
+    def ended?
+      @end
+    end
+
+    # Checks whether this buffer has reached its end. Raises IOError
+    # otherwise.
+    def check_end!
+      unless @end
+        # We need to raise this to signal that a complete contents
+        # was not returned.
+        raise IOError, "End of stream expected"
+      end
+    end
+
+    # Feeds data into the buffer.
+    def <<(data)
+      return if data.empty?
+      @buf << data
+      begin
+        if /\A(?<line>[^\n]*)\n(?<rest>.*)\z/m =~ @buf
+          if line.length == 0 && rest.length == 0
+            @buf.clear
+            @end = true
+          else
+            payload, @buf = JSON.parse(line), rest
+            @handler.call(payload)
+          end
+        else
+          break
+        end
+      end until @end
+    end
+
+  end
+
+end

data/lib/pebblebed/version.rb

@@ -1,3 +1,3 @@
 module Pebblebed
-  VERSION = "0.3.20"
+  VERSION = "0.3.21"
 end

data/spec/generic_client_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'pebblebed/config'
 require 'pebblebed/clients/abstract_client'
 require 'pebblebed/clients/generic_client'
+require 'pebblebed/http'
 
 module Pebblebed
   module Http
@@ -72,4 +73,118 @@ describe Pebblebed::GenericClient do
     end
   end
 
+  context 'NDJSON streams' do
+    context 'GET' do
+      it "streams response body" do
+        curl_result = DeepStruct.wrap({status: 200, body: nil})
+        allow(Pebblebed::Http).to receive(:stream_get).with(
+          URI.parse("http://example.org/"),
+          {"session" => "session_key"},
+          anything) { |_, _, options|
+          options[:on_data].call(%{{"hello":"world"}\n{"a":42}\n\n})
+        }.and_return(curl_result)
+
+        payloads = []
+        client = Pebblebed::GenericClient.new("session_key", "http://example.org/")
+        result = client.stream(:get, '/', {},
+          accept: 'application/x-ndjson',
+          on_data: ->(payload) {
+            payloads << payload
+          })
+        expect(payloads).to eq [
+          {'hello' => 'world'},
+          {'a' => 42}
+        ]
+        expect(result.status).to eq 200
+        expect(result.body).to eq nil
+      end
+
+      [
+        %{{"hello":"world"}\n},
+        %{{"hello":"world"}\n{"hello":"world"}}
+      ].each do |scenario|
+        it "detects incomplete stream" do
+          curl_result = DeepStruct.wrap({status: 200, body: nil})
+          allow(Pebblebed::Http).to receive(:stream_get).with(
+            URI.parse("http://example.org/"),
+            {"session" => "session_key"},
+            anything) { |_, _, options|
+            options[:on_data].call(scenario)
+          }.and_return(curl_result)
+
+          payloads = []
+          client = Pebblebed::GenericClient.new("session_key", "http://example.org/")
+          expect {
+            client.stream(:get, '/', {},
+              accept: 'application/x-ndjson',
+              on_data: ->(payload) {
+                payloads << payload
+              })
+            }.to raise_error(IOError)
+        end
+      end
+
+      it "raises error on bad JSON" do
+        curl_result = DeepStruct.wrap({status: 200, body: nil})
+        allow(Pebblebed::Http).to receive(:stream_get).with(
+          URI.parse("http://example.org/"),
+          {"session" => "session_key"},
+          anything) { |_, _, options|
+          options[:on_data].call(%{fnord\n})
+        }.and_return(curl_result)
+
+        payloads = []
+        client = Pebblebed::GenericClient.new("session_key", "http://example.org/")
+        expect {
+          client.stream(:get, '/', {},
+            accept: 'application/x-ndjson',
+            on_data: ->(payload) {
+              payloads << payload
+            })
+        }.to raise_error(JSON::ParserError)
+      end
+
+      it "returns HTTP status" do
+        curl_result = DeepStruct.wrap({status: 201, body: 'halp'})
+        allow(Pebblebed::Http).to receive(:stream_get).with(
+          URI.parse("http://example.org/"),
+          {"session" => "session_key"},
+          anything) { |_, _, options|
+          options[:on_data].call(%{"a"\n\n})
+        }.and_return(curl_result)
+
+        payloads = []
+        client = Pebblebed::GenericClient.new("session_key", "http://example.org/")
+        response = client.stream(:get, '/', {},
+          accept: 'application/x-ndjson',
+          on_data: ->(payload) {
+            payloads << payload
+          })
+        expect(payloads).to eq ['a']
+        expect(response.status).to eq 201
+        expect(response.body).to eq "halp"
+      end
+
+      it "raises on HTTP error" do
+        curl_result = DeepStruct.wrap({status: 500, body: 'halp'})
+        allow(Pebblebed::Http).to receive(:stream_get).with(
+          URI.parse("http://example.org/"),
+          {"session" => "session_key"},
+          anything) { |_, _, options|
+          raise Pebblebed::HttpError.new("error", 500, curl_result)
+        }
+
+        payloads = []
+        client = Pebblebed::GenericClient.new("session_key", "http://example.org/")
+        expect {
+          client.stream(:get, '/', {},
+            accept: 'application/x-ndjson',
+            on_data: ->(payload) {
+              payloads << payload
+            })
+        }.to raise_error(Pebblebed::HttpError)
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pebblebed
 version: !ruby/object:Gem::Version
-  version: 0.3.20
+  version: 0.3.21
 platform: ruby
 authors:
 - Katrina Owen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -257,6 +257,7 @@ files:
 - lib/pebblebed/connector.rb
 - lib/pebblebed/http.rb
 - lib/pebblebed/labels.rb
+- lib/pebblebed/ndjson.rb
 - lib/pebblebed/parts.rb
 - lib/pebblebed/river.rb
 - lib/pebblebed/river/subscription.rb