json_apiable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0527cb82ea3c0689d6086d1728291e77bff1cd94da969953b8965e729eb66b6
+  data.tar.gz: e98ff51f719ca22f14574c9acdb4a8b1175e13d513b8f93f2595d4d83cdffa89
+SHA512:
+  metadata.gz: c424b59b59efa76d8f04c248345ce5a42b9c2b2f53bf539a73f0eea4e4b4551186f32c8923fc097182c54e123582e9a4bdfdf7a715e5417de724bbe485715715
+  data.tar.gz: 73af3e75acfb6a3e8a69fafdb338882cbcd2e6bcc38d5b9e65600ee5824b7af98ae650e38ec8520fe9b1f38a2591d34652081a18e3d1df1d977c072c5ecfdc48

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+*.sqlite3
+
+# rspec failure tracking
+.rspec_status
+/spec/support/rails_app/db/*.sqlite3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_apiable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,193 @@
+PATH
+  remote: .
+  specs:
+    json_apiable (0.1.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+      fast_jsonapi (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    factory_bot_rails (5.1.1)
+      factory_bot (~> 5.1.0)
+      railties (>= 4.2.0)
+    faker (2.9.0)
+      i18n (>= 1.6, < 1.8)
+    fast_jsonapi (1.5)
+      activesupport (>= 4.2)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.0.8)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-controller-testing (1.0.4)
+      actionpack (>= 5.0.1.x)
+      actionview (>= 5.0.1.x)
+      activesupport (>= 5.0.1.x)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (10.5.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  factory_bot_rails
+  faker
+  json_apiable!
+  pry
+  pry-byebug
+  rails
+  rails-controller-testing
+  rake (~> 10.0)
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   2.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 mike
+
+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 @@
+# JsonApiable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_apiable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_apiable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_apiable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_apiable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_apiable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_apiable.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_apiable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_apiable"
+  spec.version       = JsonApiable::VERSION
+  spec.authors       = ["Mike Polischuk"]
+  spec.email         = ["mike.polis@gmail.com"]
+
+  spec.summary       = %q{Include JsonApiable module in your API::BaseController to receive a collection of useful
+                          methods, such as arguments and relationships parser, filters, etc.}
+  spec.homepage      = "http://github.com/mikemarsian/json_apiable"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency 'fast_jsonapi', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'factory_bot_rails'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/json_apiable/configuration.rb

@@ -0,0 +1,32 @@
+module JsonApiable
+  class Configuration
+    attr_accessor :valid_query_params, :supported_media_type_proc, :not_found_exception_class, :page_size
+
+    DEFAULT_PAGE_NUMBER = 1
+    DEFAULT_PAGE_SIZE = 25
+    # 2^32 / 2 * 10: greater than which raises a java.lang.ArrayIndexOutOfBoundsException exception in Solr
+    MAX_PAGE_SIZE = 214_748_364
+
+    def initialize
+      @valid_query_params = %w[id access_token filter include page]
+      @supported_media_type_proc = nil
+      @not_found_exception_class = ActiveRecord::RecordNotFound
+      @page_size = DEFAULT_PAGE_SIZE
+    end
+
+    def valid_query_params=(value)
+      raise JsonApiable::ConfigurationError, 'Should be an array containing strings' unless value.is_a?(Array)
+      @valid_query_params = value
+    end
+
+    def supported_media_type_proc=(prok)
+      raise JsonApiable::ConfigurationError, 'Should be a proc' unless prok.is_a?(Proc)
+      @supported_media_type_proc = prok
+    end
+
+    def not_found_exception_class=(klass)
+      raise JsonApiable::ConfigurationError, 'Should be a class' unless klass.is_a?(Class)
+      @not_found_exception_class = klass
+    end
+  end
+end

data/lib/json_apiable/core_extensions.rb

@@ -0,0 +1,7 @@
+module CoreExtensions
+  module String
+    def integer?
+      to_i.to_s == self
+    end
+  end
+end

data/lib/json_apiable/errors.rb

@@ -0,0 +1,10 @@
+module JsonApiable
+  module Errors
+    class ApiError < StandardError; end
+    class MalformedRequestError < ApiError; end
+    class UnprocessableEntityError < ApiError; end
+    class UnauthorizedError < ApiError; end
+    class ForbiddenError < ApiError; end
+    class ConfigurationError < ApiError; end
+  end
+end

data/lib/json_apiable/json_apiable.rb

@@ -0,0 +1,122 @@
+module JsonApiable
+  extend ActiveSupport::Concern
+  include Errors
+  include Renderers
+
+  JSONAPI_CONTENT_TYPE = 'application/vnd.api+json'
+
+  attr_reader :jsonapi_page, :jsonapi_include, :jsonapi_build_params, :jsonapi_assign_params, :jsonapi_default_page_size,
+              :jsonapi_exclude_attributes, :jsonapi_exclude_relationships
+
+  included do
+    before_action :ensure_content_type
+    before_action :ensure_valid_query_params
+    before_action :parse_pagination
+    before_action :parse_include
+
+    after_action :set_content_type
+
+    rescue_from ArgumentError, with: :respond_to_bad_argument
+    rescue_from ActionController::UnpermittedParameters, with: :respond_to_bad_argument
+    rescue_from MalformedRequestError, with: :respond_to_malformed_request
+    rescue_from UnprocessableEntityError, with: :respond_to_unprocessable_entity
+    rescue_from UnauthorizedError, with: :respond_to_unauthorized
+    rescue_from ForbiddenError, with: :respond_to_forbidden
+    rescue_from JsonApiable.configuration.not_found_exception_class, with: :respond_to_not_found
+  end
+
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def jsonapi_attribute_present?(attrib_key)
+    jsonapi_build_params.dig(:data, :attributes, attrib_key).present?
+  end
+
+  def jsonapi_assign_params
+    @jsonapi_assign_params ||= ParamsParser.parse_body_params(request,
+                                                              jsonapi_build_params,
+                                                              jsonapi_allowed_attributes,
+                                                              jsonapi_exclude_attributes,
+                                                              jsonapi_allowed_relationships,
+                                                              jsonapi_exclude_relationships)
+  end
+
+  def jsonapi_exclude_attribute(attrib_key)
+    @jsonapi_exclude_attributes ||= []
+    @jsonapi_exclude_attributes << attrib_key.to_sym
+    jsonapi_build_params.dig(:data, :attributes, attrib_key)
+  end
+
+  def jsonapi_exclude_relationship(rel_key)
+    @jsonapi_exclude_relationships ||= []
+    @jsonapi_exclude_relationships << rel_key.to_sym
+    jsonapi_build_params.dig(:data, :relationships, rel_key)
+  end
+
+  # Should be overwritten in specific controllers
+  def jsonapi_build_params
+    params
+  end
+
+  # Should be overwritten in specific controllers
+  def jsonapi_default_page_size
+    JsonApiable.configuration.page_size
+  end
+
+  # Should be overwritten in specific controllers
+  def jsonapi_allowed_attributes
+    %i[]
+  end
+
+  # Should be overwritten in specific controllers
+  def jsonapi_allowed_relationships
+    %i[]
+  end
+
+  def ensure_content_type
+    respond_to_unsupported_media_type unless supported_media_type?
+  end
+
+  def ensure_valid_query_params
+    invalid_params = request.query_parameters.keys.reject { |k| JsonApiable.configuration.valid_query_params.include?(k) }
+    respond_to_bad_argument(invalid_params.first) if invalid_params.present?
+  end
+
+  def supported_media_type?
+    if JsonApiable.configuration.supported_media_type_proc.present?
+      JsonApiable.configuration.supported_media_type_proc.call(request)
+    else
+      request.content_type == JSONAPI_CONTENT_TYPE
+    end
+  end
+
+  def set_content_type
+    response.headers['Content-Type'] = JSONAPI_CONTENT_TYPE
+  end
+
+  def parse_pagination
+    @jsonapi_page = PaginationParser.parse_pagination!(query_params, jsonapi_default_page_size)
+  end
+
+  def parse_include
+    @jsonapi_include = query_params[:include].presence&.gsub(/ /, '')&.split(',')&.map(&:to_sym).to_a
+  end
+
+  def query_params
+    request.query_parameters
+  end
+end

data/lib/json_apiable/pagination_parser.rb

@@ -0,0 +1,59 @@
+module JsonApiable
+  class PaginationParser
+
+    def self.parse_pagination!(query_params, default_page_size)
+      PaginationParser.new(query_params[:page], query_params[:no_pagination], default_page_size).parse!
+    end
+
+    attr_reader :page_param, :no_pagination, :default_page_size
+
+    def initialize(page_arg, no_pagination_arg, default_page_size)
+      @page_param = page_arg
+      @no_pagination = no_pagination_arg
+      @default_page_size = default_page_size
+    end
+
+    def parse!
+      if no_pagination
+        jsonapi_page = nil
+      elsif invalid_page_param?
+        raise ArgumentError, 'page'
+      elsif invalid_page_number?
+        raise ArgumentError, 'page[number]'
+      elsif invalid_page_size?
+        raise ArgumentError, 'page[size]'
+      else
+        jsonapi_page = page_param.presence.to_h.with_indifferent_access
+        # convert values to integers
+        jsonapi_page = jsonapi_page.merge(jsonapi_page) { |k,v| v.to_i } if jsonapi_page.present?
+        jsonapi_page = { number: Configuration::DEFAULT_PAGE_NUMBER, size: default_page_size } if jsonapi_page.blank?
+        jsonapi_page[:number] = Configuration::DEFAULT_PAGE_NUMBER if jsonapi_page[:number].blank?
+        jsonapi_page[:size] = default_page_size if jsonapi_page[:size].blank?
+      end
+      jsonapi_page
+    end
+
+    private
+
+    def invalid_page_param?
+      page_param.present? && !page_param.is_a?(HashWithIndifferentAccess)
+    end
+
+    def invalid_page_number?
+      page_num_param = page_param&.dig(:number)
+      page_num_param.present? && invalid_number?(page_num_param)
+    end
+
+    def invalid_page_size?
+      page_size_param = page_param&.dig(:size)
+      page_size_param.present? && invalid_number?(page_size_param)
+    end
+
+    def invalid_number?(number_param)
+      return true unless number_param.integer?
+
+      number = number_param.to_i
+      number > Configuration::MAX_PAGE_SIZE || number.zero? || number.negative?
+    end
+  end
+end

data/lib/json_apiable/params_parser.rb

@@ -0,0 +1,89 @@
+module JsonApiable
+  class ParamsParser
+    class DataParams
+      def self.build(params, attributes, relationships)
+        params.require(:data).permit(:id, :type,
+                                     attributes: attributes,
+                                     relationships: relationships)
+      end
+    end
+
+    # Convert JsonAPI request body into Rails params hash
+    def self.parse_body_params(request, params, allowed_attributes, excluded_attributes,
+                               allowed_relationships, excluded_relationships)
+      permitted_params = validate_data_params!(params,
+                                               allowed_attributes,
+                                               hashify(allowed_relationships))
+      attributes_hash = build_attributes_hash(permitted_params.dig(:attributes), excluded_attributes)
+      relationships_hash = build_relationships_hash(permitted_params.dig(:relationships), excluded_relationships, request)
+      attributes_hash.merge(relationships_hash)
+    rescue ArgumentError, ActionController::UnpermittedParameters
+      raise
+    rescue StandardError => e
+      raise Errors::MalformedRequestError, e.message
+    end
+
+    def self.validate_data_params!(params, attributes, relationships)
+      permitted = DataParams.build(params, attributes, relationships)
+      unpermitted = params.dig(:data)&.keys.to_a - permitted&.keys.to_a
+      raise ArgumentError, "Unpermitted member: #{unpermitted.first}" if unpermitted.present?
+
+
+      unpermitted_arguments = params.dig(:data, :attributes)&.keys.to_a - permitted.dig(:attributes)&.keys.to_a
+      raise ArgumentError, "Unpermitted attribute: #{unpermitted_arguments.first}" if unpermitted_arguments.present?
+
+      unpermitted_relationships = params.dig(:data, :relationships)&.keys.to_a - permitted.dig(:relationships)&.keys.to_a
+      raise ArgumentError, "Unpermitted relationship: #{unpermitted_relationships.first}" if unpermitted_relationships.present?
+
+      permitted
+    end
+
+    def self.build_attributes_hash(attributes, excluded_attributes)
+      attrs_hash = {}
+      attributes&.each do |key, value|
+        next if excluded_attributes&.include?(key.to_sym)
+
+        new_key = value.is_a?(ActionController::Parameters) ? "#{key}_attributes" : key
+        attrs_hash[new_key] = value.is_a?(ActionController::Parameters) ? value.to_h : value
+      end
+      attrs_hash
+    end
+
+    def self.build_relationships_hash(relationships, excluded_relationships, request)
+      attr_hash = {}; ids_array = []; ids_key = nil
+
+      relationships&.each_pair do |key, data_hash|
+        next if excluded_relationships&.include?(key.to_sym)
+
+        if ActiveSupport::Inflector.pluralize(key) == key
+          new_key = "#{key}_attributes"
+          new_value = build_relationship_attribute_hash(data_hash)
+          ids_key = "#{ActiveSupport::Inflector.singularize(key)}_ids"
+          ids_array = data_hash['data']&.map { |h| h['id'] }
+        else
+          new_key = "#{key}_id"
+          new_value = data_hash['data']['id']
+        end
+        attr_hash[new_key] = new_value
+        # ids array is needed when creating a new AR object which accepts_nested_attributes for existing AR object(s)
+        # as in the case of a new Message which accepts existing attachments
+        # https://stackoverflow.com/a/25943832/1983833
+        attr_hash[ids_key] = ids_array if ids_array.present? && (request.post? || request.patch?)
+      end
+      attr_hash
+    end
+
+    def self.build_relationship_attribute_hash(data_hash)
+      attr_hash = {}
+      data_hash['data'].each_with_index do |arr_item, i|
+        item_hash = { 'id' => arr_item['id'], '_destroy' => 'false' }
+        attr_hash[i.to_s] = item_hash
+      end
+      attr_hash
+    end
+
+    def self.hashify(allowed_relationships)
+      allowed_relationships.map{|rel| { rel => {}}}
+    end
+  end
+end

data/lib/json_apiable/renderers.rb

@@ -0,0 +1,52 @@
+module JsonApiable
+  module Renderers
+    def respond_to_unsupported_media_type
+      errors = [{ title: 'Unsupported Media Type', detail: 'application/vnd.api+json is expected' }]
+      json_render_errors json: errors, status: :unsupported_media_type
+    end
+
+    def respond_to_unprocessable_entity(err_msg = nil)
+      errors = [{ title: 'Unprocessable', detail: err_msg.to_s }]
+      json_render_errors json: errors, status: :unprocessable_entity
+    end
+
+    def respond_to_forbidden(err_msg = nil)
+      errors = [{ title: 'Forbidden', detail: err_msg.to_s || 'You are not authorized to perform this action' }]
+      json_render_errors json: errors, status: :forbidden
+    end
+
+    def respond_to_unauthorized(err_msg = nil)
+      errors = [{ title: 'Unauthorized', detail: err_msg.to_s || 'You have to be authenticated to perform this action' }]
+      json_render_errors json: errors, status: :unauthorized
+    end
+
+    def respond_to_not_found(err_msg = nil)
+      errors = [{ title: 'Not Found', detail: err_msg.to_s || 'Resource not found on the server' }]
+      json_render_errors json: errors, status: :not_found
+    end
+
+    def respond_to_bad_argument(err_msg)
+      errors = [{ title: 'Invalid Argument', detail: err_msg.to_s }]
+      json_render_errors json: errors, status: :bad_request
+    end
+
+    def respond_to_malformed_request(err_msg = nil)
+      errors = [{ title: 'Malformed Request', detail: err_msg.to_s }]
+      json_render_errors json: errors, status: :bad_request
+    end
+
+    def respond_to_capability_error
+      errors = [{ title: 'Capability Error', detail: "Your plan doesn't allow this action" }]
+      json_render_errors json: errors, status: :forbidden
+    end
+
+    def json_render_errors(json: nil, status: nil)
+      err_json = json.first
+      if err_json.present? && err_json[:status].blank?
+        status_code = status.is_a?(Symbol) ? Rack::Utils::SYMBOL_TO_STATUS_CODE[status] : status
+        err_json[:status] = status_code.to_s
+      end
+      render json: { errors: json }, status: status
+    end
+  end
+end

data/lib/json_apiable/version.rb

@@ -0,0 +1,3 @@
+module JsonApiable
+  VERSION = "0.1.0"
+end

data/lib/json_apiable.rb

@@ -0,0 +1,12 @@
+require 'active_support/all'
+require "json_apiable/version"
+require "json_apiable/core_extensions"
+require 'json_apiable/configuration'
+require 'json_apiable/renderers'
+require 'json_apiable/errors'
+require 'json_apiable/params_parser'
+require 'json_apiable/pagination_parser'
+require 'json_apiable/json_apiable'
+
+String.include CoreExtensions::String
+Mime::Type.register JsonApiable::JSONAPI_CONTENT_TYPE, :json_api

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: json_apiable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Polischuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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: faker
+  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: pry
+  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: pry-byebug
+  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: rails
+  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: rails-controller-testing
+  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: '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: rspec-rails
+  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: sqlite3
+  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: 
+email:
+- mike.polis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_apiable.gemspec
+- lib/json_apiable.rb
+- lib/json_apiable/configuration.rb
+- lib/json_apiable/core_extensions.rb
+- lib/json_apiable/errors.rb
+- lib/json_apiable/json_apiable.rb
+- lib/json_apiable/pagination_parser.rb
+- lib/json_apiable/params_parser.rb
+- lib/json_apiable/renderers.rb
+- lib/json_apiable/version.rb
+homepage: http://github.com/mikemarsian/json_apiable
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/mikemarsian/json_apiable
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Include JsonApiable module in your API::BaseController to receive a collection
+  of useful methods, such as arguments and relationships parser, filters, etc.
+test_files: []