Class: Comet::SoftwareUpdateNewsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/software_update_news_response.rb

Overview

SoftwareUpdateNewsResponse is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SoftwareUpdateNewsResponse

Returns a new instance of SoftwareUpdateNewsResponse.



34
35
36
 
# File 'lib/comet/models/software_update_news_response.rb', line 34

def initialize
  clear
end

Instance Attribute Details

#downloads_url ⇒ Object

A URL linking to the Comet Server downloads page.



25
26
27
 
# File 'lib/comet/models/software_update_news_response.rb', line 25

def downloads_url
  @downloads_url
end

#latest_prerelease ⇒ Object

The latest “Voyager” release version of Comet known to the account.cometbackup.com system.



21
22
23
 
# File 'lib/comet/models/software_update_news_response.rb', line 21

def latest_prerelease
  @latest_prerelease
end

#latest_stable ⇒ Object

The latest “Quarterly” release version of Comet known to the account.cometbackup.com system.



17
18
19
 
# File 'lib/comet/models/software_update_news_response.rb', line 17

def latest_stable
  @latest_stable
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



32
33
34
 
# File 'lib/comet/models/software_update_news_response.rb', line 32

def unknown_json_fields
  @unknown_json_fields
end

#whats_new ⇒ Object

An array of recent news items written by Comet Backup staff. Entries are english plaintext.



29
30
31
 
# File 'lib/comet/models/software_update_news_response.rb', line 29

def whats_new
  @whats_new
end

Instance Method Details

#clear ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/comet/models/software_update_news_response.rb', line 38

def clear
  @latest_stable = ''
  @latest_prerelease = ''
  @downloads_url = ''
  @whats_new = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
 
# File 'lib/comet/models/software_update_news_response.rb', line 54

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'latest_stable'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @latest_stable = v
    when 'latest_prerelease'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @latest_prerelease = v
    when 'downloads_url'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @downloads_url = v
    when 'updates_info'
      if v.nil?
        @whats_new = []
      else
        @whats_new = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @whats_new[i1] = v1
        end
      end
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


47
48
49
50
51
 
# File 'lib/comet/models/software_update_news_response.rb', line 47

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



102
103
104
 
# File 'lib/comet/models/software_update_news_response.rb', line 102

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/comet/models/software_update_news_response.rb', line 89

def to_hash
  ret = {}
  ret['latest_stable'] = @latest_stable
  ret['latest_prerelease'] = @latest_prerelease
  ret['downloads_url'] = @downloads_url
  ret['updates_info'] = @whats_new
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



107
108
109
 
# File 'lib/comet/models/software_update_news_response.rb', line 107

def to_json(options = {})
  to_hash.to_json(options)
end