Class: LinodeOpenapiClient::OauthClient

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/oauth_client.rb

Overview

A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User’s account for the purposes of their application.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OauthClient

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
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
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 102

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

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

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

  if attributes.key?(:'public')
    self.public = attributes[:'public']
  else
    self.public = false
  end

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

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

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

Instance Attribute Details

#id ⇒ Object

Read-only The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).



23
24
25
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 23

def id
  @id
end

#label ⇒ Object

__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.



32
33
34
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 32

def label
  @label
end

#public ⇒ Object

__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](oauth.net/2/) for more details.



29
30
31
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 29

def public
  @public
end

#redirect_uri ⇒ Object

The location a successful log in from [login.linode.com](login.linode.com) should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.



26
27
28
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 26

def redirect_uri
  @redirect_uri
end

#secret ⇒ Object

Read-only The OAuth Client secret, used in the OAuth exchange. This is returned as ‘<REDACTED>` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.



20
21
22
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 20

def secret
  @secret
end

#status ⇒ Object

Read-only The status of this application. ‘active` by default.



38
39
40
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 38

def status
  @status
end

#thumbnail_url ⇒ Object

Read-only The URL where this client’s thumbnail may be viewed, or ‘null` if this client does not have a thumbnail set.



35
36
37
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 35

def thumbnail_url
  @thumbnail_url
end

Class Method Details

._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



254
255
256
257
258
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
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 254

def self._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 = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 63

def self.attribute_map
  {
    :'secret' => :'secret',
    :'id' => :'id',
    :'redirect_uri' => :'redirect_uri',
    :'public' => :'public',
    :'label' => :'label',
    :'thumbnail_url' => :'thumbnail_url',
    :'status' => :'status'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 230

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
98
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 81

def self.openapi_types
  {
    :'secret' => :'String',
    :'id' => :'String',
    :'redirect_uri' => :'String',
    :'public' => :'Boolean',
    :'label' => :'String',
    :'thumbnail_url' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      secret == o.secret &&
      id == o.id &&
      redirect_uri == o.redirect_uri &&
      public == o.public &&
      label == o.label &&
      thumbnail_url == o.thumbnail_url &&
      status == o.status
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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 325

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 223

def hash
  [secret, id, redirect_uri, public, label, thumbnail_url, status].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



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 148

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@label.nil? && @label.to_s.length > 512
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 512.')
  end

  if !@label.nil? && @label.to_s.length < 1
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
  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



301
302
303
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 307

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



295
296
297
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 295

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



164
165
166
167
168
169
170
171
 
# File 'lib/linode_openapi_client/models/oauth_client.rb', line 164

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@label.nil? && @label.to_s.length > 512
  return false if !@label.nil? && @label.to_s.length < 1
  status_validator = EnumAttributeValidator.new('String', ["active", "disabled", "suspended"])
  return false unless status_validator.valid?(@status)
  true
end