jsonapi-utils 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0600b0456c3a82eead45d6b278f6edd3a0eaf69
-  data.tar.gz: f7ae630485129ae7f4ed320b2b66a43b4988be2b
+  metadata.gz: 1e857579e82b9b5550ec7224bd1c2659b4e06e9f
+  data.tar.gz: 468183964c826b06cff256ccfd2b4305b43f68bb
 SHA512:
-  metadata.gz: 17a24aeb6bd942161301874c84c290d6214382a89f6d459b3c27a2c0e8036c6a24671e780cebe0e575ef699a0e1d86144839e7b626423f4c2803f267772b6a2c
-  data.tar.gz: 90a95d43903965f646c5b2be1679b01bab64d6868785d245bffd008e65e6ee8e5c62c30f8c6ebe090234e0890c98a728494e0012caae26807a4a028904eb5f2b
+  metadata.gz: 597e131379f735cda8fb5f980256966089d0dacc4d5a552709a20524f30e4b5ab94e8ee01a3a0a22f861911bbeefa470341c35c5946badbc0319437353c34e02
+  data.tar.gz: 9715af2a8aeae7cda56d8f24e8f43f982774ab9db0d64e0c15aef2ada82a9f7714f4556895adfc06583a8a76539cd5dc2bee0a9b8df4c97d9d8beab8d0711510

data/jsonapi-utils.gemspec

@@ -19,7 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'jsonapi-resources', '~> 0.5.7'
+  spec.add_development_dependency 'rails', '>= 4.0'
 end

data/lib/jsonapi/utils.rb

@@ -33,8 +33,8 @@ module JSONAPI
       jsonapi_render_errors(::JSONAPI::Utils::Exceptions::BadRequest.new)
     end
 
-    def jsonapi_render_not_found
-      id = extract_ids(@request.params)
+    def jsonapi_render_not_found(exception)
+      id = exception.message.match(/=(\d+)/)[1]
       jsonapi_render_errors(JSONAPI::Exceptions::RecordNotFound.new(id))
     end
 
@@ -48,12 +48,12 @@ module JSONAPI
       fix_request_options(params, records)
 
       if records.respond_to?(:to_ary)
-        records = fix_when_hash(records, options) if needs_to_be_fixed?(records)
-        @resources = build_collection(records, options)
-        results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, @resources, result_options(options)))
+        records   = fix_when_hash(records, options) if needs_to_be_fixed?(records)
+        @_records = build_collection(records, options)
+        results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, @_records, result_options(records, options)))
       else
-        @resource = turn_into_resource(records, options)
-        results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @resource))
+        @_record = turn_into_resource(records, options)
+        results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @_record))
       end
 
       create_response_document(results).contents
@@ -61,11 +61,6 @@ module JSONAPI
 
     private
 
-    def extract_ids(hash)
-      ids = hash.keys.select { |e| e =~ /id$/i }.map { |e| hash[e] }
-      ids.first rescue '(id not identified)'
-    end
-
     def fix_request_options(params, records)
       return if request.method !~ /get/i ||
                 params.nil? ||
@@ -78,33 +73,33 @@ module JSONAPI
       records.is_a?(Array) && records.all? { |e| e.is_a?(Hash) }
     end
 
-    def result_options(options)
-      hash = {}
-
-      if JSONAPI.configuration.top_level_links_include_pagination
-        hash[:pagination_params] = pagination_params(options)
-      end
+    def result_options(records, options)
+      {}.tap do |data|
+        if JSONAPI.configuration.top_level_links_include_pagination
+          data[:pagination_params] = pagination_params(records, options)
+        end
 
-      if JSONAPI.configuration.top_level_meta_include_record_count
-        hash[:record_count] = count_records(@resources, options)
+        if JSONAPI.configuration.top_level_meta_include_record_count
+          data[:record_count] = count_records(records, options)
+        end
       end
-
-      hash
     end
 
-    def pagination_params(options)
-      if @paginator && JSONAPI.configuration.top_level_links_include_pagination
-        options = {}
-        @paginator.class.requires_record_count &&
-          options[:record_count] = count_records(@resources, options)
-        return @paginator.links_page_params(options)
+    def pagination_params(records, options)
+      data = {}
+      if @_paginator && JSONAPI.configuration.top_level_links_include_pagination
+        @_paginator.class.requires_record_count &&
+          data[:record_count] = count_records(records, options)
+        @_paginator.links_page_params(data)
       else
-        return {}
+        data
       end
     end
 
     def build_collection(records, options = {})
-      records = paginate(records, options)
+      records = apply_filter(records, options)
+      records = apply_pagination(records, options)
+      records = apply_sort(records)
       records.respond_to?(:to_ary) ? records.map { |record| turn_into_resource(record, options) } : []
     end
 
@@ -116,8 +111,28 @@ module JSONAPI
       end
     end
 
-    def paginate(records, options = {})
-      return records if pagination_disabled?(options)
+    def apply_filter(records, options = {})
+      if apply_filter?(records, options)
+        records.where(filter_params)
+      else
+        records
+      end
+    end
+
+    def apply_filter?(records, options = {})
+      params[:filter].present? && records.respond_to?(:where) &&
+        (options[:filter].nil? || options[:filter])
+    end
+
+    def filter_params
+      @_filter_params =
+        params[:filter].keys.each_with_object({}) do |resource, hash|
+          hash[resource] = params[:filter][resource]
+        end
+    end
+
+    def apply_pagination(records, options = {})
+      return records unless apply_pagination?(options)
       pagination = set_pagination(options)
 
       records =
@@ -128,43 +143,71 @@ module JSONAPI
         end
     end
 
+    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
+
+    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
+    end
+
+    def sort_params
+      @_sort_params ||=
+        params[:sort].split(',').each_with_object({}) do |criteria, hash|
+          order, field = criteria.match(/(\-?)(\w+)/i)[1..2]
+          hash[field]  = order == '-' ? :desc : :asc
+        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)
-        n = page_params['number'].to_i.nonzero? || 1
-        s = page_params['size'].to_i.nonzero?   || JSONAPI.configuration.default_page_size
-        { paginator: @paginator, range: (n - 1) * s..n * s - 1 }
+        @_paginator ||= PagedPaginator.new(page_params)
+        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)
-        o = page_params['offset'].to_i.nonzero? || 0
-        l = page_params['limit'].to_i.nonzero?  || JSONAPI.configuration.default_page_size
-        { paginator: @paginator, range: o..o + l - 1 }
+        @_paginator ||= OffsetPaginator.new(page_params)
+        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 }
       else
         {}
       end
     end
 
-    def pagination_disabled?(options)
-      JSONAPI.configuration.default_paginator == :none ||
-        !options[:paginate].nil? && !options[:paginate]
+    def apply_pagination?(options)
+      JSONAPI.configuration.default_paginator != :none &&
+        (options[:paginate].nil? || options[:paginate])
     end
 
     def fix_when_hash(records, options)
       return [] unless options[:model]
       records.map { |hash| options[:model].new(hash) }
-    rescue
+    rescue ActiveRecord::UnknownAttributeError
       ids = records.map { |e| e[:id] || e['id'] }
       scope = options[:scope] ? options[:model].send(options[:scope]) : options[:model]
       scope.where(id: ids)
     end
 
     def count_records(records, options)
-      if records.size.zero? then 0
-      elsif options[:count] then options[:count]
-      elsif options[:model] && options[:scope] then options[:model].send(options[:scope]).count
-      elsif options[:model] then options[:model].count
-      else records.first.model.class.count
+      if options[:count].present?
+        options[:count]
+      elsif records.is_a?(Array)
+        records.length
+      else
+        records = apply_filter(records, options) if params[:filter].present?
+        records.except(:group, :order).count("DISTINCT #{records.table.name}.id")
       end
     end
   end

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.3.4'
+    VERSION = '0.3.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,6 +53,62 @@ dependencies:
     - - ">="
       - !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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: A Rails way to get your API's data following the JSON API's specs (http://jsosapi.org)
 email:
 - tiagopog@gmail.com
@@ -95,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: JSON::Utils is a simple way to get a full-featured JSON API serialization