Class: CASClient::ValidationResponse

Inherits:
Object
  • Object
show all
Includes:
XmlResponse
Defined in:
lib/casclient/responses.rb

Overview

Represents a response from the CAS server to a ‘validate’ request (i.e. after validating a service/proxy ticket).

Instance Attribute Summary collapse

Attributes included from XmlResponse

#failure_code, #failure_message, #parse_datetime, #xml

Instance Method Summary collapse

Methods included from XmlResponse

#check_and_parse_xml, #to_s

Constructor Details

#initialize(raw_text, options = {}) ⇒ ValidationResponse

Returns a new instance of ValidationResponse.



34
35
36
 
# File 'lib/casclient/responses.rb', line 34

def initialize(raw_text, options={})
  parse(raw_text, options)
end

Instance Attribute Details

#extra_attributes ⇒ Object (readonly)

Returns the value of attribute extra_attributes.



32
33
34
 
# File 'lib/casclient/responses.rb', line 32

def extra_attributes
  @extra_attributes
end

#pgt_iou ⇒ Object (readonly)

Returns the value of attribute pgt_iou.



32
33
34
 
# File 'lib/casclient/responses.rb', line 32

def pgt_iou
  @pgt_iou
end

#protocol ⇒ Object (readonly)

Returns the value of attribute protocol.



32
33
34
 
# File 'lib/casclient/responses.rb', line 32

def protocol
  @protocol
end

#proxies ⇒ Object (readonly)

Returns the value of attribute proxies.



32
33
34
 
# File 'lib/casclient/responses.rb', line 32

def proxies
  @proxies
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



32
33
34
 
# File 'lib/casclient/responses.rb', line 32

def user
  @user
end

Instance Method Details

#is_failure? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/casclient/responses.rb', line 125

def is_failure?
  (instance_variable_defined?(:@valid) && !@valid) || (protocol > 1.0 && xml.name == "authenticationFailure" )
end

#is_success? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/casclient/responses.rb', line 121

def is_success?
  (instance_variable_defined?(:@valid) &&  @valid) || (protocol > 1.0 && xml.name == "authenticationSuccess")
end

#parse(raw_text, options) ⇒ Object

Raises:



38
39
40
41
42
43
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
 
# File 'lib/casclient/responses.rb', line 38

def parse(raw_text, options)
  raise BadResponseException, 
    "CAS response is empty/blank." if raw_text.blank?
  @parse_datetime = Time.now
  if raw_text =~ /^(yes|no)\n(.*?)\n$/m
    @protocol = 1.0
    @valid = $~[1] == 'yes'
    @user = $~[2]
    return
  end

  @xml = check_and_parse_xml(raw_text)

  # if we got this far then we've got a valid XML response, so we're doing CAS 2.0
  @protocol = 2.0

  if is_success?
    cas_user = @xml.elements["cas:user"]
    @user = cas_user.text.strip if cas_user
    @pgt_iou =  @xml.elements["cas:proxyGrantingTicket"].text.strip if @xml.elements["cas:proxyGrantingTicket"]

    proxy_els = @xml.elements.to_a('//cas:authenticationSuccess/cas:proxies/cas:proxy')
    if proxy_els.size > 0
      @proxies = []
      proxy_els.each do |el|
        @proxies << el.text
      end
    end

    @extra_attributes = {}
    @xml.elements.to_a('//cas:authenticationSuccess/cas:attributes/* | //cas:authenticationSuccess/*[local-name() != \'proxies\' and local-name() != \'proxyGrantingTicket\' and local-name() != \'user\' and local-name() != \'attributes\']').each do |el|
      inner_text = el.cdatas.length > 0 ? el.cdatas.join('') : el.text
      name = el.name
      unless (attrs = el.attributes).empty?
        name       = attrs['name']
        inner_text = attrs['value']
      end
      @extra_attributes.merge! name => inner_text
    end

    # unserialize extra attributes
    @extra_attributes.each do |k, v|
      @extra_attributes[k] = parse_extra_attribute_value(v, options[:encode_extra_attributes_as])
    end
  elsif is_failure?
    @failure_code = @xml.elements['//cas:authenticationFailure'].attributes['code']
    @failure_message = @xml.elements['//cas:authenticationFailure'].text.strip
  else
    # this should never happen, since the response should already have been recognized as invalid
    raise BadResponseException, "BAD CAS RESPONSE:\n#{raw_text.inspect}\n\nXML DOC:\n#{doc.inspect}"
  end
end

#parse_extra_attribute_value(value, encode_extra_attributes_as) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/casclient/responses.rb', line 91

def parse_extra_attribute_value(value, encode_extra_attributes_as)
  attr_value = if value.blank?
     nil
   elsif !encode_extra_attributes_as
     begin
       YAML.load(value)
     rescue ArgumentError => e
       raise ArgumentError, "Error parsing extra attribute with value #{value} as YAML: #{e}"
     end
   else
     if encode_extra_attributes_as == :json
       begin
         JSON.parse(value)
       rescue JSON::ParserError
         value
       end
     elsif encode_extra_attributes_as == :raw
       value
     else
       YAML.load(value)
     end
   end

  unless attr_value.kind_of?(Enumerable) || attr_value.kind_of?(TrueClass) || attr_value.kind_of?(FalseClass) || attr_value.nil?
    attr_value.to_s
  else
    attr_value
  end
end