Module: JsonApiServer

Defined in:
lib/json_api_server.rb,
lib/json_api_server/cast.rb,
lib/json_api_server/sort.rb,
lib/json_api_server/error.rb,
lib/json_api_server/engine.rb,
lib/json_api_server/errors.rb,
lib/json_api_server/fields.rb,
lib/json_api_server/filter.rb,
lib/json_api_server/builder.rb,
lib/json_api_server/include.rb,
lib/json_api_server/version.rb,
lib/json_api_server/paginator.rb,
lib/json_api_server/exceptions.rb,
lib/json_api_server/mime_types.rb,
lib/json_api_server/pagination.rb,
lib/json_api_server/serializer.rb,
lib/json_api_server/api_version.rb,
lib/json_api_server/meta_builder.rb,
lib/json_api_server/sort_configs.rb,
lib/json_api_server/configuration.rb,
lib/json_api_server/filter_config.rb,
lib/json_api_server/filter_parser.rb,
lib/json_api_server/base_serializer.rb,
lib/json_api_server/filter_builders.rb,
lib/json_api_server/validation_errors.rb,
lib/json_api_server/attributes_builder.rb,
lib/json_api_server/resource_serializer.rb,
lib/json_api_server/resources_serializer.rb,
lib/json_api_server/relationships_builder.rb,
lib/json_api_server/controller/error_handling.rb

Overview

:nodoc:

Defined Under Namespace

Modules: ApiVersion, Controller, MimeTypes, Serializer Classes: AttributesBuilder, BadRequest, BaseSerializer, Builder, Cast, Configuration, Engine, Error, Errors, Fields, Filter, FilterBuilder, FilterConfig, FilterParser, Include, MetaBuilder, ModelQuery, Pagination, Paginator, PgIlike, PgJsonbArray, PgJsonbIlikeArray, RelationshipsBuilder, ResourceSerializer, ResourcesSerializer, Sort, SortConfigs, SqlComp, SqlEql, SqlIn, SqlLike, ValidationErrors

Constant Summary collapse

VERSION = 
'0.0.1.1'.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object 



51
52
53
 
# File 'lib/json_api_server.rb', line 51

def configuration
  @configuration ||= JsonApiServer::Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



55
56
57
 
# File 'lib/json_api_server.rb', line 55

def configure
  yield configuration
end

.errors(errors) ⇒ Object 



59
60
61
 
# File 'lib/json_api_server.rb', line 59

def errors(errors)
  JsonApiServer::Errors.new(errors)
end

.filter_builder(key) ⇒ Object

Returns query_builder class for key specified.



3
4
5
 
# File 'lib/json_api_server/filter_parser.rb', line 3

def self.filter_builder(key)
  JsonApiServer.configuration.filter_builders[key]
end

.logger ⇒ Object

Convenience method to JsonApiServer.configuration.logger.



72
73
74
 
# File 'lib/json_api_server.rb', line 72

def logger
  JsonApiServer.configuration.logger
end

.paginator(current_page, total_pages, per_page, base_url, params = {}) ⇒ Object 



67
68
69
 
# File 'lib/json_api_server.rb', line 67

def paginator(current_page, total_pages, per_page, base_url, params = {})
  JsonApiServer::Paginator.new(current_page, total_pages, per_page, base_url, params)
end

.validation_errors(model) ⇒ Object 



63
64
65
 
# File 'lib/json_api_server.rb', line 63

def validation_errors(model)
  JsonApiServer::ValidationErrors.new(model)
end