jsonapi-utils 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e857579e82b9b5550ec7224bd1c2659b4e06e9f
-  data.tar.gz: 468183964c826b06cff256ccfd2b4305b43f68bb
+  metadata.gz: 768ad917f0e0006484fcca29a138f05c0b2f9a7b
+  data.tar.gz: 8be72ed0a02e3e86f0b73edd822a0f791992cb36
 SHA512:
-  metadata.gz: 597e131379f735cda8fb5f980256966089d0dacc4d5a552709a20524f30e4b5ab94e8ee01a3a0a22f861911bbeefa470341c35c5946badbc0319437353c34e02
-  data.tar.gz: 9715af2a8aeae7cda56d8f24e8f43f982774ab9db0d64e0c15aef2ada82a9f7714f4556895adfc06583a8a76539cd5dc2bee0a9b8df4c97d9d8beab8d0711510
+  metadata.gz: 3fd1c7fa5ca1e4c2d075be52fe75d058555a840fb0c70b43d94bf687f13fd7740d340f74f50fc6f64c4d90a171493c27425661ca26a6b7a99992472d697bc96a
+  data.tar.gz: 3a31efa4514d307eaccaf1c244db587cafccbca885bd2eafbbd8c846829a0d5ed0e4f86697a4e31b5cf46429e8f38b16bf4b0d16e85487dd52d09751ce94f4bc

data/.gitignore

@@ -9,6 +9,8 @@
 /spec/test_db
 /spec/reports/
 /tmp/
+/log/
+*.log
 *.bundle
 *.so
 *.sw*
@@ -16,5 +18,5 @@
 *.a
 *.gem
 .DS_Store
-mkmf.log
+test_db
 

data/README.md

@@ -1,5 +1,8 @@
 # JSONAPI::Utils
 
+[![Code Climate](https://codeclimate.com/github/b2beauty/jsonapi-utils/badges/gpa.svg)](https://codeclimate.com/github/b2beauty/jsonapi-utils)
+[![Gem Version](https://badge.fury.io/rb/jsonapi-utils.svg)](https://badge.fury.io/rb/jsonapi-utils)
+
 JSON::Utils is a simple way to get a full-featured [JSON API](jsonapi.org) serialization in your
 controller's responses. This gem works on top of the awesome gem [jsonapi-resources](https://github.com/cerebris/jsonapi-resources),
 bringing to controllers a Rails-native way to render data.
@@ -9,7 +12,7 @@ bringing to controllers a Rails-native way to render data.
 Add these lines to your application's Gemfile:
 
 ```ruby
-gem 'jsonapi-resources', '~> 0.5.7'
+gem 'jsonapi-resources', '~> 0.7.0'
 gem 'jsonapi-utils'
 ```
 

data/jsonapi-utils.gemspec

@@ -10,20 +10,24 @@ Gem::Specification.new do |spec|
   spec.email         = ["tiagopog@gmail.com", "douglas@beautydate.com.br"]
 
   spec.summary       = %q{JSON::Utils is a simple way to get a full-featured JSON API serialization for your controller's responses.}
-  spec.description   = %q{A Rails way to get your API's data following the JSON API's specs (http://jsosapi.org)}
+  spec.description   = %q{A Rails way to get your API's data serialized through JSON API's specs (http://jsosapi.org)}
   spec.homepage      = "https://github.com/b2beauty/jsonapi-utils"
   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.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 'rspec-rails'
+  spec.add_development_dependency 'smart_rspec'
+  spec.add_development_dependency 'pry'
   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'
+  spec.add_development_dependency 'jsonapi-resources', '~> 0.7.0'
+
+  spec.add_dependency 'rails', '>= 4.0'
 end

data/lib/jsonapi/utils.rb

@@ -1,9 +1,11 @@
 require 'jsonapi/utils/version'
+require 'active_support/concern'
 require 'jsonapi/utils/exceptions'
+require 'pry'
 
 module JSONAPI
   module Utils
-    extend ActiveSupport::Concern
+    extend ::ActiveSupport::Concern
 
     include do
       helper_method :jsonapi_serialize
@@ -13,7 +15,14 @@ module JSONAPI
       if options.has_key?(:json)
         response = jsonapi_serialize(options[:json], options[:options] || {})
         render json: response, status: options[:status] || :ok
+      else
+        raise ArgumentError.new('":json" key must be set to JSONAPI::Utils#jsonapi_render')
       end
+    rescue => e
+      raise e unless e.class.name.starts_with?('JSONAPI::Exceptions')
+      handle_exceptions(e)
+    ensure
+      headers['Content-Type'] = JSONAPI::MEDIA_TYPE
     end
 
     def jsonapi_render_errors(exception)
@@ -33,8 +42,8 @@ module JSONAPI
       jsonapi_render_errors(::JSONAPI::Utils::Exceptions::BadRequest.new)
     end
 
-    def jsonapi_render_not_found(exception)
-      id = exception.message.match(/=(\d+)/)[1]
+    def jsonapi_render_not_found
+      id = extract_ids(@request.params)
       jsonapi_render_errors(JSONAPI::Exceptions::RecordNotFound.new(id))
     end
 
@@ -43,17 +52,18 @@ module JSONAPI
     end
 
     def jsonapi_serialize(records, options = {})
+      setup_request
       results = JSONAPI::OperationResults.new
 
       fix_request_options(params, records)
 
       if records.respond_to?(:to_ary)
-        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)))
+        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)))
       else
-        @_record = turn_into_resource(records, options)
-        results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @_record))
+        @resource = turn_into_resource(records, options)
+        results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @resource))
       end
 
       create_response_document(results).contents
@@ -61,6 +71,11 @@ 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? ||
@@ -73,142 +88,87 @@ module JSONAPI
       records.is_a?(Array) && records.all? { |e| e.is_a?(Hash) }
     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
+    def result_options(options)
+      hash = {}
 
-        if JSONAPI.configuration.top_level_meta_include_record_count
-          data[:record_count] = count_records(records, options)
-        end
+      if JSONAPI.configuration.top_level_links_include_pagination
+        hash[:pagination_params] = pagination_params(options)
       end
-    end
 
-    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
-        data
+      if JSONAPI.configuration.top_level_meta_include_record_count
+        hash[:record_count] = count_records(@resources, options)
       end
-    end
 
-    def build_collection(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) } : []
+      hash
     end
 
-    def turn_into_resource(record, options = {})
-      if options[:resource]
-        options[:resource].to_s.constantize.new(record)
+    def pagination_params(options)
+      @paginator ||= paginator(params)
+      if @paginator && JSONAPI.configuration.top_level_links_include_pagination
+        options = {}
+        @paginator.class.requires_record_count &&
+          options[:record_count] = count_records(@resources, options)
+        @paginator.links_page_params(options)
       else
-        @request.resource_klass.new(record)
-      end
-    end
-
-    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)
+    def paginator(params)
+      page_params = ActionController::Parameters.new(params[:page])
 
-      records =
-        if records.is_a?(Array)
-          records[pagination[:range]]
-        else
-          pagination[:paginator].apply(records, nil)
+      @paginator ||=
+        if JSONAPI.configuration.default_paginator == :paged
+          PagedPaginator.new(page_params)
+        elsif JSONAPI.configuration.default_paginator == :offset
+          OffsetPaginator.new(page_params)
         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; "
+    def build_collection(records, options = {})
+      unless JSONAPI.configuration.default_paginator == :none
+        records = paginator(@request.params).apply(records, nil)
       end
+      records.respond_to?(:to_ary) ? records.map { |record| turn_into_resource(record, options) } : []
     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)
-        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)
-        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 }
+    def turn_into_resource(record, options = {})
+      if options[:resource]
+        options[:resource].to_s.constantize.new(record, context)
       else
-        {}
+        @request.resource_klass.new(record, context)
       end
     end
 
-    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 ActiveRecord::UnknownAttributeError
+    rescue
       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 options[:count].present?
-        options[:count]
-      elsif records.is_a?(Array)
-        records.length
+      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 = apply_filter(records, options) if params[:filter].present?
-        records.except(:group, :order).count("DISTINCT #{records.table.name}.id")
+        record = records.first
+        model  = record.try(:model) || record.try(:_model)
+        model.class.count
       end
     end
+
+    def setup_request
+      @request ||=
+        JSONAPI::Request.new(
+          params,
+          context: context,
+          key_formatter: key_formatter,
+          server_error_callbacks: (self.class.server_error_callbacks || [])
+        )
+    end
   end
 end

data/lib/jsonapi/utils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +67,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: smart_rspec
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +144,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-  type: :development
+  type: :runtime
   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)
+description: A Rails way to get your API's data serialized through JSON API's specs
+  (http://jsosapi.org)
 email:
 - tiagopog@gmail.com
 - douglas@beautydate.com.br
@@ -151,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: JSON::Utils is a simple way to get a full-featured JSON API serialization