Class: WindcaveRest::Base

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Base

Initializes the object

Parameters:

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

    Model attributes in the form of hash



5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/windcave_rest/models/base.rb', line 5

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  self.class.windcave_types.keys.each do |attrib|
    if attributes.has_key?(attrib)
      self.send("#{attrib.to_s}=", attributes[attrib])
    end
  end
end

Class Method Details

.api_attribute(attribute, datatype = :'String', api_format = :"#{attribute.to_s.camel_case_lower}") ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/windcave_rest/models/base.rb', line 18

def self.api_attribute(attribute, datatype = :'String', api_format = :"#{attribute.to_s.camel_case_lower}")
  self.__send__(:attr_accessor, attribute)

  @attribute_map ||= {}
  @windcave_types ||= {}

  @attribute_map[attribute] = api_format
  @windcave_types[attribute] = datatype
end

.attribute_map ⇒ Object 



28
29
30
 
# File 'lib/windcave_rest/models/base.rb', line 28

def self.attribute_map
  @attribute_map
end

.windcave_types ⇒ Object 



32
33
34
 
# File 'lib/windcave_rest/models/base.rb', line 32

def self.windcave_types
  @windcave_types
end

Instance 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



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

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 =~ /\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
    temp_model = WindcaveRest.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



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/windcave_rest/models/base.rb', line 126

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/windcave_rest/models/base.rb', line 39

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.windcave_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



106
107
108
 
# File 'lib/windcave_rest/models/base.rb', line 106

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



112
113
114
115
116
117
118
119
120
 
# File 'lib/windcave_rest/models/base.rb', line 112

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



100
101
102
 
# File 'lib/windcave_rest/models/base.rb', line 100

def to_s
  to_hash.to_s
end