Class: BotFramework::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/bot_framework/models/base.rb

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Base

Returns a new instance of Base.



33
34
35
36
37
38
 
# File 'lib/bot_framework/models/base.rb', line 33

def initialize(options = {})
  return unless options.is_a?(Hash)
  options.each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Class Attribute Details

.attributes ⇒ Object

Returns the value of attribute attributes.



4
5
6
 
# File 'lib/bot_framework/models/base.rb', line 4

def attributes
  @attributes
end

Class Method Details

.attr_accessor(*args) ⇒ Object 



7
8
9
10
11
 
# File 'lib/bot_framework/models/base.rb', line 7

def self.attr_accessor(*args)
  @attributes ||= []
  @attributes.concat args
  super(*args)
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
 
# File 'lib/bot_framework/models/base.rb', line 41

def self.attribute_map
  # FIXME: using class level caching breaks inheritance
  @attribute_map ||= attributes.map do |attribute|
    { attribute => BotFramework::Util.camel_case_lower(attribute).to_sym }
  end.reduce({}, :merge)
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



63
64
65
66
 
# File 'lib/bot_framework/models/base.rb', line 63

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



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
 
# File 'lib/bot_framework/models/base.rb', line 107

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 =~ /^(true|t|yes|y|1)$/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 = BotFramework.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



173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/bot_framework/models/base.rb', line 173

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

#as_json ⇒ Object 



25
26
27
 
# File 'lib/bot_framework/models/base.rb', line 25

def as_json
  to_hash
end

#attributes ⇒ Object 



13
14
15
 
# File 'lib/bot_framework/models/base.rb', line 13

def attributes
  self.class.attributes
end

#attributes_hash ⇒ Object 



17
18
19
 
# File 'lib/bot_framework/models/base.rb', line 17

def attributes_hash
  attributes.map { |attribute| { attribute => send(attribute) } }.reduce({}, :merge)
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



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

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

  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(Regexp.last_match(1), v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      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

#compact_attributes_hash ⇒ Object 



21
22
23
 
# File 'lib/bot_framework/models/base.rb', line 21

def compact_attributes_hash
  to_hash
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


70
71
72
 
# File 'lib/bot_framework/models/base.rb', line 70

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



76
77
78
 
# File 'lib/bot_framework/models/base.rb', line 76

def hash
  attributes_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



50
51
52
53
 
# File 'lib/bot_framework/models/base.rb', line 50

def list_invalid_properties
  invalid_properties = []
  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



153
154
155
 
# File 'lib/bot_framework/models/base.rb', line 153

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



159
160
161
162
163
164
165
166
167
 
# File 'lib/bot_framework/models/base.rb', line 159

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

#to_json ⇒ Object 



29
30
31
 
# File 'lib/bot_framework/models/base.rb', line 29

def to_json
  as_json.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



147
148
149
 
# File 'lib/bot_framework/models/base.rb', line 147

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



57
58
59
 
# File 'lib/bot_framework/models/base.rb', line 57

def valid?
  true
end