Module: Ballast::Concerns::AjaxHandling

Extended by:
ActiveSupport::Concern
Defined in:
lib/ballast/concerns/ajax_handling.rb

Overview

A concern to handle AJAX and HTTP requests.

Instance Method Summary (collapse)

Instance Method Details

- (Boolean) ajax_request?

Checks if the current request is AJAX.

Returns:

  • (Boolean) —

    true if the request is AJAX, false otherwise.



16
17
18
 
# File 'lib/ballast/concerns/ajax_handling.rb', line 16

def ajax_request?
  request.safe_send(:xhr?).to_boolean || params[:xhr].to_boolean
end

- (Object) allow_cors(allow_origin: "*", allow_methods: [:post, :get, :options], allow_headers: "*", max_age: 1.year, allow_credentials: false)

Allows HTTP Cross-Origin Resource Sharing.

Parameters:

  • allow_origin (String) —

    The value for the Access-Control-Allow-Origin header.

  • allow_methods (Array) —

    A list of methods for the Access-Control-Allow-Methods header.

  • allow_headers (String) —

    The value for the Access-Control-Allow-Headers header.

  • max_age (Float|Fixnum) —

    The value for the Access-Control-Max-Age header.

  • allow_credentials (Boolean) —

    The value for the Access-Control-Allow-Credentials header.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/ballast/concerns/ajax_handling.rb', line 45

def allow_cors(allow_origin: "*", allow_methods: [:post, :get, :options], allow_headers: "*", max_age: 1.year, allow_credentials: false)
  headers.merge!({
    "Access-Control-Allow-Origin" => allow_origin,
    "Access-Control-Allow-Methods" => allow_methods.map { |m| m.to_s.upcase }.join(", "),
    "Access-Control-Allow-Headers" => allow_headers,
    "Access-Control-Max-Age" => max_age.to_i.to_s
  })

  headers["Access-Control-Allow-Credentials"] = "true" if allow_credentials
end

- (Object) generate_robots_txt(configuration = nil) Also known as: disallow_robots

Generates a `robots.txt file.

Parameters:

  • configuration (Hash|NilClass) (defaults to: nil) —

    An hash of agent and list of paths to include.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ballast/concerns/ajax_handling.rb', line 59

def generate_robots_txt(configuration = nil)
  configuration ||= {"*" => "/"}
  rv = configuration.reduce([]) { |accu, (agent, paths)|
    paths = paths.ensure_array.map { |e| "Disallow: #{e}" }

    accu << "User-agent: #{agent}\n#{paths.join("\n")}"
    accu
  }.join("\n\n")

  render(text: rv, content_type: "text/plain")
end

- (Object) prepare_ajax_response(status: :ok, data: {}, error: nil)

Prepares an AJAX response.

Parameters:

  • status (Symbol|Fixnum) —

    The HTTP status of the response.

  • data (Object) —

    The data of the response.

  • error (Object|NilClass) —

    The error of the response.



25
26
27
 
# File 'lib/ballast/concerns/ajax_handling.rb', line 25

def prepare_ajax_response(status: :ok, data: {}, error: nil)
  Ballast::AjaxResponse.new(status: status, data: data, error: error, transport: self)
end

- (Object) prevent_caching

Prevents HTTP caching.



30
31
32
33
34
35
36
 
# File 'lib/ballast/concerns/ajax_handling.rb', line 30

def prevent_caching
  response.headers.merge!({
    "Cache-Control" => "no-cache, no-store, max-age=0, must-revalidate",
    "Pragma" => "no-cache",
    "Expires" => "Fri, 01 Jan 1990 00:00:00 GMT"
  })
end