grape_json_api_streamer 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3947b19e1ad570c1531abc9c18f65265ff142a46
+  data.tar.gz: f68ff8b85660052472a4b10f7fad6f4812880fd3
+SHA512:
+  metadata.gz: 8d68e245263cc345eb74dcf5215d30d85cbc275b88b2dcf7ce15e5a82fb4e8c02035ff301c9dca64b238fe3c8d872a25e72236f9b97b7a468389cf160ed2638d
+  data.tar.gz: 1fe50ea846c4e06fd7fdcea3def08759cc17aa18a212acbcfb275e822fc07c9d766e53e06aa78a8de857b702fe55f08a221146e1a285902b618226e249a9bccb

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+coverage
+dump.rdb

data/.hound.yml

@@ -0,0 +1,16 @@
+LineLength:
+  Description: 'Limit lines to 130 characters.'
+  Max: 130
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+HashSyntax:
+  Description: >
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  EnforcedStyle: ruby19
+  Enabled: true
+
+RedundantBegin:
+  Enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .hound.yml
+
+Documentation:
+  Enabled: false
+NumericLiterals:
+  MinDigits: 10

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in starbuck_core.gemspec
+gemspec
+
+gem 'rubocop', require: false
+gem 'simplecov', require: false, group: :test
+gem 'pry', require: false

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_spec.rb'
+end

data/grape_json_api_streamer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/json_api/streamer'
+require 'grape/json_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape_json_api_streamer'
+  spec.version       = Grape::JSONAPI::Streamer::VERSION
+  spec.authors       = ['David Roy']
+  spec.email         = ['david.roy@cabbit.co.uk']
+  spec.summary       = 'Class for streaming JSON API via Grape stream'
+  spec.homepage      = 'https://github.com/Cabbit/grape_json_api_streamer'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'grape', '~> 0.16', '>= 0.16.2'
+  spec.add_dependency 'jsonapi-serializers', '~> 0.13', '>= 0.13.0'
+  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
+  spec.add_development_dependency 'mocha', '~> 1.1.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6.3'
+end

data/lib/grape/json_api/streamer.rb

@@ -0,0 +1,29 @@
+require 'jsonapi-serializers'
+
+module Grape
+  module JSONAPI
+    class Streamer
+      def initialize(collection)
+        @collection = collection
+      end
+
+      def each
+        yield '{"data":['
+        first = true
+        @collection.lazy.each do |object|
+          buffer = ''
+          buffer << ',' unless first
+          first = false
+          data = serialize(object)
+          buffer << JSON.unparse(data)[8..-2].strip
+          yield buffer
+        end
+        yield ']}'
+      end
+
+      def serialize(model)
+        ::JSONAPI::Serializer.serialize(model, is_collection: false)
+      end
+    end
+  end
+end

data/lib/grape/json_api/version.rb

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

data/test/streamer_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative './test_helper'
+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
+
+class StreamerSpec < Minitest::Spec
+  include Rack::Test::Methods
+
+  def app
+    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' }
+        }
+      ]
+    }
+  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

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Lib', 'lib'
+end
+
+ENV['RACK_ENV'] = 'test'
+$VERBOSE = nil
+require 'pry'
+require 'minitest/autorun'
+Dir.glob('./test/support/*.rb').each { |file| require file }
+
+require 'mocha/mini_test'
+require 'minitest-spec-context'
+require 'rack/test'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: grape_json_api_streamer
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- David Roy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: 
+email:
+- david.roy@cabbit.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- grape_json_api_streamer.gemspec
+- lib/grape/json_api/streamer.rb
+- lib/grape/json_api/version.rb
+- test/.keep
+- test/streamer_spec.rb
+- test/test_helper.rb
+homepage: https://github.com/Cabbit/grape_json_api_streamer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Class for streaming JSON API via Grape stream
+test_files:
+- test/.keep
+- test/streamer_spec.rb
+- test/test_helper.rb