Class: BrowserupMitmProxy::MatchCriteria

Inherits:
Object
  • Object
show all
Defined in:
lib/browserup_mitmproxy_client/models/match_criteria.rb

Overview

A set of criteria for filtering HTTP Requests and Responses. Criteria are AND based, and use python regular expressions for string comparison

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MatchCriteria

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 110

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `BrowserupMitmProxy::MatchCriteria` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `BrowserupMitmProxy::MatchCriteria`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'page')
    self.page = attributes[:'page']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.key?(:'content_type')
    self.content_type = attributes[:'content_type']
  end

  if attributes.key?(:'websocket_message')
    self.websocket_message = attributes[:'websocket_message']
  end

  if attributes.key?(:'request_header')
    self.request_header = attributes[:'request_header']
  end

  if attributes.key?(:'request_cookie')
    self.request_cookie = attributes[:'request_cookie']
  end

  if attributes.key?(:'response_header')
    self.response_header = attributes[:'response_header']
  end

  if attributes.key?(:'response_cookie')
    self.response_cookie = attributes[:'response_cookie']
  end

  if attributes.key?(:'json_valid')
    self.json_valid = attributes[:'json_valid']
  end

  if attributes.key?(:'json_path')
    self.json_path = attributes[:'json_path']
  end

  if attributes.key?(:'json_schema')
    self.json_schema = attributes[:'json_schema']
  end

  if attributes.key?(:'error_if_no_traffic')
    self.error_if_no_traffic = attributes[:'error_if_no_traffic']
  end
end

Instance Attribute Details

#content ⇒ Object

Body content regexp content to match



29
30
31
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 29

def content
  @content
end

#content_type ⇒ Object

Content type



32
33
34
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 32

def content_type
  @content_type
end

#error_if_no_traffic ⇒ Object

If the proxy has NO traffic at all, return error



55
56
57
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 55

def error_if_no_traffic
  @error_if_no_traffic
end

#json_path ⇒ Object

Has JSON path



49
50
51
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 49

def json_path
  @json_path
end

#json_schema ⇒ Object

Validates against passed JSON schema



52
53
54
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 52

def json_schema
  @json_schema
end

#json_valid ⇒ Object

Is valid JSON



46
47
48
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 46

def json_valid
  @json_valid
end

#page ⇒ Object

current|all



23
24
25
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 23

def page
  @page
end

#request_cookie ⇒ Object

Returns the value of attribute request_cookie.



39
40
41
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 39

def request_cookie
  @request_cookie
end

#request_header ⇒ Object

Returns the value of attribute request_header.



37
38
39
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 37

def request_header
  @request_header
end

#response_cookie ⇒ Object

Returns the value of attribute response_cookie.



43
44
45
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 43

def response_cookie
  @response_cookie
end

#response_header ⇒ Object

Returns the value of attribute response_header.



41
42
43
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 41

def response_header
  @response_header
end

#status ⇒ Object

HTTP Status code to match.



26
27
28
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 26

def status
  @status
end

#url ⇒ Object

Request URL regexp to match



20
21
22
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 20

def url
  @url
end

#websocket_message ⇒ Object

Websocket message text to match



35
36
37
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 35

def websocket_message
  @websocket_message
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 58

def self.attribute_map
  {
    :'url' => :'url',
    :'page' => :'page',
    :'status' => :'status',
    :'content' => :'content',
    :'content_type' => :'content_type',
    :'websocket_message' => :'websocket_message',
    :'request_header' => :'request_header',
    :'request_cookie' => :'request_cookie',
    :'response_header' => :'response_header',
    :'response_cookie' => :'response_cookie',
    :'json_valid' => :'json_valid',
    :'json_path' => :'json_path',
    :'json_schema' => :'json_schema',
    :'error_if_no_traffic' => :'error_if_no_traffic'
  }
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



229
230
231
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 103

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 83

def self.openapi_types
  {
    :'url' => :'String',
    :'page' => :'String',
    :'status' => :'String',
    :'content' => :'String',
    :'content_type' => :'String',
    :'websocket_message' => :'String',
    :'request_header' => :'NameValuePair',
    :'request_cookie' => :'NameValuePair',
    :'response_header' => :'NameValuePair',
    :'response_cookie' => :'NameValuePair',
    :'json_valid' => :'Boolean',
    :'json_path' => :'String',
    :'json_schema' => :'String',
    :'error_if_no_traffic' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      page == o.page &&
      status == o.status &&
      content == o.content &&
      content_type == o.content_type &&
      websocket_message == o.websocket_message &&
      request_header == o.request_header &&
      request_cookie == o.request_cookie &&
      response_header == o.response_header &&
      response_cookie == o.response_cookie &&
      json_valid == o.json_valid &&
      json_path == o.json_path &&
      json_schema == o.json_schema &&
      error_if_no_traffic == o.error_if_no_traffic
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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 259

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = BrowserupMitmProxy.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 330

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 236

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 222

def hash
  [url, page, status, content, content_type, websocket_message, request_header, request_cookie, response_header, response_cookie, json_valid, json_path, json_schema, error_if_no_traffic].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



182
183
184
185
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  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



306
307
308
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 312

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



300
301
302
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 300

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



189
190
191
 
# File 'lib/browserup_mitmproxy_client/models/match_criteria.rb', line 189

def valid?
  true
end