Class: PluralKitAPI::ProxyTag

Inherits:
Object
  • Object
show all
Defined in:
lib/pluralkit-api/models/proxy_tag.rb

Overview

Represents a proxy tag to match messages on. A "proxy tag" consists of a prefix and a suffix, and a given proxy tag set matches a string if that string begins with the prefix and ends with the suffix. It’s often represented to the user with the word ‘text` between them, eg. `[text]`, `{{text`, and so on. For example, the proxy tag pair "[" and "]" will match any string \[in square brackets\]. Either the prefix or the suffix may be missing (or both may be present), but it is invalid for both values to be null.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProxyTag

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 56

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PluralKitAPI::ProxyTag` 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 `PluralKitAPI::ProxyTag`. 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?(:'prefix')
    self.prefix = attributes[:'prefix']
  end

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

Instance Attribute Details

#prefix ⇒ Object

The proxy tag prefix. This is the string that goes before the inner text. An empty prefix is represented as ‘null` and an empty string will be converted as such.



20
21
22
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 20

def prefix
  @prefix
end

#suffix ⇒ Object

The proxy tag suffix. This is the string that goes after the inner text. An empty suffix is represented as ‘null` and an empty string will be converted as such.



23
24
25
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 23

def suffix
  @suffix
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



34
35
36
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 34

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 26

def self.attribute_map
  {
    :'prefix' => :'prefix',
    :'suffix' => :'suffix'
  }
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



145
146
147
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 145

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
50
51
52
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 47

def self.openapi_nullable
  Set.new([
    :'prefix',
    :'suffix'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 39

def self.openapi_types
  {
    :'prefix' => :'String',
    :'suffix' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 123

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      prefix == o.prefix &&
      suffix == o.suffix
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 175

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 = PluralKitAPI.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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 246

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 152

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


132
133
134
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 138

def hash
  [prefix, suffix].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



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 80

def list_invalid_properties
  invalid_properties = Array.new
  if !@prefix.nil? && @prefix.to_s.length > 100
    invalid_properties.push('invalid value for "prefix", the character length must be smaller than or equal to 100.')
  end

  if !@suffix.nil? && @suffix.to_s.length > 100
    invalid_properties.push('invalid value for "suffix", the character length must be smaller than or equal to 100.')
  end

  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



222
223
224
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 222

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 228

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



216
217
218
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 216

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



95
96
97
98
99
 
# File 'lib/pluralkit-api/models/proxy_tag.rb', line 95

def valid?
  return false if !@prefix.nil? && @prefix.to_s.length > 100
  return false if !@suffix.nil? && @suffix.to_s.length > 100
  true
end