/
user.rb
442 lines (373 loc) · 13.5 KB
/
user.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
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
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
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
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
241
242
243
244
245
246
247
248
249
250
251
252
253
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
=begin
#DevCycle Bucketing API
#Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
The version of the OpenAPI document: 1.0.0
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 5.3.0
=end
require 'date'
require 'time'
require 'oj'
module DevCycle
class User
# Unique id to identify the user
attr_accessor :user_id
# User's email used to identify the user on the dashboard / target audiences
attr_accessor :email
# User's name used to identify the user on the dashboard / target audiences
attr_accessor :name
# User's language in ISO 639-1 format
attr_accessor :language
# User's country in ISO 3166 alpha-2 format
attr_accessor :country
# App Version of the running application
attr_accessor :appVersion
# App Build number of the running application
attr_accessor :appBuild
# User's custom data to target the user with, data will be logged to DevCycle for use in dashboard.
attr_accessor :customData
# User's custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing.
attr_accessor :privateCustomData
# User's device model
attr_accessor :deviceModel
# read-only instance variables
# Date the user was created, Unix epoch timestamp format
attr_reader :createdDate
# Date the user was created, Unix epoch timestamp format
attr_reader :lastSeenDate
# Platform the Client SDK is running on
attr_reader :platform
# Version of the platform the Client SDK is running on
attr_reader :platformVersion
# DevCycle SDK type
attr_reader :sdkType
# DevCycle SDK Version
attr_reader :sdkVersion
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'user_id' => :'user_id',
:'email' => :'email',
:'name' => :'name',
:'language' => :'language',
:'country' => :'country',
:'appVersion' => :'appVersion',
:'appBuild' => :'appBuild',
:'customData' => :'customData',
:'privateCustomData' => :'privateCustomData',
:'createdDate' => :'createdDate',
:'lastSeenDate' => :'lastSeenDate',
:'platform' => :'platform',
:'platformVersion' => :'platformVersion',
:'deviceModel' => :'deviceModel',
:'sdkType' => :'sdkType',
:'sdkVersion' => :'sdkVersion'
}
end
# Returns all the JSON keys this model knows about
def self.acceptable_attributes
attribute_map.values
end
# Attribute type mapping.
def self.openapi_types
{
:'user_id' => :'String',
:'email' => :'String',
:'name' => :'String',
:'language' => :'String',
:'country' => :'String',
:'appVersion' => :'String',
:'appBuild' => :'String',
:'customData' => :'Object',
:'privateCustomData' => :'Object',
:'createdDate' => :'Float',
:'lastSeenDate' => :'Float',
:'platform' => :'String',
:'platformVersion' => :'String',
:'deviceModel' => :'String',
:'sdkType' => :'String',
:'sdkVersion' => :'String'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `DevCycle::User` 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 `DevCycle::User`. 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?(:'user_id')
self.user_id = attributes[:'user_id']
end
if attributes.key?(:'email')
self.email = attributes[:'email']
end
if attributes.key?(:'name')
self.name = attributes[:'name']
end
if attributes.key?(:'language')
self.language = attributes[:'language']
end
if attributes.key?(:'country')
self.country = attributes[:'country']
end
if attributes.key?(:'appVersion')
self.appVersion = attributes[:'appVersion']
end
if attributes.key?(:'appBuild')
self.appBuild = attributes[:'appBuild']
end
if attributes.key?(:'customData')
self.customData = attributes[:'customData']
end
if attributes.key?(:'privateCustomData')
self.privateCustomData = attributes[:'privateCustomData']
end
if attributes.key?(:'deviceModel')
self.deviceModel = attributes[:'deviceModel']
end
# set read-only instance variables
default_platform_data = PlatformData.new.default
@sdkType = default_platform_data.sdkType
@sdkVersion = default_platform_data.sdkVersion
@platform = default_platform_data.platform
@platformVersion = default_platform_data.platformVersion
@createdDate = Time.now.utc.iso8601
@lastSeenDate = Time.now.utc.iso8601
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
def list_invalid_properties
invalid_properties = Array.new
if @user_id.nil?
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
end
if !@user_id.is_a?(String)
invalid_properties.push('invalid value for "user_id", user_id must be a string.')
end
if !@language.nil? && @language.to_s.length > 2
invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 2.')
end
if !@country.nil? && @country.to_s.length > 2
invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
end
invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
return false if @user_id.nil?
return false if !@user_id.is_a?(String)
return false if !@language.nil? && @language.to_s.length > 2
return false if !@country.nil? && @country.to_s.length > 2
sdk_type_validator = EnumAttributeValidator.new('String', ["api", "server"])
return false unless sdk_type_validator.valid?(@sdk_type)
true
end
# Custom attribute writer method with validation
# @param [Object] language Value to be assigned
def language=(language)
if !language.nil? && language.to_s.length > 2
fail ArgumentError, 'invalid value for "language", the character length must be smaller than or equal to 2.'
end
@language = language
end
# Custom attribute writer method with validation
# @param [Object] country Value to be assigned
def country=(country)
if !country.nil? && country.to_s.length > 2
fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
end
@country = country
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
user_id == o.user_id &&
email == o.email &&
name == o.name &&
language == o.language &&
country == o.country &&
appVersion == o.appVersion &&
appBuild == o.appBuild &&
customData == o.customData &&
privateCustomData == o.privateCustomData &&
createdDate == o.createdDate &&
lastSeenDate == o.lastSeenDate &&
platform == o.platform &&
platformVersion == o.platformVersion &&
deviceModel == o.deviceModel &&
sdkType == o.sdkType &&
sdkVersion == o.sdkVersion
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[user_id, email, name, language, country, appVersion, appBuild, customData, privateCustomData, createdDate, lastSeenDate, platform, platformVersion, deviceModel, sdkType, sdkVersion].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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 = DevCycle.const_get(type)
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
end
end
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
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
def to_json
Oj.dump(to_hash, mode: :json)
end
def to_pb_user_data
pb_user = Proto::DVCUser_PB.new
pb_user.user_id = @user_id
pb_user.email = create_nullable_string(@email)
pb_user.name = create_nullable_string(@name)
pb_user.language = create_nullable_string(@language)
pb_user.country = create_nullable_string(@country)
pb_user.appVersion = create_nullable_string(@appVersion)
pb_user.appBuild = create_nullable_double(@appBuild)
pb_user.customData = create_nullable_custom_data(@customData)
pb_user.privateCustomData = create_nullable_custom_data(@privateCustomData)
pb_user
end
end
# @deprecated Use `DevCycle::User` instead.
UserData = User
end