Class: RusticiSoftwareCloudV2::PostBackSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/models/post_back_schema.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostBackSchema

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
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
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 82

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'authType')
    self.auth_type = attributes[:'authType']
  else
    self.auth_type = "UNDEFINED"
  end

  if attributes.has_key?(:'userName')
    self.user_name = attributes[:'userName']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'resultsFormat')
    self.results_format = attributes[:'resultsFormat']
  else
    self.results_format = "UNDEFINED"
  end

  if attributes.has_key?(:'legacy')
    self.legacy = attributes[:'legacy']
  end

end

Instance Attribute Details

#auth_type ⇒ Object

Optional parameter to specify how to authorize against the given postbackurl, can be ‘form’ or ‘httpbasic’. If form authentication, the username and password for authentication are submitted as form fields ‘username’ and ‘password’, and the registration data as the form field ‘data’. If httpbasic authentication is used, the username and password are placed in the standard Authorization HTTP header, and the registration data is the body of the message (sent as text/xml content type). This field is set to ‘form’ by default.



20
21
22
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 20

def auth_type
  @auth_type
end

#legacy ⇒ Object

This paramenter is ONLY used for backwards compatibility with XML postback implementations. You probably shouldn’t need to use this unless you’re currently transitioning from the V1 api to the V2 api and already have existing XML postback logic in your application, but have not yet built out JSON postback logic. If a registration is created with the V2 api we will assume that you’re expecting JSON results unless otherwise specified.



32
33
34
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 32

def legacy
  @legacy
end

#password ⇒ Object

The password to be used in authorizing the postback of data to the URL specified by postback url.



26
27
28
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 26

def password
  @password
end

#results_format ⇒ Object

This parameter allows you to specify a level of detail in the information that is posted back while the course is being taken. It may be one of three values: ‘course’ (course summary), ‘activity’ (activity summary, or ‘full’ (full detail), and is set to ‘course’ by default. The information will be posted as xml, and the format of that xml is specified below under the method ‘getRegistrationResult’



29
30
31
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 29

def results_format
  @results_format
end

#url ⇒ Object

Returns the value of attribute url.



17
18
19
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 17

def url
  @url
end

#user_name ⇒ Object

The user name to be used in authorizing the postback of data to the URL specified by postback url.



23
24
25
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 23

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 57

def self.attribute_map
  {
    :'url' => :'url',
    :'auth_type' => :'authType',
    :'user_name' => :'userName',
    :'password' => :'password',
    :'results_format' => :'resultsFormat',
    :'legacy' => :'legacy'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 69

def self.swagger_types
  {
    :'url' => :'String',
    :'auth_type' => :'String',
    :'user_name' => :'String',
    :'password' => :'String',
    :'results_format' => :'String',
    :'legacy' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      auth_type == o.auth_type &&
      user_name == o.user_name &&
      password == o.password &&
      results_format == o.results_format &&
      legacy == o.legacy
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 204

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = RusticiSoftwareCloudV2.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 270

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 183

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


170
171
172
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 176

def hash
  [url, auth_type, user_name, password, results_format, legacy].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



120
121
122
123
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 250

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 256

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



244
245
246
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 244

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
132
133
 
# File 'lib/rustici_software_cloud_v2/models/post_back_schema.rb', line 127

def valid?
  auth_type_validator = EnumAttributeValidator.new('String', ["UNDEFINED", "FORM", "HTTPBASIC"])
  return false unless auth_type_validator.valid?(@auth_type)
  results_format_validator = EnumAttributeValidator.new('String', ["UNDEFINED", "COURSE", "ACTIVITY", "FULL"])
  return false unless results_format_validator.valid?(@results_format)
  return true
end