Class: GovukAbTesting::RequestedVariant

Inherits:
Object
  • Object
show all
Defined in:
lib/govuk_ab_testing/requested_variant.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ab_test, request_headers, dimension) ⇒ RequestedVariant

‘request.headers` in the controller. for this specific A/B test

Parameters:

  • ab_test (AbTest) —

    the A/B test being performed

  • request_headers (ActionDispatch::Http::Headers) —

    the

  • dimension (Integer) —

    the dimension registered with Google Analytics



10
11
12
13
14
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 10

def initialize(ab_test, request_headers, dimension)
  @ab_test = ab_test
  @request_headers = request_headers
  @dimension = dimension
end

Instance Attribute Details

#ab_test ⇒ Object (readonly)

Returns the value of attribute ab_test.



3
4
5
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 3

def ab_test
  @ab_test
end

#request_headers ⇒ Object (readonly)

Returns the value of attribute request_headers.



3
4
5
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 3

def request_headers
  @request_headers
end

Instance Method Details

#analytics_meta_tag ⇒ String

HTML meta tag used to track the results of your experiment

Returns:

  • (String) 


43
44
45
46
47
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 43

def analytics_meta_tag
  '<meta name="govuk:ab-test" ' +
    'content="' + ab_test.meta_tag_name + ':' + variant_name + '" ' +
    'data-analytics-dimension="' + @dimension.to_s + '">'
end

#configure_response(response) ⇒ Object

Configure the response

Parameters:

  • the (ApplicationController::Response) —

    ‘response` in the controller



36
37
38
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 36

def configure_response(response)
  response.headers['Vary'] = [response.headers['Vary'], ab_test.response_header].compact.join(', ')
end

#variant_a? ⇒ Boolean

Returns if the user is to be served variant A.

Returns:

  • (Boolean) —

    if the user is to be served variant A



24
25
26
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 24

def variant_a?
  variant_name == "A"
end

#variant_b? ⇒ Boolean

Returns if the user is to be served variant B.

Returns:

  • (Boolean) —

    if the user is to be served variant B



29
30
31
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 29

def variant_b?
  variant_name == "B"
end

#variant_name ⇒ String

Get the bucket this user is in

Returns:

  • (String) —

    the current variant, “A” or “B”



19
20
21
 
# File 'lib/govuk_ab_testing/requested_variant.rb', line 19

def variant_name
  request_headers[ab_test.request_header] == "B" ? "B" : "A"
end