jsonapi_compliable 0.3.4

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://artprod.dev.bloomberg.com/artifactory/api/gems/rubygems/"
+
+gem "active_model_serializers", :git => "https://github.com/richmolj/active_model_serializers.git"
+gem "rails", "~> 5.0"
+
+group :test do
+  gem "appraisal"
+  gem "guard"
+  gem "guard-rspec"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_5.gemfile.lock

@@ -0,0 +1,222 @@
+GIT
+  remote: https://github.com/richmolj/active_model_serializers.git
+  revision: 1dc2b74059731339f4df3e7882fd949e20433013
+  specs:
+    active_model_serializers (0.10.2)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      jsonapi (~> 0.1.1.beta2)
+      railties (>= 4.1, < 6)
+
+PATH
+  remote: ../
+  specs:
+    jsonapi_compliable (0.3.2)
+      active_model_serializers (~> 0.10)
+      jsonapi (~> 0.1.1.beta2)
+      jsonapi_ams_extensions (~> 0.1)
+      rails (>= 4.1, < 6)
+
+GEM
+  remote: http://artprod.dev.bloomberg.com/artifactory/api/gems/rubygems/
+  specs:
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.1)
+    builder (3.2.2)
+    byebug (9.0.5)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    jsonapi (0.1.1.beta2)
+      json (~> 1.8)
+    jsonapi_ams_extensions (0.1.0)
+      active_model_serializers (~> 0.10.x)
+    jsonapi_spec_helpers (0.2.0)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.10)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nenv (0.3.0)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pkg-config (1.1.7)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby_dep (1.4.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers!
+  appraisal
+  bundler (~> 1.12)
+  database_cleaner
+  guard
+  guard-rspec
+  jsonapi_compliable!
+  jsonapi_spec_helpers
+  kaminari
+  pry
+  pry-byebug
+  rails (~> 5.0)
+  rake (~> 10.0)
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   1.12.5

data/jsonapi_compliable.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_compliable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_compliable"
+  spec.version       = JsonapiCompliable::VERSION
+  spec.authors       = ["Lee Richmond", "Venkata Pasupuleti"]
+  spec.email         = ["richmolj@gmail.com", "spasupuleti4@bloomberg.net"]
+
+  spec.summary       = %q{JSON Compliable serializer for action controller}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ['>= 4.1', '< 6']
+  spec.add_dependency "jsonapi", '~> 0.1.1.beta2'
+  spec.add_dependency "active_model_serializers", "~> 0.10"
+  spec.add_dependency "jsonapi_ams_extensions", "~> 0.1"
+
+  spec.add_development_dependency "kaminari"
+  spec.add_development_dependency "active_model_serializers"
+  spec.add_development_dependency "jsonapi_spec_helpers"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+end

data/lib/jsonapi_compliable.rb

@@ -0,0 +1,30 @@
+require 'active_model_serializers'
+require 'jsonapi'
+require 'jsonapi_ams_extensions'
+
+require "jsonapi_compliable/version"
+require "jsonapi_compliable/errors"
+require "jsonapi_compliable/dsl"
+require "jsonapi_compliable/scope/base"
+require "jsonapi_compliable/scope/sort"
+require "jsonapi_compliable/scope/paginate"
+require "jsonapi_compliable/scope/sideload"
+require "jsonapi_compliable/scope/extra_fields"
+require "jsonapi_compliable/scope/filterable"
+require "jsonapi_compliable/scope/default_filter"
+require "jsonapi_compliable/scope/filter"
+require "jsonapi_compliable/util/include_params"
+require "jsonapi_compliable/util/field_params"
+require "jsonapi_compliable/util/scoping"
+
+module JsonapiCompliable
+  autoload :Base,           'jsonapi_compliable/base'
+  autoload :Deserializable, 'jsonapi_compliable/deserializable'
+
+  def self.included(klass)
+    klass.instance_eval do
+      include Base
+      include Deserializable
+    end
+  end
+end

data/lib/jsonapi_compliable/base.rb

@@ -0,0 +1,105 @@
+module JsonapiCompliable
+  module Base
+    extend ActiveSupport::Concern
+    include Deserializable
+
+    MAX_PAGE_SIZE = 1_000
+
+    included do
+      class_attribute :_jsonapi_compliable
+      attr_reader :_jsonapi_scoped
+
+      before_action :parse_fieldsets!
+      after_action :reset_scope_flag
+    end
+
+    def default_page_number
+      1
+    end
+
+    def default_page_size
+      20
+    end
+
+    def jsonapi_scope(scope,
+                      filter: true,
+                      includes: true,
+                      paginate: true,
+                      extra_fields: true,
+                      sort: true)
+      scope = JsonapiCompliable::Scope::DefaultFilter.new(self, scope).apply
+      scope = JsonapiCompliable::Scope::Filter.new(self, scope).apply if filter
+      scope = JsonapiCompliable::Scope::ExtraFields.new(self, scope).apply if extra_fields
+      scope = JsonapiCompliable::Scope::Sideload.new(self, scope).apply if includes
+      scope = JsonapiCompliable::Scope::Sort.new(self, scope).apply if sort
+      scope = JsonapiCompliable::Scope::Paginate.new(self, scope).apply if paginate
+      @_jsonapi_scoped = true
+      scope
+    end
+
+    def reset_scope_flag
+      @_jsonapi_scoped = false
+    end
+
+    def parse_fieldsets!
+      Util::FieldParams.parse!(params, :fields)
+      Util::FieldParams.parse!(params, :extra_fields)
+    end
+
+    def render_ams(scope, opts = {})
+      scope = jsonapi_scope(scope) if Util::Scoping.apply?(self, scope, opts.delete(:scope))
+      options = default_ams_options
+      options[:include] = forced_includes || Util::IncludeParams.scrub(self)
+      options[:json] = scope
+      options[:fields] = Util::FieldParams.fieldset(params, :fields) if params[:fields]
+      options[:extra_fields] = Util::FieldParams.fieldset(params, :extra_fields) if params[:extra_fields]
+
+      options.merge!(opts)
+      render(options)
+    end
+
+    # render_ams(foo) equivalent to
+    # render json: foo, ams_default_options
+    def default_ams_options
+      {}.tap do |options|
+        options[:adapter] = :json_api
+      end
+    end
+
+    # TODO: This nastiness likely goes away once jsonapi standardizes
+    # a spec for nested relationships.
+    # See: https://github.com/json-api/json-api/issues/1089
+    def forced_includes(data = nil)
+      return unless force_includes?
+      data = raw_params[:data] unless data
+
+      {}.tap do |forced|
+        (data[:relationships] || {}).each_pair do |relation_name, relation|
+          if relation[:data].is_a?(Array)
+            forced[relation_name] = {}
+            relation[:data].each do |datum|
+              forced[relation_name].deep_merge!(forced_includes(datum))
+            end
+          else
+            forced[relation_name] = forced_includes(relation[:data])
+          end
+        end
+      end
+    end
+
+    def force_includes?
+      %w(PUT PATCH POST).include?(request.method) and
+        raw_params[:data][:relationships].present?
+    end
+
+    module ClassMethods
+      def jsonapi(&blk)
+        if !self._jsonapi_compliable
+          dsl = JsonapiCompliable::DSL.new
+          self._jsonapi_compliable = dsl
+        end
+        self._jsonapi_compliable.instance_eval(&blk)
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/deserializable.rb

@@ -0,0 +1,122 @@
+# This will convert JSONAPI-compatible POST/PUT payloads
+# into something Rails better understands. Example:
+#
+# {
+#   "data": {
+#     "type": "articles",
+#     "attributes": { "title": "the first article" },
+#     "relationships": {
+#       "tags": {
+#         "data": [{
+#           "type": "tags",
+#           "attributes": { "name": "One" }
+#         }, {
+#           "type": "tags",
+#           "attributes": { "name": "Two" }
+#         }]
+#       }
+#     }
+#   }
+# }
+#
+# Into:
+#
+# {
+#    article: {
+#      title: 'the first article',
+#      tags_attributes: [
+#        { name: 'One' },
+#        { name: 'Two' },
+#      ]
+#    }
+# }
+#
+# Why we don't use AMS deserialization - AMS will:
+# * not support relationship data
+# * override foreign key incorrectly, ie
+#   post_id incorrectly becomes nil if post relation is nil,
+#   even if it is in the attributes payload
+#
+# Usage:
+#
+# In controller:
+#
+# before_action :deserialize_jsonapi!, only: [:my_action]
+
+module JsonapiCompliable
+  module Deserializable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :raw_params
+    end
+
+    class Deserialization
+      def initialize(params, namespace: true)
+        @params = params
+        @namespace = namespace
+      end
+
+      def deserialize
+        hash = attributes
+        hash = hash.merge(relationships)
+        hash = @namespace ? { parsed_type => hash } : hash
+        hash.merge(@params.except(:data)).deep_symbolize_keys
+      end
+
+      private
+
+      def parsed_type
+        @params[:data][:type].underscore.singularize.to_sym
+      end
+
+      def attributes
+        attrs = {}
+        attrs[:id] = @params[:data].try(:[], :id) if @params[:data].try(:[], :id)
+        attrs.merge!(@params[:data].try(:[], :attributes) || {})
+        attrs
+      end
+
+      def relationships
+        return {} if @params[:data].try(:[], :relationships).blank?
+
+        {}.tap do |hash|
+          @params[:data][:relationships].each_pair do |relationship_name, payload|
+            parsed_relation = parse_relation(payload)
+
+            if parsed_relation.present?
+              hash["#{relationship_name}_attributes".to_sym] = parsed_relation
+            end
+          end
+        end
+      end
+
+      def parse_relation(payload)
+        if payload[:data].is_a?(Array)
+          parse_has_many(payload[:data])
+        else
+          parse_belongs_to(payload)
+        end
+      end
+
+      def parse_belongs_to(payload)
+        self.class.new(payload, namespace: false).deserialize
+      end
+
+      def parse_has_many(payloads)
+        payloads.map do |payload|
+          payload = { data: payload }
+          self.class.new(payload, namespace: false).deserialize
+        end.compact
+      end
+    end
+
+    def deserialize_jsonapi!
+      self.raw_params = self.params.deep_dup
+      hash = params.to_unsafe_h
+      hash = hash.with_indifferent_access if Rails::VERSION::MAJOR == 4
+      deserialized = Deserialization.new(hash).deserialize
+      self.params = ActionController::Parameters.new(deserialized)
+    end
+  end
+end