Class: JSONAPI::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/jsonapi/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/jsonapi/configuration.rb', line 37

def initialize
  #:underscored_key, :camelized_key, :dasherized_key, or custom
  self.json_key_format = :dasherized_key

  #:underscored_route, :camelized_route, :dasherized_route, or custom
  self.route_format = :dasherized_route

  #:integer, :uuid, :string, or custom (provide a proc)
  self.resource_key_type = :integer

  # optional request features
  self.allow_include = true
  self.allow_sort = true
  self.allow_filter = true

  self.raise_if_parameters_not_allowed = true

  # :none, :offset, :paged, or a custom paginator name
  self.default_paginator = :none

  # Output pagination links at top level
  self.top_level_links_include_pagination = true

  self.default_page_size = 10
  self.maximum_page_size = 20

  # Metadata
  # Output record count in top level meta for find operation
  self.top_level_meta_include_record_count = false
  self.top_level_meta_record_count_key = :record_count

  self.top_level_meta_include_page_count = false
  self.top_level_meta_page_count_key = :page_count

  self.use_text_errors = false

  # Whether or not to include exception backtraces in JSONAPI error
  # responses.  Defaults to `false` in production, and `true` otherwise.
  self.include_backtraces_in_errors = !Rails.env.production?

  # List of classes that should not be rescued by the operations processor.
  # For example, if you use Pundit for authorization, you might
  # raise a Pundit::NotAuthorizedError at some point during operations
  # processing. If you want to use Rails' `rescue_from` macro to
  # catch this error and render a 403 status code, you should add
  # the `Pundit::NotAuthorizedError` to the `exception_class_whitelist`.
  self.exception_class_whitelist = []

  # If enabled, will override configuration option `exception_class_whitelist`
  # and whitelist all exceptions.
  self.whitelist_all_exceptions = false

  # Resource Linkage
  # Controls the serialization of resource linkage for non compound documents
  # NOTE: always_include_to_many_linkage_data is not currently implemented
  self.always_include_to_one_linkage_data = false
  self.always_include_to_many_linkage_data = false

  # The default Operation Processor to use if one is not defined specifically
  # for a Resource.
  self.default_processor_klass = JSONAPI::Processor

  # Allows transactions for creating and updating records
  # Set this to false if your backend does not support transactions (e.g. Mongodb)
  self.allow_transactions = true

  # Formatter Caching
  # Set to false to disable caching of string operations on keys and links.
  # Note that unlike the resource cache, formatter caching is always done
  # internally in-memory and per-thread; no ActiveSupport::Cache is used.
  self.cache_formatters = true

  # Relationship reflection invokes the related resource when updates
  # are made to a has_many relationship. By default relationship_reflection
  # is turned off because it imposes a small performance penalty.
  self.use_relationship_reflection = false

  # Resource cache
  # An ActiveSupport::Cache::Store or similar, used by Resources with caching enabled.
  # Set to `nil` (the default) to disable caching, or to `Rails.cache` to use the
  # Rails cache store.
  self.resource_cache = nil

  # Default resource cache field
  # On Resources with caching enabled, this field will be used to check for out-of-date
  # cache entries, unless overridden on a specific Resource. Defaults to "updated_at".
  self.default_resource_cache_field = :updated_at

  # Resource cache digest function
  # Provide a callable that returns a unique value for string inputs with
  # low chance of collision. The default is SHA256 base64.
  self.resource_cache_digest_function = Digest::SHA2.new.method(:base64digest)

  # Resource cache usage reporting
  # Optionally provide a callable which JSONAPI will call with information about cache
  # performance. Should accept three arguments: resource name, hits count, misses count.
  self.resource_cache_usage_report_function = nil
end

Instance Attribute Details

#allow_filter ⇒ Object

Returns the value of attribute allow_filter.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def allow_filter
  @allow_filter
end

#allow_include ⇒ Object

Returns the value of attribute allow_include.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def allow_include
  @allow_include
end

#allow_sort ⇒ Object

Returns the value of attribute allow_sort.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def allow_sort
  @allow_sort
end

#allow_transactions ⇒ Object

Returns the value of attribute allow_transactions.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def allow_transactions
  @allow_transactions
end

#always_include_to_many_linkage_data ⇒ Object

Returns the value of attribute always_include_to_many_linkage_data.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def always_include_to_many_linkage_data
  @always_include_to_many_linkage_data
end

#always_include_to_one_linkage_data ⇒ Object

Returns the value of attribute always_include_to_one_linkage_data.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def always_include_to_one_linkage_data
  @always_include_to_one_linkage_data
end

#cache_formatters ⇒ Object

Returns the value of attribute cache_formatters.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def cache_formatters
  @cache_formatters
end

#default_page_size ⇒ Object

Returns the value of attribute default_page_size.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def default_page_size
  @default_page_size
end

#default_paginator ⇒ Object

Returns the value of attribute default_paginator.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def default_paginator
  @default_paginator
end

#default_processor_klass ⇒ Object

Returns the value of attribute default_processor_klass.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def default_processor_klass
  @default_processor_klass
end

#default_resource_cache_field ⇒ Object

Returns the value of attribute default_resource_cache_field.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def default_resource_cache_field
  @default_resource_cache_field
end

#exception_class_whitelist ⇒ Object

Returns the value of attribute exception_class_whitelist.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def exception_class_whitelist
  @exception_class_whitelist
end

#include_backtraces_in_errors ⇒ Object

Returns the value of attribute include_backtraces_in_errors.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def include_backtraces_in_errors
  @include_backtraces_in_errors
end

#json_key_format ⇒ Object

Returns the value of attribute json_key_format.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def json_key_format
  @json_key_format
end

#maximum_page_size ⇒ Object

Returns the value of attribute maximum_page_size.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def maximum_page_size
  @maximum_page_size
end

#raise_if_parameters_not_allowed ⇒ Object

Returns the value of attribute raise_if_parameters_not_allowed.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def raise_if_parameters_not_allowed
  @raise_if_parameters_not_allowed
end

#resource_cache ⇒ Object

Returns the value of attribute resource_cache.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def resource_cache
  @resource_cache
end

#resource_cache_digest_function ⇒ Object

Returns the value of attribute resource_cache_digest_function.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def resource_cache_digest_function
  @resource_cache_digest_function
end

#resource_cache_usage_report_function ⇒ Object

Returns the value of attribute resource_cache_usage_report_function.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def resource_cache_usage_report_function
  @resource_cache_usage_report_function
end

#resource_key_type ⇒ Object

Returns the value of attribute resource_key_type.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def resource_key_type
  @resource_key_type
end

#route_format ⇒ Object

Returns the value of attribute route_format.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def route_format
  @route_format
end

#top_level_links_include_pagination ⇒ Object

Returns the value of attribute top_level_links_include_pagination.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def top_level_links_include_pagination
  @top_level_links_include_pagination
end

#top_level_meta_include_page_count ⇒ Object

Returns the value of attribute top_level_meta_include_page_count.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def top_level_meta_include_page_count
  @top_level_meta_include_page_count
end

#top_level_meta_include_record_count ⇒ Object

Returns the value of attribute top_level_meta_include_record_count.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def top_level_meta_include_record_count
  @top_level_meta_include_record_count
end

#top_level_meta_page_count_key ⇒ Object

Returns the value of attribute top_level_meta_page_count_key.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def top_level_meta_page_count_key
  @top_level_meta_page_count_key
end

#top_level_meta_record_count_key ⇒ Object

Returns the value of attribute top_level_meta_record_count_key.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def top_level_meta_record_count_key
  @top_level_meta_record_count_key
end

#use_relationship_reflection ⇒ Object

Returns the value of attribute use_relationship_reflection.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def use_relationship_reflection
  @use_relationship_reflection
end

#use_text_errors ⇒ Object

Returns the value of attribute use_text_errors.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def use_text_errors
  @use_text_errors
end

#whitelist_all_exceptions ⇒ Object

Returns the value of attribute whitelist_all_exceptions.



7
8
9
 
# File 'lib/jsonapi/configuration.rb', line 7

def whitelist_all_exceptions
  @whitelist_all_exceptions
end

Instance Method Details

#exception_class_whitelisted?(e) ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
198
 
# File 'lib/jsonapi/configuration.rb', line 195

def exception_class_whitelisted?(e)
  @whitelist_all_exceptions ||
    @exception_class_whitelist.flatten.any? { |k| e.class.ancestors.map(&:to_s).include?(k.to_s) }
end

#key_formatter ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/jsonapi/configuration.rb', line 161

def key_formatter
  if self.cache_formatters
    formatter = @key_formatter_tlv.value
    return formatter if formatter
  end

  formatter = JSONAPI::Formatter.formatter_for(self.json_key_format)

  if self.cache_formatters
    formatter = @key_formatter_tlv.value = formatter.cached
  end

  return formatter
end

#route_formatter ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/jsonapi/configuration.rb', line 180

def route_formatter
  if self.cache_formatters
    formatter = @route_formatter_tlv.value
    return formatter if formatter
  end

  formatter = JSONAPI::Formatter.formatter_for(self.route_format)

  if self.cache_formatters
    formatter = @route_formatter_tlv.value = formatter.cached
  end

  return formatter
end