class JSONAPI::ResponseDocument

Attributes

serialized_results[R]

Public Class Methods

new(options = {}) click to toggle source
# File lib/jsonapi/response_document.rb, line 5
def initialize(options = {})
  @serialized_results = []
  @result_codes = []
  @error_results = []
  @global_errors = []

  @options = options

  @top_level_meta = @options.fetch(:base_meta, {})
  @top_level_links = @options.fetch(:base_links, {})

  @key_formatter = @options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
end

Public Instance Methods

add_global_error(error) click to toggle source
# File lib/jsonapi/response_document.rb, line 40
def add_global_error(error)
  @global_errors.push error
end
add_result(result, operation) click to toggle source
# File lib/jsonapi/response_document.rb, line 23
def add_result(result, operation)
  if result.is_a?(JSONAPI::ErrorsOperationResult)
    # Clear any serialized results
    @serialized_results = []

    # In JSONAPI v1 we only have one operation so all errors can be kept together
    result.errors.each do |error|
      add_global_error(error)
    end
  else
    @serialized_results.push result.to_hash(operation.options[:serializer])
    @result_codes.push result.code.to_i
    update_links(operation.options[:serializer], result)
    update_meta(result)
  end
end
contents() click to toggle source
# File lib/jsonapi/response_document.rb, line 44
def contents
  if has_errors?
    return { 'errors' => @global_errors }
  else
    hash = @serialized_results[0]
    meta = top_level_meta
    hash.merge!('meta' => meta) unless meta.empty?

    links = top_level_links
    hash.merge!('links' => links) unless links.empty?

    return hash
  end
end
has_errors?() click to toggle source
# File lib/jsonapi/response_document.rb, line 19
def has_errors?
  @error_results.length > 0 || @global_errors.length > 0
end
status() click to toggle source
# File lib/jsonapi/response_document.rb, line 59
def status
  status_codes = if has_errors?
                   @global_errors.collect do |error|
                     error.status.to_i
                   end
                 else
                   @result_codes
                 end

  # Count the unique status codes
  counts = status_codes.each_with_object(Hash.new(0)) { |code, counts| counts[code] += 1 }

  # if there is only one status code we can return that
  return counts.keys[0].to_i if counts.length == 1

  # :nocov: not currently used

  # if there are many we should return the highest general code, 200, 400, 500 etc.
  max_status = 0
  status_codes.each do |status|
    code = status.to_i
    max_status = code if max_status < code
  end
  return (max_status / 100).floor * 100
  # :nocov:
end

Private Instance Methods

query_params(params) click to toggle source
# File lib/jsonapi/response_document.rb, line 138
def query_params(params)
  query_params = {}
  query_params[:page] = params

  request = @options[:request]
  if request.params[:fields]
    query_params[:fields] = request.params[:fields].respond_to?(:to_unsafe_hash) ? request.params[:fields].to_unsafe_hash : request.params[:fields]
  end

  query_params[:include] = request.params[:include] if request.params[:include]
  query_params[:sort] = request.params[:sort] if request.params[:sort]

  if request.params[:filter]
    query_params[:filter] = request.params[:filter].respond_to?(:to_unsafe_hash) ? request.params[:filter].to_unsafe_hash : request.params[:filter]
  end

  query_params
end
top_level_meta() click to toggle source
# File lib/jsonapi/response_document.rb, line 106
def top_level_meta
  @top_level_meta.as_json.deep_transform_keys { |key| @key_formatter.format(key) }
end
update_meta(result) click to toggle source
# File lib/jsonapi/response_document.rb, line 88
def update_meta(result)
  @top_level_meta.merge!(result.meta)

  if JSONAPI.configuration.top_level_meta_include_record_count && result.respond_to?(:record_count)
    @top_level_meta[JSONAPI.configuration.top_level_meta_record_count_key] = result.record_count
  end

  if JSONAPI.configuration.top_level_meta_include_page_count && result.respond_to?(:page_count)
    @top_level_meta[JSONAPI.configuration.top_level_meta_page_count_key] = result.page_count
  end

  if result.warnings.any?
    @top_level_meta[:warnings] = result.warnings.collect do |warning|
      warning.to_hash
    end
  end
end