Module: Sinja::Helpers::Serializers
- Defined in:
- lib/sinja/helpers/serializers.rb
Constant Summary collapse
- VALID_PAGINATION_KEYS =
Set.new(%i[self first prev next last]).freeze
Instance Method Summary collapse
- #dedasherize(s = nil) ⇒ Object
- #dedasherize_names(*args) ⇒ Object
- #deserialize_request_body ⇒ Object
- #error_hash(title: nil, detail: nil, source: nil) ⇒ Object
- #exception_title(e) ⇒ Object
- #include_exclude!(options) ⇒ Object
- #serialize_errors(&block) ⇒ Object
- #serialize_linkage(model, rel, options = {}) ⇒ Object
- #serialize_linkage?(updated = false, options = {}) ⇒ Boolean
- #serialize_linkages?(updated = false, options = {}) ⇒ Boolean
- #serialize_model(model = nil, options = {}) ⇒ Object
- #serialize_model?(model = nil, options = {}) ⇒ Boolean
- #serialize_models(models = [], options = {}, pagination = nil) ⇒ Object
- #serialize_models?(models = [], options = {}, pagination = nil) ⇒ Boolean
- #serialize_response_body ⇒ Object
Instance Method Details
#dedasherize(s = nil) ⇒ Object
13 14 15 |
# File 'lib/sinja/helpers/serializers.rb', line 13 def dedasherize(s=nil) s.to_s.underscore.send(Symbol === s ? :to_sym : :itself) end |
#dedasherize_names(*args) ⇒ Object
17 18 19 |
# File 'lib/sinja/helpers/serializers.rb', line 17 def dedasherize_names(*args) _dedasherize_names(*args).to_h end |
#deserialize_request_body ⇒ Object
29 30 31 32 33 34 35 36 |
# File 'lib/sinja/helpers/serializers.rb', line 29 def deserialize_request_body return {} unless content? request.body.rewind JSON.parse(request.body.read, :symbolize_names=>true) rescue JSON::ParserError raise BadRequestError, 'Malformed JSON in the request body' end |
#error_hash(title: nil, detail: nil, source: nil) ⇒ Object
190 191 192 193 194 195 196 197 198 199 |
# File 'lib/sinja/helpers/serializers.rb', line 190 def error_hash(title: nil, detail: nil, source: nil) [ { id: SecureRandom.uuid }.tap do |hash| hash[:title] = title if title hash[:detail] = detail if detail hash[:status] = status.to_s if status hash[:source] = source if source end ] end |
#exception_title(e) ⇒ Object
201 202 203 |
# File 'lib/sinja/helpers/serializers.rb', line 201 def exception_title(e) e.respond_to?(:title) ? e.title : e.class.name.demodulize.titleize end |
#include_exclude!(options) ⇒ Object
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 |
# File 'lib/sinja/helpers/serializers.rb', line 44 def include_exclude!() included, default, excluded = params[:include], .delete(:include) || [], .delete(:exclude) || [] if included.empty? included = Array === default ? default : default.split(',') return included if included.empty? end excluded = Array === excluded ? excluded : excluded.split(',') unless excluded.empty? excluded = Set.new(excluded) included.delete_if do |termstr| terms = termstr.split('.') terms.length.times.any? do |i| excluded.include?(terms.take(i.succ).join('.')) end end return included if included.empty? end return included unless settings._resource_config # Walk the tree and try to exclude based on fetch and pluck permissions included.keep_if do |termstr| catch :keep? do *terms, last_term = termstr.split('.') # Start cursor at root of current resource config = settings._resource_config terms.each do |term| # Move cursor through each term, avoiding the default proc, # halting if no roles found, i.e. client asked to include # something that Sinja doesn't know about throw :keep?, true \ unless config = settings._sinja.resource_config.fetch(term.pluralize.to_sym, nil) end roles = ( config.dig(:has_many, last_term.pluralize.to_sym, :fetch) || config.dig(:has_one, last_term.singularize.to_sym, :pluck) )[:roles] throw :keep?, roles && (roles.empty? || roles === memoized_role) end end end |
#serialize_errors(&block) ⇒ Object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/sinja/helpers/serializers.rb', line 205 def serialize_errors(&block) raise env['sinatra.error'] if env['sinatra.error'] && sideloaded? error_hashes = if [*body].any? if [*body].all? { |error| Hash === error } # `halt' with a hash or array of hashes [*body].flat_map { |error| error_hash(error) } elsif not_found? # `not_found' or `halt 404' = [*body].first.to_s error_hash \ :title=>'Not Found Error', :detail=>( unless == '<h1>Not Found</h1>') else # `halt' error_hash \ :title=>'Unknown Error', :detail=>[*body].first.to_s end end # Exception already contains formatted errors error_hashes ||= env['sinatra.error'].error_hashes \ if env['sinatra.error'].respond_to?(:error_hashes) error_hashes ||= case e = env['sinatra.error'] when UnprocessibleEntityError e.tuples.flat_map do |attribute, | error_hash \ :title=>exception_title(e), :detail=>.to_s, :source=>{ :pointer=>(attribute ? "/data/attributes/#{attribute.to_s.dasherize}" : '/data') } end when Exception error_hash \ :title=>exception_title(e), :detail=>(e..to_s unless e. == e.class.name) else error_hash \ :title=>'Unknown Error' end error_hashes.each { |h| instance_exec(h, &block) } if block content_type :api_json JSON.send settings._sinja.json_error_generator, ::JSONAPI::Serializer.serialize_errors(error_hashes) end |
#serialize_linkage(model, rel, options = {}) ⇒ Object
167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/sinja/helpers/serializers.rb', line 167 def serialize_linkage(model, rel, ={}) [:is_collection] = false [:skip_collection_check] = defined?(::Sequel) && ::Sequel::Model === model [:include] = rel.to_s = settings._sinja.serializer_opts.merge() # TODO: This is extremely wasteful. Refactor JAS to expose the linkage serializer? content = ::JSONAPI::Serializer.serialize(model, ) content['data']['relationships'][rel.to_s].tap do |linkage| %w[meta jsonapi].each do |key| linkage[key] = content[key] if content.key?(key) end end end |
#serialize_linkage?(updated = false, options = {}) ⇒ Boolean
182 183 184 |
# File 'lib/sinja/helpers/serializers.rb', line 182 def serialize_linkage?(updated=false, ={}) body updated ? serialize_linkage() : serialize_model?(nil, ) end |
#serialize_linkages?(updated = false, options = {}) ⇒ Boolean
186 187 188 |
# File 'lib/sinja/helpers/serializers.rb', line 186 def serialize_linkages?(updated=false, ={}) body updated ? serialize_linkage() : serialize_models?([], ) end |
#serialize_model(model = nil, options = {}) ⇒ Object
96 97 98 99 100 101 102 103 104 |
# File 'lib/sinja/helpers/serializers.rb', line 96 def serialize_model(model=nil, ={}) [:is_collection] = false [:skip_collection_check] = defined?(::Sequel) && ::Sequel::Model === model [:include] = include_exclude!() [:fields] ||= params[:fields] unless params[:fields].empty? = settings._sinja.serializer_opts.merge() ::JSONAPI::Serializer.serialize(model, ) end |
#serialize_model?(model = nil, options = {}) ⇒ Boolean
106 107 108 109 110 111 112 113 114 |
# File 'lib/sinja/helpers/serializers.rb', line 106 def serialize_model?(model=nil, ={}) if model body serialize_model(model, ) elsif .key?(:meta) body serialize_model(nil, :meta=>[:meta]) else status 204 end end |
#serialize_models(models = [], options = {}, pagination = nil) ⇒ Object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/sinja/helpers/serializers.rb', line 116 def serialize_models(models=[], ={}, pagination=nil) [:is_collection] = true [:include] = include_exclude!() [:fields] ||= params[:fields] unless params[:fields].empty? = settings._sinja.serializer_opts.merge() if pagination # Whitelist pagination keys and dasherize query parameter names pagination = VALID_PAGINATION_KEYS .select { |outer_key| pagination.key?(outer_key) } .map! do |outer_key| [outer_key, pagination[outer_key].map do |inner_key, value| [inner_key.to_s.dasherize.to_sym, value] end.to_h] end.to_h [:meta] ||= {} [:meta][:pagination] = pagination [:links] ||= {} [:links][:self] = request.url unless pagination.key?(:self) base_query = Rack::Utils.build_nested_query \ env['rack.request.query_hash'].dup.tap { |h| h.delete('page') } self_link, join_char = if base_query.empty? [request.path, ??] else ["#{request.path}?#{base_query}", ?&] end [:links].merge!(pagination.map do |key, value| [key, [self_link, Rack::Utils.build_nested_query(:page=>value)].join(join_char)] end.to_h) end ::JSONAPI::Serializer.serialize([*models], ) end |
#serialize_models?(models = [], options = {}, pagination = nil) ⇒ Boolean
157 158 159 160 161 162 163 164 165 |
# File 'lib/sinja/helpers/serializers.rb', line 157 def serialize_models?(models=[], ={}, pagination=nil) if [*models].any? body serialize_models(models, , pagination) elsif .key?(:meta) body serialize_models([], :meta=>[:meta]) else status 204 end end |
#serialize_response_body ⇒ Object
38 39 40 41 42 |
# File 'lib/sinja/helpers/serializers.rb', line 38 def serialize_response_body JSON.send settings._sinja.json_generator, response.body rescue JSON::GeneratorError raise BadRequestError, 'Unserializable entities in the response body' end |