grape_json_api_streamer 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3947b19e1ad570c1531abc9c18f65265ff142a46
-  data.tar.gz: f68ff8b85660052472a4b10f7fad6f4812880fd3
+  metadata.gz: 395983ae9909735b82f732588bfeba09e1033343
+  data.tar.gz: 18096e8bd416a14eae54994259f27869d100106a
 SHA512:
-  metadata.gz: 8d68e245263cc345eb74dcf5215d30d85cbc275b88b2dcf7ce15e5a82fb4e8c02035ff301c9dca64b238fe3c8d872a25e72236f9b97b7a468389cf160ed2638d
-  data.tar.gz: 1fe50ea846c4e06fd7fdcea3def08759cc17aa18a212acbcfb275e822fc07c9d766e53e06aa78a8de857b702fe55f08a221146e1a285902b618226e249a9bccb
+  metadata.gz: 8bf85ef0d45f9154cc7b7c980db3fbcc8ba188b74bfe253e2fd46587e94527f7a388c5a1fecb206d272a5338caac9b3e2d8d1aca3033a2f33f2f24331d420163
+  data.tar.gz: 817b936c8d05be5fb5f0563d320ad12ce81f6bd02651d41b8185fdca2ee4910fbfee2eb916384f4c12a98ce552205404b52a2f8362246fbd81a100e0ef088ee5

data/README.md

@@ -0,0 +1,42 @@
+# grape_json_api_streamer
+
+Based heavily on the suggestion by raulpopadineti at https://github.com/ruby-grape/grape/issues/1392 which is used for streaming Grape::Entity, this class provides a way to stream JSON::API using the jsonapi-serializers gem in grape.
+
+## Example
+```
+require 'grape'
+require 'grape/json_api/streamer'
+
+class Model
+  def initialize(id)
+    @id = id
+  end
+
+  def id
+    @id
+  end
+
+  def foo
+    'bar'
+  end
+end
+
+class ModelSerializer
+  include JSONAPI::Serializer
+
+  attribute :foo
+end
+
+class MockAPI < Grape::API
+  format :json
+  content_type :json, 'application/json;charset=UTF-8'
+
+  resource :foo do
+    get do
+      model  = Model.new(1)
+      model2 = Model.new(2)
+      stream Grape::JSONAPI::Streamer.new([model, model2])
+    end
+  end
+end
+```

data/lib/grape/json_api/streamer.rb

@@ -3,12 +3,15 @@ require 'jsonapi-serializers'
 module Grape
   module JSONAPI
     class Streamer
-      def initialize(collection)
+      def initialize(collection, options = {})
         @collection = collection
+        @options    = ActiveSupport::HashWithIndifferentAccess.new(options)
       end
 
       def each
-        yield '{"data":['
+        yield '{'
+        yield "\"meta\": #{@options[:meta].to_json}," if @options[:meta]
+        yield '"data":['
         first = true
         @collection.lazy.each do |object|
           buffer = ''
@@ -18,7 +21,9 @@ module Grape
           buffer << JSON.unparse(data)[8..-2].strip
           yield buffer
         end
-        yield ']}'
+        yield ']'
+        yield ",\"links\": #{@options[:links].to_json}" if @options[:links]
+        yield '}'
       end
 
       def serialize(model)

data/lib/grape/json_api/version.rb

@@ -1,7 +1,7 @@
 module Grape
   module JSONAPI
     class Streamer
-      VERSION = '0.0.3'
+      VERSION = '0.0.4'
     end
   end
 end

data/test/streamer_spec.rb

@@ -28,10 +28,17 @@ class MockAPI < Grape::API
   content_type :json, 'application/json;charset=UTF-8'
 
   resource :foo do
+    params do
+      optional :limit, type: Integer
+    end
     get do
-      model  = Model.new(1)
-      model2 = Model.new(2)
-      stream Grape::JSONAPI::Streamer.new([model, model2])
+      models = [Model.new(1), Model.new(2)]
+      if params[:limit]
+        options = { 'meta' => { 'total-records' => 100 }, 'links' => { 'self' => '/foo?limit=2' } }
+        stream Grape::JSONAPI::Streamer.new(models, options)
+      else
+        stream Grape::JSONAPI::Streamer.new(models)
+      end
     end
   end
 end
@@ -43,28 +50,63 @@ class StreamerSpec < Minitest::Spec
     MockAPI
   end
 
-  let(:body) do
-    {
-      'data' => [
-        {
-          'type'       => 'models',
-          'id'         => '1',
-          'attributes' => { 'foo'  => 'bar' },
-          'links'      => { 'self' => '/models/1' }
-        }, {
-          'type'       => 'models',
-          'id'         => '2',
-          'attributes' => { 'foo'  => 'bar' },
-          'links'      => { 'self' => '/models/2' }
-        }
-      ]
-    }
+  context 'when no options' do
+    let(:body) do
+      {
+        'data' => [
+          {
+            'type'       => 'models',
+            'id'         => '1',
+            'attributes' => { 'foo'  => 'bar' },
+            'links'      => { 'self' => '/models/1' }
+          }, {
+            'type'       => 'models',
+            'id'         => '2',
+            'attributes' => { 'foo'  => 'bar' },
+            'links'      => { 'self' => '/models/2' }
+          }
+        ]
+      }
+    end
+
+    it 'should output json response' do
+      get '/foo'
+
+      assert_equal body, JSON.parse(last_response.body)
+      assert_equal 200, last_response.status
+    end
   end
 
-  it 'should output json response' do
-    get '/foo'
+  context 'when meta and links options provided' do
+    let(:body) do
+      {
+        'meta' => {
+          'total-records' => 100
+        },
+        'data' => [
+          {
+            'type'       => 'models',
+            'id'         => '1',
+            'attributes' => { 'foo'  => 'bar' },
+            'links'      => { 'self' => '/models/1' }
+          }, {
+            'type'       => 'models',
+            'id'         => '2',
+            'attributes' => { 'foo'  => 'bar' },
+            'links'      => { 'self' => '/models/2' }
+          }
+        ],
+        'links' => {
+          'self' => '/foo?limit=2'
+        }
+      }
+    end
 
-    assert_equal body, JSON.parse(last_response.body)
-    assert_equal 200, last_response.status
+    it 'should output json response' do
+      get '/foo?limit=2'
+
+      assert_equal body, JSON.parse(last_response.body)
+      assert_equal 200, last_response.status
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_json_api_streamer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - David Roy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape