Module: Parliament::Utils::Helpers::ApplicationHelper

Defined in:
lib/parliament/utils/helpers/application_helper.rb

Constant Summary collapse

API_MIME_TYPE_CONFIG =

What MIME types does the API accept?

Note: All of the below are used to generate MIME types that our application will answer to, but NOT the alternatives shown in our header. See ALTERNATIVE_MIME_TYPE_CONFIG.

[
  {
    nt: 'application/n-triples'
  },
  {
    ttl: 'text/turtle'
  },
  {
    tsv: 'text/tab-separated-values'
  },
  {
    csv: 'text/csv'
  },
  {
    rj: 'application/json+rdf'
  },
  {
    jsonld: 'application/json+ld',
    json:   'application/json'
  },
  {
    rdfxml: 'application/rdf+xml',
    rdf:    'application/xml',
    xml:    'text/xml'
  }
].freeze
ALTERNATIVE_MIME_TYPE_CONFIG =

Use the above, minus the last two entries (json & xml), to build an alternative URL list. Then re-create JSON and XML with the correct alternatives

API_MIME_TYPE_CONFIG.take(API_MIME_TYPE_CONFIG.size - 2).concat(
  [
    {
      json: 'application/json+ld'
    },
    {
      xml: 'application/rdf+xml'
    }
  ]
)
API_MIME_TYPES = 
Parliament::Utils::Helpers::ApplicationHelper::API_MIME_TYPE_CONFIG.map(&:values).flatten.freeze
API_FILE_EXTENSIONS = 
Parliament::Utils::Helpers::ApplicationHelper::API_MIME_TYPE_CONFIG.map(&:keys).flatten.freeze
ALTERNATIVE_MIME_TYPES_FLATTENED = 
Parliament::Utils::Helpers::ApplicationHelper::ALTERNATIVE_MIME_TYPE_CONFIG.reduce(:merge)

Instance Method Summary collapse

Instance Method Details

#build_request ⇒ Object

Populates @request with a data url which can be used within controllers.



98
99
100
101
102
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 98

def build_request
  @request = data_url.call(params)

  populate_alternates(@request.query_url)
end

#data_check ⇒ Object

Before every request that provides data, see if the user is requesting a format that can be served by the data API. If they are, transparently redirect them with a ‘302: Found’ status code

Raises:

  • (StandardError) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 64

def data_check
  # Check format to see if it is available from the data API
  # We DO NOT offer data formats for constituency maps
  return if !API_MIME_TYPES.include?(request.formats.first) || (params[:controller] == 'constituencies' && params[:action] == 'map')

  # Find the current controller/action's API url
  @data_url = data_url

  # Catch potential nil values
  raise StandardError, 'Data URL does not exist' if @data_url.nil?

  # Get the requested type
  response.headers['Accept'] = request.formats.first.to_s

  # Set redirect_url as URI object
  redirect_url = URI(@data_url.call(params).query_url)

  # Get the request url as a URI object
  request_extension = File.extname(URI.parse(request.url).path)
  redirect_url.path = redirect_url.path + request_extension if request_extension != ''

  redirect_to(redirect_url.to_s)
end

#data_url ⇒ Proc

Get the data URL for our current controller and action OR raise a StandardError

Returns:

  • (Proc) —

    a Proc which can be called to generate a data URL



93
94
95
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 93

def data_url
  self.class::ROUTE_MAP[params[:action].to_sym] || raise(StandardError, "You must provide a ROUTE_MAP proc for #{params[:controller]}##{params[:action]}")
end

#populate_alternates(url) ⇒ Object

Populates Pugin.alternates with a list of data formats and corresponding urls

Parameters:

  • url (String) —

    the url where alternatives can be found



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 107

def populate_alternates(url)
  alternates = []

  ALTERNATIVE_MIME_TYPES_FLATTENED.each do |extension, format| # (key, value)
    uri = URI.parse(url)
    uri.path = "#{uri.path}.#{extension}"

    alternates << { type: format, href: uri.to_s }
  end

  Pugin.alternates = alternates
end

#populate_request_id ⇒ Object

Populates @app_insights_request_id if present



121
122
123
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 121

def populate_request_id
  @app_insights_request_id = request.env['ApplicationInsights.request.id']
end

#title(page_title) ⇒ String

Sets the title for a page.

Parameters:

  • page_title (String) —

    the title of the page.

Returns:

  • (String) —

    the title of the page.



57
58
59
60
 
# File 'lib/parliament/utils/helpers/application_helper.rb', line 57

def title(page_title)
  content_for(:title) { page_title }
  page_title
end