jsonapi_compliable 0.3.4

data/lib/jsonapi_compliable/dsl.rb

@@ -0,0 +1,60 @@
+module JsonapiCompliable
+  class DSL
+    attr_accessor :sideloads,
+      :default_filters,
+      :extra_fields,
+      :filters,
+      :sorting,
+      :pagination
+
+    def initialize
+      @sideloads = {}
+      @filters = {}
+      @default_filters = {}
+      @extra_fields = {}
+      @sorting = nil
+      @pagination = nil
+    end
+
+    def includes(whitelist: nil, &blk)
+      whitelist = JSONAPI::IncludeDirective.new(whitelist) if whitelist
+
+      @sideloads = {
+        whitelist: whitelist,
+        custom_scope: blk
+      }
+    end
+
+    def allow_filter(name, *args, &blk)
+      opts = args.extract_options!
+      aliases = [name, opts[:aliases]].flatten.compact
+      @filters[name.to_sym] = {
+        aliases: aliases,
+        if: opts[:if],
+        filter: blk
+      }
+    end
+
+    def default_filter(name, &blk)
+      @default_filters[name.to_sym] = {
+        filter: blk
+      }
+    end
+
+    def sort(&blk)
+      @sorting = blk
+    end
+
+    def paginate(&blk)
+      @pagination = blk
+    end
+
+    def extra_field(field, &blk)
+      @extra_fields[field.keys.first] ||= []
+      @extra_fields[field.keys.first] << {
+        name: field.values.first,
+        proc: blk
+      }
+    end
+  end
+end

data/lib/jsonapi_compliable/errors.rb

@@ -0,0 +1,15 @@
+module JsonapiCompliable
+  module Errors
+    class BadFilter < StandardError; end
+
+    class UnsupportedPageSize < StandardError
+      def initialize(size, max)
+        @size, @max = size, max
+      end
+
+      def message
+        "Requested page size #{@size} is greater than max supported size #{@max}"
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/base.rb

@@ -0,0 +1,40 @@
+module JsonapiCompliable
+  module Scope
+    class Base
+      attr_reader :controller, :dsl, :params, :scope
+
+      def initialize(controller, scope)
+        @controller = controller
+        @dsl        = controller._jsonapi_compliable
+        @params     = controller.params
+        @scope      = scope
+      end
+
+      def apply
+        apply_standard_or_override
+      end
+
+      def apply_standard_or_override
+        if apply_standard_scope?
+          @scope = apply_standard_scope
+        else
+          @scope = apply_custom_scope
+        end
+
+        @scope
+      end
+
+      def apply_standard_scope?
+        custom_scope.nil?
+      end
+
+      def apply_standard_scope
+        raise 'override in subclass'
+      end
+
+      def apply_custom_scope
+        raise 'override in subclass'
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/default_filter.rb

@@ -0,0 +1,25 @@
+module JsonapiCompliable
+  class Scope::DefaultFilter < Scope::Base
+    include Scope::Filterable
+
+    def apply
+      dsl.default_filters.each_pair do |name, opts|
+        next if overridden?(name)
+        @scope = opts[:filter].call(@scope)
+      end
+
+      @scope
+    end
+
+    private
+
+    def overridden?(name)
+      if found = find_filter(name)
+        found_aliases = found[name][:aliases]
+        filter_param.keys.any? { |k| found_aliases.include?(k.to_sym) }
+      else
+        false
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/extra_fields.rb

@@ -0,0 +1,35 @@
+module JsonapiCompliable
+  class Scope::ExtraFields < Scope::Base
+    def apply
+      each_extra_field do |extra_field|
+        @scope = extra_field[:proc].call(@scope)
+      end
+
+      @scope
+    end
+
+    private
+
+    def each_extra_field
+      dsl.extra_fields.each_pair do |namespace, extra_fields|
+        extra_fields.each do |extra_field|
+          if requested_extra_field?(namespace, extra_field[:name])
+            yield extra_field
+          end
+        end
+      end
+    end
+
+    def extra_fields
+      params[:extra_fields] || {}
+    end
+
+    def requested_extra_field?(namespace, field)
+      if namespaced = extra_fields[namespace]
+        namespaced.include?(field)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/filter.rb

@@ -0,0 +1,32 @@
+module JsonapiCompliable
+  class Scope::Filter < Scope::Base
+    include Scope::Filterable
+
+    def apply
+      each_filter do |filter, value|
+        @scope = filter_scope(filter, value)
+      end
+
+      @scope
+    end
+
+    def filter_scope(filter, value)
+      if custom_scope = filter.values.first[:filter]
+        custom_scope.call(@scope, value)
+      else
+        @scope.where(filter.keys.first => value)
+      end
+    end
+
+    private
+
+    def each_filter
+      filter_param.each_pair do |param_name, param_value|
+        filter = find_filter!(param_name.to_sym)
+        value  = param_value
+        value  = value.split(',') if value.include?(',')
+        yield filter, value
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/filterable.rb

@@ -0,0 +1,23 @@
+module JsonapiCompliable
+  module Scope::Filterable
+    def find_filter(name)
+      find_filter!(name)
+    rescue JsonapiCompliable::Errors::BadFilter
+      nil
+    end
+
+    def find_filter!(name)
+      filter_name, filter_value = \
+        dsl.filters.find { |_name, opts| opts[:aliases].include?(name.to_sym) }
+      raise JsonapiCompliable::Errors::BadFilter unless filter_name
+      if guard = filter_value[:if]
+        raise JsonapiCompliable::Errors::BadFilter if controller.send(guard) == false
+      end
+      { filter_name => filter_value }
+    end
+
+    def filter_param
+      params[:filter] || {}
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/paginate.rb

@@ -0,0 +1,40 @@
+module JsonapiCompliable
+  class Scope::Paginate < Scope::Base
+    MAX_PAGE_SIZE = 1_000
+
+    def apply
+      if size > MAX_PAGE_SIZE
+        raise JsonapiCompliable::Errors::UnsupportedPageSize
+          .new(size, MAX_PAGE_SIZE)
+      else
+        super
+      end
+    end
+
+    def custom_scope
+      dsl.pagination
+    end
+
+    def apply_standard_scope
+      @scope.page(number).per(size)
+    end
+
+    def apply_custom_scope
+      custom_scope.call(@scope, number, size)
+    end
+
+    private
+
+    def page_param
+      @page_param ||= (params[:page] || {})
+    end
+
+    def number
+      (page_param[:number] || controller.default_page_number).to_i
+    end
+
+    def size
+      (page_param[:size] || controller.default_page_size).to_i
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/sideload.rb

@@ -0,0 +1,25 @@
+module JsonapiCompliable
+  class Scope::Sideload < Scope::Base
+    def apply
+      params[:include] ? super : @scope
+    end
+
+    def custom_scope
+      dsl.sideloads[:custom_scope]
+    end
+
+    def apply_standard_scope
+      @scope.includes(scrubbed)
+    end
+
+    def apply_custom_scope
+      custom_scope.call(@scope, scrubbed)
+    end
+
+    private
+
+    def scrubbed
+      Util::IncludeParams.scrub(controller)
+    end
+  end
+end

data/lib/jsonapi_compliable/scope/sort.rb

@@ -0,0 +1,29 @@
+module JsonapiCompliable
+  class Scope::Sort < Scope::Base
+    def custom_scope
+      dsl.sorting
+    end
+
+    def apply_standard_scope
+      @scope.order(attribute => direction)
+    end
+
+    def apply_custom_scope
+      custom_scope.call(@scope, attribute, direction)
+    end
+
+    private
+
+    def sort_param
+      @sort_param ||= (params[:sort] || 'id')
+    end
+
+    def direction
+      sort_param.starts_with?('-') ? :desc : :asc
+    end
+
+    def attribute
+      sort_param.dup.sub('-', '').to_sym
+    end
+  end
+end

data/lib/jsonapi_compliable/util/field_params.rb

@@ -0,0 +1,17 @@
+module JsonapiCompliable
+  module Util
+    class FieldParams
+      def self.parse!(params, name)
+        return unless params[name]
+
+        params[name].each_pair do |key, value|
+          params[name][key] = value.split(',').map(&:to_sym)
+        end
+      end
+
+      def self.fieldset(params, name)
+        params[name].to_unsafe_hash.deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/include_params.rb

@@ -0,0 +1,28 @@
+module JsonapiCompliable
+  module Util
+    class IncludeParams
+      def self.compare(includes, whitelist)
+        {}.tap do |valid|
+          includes.to_hash.each_pair do |key, sub_hash|
+            if whitelist[key]
+              valid[key] = compare(sub_hash, whitelist[key])
+            end
+          end
+        end
+      end
+
+      def self.scrub(controller)
+        dsl       = controller._jsonapi_compliable
+        whitelist = dsl.sideloads[:whitelist] || {}
+        whitelist = whitelist[controller.action_name]
+        includes  = JSONAPI::IncludeDirective.new(controller.params[:include])
+
+        if whitelist
+          Util::IncludeParams.compare(includes, whitelist)
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/scoping.rb

@@ -0,0 +1,20 @@
+module JsonapiCompliable
+  module Util
+    class Scoping
+      def self.apply?(controller, object, force)
+        return false if force == false
+        return true if !controller._jsonapi_scoped && object.is_a?(ActiveRecord::Relation)
+
+        already_scoped = !!controller._jsonapi_scoped
+        is_activerecord = object.is_a?(ActiveRecord::Base)
+        is_activerecord_array = object.is_a?(Array) && object[0].is_a?(ActiveRecord::Base)
+
+        if [already_scoped, is_activerecord, is_activerecord_array].any?
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/version.rb

@@ -0,0 +1,3 @@
+module JsonapiCompliable
+  VERSION = "0.3.4"
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_compliable
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+platform: ruby
+authors:
+- Lee Richmond
+- Venkata Pasupuleti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: jsonapi_ams_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: active_model_serializers
+  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: jsonapi_spec_helpers
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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:
+- richmolj@gmail.com
+- spasupuleti4@bloomberg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/appraisal
+- bin/console
+- bin/rspec
+- bin/setup
+- gemfiles/rails_3.gemfile
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_4.gemfile.lock
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_5.gemfile.lock
+- jsonapi_compliable.gemspec
+- lib/jsonapi_compliable.rb
+- lib/jsonapi_compliable/base.rb
+- lib/jsonapi_compliable/deserializable.rb
+- lib/jsonapi_compliable/dsl.rb
+- lib/jsonapi_compliable/errors.rb
+- lib/jsonapi_compliable/scope/base.rb
+- lib/jsonapi_compliable/scope/default_filter.rb
+- lib/jsonapi_compliable/scope/extra_fields.rb
+- lib/jsonapi_compliable/scope/filter.rb
+- lib/jsonapi_compliable/scope/filterable.rb
+- lib/jsonapi_compliable/scope/paginate.rb
+- lib/jsonapi_compliable/scope/sideload.rb
+- lib/jsonapi_compliable/scope/sort.rb
+- lib/jsonapi_compliable/util/field_params.rb
+- lib/jsonapi_compliable/util/include_params.rb
+- lib/jsonapi_compliable/util/scoping.rb
+- lib/jsonapi_compliable/version.rb
+homepage: 
+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.1
+signing_key: 
+specification_version: 4
+summary: JSON Compliable serializer for action controller
+test_files: []