jsonapi-utils 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c328df382d804f5ae2d625216ac2febd26b952ac
-  data.tar.gz: b13829c6b72e5d4a8fb76fcafcac900916c5d8f6
+  metadata.gz: 5c64468130b16c1b4247c925d9fc25a583d6134d
+  data.tar.gz: 8d90c469c22ed667afb6b72dc02b2fcd31997e4b
 SHA512:
-  metadata.gz: 60a974e53b5e40f500bc8a99cba456d21ca7c9c960ff040e91622f35bf40dcae9d6101fa38e93491d79fa96f7ca6e362d0d3857329c1841a06b541903bea2f27
-  data.tar.gz: fc039cfdecd100db6b4d316e5b232734e9b96ec9e77ad8578398e9a542a17828a233a58ee39ea28fbfe673f50f43de783b3fec5fe350145022749662d7c408bf
+  metadata.gz: 9ef5754a5dbe043c4bfeb30f40532c9a893c98ce65c15b2ca0d46196386b5eaa8e77b80a59f8e4350fdaafb867cdb7fef357a342ea1a322813a09341f5af0403
+  data.tar.gz: da448b2469e853c89e027960810325eaf90e66191b93769ac30cb41d8e565455b37a2a23f5e923581ab8ce74abddd8065dc9b4d85539439dd97718b465ed3ebd

data/lib/jsonapi/utils.rb

@@ -1,8 +1,12 @@
+
 require 'jsonapi-resources'
 require 'jsonapi/utils/version'
 require 'jsonapi/utils/exceptions'
 require 'jsonapi/utils/request'
 require 'jsonapi/utils/response'
+require 'jsonapi/utils/support/filter/custom'
+
+JSONAPI::Resource.extend JSONAPI::Utils::Support::Filter::Custom
 
 module JSONAPI
   module Utils
@@ -10,6 +14,8 @@ module JSONAPI
     include Response
 
     def self.included(base)
+      base.include ActsAsResourceController
+
       if base.respond_to?(:before_action)
         base.before_action :jsonapi_request_handling
       end

data/lib/jsonapi/utils/exceptions.rb

@@ -23,20 +23,24 @@ module JSONAPI
       end
 
       class BadRequest < ::JSONAPI::Exceptions::Error
-        def code; '400' end
+        def code
+          '400'
+        end
 
         def errors
           [JSONAPI::Error.new(
-              code: code,
-              status: :bad_request,
-              title: 'Bad Request',
-              detail: 'This request is not supported.'
-            )]
+            code: code,
+            status: :bad_request,
+            title: 'Bad Request',
+            detail: 'This request is not supported.'
+          )]
         end
       end
 
       class InternalServerError < ::JSONAPI::Exceptions::Error
-        def code; '500' end
+        def code
+          '500'
+        end
 
         def errors
           [JSONAPI::Error.new(

data/lib/jsonapi/utils/response/support.rb

@@ -1,21 +1,21 @@
-require 'jsonapi/utils/support/filter'
+require 'jsonapi/utils/support/error'
+require 'jsonapi/utils/support/filter/default'
 require 'jsonapi/utils/support/pagination'
 require 'jsonapi/utils/support/sort'
-require 'jsonapi/utils/support/error'
 
 module JSONAPI
   module Utils
     module Response
       module Support
         include ::JSONAPI::Utils::Support::Error
-        include ::JSONAPI::Utils::Support::Filter
+        include ::JSONAPI::Utils::Support::Filter::Default
         include ::JSONAPI::Utils::Support::Pagination
         include ::JSONAPI::Utils::Support::Sort
 
         private
 
         def correct_media_type
-          if response.body.size > 0
+          unless response.body.empty?
             response.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
           end
         end

data/lib/jsonapi/utils/support/error.rb

@@ -2,7 +2,7 @@ module JSONAPI
   module Utils
     module Support
       module Error
-        MEMBERS = %i(title detail id code source links status meta)
+        MEMBERS = %i(title detail id code source links status meta).freeze
 
         module_function
 

data/lib/jsonapi/utils/support/filter.rb

@@ -17,9 +17,11 @@ module JSONAPI
 
         def filter_params
           @_filter_params ||=
-            if params[:filter].is_a?(Hash)
-              params[:filter].keys.each_with_object({}) do |resource, hash|
-                hash[resource] = params[:filter][resource]
+            case params[:filter]
+            when Hash, ActionController::Parameters
+              default_filters.each_with_object({}) do |field, hash|
+                unformatted_field = @request.unformat_key(field)
+                hash[unformatted_field] = params[:filter][field]
               end
             end
         end

data/lib/jsonapi/utils/support/filter/custom.rb

@@ -0,0 +1,22 @@
+module JSONAPI::Utils::Support::Filter
+  module Custom
+    def _custom_filters
+      @_allowed_custom_filters || []
+    end
+
+    def custom_filters(*attrs)
+      attrs.each { |attr| custom_filter(attr) }
+    end
+
+    def custom_filter(attr)
+      attr = attr.to_sym
+      @_allowed_filters[attr] = {}
+
+      if !@_allowed_custom_filters.is_a?(Array)
+        @_allowed_custom_filters = Array(attr)
+      elsif @_allowed_custom_filters.include?(attr)
+        @_allowed_custom_filters.push(attr)
+      end
+    end
+  end
+end

data/lib/jsonapi/utils/support/filter/default.rb

@@ -0,0 +1,66 @@
+module JSONAPI::Utils::Support::Filter
+  module Default
+    # Apply default equality filters.
+    #   e.g.: User.where(name: 'Foobar')
+    #
+    # @param records [ActiveRecord::Relation, Array] collection of records
+    #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+    #
+    # @param options [Hash] JU's options
+    #   e.g.: { filter: false, paginate: false }
+    #
+    # @return [ActiveRecord::Relation, Array]
+    #
+    # @api public
+    def apply_filter(records, options = {})
+      if apply_filter?(records, options)
+        records.where(filter_params)
+      else
+        records
+      end
+    end
+
+    # Check whether default filters should be applied.
+    #
+    # @param records [ActiveRecord::Relation, Array] collection of records
+    #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+    #
+    # @param options [Hash] JU's options
+    #   e.g.: { filter: false, paginate: false }
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def apply_filter?(records, options = {})
+      params[:filter].present? && records.respond_to?(:where) &&
+        (options[:filter].nil? || options[:filter])
+    end
+
+    # Build a Hash with the default filters.
+    #
+    # @return [Hash, NilClass]
+    #
+    # @api public
+    def filter_params
+      @_filter_params ||=
+        case params[:filter]
+        when Hash, ActionController::Parameters
+          default_filters.each_with_object({}) do |field, hash|
+            unformatted_field = @request.unformat_key(field)
+            hash[unformatted_field] = params[:filter][field]
+          end
+        end
+    end
+
+    private
+
+    # Take all allowed filters and remove the custom ones.
+    #
+    # @return [Array]
+    #
+    # @api private
+    def default_filters
+      params[:filter].keys.map(&:to_sym) - @request.resource_klass._custom_filters
+    end
+  end
+end

data/lib/jsonapi/utils/support/pagination.rb

@@ -2,63 +2,133 @@ module JSONAPI
   module Utils
     module Support
       module Pagination
+        # Apply proper pagination to the records.
+        #
+        # @param records [ActiveRecord::Relation, Array] collection of records
+        #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+        #
+        # @param options [Hash] JU's options
+        #   e.g.: { resource: V2::UserResource, count: 100 }
+        #
+        # @return [ActiveRecord::Relation, Array]
+        #
+        # @api public
         def apply_pagination(records, options = {})
           return records unless apply_pagination?(options)
-          pagination = set_pagination(options)
+          records.is_a?(Array) ? records[paginate_with(:range)] : paginate_with(:paginator).apply(records, nil)
+        end
 
-          records =
-            if records.is_a?(Array)
-              records[pagination[:range]]
-            else
-              pagination[:paginator].apply(records, nil)
-            end
+        # Mount pagination params for JSONAPI::ResourcesOperationResult.
+        # It can also be used anywhere else as a helper method.
+        #
+        # @param records [ActiveRecord::Relation, Array] collection of records
+        #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+        #
+        # @param options [Hash] JU's options
+        #   e.g.: { resource: V2::UserResource, count: 100 }
+        #
+        # @return [Hash]
+        #   e.g.: {"first"=>{"number"=>1, "size"=>2}, "next"=>{"number"=>2, "size"=>2}, "last"=>{"number"=>2, "size"=>2}}
+        #
+        # @api public
+        def pagination_params(records, options)
+          return {} unless JSONAPI.configuration.top_level_links_include_pagination
+          paginator.links_page_params(record_count: count_records(records, options))
+        end
+
+        private
+
+        # Define the paginator object to be used in the response's pagination.
+        #
+        # @return [PagedPaginator, OffsetPaginator]
+        #
+        # @api private
+        def paginator
+          @paginator ||= paginator_klass.new(page_params)
         end
 
+        # Returns the paginator class to be used in the response's pagination.
+        #
+        # @return [Paginator]
+        #
+        # @api private
+        def paginator_klass
+          "#{JSONAPI.configuration.default_paginator}_paginator".classify.constantize
+        end
+
+        # Check whether pagination should be applied to the response.
+        #
+        # @return [Boolean]
+        #
+        # @api private
         def apply_pagination?(options)
           JSONAPI.configuration.default_paginator != :none &&
             (options[:paginate].nil? || options[:paginate])
         end
 
-        def pagination_params(records, options)
-          @paginator ||= paginator(params)
-          if @paginator && JSONAPI.configuration.top_level_links_include_pagination
-            options = {}
-            @paginator.class.requires_record_count &&
-              options[:record_count] = count_records(records, options)
-            @paginator.links_page_params(options)
-          else
-            {}
+        # Creates an instance of ActionController::Parameters for page params.
+        #
+        # @return [ActionController::Parameters]
+        #
+        # @api private
+        def page_params
+          @page_params ||= begin
+            page = @request.params.to_unsafe_hash['page'] || {}
+            ActionController::Parameters.new(page)
           end
         end
 
-        def paginator(params)
-          page_params = ActionController::Parameters.new(params[:page])
-
-          @paginator ||=
-            if JSONAPI.configuration.default_paginator == :paged
-              PagedPaginator.new(page_params)
-            elsif JSONAPI.configuration.default_paginator == :offset
-              OffsetPaginator.new(page_params)
+        # Define the paginator or range according to the pagination strategy.
+        #
+        # @param kind [Symbol] pagination object's kind
+        #   e.g.: :paginator or :range
+        #
+        # @return [PagedPaginator, OffsetPaginator, Range]
+        #   e.g.: #<PagedPaginator:0x00561ed06dc5a0 @number=1, @size=2>
+        #         0..9
+        #
+        # @api private
+        def paginate_with(kind)
+          @pagination ||=
+            case kind
+            when :paginator then paginator
+            when :range     then pagination_range
             end
         end
 
-        def set_pagination(options)
-          page_params = ActionController::Parameters.new(@request.params[:page])
-          if JSONAPI.configuration.default_paginator == :paged
-            @_paginator ||= PagedPaginator.new(page_params)
+        # Define a pagination range for objects which quack like Arrays.
+        #
+        # @return [Range]
+        #   e.g.: 0..9
+        #
+        # @api private
+        def pagination_range
+          case JSONAPI.configuration.default_paginator
+          when :paged
             number = page_params['number'].to_i.nonzero? || 1
             size   = page_params['size'].to_i.nonzero?   || JSONAPI.configuration.default_page_size
-            { paginator: @_paginator, range: (number - 1) * size..number * size - 1 }
-          elsif JSONAPI.configuration.default_paginator == :offset
-            @_paginator ||= OffsetPaginator.new(page_params)
+            (number - 1) * size..number * size - 1
+          when :offset
             offset = page_params['offset'].to_i.nonzero? || 0
             limit  = page_params['limit'].to_i.nonzero?  || JSONAPI.configuration.default_page_size
-            { paginator: @_paginator, range: offset..offset + limit - 1 }
+            offset..offset + limit - 1
           else
-            {}
+            paginator.pagination_range(page_params)
           end
         end
 
+        # Count records in order to build a proper pagination and to fill up the "record_count" response's member.
+        #
+        # @param records [ActiveRecord::Relation, Array] collection of records
+        #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+        #
+        # @param options [Hash] JU's options
+        #   e.g.: { resource: V2::UserResource, count: 100 }
+        #
+        # @return [Integer]
+        #   e.g.: 42
+        #
+        # @api private
         def count_records(records, options)
           if options[:count].present?
             options[:count]

data/lib/jsonapi/utils/support/sort.rb

@@ -1,35 +1,53 @@
-module JSONAPI
-  module Utils
-    module Support
-      module Sort
-        def apply_sort(records)
-          return records unless params[:sort].present?
+module JSONAPI::Utils::Support
+  module Sort
+    # Apply sort on result set (ascending by default).
+    #   e.g.: User.order(:first_name)
+    #
+    # @param records [ActiveRecord::Relation, Array] collection of records
+    #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+    #
+    # @return [ActiveRecord::Relation, Array]
+    #
+    # @api public
+    def apply_sort(records)
+      return records unless params[:sort].present?
 
-          if records.is_a?(Array)
-            records.sort { |a, b| comp = 0; eval(sort_criteria) }
-          elsif records.respond_to?(:order)
-            records.order(sort_params)
-          end
-        end
+      if records.is_a?(Array)
+        records.sort { |a, b| comp = 0; eval(sort_criteria) }
+      elsif records.respond_to?(:order)
+        records.order(sort_params)
+      end
+    end
 
-        def sort_criteria
-          sort_params.reduce('') do |sum, hash|
-            foo = ["a[:#{hash[0]}]", "b[:#{hash[0]}]"]
-            foo.reverse! if hash[1] == :desc
-            sum + "comp = comp == 0 ? #{foo.join(' <=> ')} : comp; "
-          end
+    # Build the criteria to be evaluated wthen applying sort
+    # on Array of Hashes (ascending by default).
+    #
+    # @return [String]
+    #
+    # @api public
+    def sort_criteria
+      @sort_criteria ||=
+        sort_params.reduce('') do |sum, (key, value)|
+          comparables = ["a[:#{key}]", "b[:#{key}]"]
+          comparables.reverse! if value == :desc
+          sum + "comp = comp == 0 ? #{comparables.join(' <=> ')} : comp; "
         end
+    end
 
-        def sort_params
-          @_sort_params ||=
-            if params[:sort].present?
-              params[:sort].split(',').each_with_object({}) do |criteria, hash|
-                order, field = criteria.match(/(\-?)(\w+)/i)[1..2]
-                hash[field]  = order == '-' ? :desc : :asc
-              end
-            end
+    # Build a Hash with the sort criteria.
+    #
+    # @return [Hash, NilClass]
+    #
+    # @api public
+    def sort_params
+      @_sort_params ||=
+        if params[:sort].present?
+          params[:sort].split(',').each_with_object({}) do |field, hash|
+            unformatted_field = @request.unformat_key(field)
+            desc, field       = unformatted_field.to_s.match(/^([-_])?(\w+)$/i)[1..2]
+            hash[field]       = desc.present? ? :desc : :asc
+          end
         end
-      end
     end
   end
 end

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.4.6'
+    VERSION = '0.4.7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-resources
@@ -123,6 +123,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !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'
 description: A Rails way to get your API's data serialized through JSON API's specs
   (http://jsosapi.org)
 email:
@@ -146,6 +174,8 @@ files:
 - lib/jsonapi/utils/response/support.rb
 - lib/jsonapi/utils/support/error.rb
 - lib/jsonapi/utils/support/filter.rb
+- lib/jsonapi/utils/support/filter/custom.rb
+- lib/jsonapi/utils/support/filter/default.rb
 - lib/jsonapi/utils/support/pagination.rb
 - lib/jsonapi/utils/support/sort.rb
 - lib/jsonapi/utils/version.rb
@@ -169,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JSON::Utils is a simple way to get a full-featured JSON API serialization