grape-jsonapi-resources 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66ed30fd8d9408e26b35c52db9035123f83efa94
+  data.tar.gz: fe03036472c71e70ab7b287dc5696a29f71d7ef1
+SHA512:
+  metadata.gz: eec5d985fa7a1d518f24ec3f5646f44cb891fbcb7a531d7d3035fc861bfe6de422f005540e0a46ef27ecdc9a7762d37360098b1a7cb419866c16576ff9d3ea29
+  data.tar.gz: 4d0a59553e96d9e29333aa4be6a50cdfb6d5f48e371bbfba71e4b1bc2643ec6b1767edcee91142e602f86052a93ec2214d26785bd0643243146798463bc84739

data/.gitignore

@@ -0,0 +1,19 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+Gemfile.lock
+.DS_Store
+*.gem

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-13 18:47:14 -0500 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 25
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 179
+
+# Offense count: 7
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 4
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.1.1
+  - 1.9.3
+  - rbx-2.2.10
+  - jruby-19mode
+
+env:
+  - GRAPE_VERSION=0.8.0
+  - GRAPE_VERSION=0.9.0
+  - GRAPE_VERSION=0.10.1
+  - GRAPE_VERSION=HEAD

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+case version = ENV['GRAPE_VERSION'] || '~> 0.10.0'
+when 'HEAD'
+  gem 'grape', github: 'intridea/grape'
+else
+  gem 'grape', version
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cary Dunn
+
+MIT License
+
+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,38 @@
+# Grape::JSONAPIResources
+
+Use [jsonapi-resources](https://github.com/cerebris/jsonapi-resources) with [Grape](https://github.com/intridea/grape)!
+
+## Installation
+
+Add the `grape` and `grape-jsonapi-resources` gems to Gemfile.
+
+```ruby
+gem 'grape'
+gem 'grape-jsonapi-resources'
+```
+
+## Usage
+
+### Require grape-jsonapi-resources
+
+### Tell your API to use Grape::Formatter::JSONAPIResources
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::JSONAPIResources
+end
+```
+
+### Use `render` to specify JSONAPI options
+
+```ruby
+get "/" do
+  user = User.find("123")
+  render user, include: ["account"], context: { something: :important }
+end
+```
+
+## Credit
+
+Code adapted from [grape-active_model_serializers](https://github.com/jrhe/grape-active_model_serializers)

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['-fd -c']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]

data/grape-jsonapi-resources.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape-jsonapi-resources/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Cary Dunn']
+  gem.email         = ['cary.dunn@gmail.com']
+  gem.summary       = 'Use jsonapi-resources in grape'
+  gem.description   = 'Provides a Formatter for the Grape API DSL to emit objects serialized with jsonapi-resources.'
+  gem.homepage      = 'https://github.com/cdunn/grape-jsonapi-resources'
+
+  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-jsonapi-resources'
+  gem.require_paths = ['lib']
+  gem.version       = Grape::JSONAPIResources::VERSION
+  gem.licenses      = ['MIT']
+
+  gem.add_dependency 'grape'
+  gem.add_dependency 'jsonapi-resources', '>= 0.5.0'
+
+  gem.add_development_dependency 'rails-api', '>= 0.4.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
+end

data/lib/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - ruby-head
+  - rbx-19mode
+
+env:
+   - JRUBY_OPTS="--1.9"

data/lib/grape-jsonapi-resources.rb

@@ -0,0 +1,6 @@
+require 'jsonapi-resources'
+require 'grape'
+require 'grape-jsonapi-resources/endpoint_extension'
+require 'grape-jsonapi-resources/api_options_extension'
+require 'grape-jsonapi-resources/formatter'
+require 'grape-jsonapi-resources/version'

data/lib/grape-jsonapi-resources/api_options_extension.rb

@@ -0,0 +1,9 @@
+module Grape
+  class API
+    class << self
+      def jsonapi_base_url(url = nil)
+        namespace_inheritable(:jsonapi_base_url, url)
+      end
+    end
+  end
+end

data/lib/grape-jsonapi-resources/endpoint_extension.rb

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

data/lib/grape-jsonapi-resources/formatter.rb

@@ -0,0 +1,74 @@
+module Grape
+  module Formatter
+    module JSONAPIResources
+      class << self
+        def call(resource, env)
+          serialize_resource(resource, env) || Grape::Formatter::Json.call(resource, env)
+        end
+
+        def serialize_resource(resource, env)
+          endpoint = env['api.endpoint']
+
+          jsonapi_options = build_options_from_endpoint(endpoint)
+          jsonapi_options.merge!(env['jsonapi_options'] || {})
+
+          context = {}
+          context.merge!(current_user: endpoint.current_user) if endpoint.respond_to?(:current_user)
+          context.merge!(jsonapi_options.delete(:context)) if jsonapi_options[:context]
+
+          resource_class = resource_class_for(resource)
+          return nil unless resource_class
+          resource_instances = nil
+          if resource.respond_to?(:to_ary)
+            resource_instances = resource.to_ary.collect do |each_resource|
+              resource_class.new(each_resource, context)
+            end
+          else
+            resource_instances = resource_class.new(resource, context)
+          end
+
+          resource_serialzer = JSONAPI::ResourceSerializer.new(resource_class, jsonapi_options).serialize_to_hash(resource_instances)
+          if jsonapi_options[:meta]
+            # Add option to merge top level meta tag as jsonapi-resources does not appear to support this
+            resource_serialzer.as_json.merge(meta: jsonapi_options[:meta]).to_json if jsonapi_options[:meta]
+          else
+            resource_serialzer.to_json
+          end
+        end
+
+        def build_options_from_endpoint(endpoint)
+          options = {}
+          options[:base_url] = endpoint.namespace_inheritable(:jsonapi_base_url) if endpoint.namespace_inheritable(:jsonapi_base_url)
+          options
+        end
+
+        def resource_class_for(resource)
+          if resource.class.respond_to?(:jsonapi_resource_class)
+            resource.class.jsonapi_resource_class
+          elsif resource.respond_to?(:to_ary)
+            resource_class_for(resource.to_ary.first)
+          else
+            get_resource_for(resource.class)
+          end
+        end
+
+        def resources_cache
+          @resources_cache ||= ThreadSafe::Cache.new
+        end
+
+        def get_resource_for(klass)
+          resources_cache.fetch_or_store(klass) do
+            resource_class_name = "#{klass.name}Resource"
+            resource_class = resource_class_name.safe_constantize
+
+            if resource_class
+              resource_class
+            elsif klass.superclass
+              get_resource_for(klass.superclass)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-jsonapi-resources/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module JSONAPIResources
+    VERSION = '0.0.1'
+  end
+end

data/spec/grape-jsonapi-resources/endpoint_extension_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'Grape::EndpointExtension' do
+  if Grape::Util.const_defined?('InheritableSetting')
+    subject { Grape::Endpoint.new(Grape::Util::InheritableSetting.new, path: '/', method: 'foo') }
+  else
+    subject { Grape::Endpoint.new({}, path: '/', method: 'foo') }
+  end
+
+  let(:serializer) { Grape::Formatter::JSONAPIResources }
+
+  let(:user) do
+    User.new(name: "yasiel")
+  end
+
+  let(:users) { [user, user] }
+
+  describe '#render' do
+    before do
+      allow(subject).to receive(:env).and_return({})
+    end
+
+    it { should respond_to(:render) }
+
+    context 'settings options' do
+      it 'sets the jsonapi options on the environment' do
+        expect(subject.render(users, {include: ["included_resource"]})).to eq(users)
+        expect(subject.env).to include({"jsonapi_options"=>{:include=>["included_resource"]}})
+      end
+    end
+  end
+end

data/spec/grape-jsonapi-resources/formatter_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Grape::Formatter::JSONAPIResources do
+  subject { Grape::Formatter::JSONAPIResources }
+
+  describe 'serializer options from namespace' do
+    let(:app) { Class.new(Grape::API) }
+
+    before do
+      app.format :json
+      app.formatter :json, Grape::Formatter::JSONAPIResources
+
+      app.namespace('space') do |ns|
+        ns.jsonapi_base_url "/api/v1"
+        ns.get('/') do
+          { user: { first_name: 'Cary', last_name: 'D' } }
+        end
+      end
+    end
+
+    it 'should read serializer options like "jsonapi_base_url"' do
+      expect(described_class.build_options_from_endpoint(app.endpoints.first)).to include({base_url: "/api/v1"})
+    end
+  end
+
+  describe '.serialize_resource' do
+    let(:user) { User.new(first_name: 'John', id: 123) }
+
+    if Grape::Util.const_defined?('InheritableSetting')
+      let(:endpoint) { Grape::Endpoint.new(Grape::Util::InheritableSetting.new, path: '/', method: 'foo', root: false) }
+    else
+      let(:endpoint) { Grape::Endpoint.new({}, path: '/', method: 'foo', root: false) }
+    end
+
+    let(:env) { { 'api.endpoint' => endpoint } }
+
+    before do
+      def endpoint.current_user
+        @current_user ||= User.new(first_name: 'Current user')
+      end
+    end
+
+    subject { described_class.serialize_resource(user, env) }
+
+    it { should be_a String }
+
+    it 'should have used the correct resource' do
+      expect(UserResource).to receive(:new).with(user, {current_user: endpoint.current_user}).once.and_call_original
+      subject
+    end
+
+    it 'should map a collect of resources' do
+      expect(UserResource).to receive(:new).with(user, {current_user: endpoint.current_user}).twice.and_call_original
+      described_class.serialize_resource([ user, user ], env)
+    end
+    # array
+
+    it 'should specify serializer options like "base_url" and "include"' do
+      allow(described_class).to receive(:build_options_from_endpoint).with(endpoint).and_return({base_url: "/api/v1"})
+      expect(JSONAPI::ResourceSerializer).to receive(:new).with(UserResource, {base_url: "/api/v1"}).and_call_original
+      subject
+    end
+
+    it 'should allow custom meta tag' do
+      meta = {total_pages: 123}
+      allow(described_class).to receive(:build_options_from_endpoint).with(endpoint).and_return({meta: meta})
+      expect(subject).to match meta.to_json
+    end
+  end
+end

data/spec/grape-jsonapi-resources_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe 'grape-jsonapi-resources' do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'rails'
+require 'action_controller'
+require 'active_model'
+require 'jsonapi-resources'
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/json'
+require 'rspec'
+require 'rack/test'
+require 'grape-jsonapi-resources'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/models/blog_post.rb

@@ -0,0 +1,13 @@
+class BlogPost
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :title, :body
+
+  def initialize(params = {})
+    @id = 1
+    params.each do |k, v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+end

data/spec/support/models/user.rb

@@ -0,0 +1,13 @@
+class User
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :first_name, :last_name, :password, :email
+
+  def initialize(params = {})
+    @id = 1
+    params.each do |k, v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+end

data/spec/support/resources/blog_post_resource.rb

@@ -0,0 +1,3 @@
+class BlogPostResource < JSONAPI::Resource
+  attributes :title, :body
+end

data/spec/support/resources/user_resource.rb

@@ -0,0 +1,3 @@
+class UserResource < JSONAPI::Resource
+  attributes :first_name, :last_name
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: grape-jsonapi-resources
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cary Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 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: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rails-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.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 jsonapi-resources.
+email:
+- cary.dunn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-jsonapi-resources.gemspec
+- lib/.travis.yml
+- lib/grape-jsonapi-resources.rb
+- lib/grape-jsonapi-resources/api_options_extension.rb
+- lib/grape-jsonapi-resources/endpoint_extension.rb
+- lib/grape-jsonapi-resources/formatter.rb
+- lib/grape-jsonapi-resources/version.rb
+- spec/grape-jsonapi-resources/endpoint_extension_spec.rb
+- spec/grape-jsonapi-resources/formatter_spec.rb
+- spec/grape-jsonapi-resources_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/blog_post.rb
+- spec/support/models/user.rb
+- spec/support/resources/blog_post_resource.rb
+- spec/support/resources/user_resource.rb
+homepage: https://github.com/cdunn/grape-jsonapi-resources
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Use jsonapi-resources in grape
+test_files:
+- spec/grape-jsonapi-resources/endpoint_extension_spec.rb
+- spec/grape-jsonapi-resources/formatter_spec.rb
+- spec/grape-jsonapi-resources_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/blog_post.rb
+- spec/support/models/user.rb
+- spec/support/resources/blog_post_resource.rb
+- spec/support/resources/user_resource.rb