Class: NexusMods::Api::ModFile

Inherits:
Object
  • Object
show all
Defined in:
lib/nexus_mods/api/mod_file.rb

Overview

A NexusMods file. Attributes info can be taken from there:

Constant Summary collapse

FILE_CATEGORIES =

Enum of file categories from the API

{
  1 => :main,
  2 => :patch,
  3 => :optional,
  4 => :old,
  5 => :miscellaneous,
  6 => :deleted,
  7 => :archived
}

Instance Method Summary collapse

Constructor Details

#initialize(ids:, uid:, id:, name:, version:, category_id:, category_name:, is_primary:, size:, file_name:, uploaded_time:, mod_version:, external_virus_scan_url:, description:, changelog_html:, content_preview_url:) ⇒ ModFile

Constructor

Parameters

  • ids (Array<Integer>): The file’s list of IDs

  • uid (Integer): The file’s UID

  • id (Integer): The file’s main ID

  • name (String): The file’s name

  • version (String): The file’s version

  • category_id (Symbol): The file’s category’s ID

  • category_name (String): The file’s category_name

  • is_primary (String): Is this file the primary download one?

  • size (Integer): The file’s size (in bytes)

  • file_name (String): The file’s exact file name

  • uploaded_time (Time): The file’s uploaded time

  • mod_version (String): The file’s mod version

  • external_virus_scan_url (String): The URL of virus scan for this file

  • description (String): The file’s description

  • changelog_html (String): The file’s change log in HTML

  • content_preview_url (String): URL to a JSON that gives info on the file’s content



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
 
# File 'lib/nexus_mods/api/mod_file.rb', line 62

def initialize(
  ids:,
  uid:,
  id:,
  name:,
  version:,
  category_id:,
  category_name:,
  is_primary:,
  size:,
  file_name:,
  uploaded_time:,
  mod_version:,
  external_virus_scan_url:,
  description:,
  changelog_html:,
  content_preview_url:
)
  @ids = ids
  @uid = uid
  @id = id
  @name = name
  @version = version
  @category_id = category_id
  @category_name = category_name
  @is_primary = is_primary
  @size = size
  @file_name = file_name
  @uploaded_time = uploaded_time
  @mod_version = mod_version
  @external_virus_scan_url = external_virus_scan_url
  @description = description
  @changelog_html = changelog_html
  @content_preview_url = content_preview_url
  # Extra fields for sugar
  @category = FILE_CATEGORIES[category_id] || :unknown
end

Instance Method Details

#==(other) ⇒ Object

Equality operator

Parameters

  • other (Object): Other object to compare with

Result

  • Boolean: Are objects equal?



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/nexus_mods/api/mod_file.rb', line 106

def ==(other)
  other.is_a?(ModFile) &&
    @ids == other.ids &&
    @uid == other.uid &&
    @id == other.id &&
    @name == other.name &&
    @version == other.version &&
    @category_id == other.category_id &&
    @category_name == other.category_name &&
    @is_primary == other.is_primary &&
    @size == other.size &&
    @file_name == other.file_name &&
    @uploaded_time == other.uploaded_time &&
    @mod_version == other.mod_version &&
    @external_virus_scan_url == other.external_virus_scan_url &&
    @description == other.description &&
    @changelog_html == other.changelog_html &&
    @content_preview_url == other.content_preview_url
end