grape_fast_jsonapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed838d297ef0c44b39588e77a204a37a8c8b4b4f
+  data.tar.gz: 0e57addeb1bfeac8b6ff3e5c54ceb85d20f9cddb
+SHA512:
+  metadata.gz: f65646281a1da90c7fb6e4d38918f67fe50c1467c3a54546b3a7a7d39e50189c907bf851c02b8bac01723196f038a842336e8f972a0772fd05d0b7b618fc9fa0
+  data.tar.gz: 62e22336e61cec1388e2980dac12e045facf7fd77c7bb0a8c3ee94b9e1a7735904bfa21d2fa819425af9669758ef6f7e23003e712abf27a03f70c553d2d55cc9

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'grape'
+gem 'fast_jsonapi'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Emmanuel Cousin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Grape::FastJsonapi
+
+Use [fast_jsonapi](https://github.com/Netflix/fast_jsonapi) with [Grape](https://github.com/ruby-grape/grape).
+
+## Installation
+
+Add the `grape` and `grape_fast_jsonapi` gems to Gemfile.
+
+```ruby
+gem 'grape'
+# gem is not published to rubygems yet
+gem 'grape_fast_jsonapi', git: 'git@github.com:EmCousin/grape_fast_jsonapi.git'
+```
+
+## Usage
+
+### Require grape_fast_jsonapi
+
+### Tell your API to use Grape::Formatter::FastJsonapi
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::FastJsonapi
+end
+```
+
+### Use `render` to specify JSONAPI options
+
+```ruby
+get "/" do
+  user = User.find("123")
+  render user, include: [:account]
+end
+```
+
+## Credit
+
+Code adapted from [grape-jsonapi-resources](https://github.com/cdunn/grape-jsonapi-resources)

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'

data/grape_fast_jsonapi.gemspec

@@ -0,0 +1,28 @@
+# Generated by EmCousin
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/grape_fast_jsonapi/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Emmanuel Cousin']
+  gem.email         = ['emmanuel_cousin@hotmail.fr']
+  gem.summary       = 'Use fast_jsonapi in grape'
+  gem.description   = 'Provides a Formatter for the Grape API DSL to emit objects serialized with fast_jsonapi.'
+  gem.homepage      = 'https://github.com/EmCousin/grape_fast_jsonapi'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  gem.name          = 'grape_fast_jsonapi'
+  gem.require_paths = ['lib']
+  gem.version       = Grape::FastJsonapi::VERSION
+  gem.licenses      = ['MIT']
+
+  gem.add_dependency 'grape'
+  gem.add_dependency 'fast_jsonapi'
+
+  gem.add_development_dependency 'rails', '>= 5.0.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
+end

data/lib/grape_fast_jsonapi/endpoint_extension.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Grape
+  module EndpointExtension
+    def render(resources, options = {})
+      env['fast_jsonapi_options'] = options
+      resources
+    end
+  end
+
+  Endpoint.send(:include, EndpointExtension)
+end

data/lib/grape_fast_jsonapi/formatter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    module FastJsonapi
+      class << self
+        def call(object, env)
+          return object if object.is_a?(String)
+          return ::Grape::Json.dump(serialize(object, env)) if serializable?(object)
+          return object.to_json if object.respond_to?(:to_json)
+          ::Grape::Json.dump(object)
+        end
+
+        private
+
+        def serializable?(object)
+          object.respond_to?(:serializable_hash) || object.respond_to?(:to_a) && object.all? { |o| o.respond_to? :serializable_hash } || object.is_a?(Hash)
+        end
+
+        def serialize(object, env)
+          if object.respond_to? :serializable_hash
+            serializable_object(object, fast_jsonapi_options(env)).serializable_hash
+          elsif object.respond_to?(:to_a) && object.all? { |o| o.respond_to? :serializable_hash }
+            fast_jsonapi_serializable(object, fast_jsonapi_options(env)).serializable_hash || object.map(&:serializable_hash)
+          elsif object.is_a?(Hash)
+            serialize_each_pair(object, env)
+          else
+            object
+          end
+        end
+
+        def serializable_object(object, options)
+          fast_jsonapi_serializable(object, options) || object
+        end
+
+        def fast_jsonapi_serializable(object, options)
+          serializable_class(object)&.new(object, options)
+        end
+
+        def serializable_class(object)
+          (object.model_name.name + 'Serializer').safe_constantize
+        end
+
+        def serialize_each_pair(object, env)
+          h = {}
+          object.each_pair { |k, v| h[k] = serialize(v, env) }
+          h
+        end
+
+        def fast_jsonapi_options(env)
+          env['fast_jsonapi_options'] || {}
+        end
+      end
+    end
+  end
+end

data/lib/grape_fast_jsonapi/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Grape
+  module FastJsonapi
+    VERSION = '0.1.0'
+  end
+end

data/lib/grape_fast_jsonapi.rb

@@ -0,0 +1,5 @@
+require 'fast_jsonapi'
+require 'grape'
+require 'grape_fast_jsonapi/endpoint_extension'
+require 'grape_fast_jsonapi/formatter'
+require 'grape_fast_jsonapi/version'

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: grape_fast_jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emmanuel Cousin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a Formatter for the Grape API DSL to emit objects serialized
+  with fast_jsonapi.
+email:
+- emmanuel_cousin@hotmail.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape_fast_jsonapi.gemspec
+- lib/grape_fast_jsonapi.rb
+- lib/grape_fast_jsonapi/endpoint_extension.rb
+- lib/grape_fast_jsonapi/formatter.rb
+- lib/grape_fast_jsonapi/version.rb
+homepage: https://github.com/EmCousin/grape_fast_jsonapi
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: Use fast_jsonapi in grape
+test_files: []