Class: Tina4::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/tina4/response.rb

Constant Summary collapse

MIME_TYPES = 
{
  ".html" => "text/html", ".htm" => "text/html",
  ".css" => "text/css", ".js" => "application/javascript",
  ".json" => "application/json", ".xml" => "application/xml",
  ".txt" => "text/plain", ".csv" => "text/csv",
  ".png" => "image/png", ".jpg" => "image/jpeg",
  ".jpeg" => "image/jpeg", ".gif" => "image/gif",
  ".svg" => "image/svg+xml", ".ico" => "image/x-icon",
  ".webp" => "image/webp", ".pdf" => "application/pdf",
  ".zip" => "application/zip", ".woff" => "font/woff",
  ".woff2" => "font/woff2", ".ttf" => "font/ttf",
  ".eot" => "application/vnd.ms-fontobject",
  ".mp3" => "audio/mpeg", ".mp4" => "video/mp4",
  ".webm" => "video/webm"
}.freeze
JSON_CONTENT_TYPE =

Pre-frozen header values

"application/json; charset=utf-8"
HTML_CONTENT_TYPE = 
"text/html; charset=utf-8"
TEXT_CONTENT_TYPE = 
"text/plain; charset=utf-8"
XML_CONTENT_TYPE = 
"application/xml; charset=utf-8"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Response

Returns a new instance of Response.



62
63
64
65
66
67
 
# File 'lib/tina4/response.rb', line 62

def initialize
  @status_code = 200
  @headers = { "content-type" => HTML_CONTENT_TYPE }
  @body = ""
  @cookies = nil  # Lazy -- most responses have no cookies
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



60
61
62
 
# File 'lib/tina4/response.rb', line 60

def body
  @body
end

#cookies ⇒ Object

Returns the value of attribute cookies.



60
61
62
 
# File 'lib/tina4/response.rb', line 60

def cookies
  @cookies
end

#headers ⇒ Object

Returns the value of attribute headers.



60
61
62
 
# File 'lib/tina4/response.rb', line 60

def headers
  @headers
end

#status_code ⇒ Object

Returns the value of attribute status_code.



60
61
62
 
# File 'lib/tina4/response.rb', line 60

def status_code
  @status_code
end

Class Method Details

.auto_detect(result, response) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/tina4/response.rb', line 324

def self.auto_detect(result, response)
  case result
  when Tina4::Response
    result
  when Hash, Array
    response.json(result)
  when String
    if result.start_with?("<")
      response.html(result)
    else
      response.text(result)
    end
  when Integer
    response.status_code = result
    response.body = ""
    response
  when NilClass
    response.status_code = 204
    response.body = ""
    response
  else
    response.json(result.respond_to?(:to_hash) ? result.to_hash : { data: result.to_s })
  end
end

.error_response(code, message, status = 400) ⇒ Object

Build a standard error envelope hash (class method).

Usage:

response.json(Tina4::Response.error_response("NOT_FOUND", "Resource not found", 404), status: 404)



217
218
219
 
# File 'lib/tina4/response.rb', line 217

def self.error_response(code, message, status = 400)
  { error: true, code: code, message: message, status: status }
end

Instance Method Details

#add_cors_headers(origin: "*", methods: "GET, POST, PUT, PATCH, DELETE, OPTIONS", headers_list: "Content-Type, Authorization, Accept", credentials: false) ⇒ Object 



258
259
260
261
262
263
264
265
266
 
# File 'lib/tina4/response.rb', line 258

def add_cors_headers(origin: "*", methods: "GET, POST, PUT, PATCH, DELETE, OPTIONS",
                     headers_list: "Content-Type, Authorization, Accept", credentials: false)
  @headers["access-control-allow-origin"] = origin
  @headers["access-control-allow-methods"] = methods
  @headers["access-control-allow-headers"] = headers_list
  @headers["access-control-allow-credentials"] = "true" if credentials
  @headers["access-control-max-age"] = "86400"
  self
end

#add_header(key, value) ⇒ Object 



253
254
255
256
 
# File 'lib/tina4/response.rb', line 253

def add_header(key, value)
  @headers[key] = value
  self
end

#call(data = nil, status_code = 200, content_type = nil) ⇒ Object

Callable response — auto-detects content type from data. Matches Python __call__ / PHP __invoke / Node response() pattern.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/tina4/response.rb', line 81

def call(data = nil, status_code = 200, content_type = nil)
  @status_code = status_code
  if content_type
    @headers["content-type"] = content_type
    @body = data.to_s
  elsif data.is_a?(Hash) || data.is_a?(Array)
    @headers["content-type"] = JSON_CONTENT_TYPE
    @body = JSON.generate(data)
  else
    @headers["content-type"] = HTML_CONTENT_TYPE
    @body = data.to_s
  end
  self
end

#cookie(name, value, opts = {}) ⇒ Object

Chainable cookie setter



232
233
234
 
# File 'lib/tina4/response.rb', line 232

def cookie(name, value, opts = {})
  set_cookie(name, value, opts)
end

#csv(content, filename: "export.csv", status: 200) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/tina4/response.rb', line 124

def csv(content, filename: "export.csv", status: 200)
  @status_code = status
  @headers["content-type"] = "text/csv"
  @headers["content-disposition"] = "attachment; filename=\"#{filename}\""
  @body = content.to_s
  self
end

#delete_cookie(name, path: "/") ⇒ Object 



249
250
251
 
# File 'lib/tina4/response.rb', line 249

def delete_cookie(name, path: "/")
  set_cookie(name, "", max_age: 0, path: path)
end

#error(code, message, status_code = 400) ⇒ Object

Standard error response envelope.

Usage:

response.error("VALIDATION_FAILED", "Email is required", 400)



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/tina4/response.rb', line 200

def error(code, message, status_code = 400)
  @status_code = status_code
  @headers["content-type"] = JSON_CONTENT_TYPE
  @body = JSON.generate({
    error: true,
    code: code,
    message: message,
    status: status_code
  })
  self
end

#file(path, content_type: nil, download: false) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/tina4/response.rb', line 139

def file(path, content_type: nil, download: false)
  unless ::File.exist?(path)
    @status_code = 404
    @body = "File not found"
    return self
  end
  ext = ::File.extname(path).downcase
  @headers["content-type"] = content_type || MIME_TYPES[ext] || "application/octet-stream"
  if download
    @headers["content-disposition"] = "attachment; filename=\"#{::File.basename(path)}\""
  end
  @body = ::File.binread(path)
  self
end

#header(name, value = nil) ⇒ Object

Chainable header setter



222
223
224
225
226
227
228
229
 
# File 'lib/tina4/response.rb', line 222

def header(name, value = nil)
  if value.nil?
    @headers[name]
  else
    @headers[name] = value
    self
  end
end

#html(content, status_or_opts = nil, status: nil) ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/tina4/response.rb', line 103

def html(content, status_or_opts = nil, status: nil)
  @status_code = status || (status_or_opts.is_a?(Integer) ? status_or_opts : 200)
  @headers["content-type"] = HTML_CONTENT_TYPE
  @body = content.to_s
  self
end

#json(data, status_or_opts = nil, status: nil) ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/tina4/response.rb', line 96

def json(data, status_or_opts = nil, status: nil)
  @status_code = status || (status_or_opts.is_a?(Integer) ? status_or_opts : 200)
  @headers["content-type"] = JSON_CONTENT_TYPE
  @body = data.is_a?(String) ? data : JSON.generate(data)
  self
end

#redirect(url, status_or_opts = nil, status: nil) ⇒ Object 



132
133
134
135
136
137
 
# File 'lib/tina4/response.rb', line 132

def redirect(url, status_or_opts = nil, status: nil)
  @status_code = status || (status_or_opts.is_a?(Integer) ? status_or_opts : 302)
  @headers["location"] = url
  @body = ""
  self
end

#render(template_path, data = {}, status: 200, template_dir: nil) ⇒ Object

Render a Frond/Twig template file with data and return self. Tries the user template directory first, falling back to the framework’s built-in templates. Sets the response body to the rendered HTML.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/tina4/response.rb', line 157

def render(template_path, data = {}, status: 200, template_dir: nil)
  @status_code = status
  @headers["content-type"] = HTML_CONTENT_TYPE

  engine = template_dir ? Tina4::Frond.new(template_dir: template_dir) : Tina4.get_frond

  # Try user templates first
  begin
    @body = engine.render(template_path, data)
    return self
  rescue Errno::ENOENT
    # Not found in user templates — try framework templates
  rescue => e
    @body = "<pre>Template error: #{e.message}</pre>"
    @status_code = 500
    return self
  end

  # Fallback: framework templates
  fw_engine = Tina4.get_framework_frond
  if fw_engine
    begin
      @body = fw_engine.render(template_path, data)
      return self
    rescue Errno::ENOENT
      # Not found in framework templates either
    rescue => e
      @body = "<pre>Template error: #{e.message}</pre>"
      @status_code = 500
      return self
    end
  end

  @body = "<pre>Template not found: #{template_path}</pre>"
  @status_code = 404
  self
end

#send(data = nil, status_code: nil, content_type: nil) ⇒ Object

Finalize and return the response — matches Python/Node API.



295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/tina4/response.rb', line 295

def send(data = nil, status_code: nil, content_type: nil)
  if data
    if data.is_a?(Hash) || data.is_a?(Array)
      return json(data, status_code || 200)
    end
    @headers["content-type"] = content_type if content_type
    @body = data.to_s
    @status_code = status_code if status_code
    return self
  end
  to_rack
end

#set_cookie(name, value, opts = {}) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/tina4/response.rb', line 236

def set_cookie(name, value, opts = {})
  cookie_str = "#{name}=#{URI.encode_www_form_component(value)}"
  cookie_str += "; Path=#{opts[:path] || '/'}"
  cookie_str += "; HttpOnly" if opts.fetch(:http_only, true)
  cookie_str += "; Secure" if opts[:secure]
  cookie_str += "; SameSite=#{opts[:same_site] || 'Lax'}"
  cookie_str += "; Max-Age=#{opts[:max_age]}" if opts[:max_age]
  cookie_str += "; Expires=#{opts[:expires].httpdate}" if opts[:expires]
  @cookies ||= []
  @cookies << cookie_str
  self
end

#status(code = nil) ⇒ Object

Chainable status setter



70
71
72
73
74
75
76
77
 
# File 'lib/tina4/response.rb', line 70

def status(code = nil)
  if code.nil?
    @status_code
  else
    @status_code = code
    self
  end
end

#stream(content_type: "text/event-stream") {|Enumerator::Yielder| ... } ⇒ self

Stream response from a block for Server-Sent Events (SSE).

Usage:

Tina4::Router.get "/events" do |request, response|
  response.stream do |out|
    10.times do |i|
      out << "data: message #{i}\n\n"
      sleep 1
    end
  end
end

Parameters:

  • content_type (String) (defaults to: "text/event-stream") —

    Content type (default: text/event-stream)

Yields:

  • (Enumerator::Yielder) —

    Block receives a yielder to push chunks

Returns:

  • (self) 


283
284
285
286
287
288
289
290
291
292
 
# File 'lib/tina4/response.rb', line 283

def stream(content_type: "text/event-stream", &block)
  @status_code = @status_code || 200
  @headers["content-type"] = content_type
  @headers["cache-control"] = "no-cache"
  @headers["connection"] = "keep-alive"
  @headers["x-accel-buffering"] = "no"
  @_streaming = true
  @_stream_block = block
  self
end

#text(content, status_or_opts = nil, status: nil) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/tina4/response.rb', line 110

def text(content, status_or_opts = nil, status: nil)
  @status_code = status || (status_or_opts.is_a?(Integer) ? status_or_opts : 200)
  @headers["content-type"] = TEXT_CONTENT_TYPE
  @body = content.to_s
  self
end

#to_rack ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/tina4/response.rb', line 308

def to_rack
  final_headers = @headers.dup
  final_headers["set-cookie"] = @cookies.join("\n") if @cookies && !@cookies.empty?

  if @_streaming
    # Streaming mode — return an Enumerator as the body
    body = Enumerator.new do |yielder|
      @_stream_block.call(yielder)
    end
    return [@status_code, final_headers, body]
  end

  # Normal buffered response
  [@status_code, final_headers, [@body.to_s]]
end

#xml(content, status: 200) ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/tina4/response.rb', line 117

def xml(content, status: 200)
  @status_code = status
  @headers["content-type"] = XML_CONTENT_TYPE
  @body = content.to_s
  self
end