Class: Factorix::API::MODInfo::Detail

Inherits:

Data

Object
Data
Factorix::API::MODInfo::Detail

show all

Defined in:: lib/factorix/api/mod_info.rb,
lib/factorix/api/mod_info.rb

Overview

Detailed MOD information from Full API endpoint

Instance Attribute Summary collapse

#category ⇒ Category readonly

MOD category.
#changelog ⇒ String readonly

Changelog text.
#created_at ⇒ Time readonly

Creation timestamp.
#deprecated ⇒ Boolean readonly

Deprecation status.
#description ⇒ String readonly

Detailed description text.
#detail ⇒ Detail^? readonly

Detailed information (Full API only).
#downloads_count ⇒ Integer readonly

Total number of downloads.
#faq ⇒ String readonly

FAQ text.
#homepage ⇒ URI, String readonly

Homepage URL or string.
#images ⇒ Array<Image> readonly

Images.
#last_highlighted_at ⇒ Time^? readonly

Last highlighted timestamp.
#latest_release ⇒ Release^? readonly

Latest release (list API without namelist).
#license ⇒ License^? readonly

License information.
#name ⇒ String readonly

Internal MOD name (unique identifier).
#owner ⇒ String readonly

MOD owner username.
#releases ⇒ Array<Release> readonly

All releases.
#score ⇒ Float readonly

MOD score/rating.
#source_url ⇒ URI::HTTPS^? readonly

Source repository URL.
#summary ⇒ String readonly

Short description.
#tags ⇒ Array<Tag> readonly

Tags.
#thumbnail ⇒ URI::HTTPS^? readonly

Thumbnail image URL.
#title ⇒ String readonly

Human-readable MOD title.
#updated_at ⇒ Time readonly

Last update timestamp.

Instance Method Summary collapse

#deprecated? ⇒ Boolean

Check if the MOD is deprecated.
#initialize(created_at:, updated_at:, homepage:, changelog: nil, last_highlighted_at: nil, description: nil, source_url: nil, faq: nil, tags: nil, license: nil, images: nil, deprecated: nil) ⇒ Detail constructor

Create Detail from API response hash.

Constructor Details

#initialize(created_at:, updated_at:, homepage:, changelog: nil, last_highlighted_at: nil, description: nil, source_url: nil, faq: nil, tags: nil, license: nil, images: nil, deprecated: nil) ⇒ `Detail`

Create Detail from API response hash

Parameters:

changelog (String, nil) (defaults to: nil) —

changelog
created_at (String) —

ISO 8601 timestamp
updated_at (String) —

ISO 8601 timestamp
last_highlighted_at (String, nil) (defaults to: nil) —

ISO 8601 timestamp
description (String, nil) (defaults to: nil) —

description
source_url (String, nil) (defaults to: nil) —

source URL
homepage (String) —

homepage URL or string
faq (String, nil) (defaults to: nil) —

FAQ
tags (Array<String>, nil) (defaults to: nil) —

tags
license (Hash, nil) (defaults to: nil) —

license data
images (Array<Hash>, nil) (defaults to: nil) —

images data
deprecated (Boolean, nil) (defaults to: nil) —

deprecated flag

# File 'lib/factorix/api/mod_info.rb', line 90

def initialize(created_at:, updated_at:, homepage:, changelog: nil, last_highlighted_at: nil, description: nil, source_url: nil, faq: nil, tags: nil, license: nil, images: nil, deprecated: nil)
  changelog ||= ""
  created_at = Time.parse(created_at).utc
  updated_at = Time.parse(updated_at).utc
  last_highlighted_at = last_highlighted_at ? Time.parse(last_highlighted_at).utc : nil
  description ||= ""
  source_url = parse_uri(source_url)
  homepage = parse_uri(homepage)
  faq ||= ""
  tags = (tags || []).map {|tag_value| Tag.for(tag_value) }
  license = license ? License[**license] : nil
  images = (images || []).map {|img| Image[**img] }
  deprecated ||= false

  super
end

Instance Attribute Details

#category ⇒ `Category` (readonly)

Returns MOD category.

Returns:

(Category) —

MOD category

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#changelog ⇒ `String` (readonly)

Returns changelog text.

Returns:

(String) —

changelog text



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def changelog
  @changelog
end

#created_at ⇒ `Time` (readonly)

Returns creation timestamp.

Returns:

(Time) —

creation timestamp



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def created_at
  @created_at
end

#deprecated ⇒ `Boolean` (readonly)

Returns deprecation status.

Returns:

(Boolean) —

deprecation status



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def deprecated
  @deprecated
end

#description ⇒ `String` (readonly)

Returns detailed description text.

Returns:

(String) —

detailed description text



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def description
  @description
end

#detail ⇒ `Detail`^? (readonly)

Returns detailed information (Full API only).

Returns:

(Detail, nil) —

detailed information (Full API only)

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#downloads_count ⇒ `Integer` (readonly)

Returns total number of downloads.

Returns:

(Integer) —

total number of downloads

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#faq ⇒ `String` (readonly)

Returns FAQ text.

Returns:

(String) —

FAQ text



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def faq
  @faq
end

#homepage ⇒ `URI`, `String` (readonly)

Returns homepage URL or string.

Returns:

(URI, String) —

homepage URL or string



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def homepage
  @homepage
end

#images ⇒ `Array<Image>` (readonly)

Returns images.

Returns:

(Array<Image>) —

images



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def images
  @images
end

#last_highlighted_at ⇒ `Time`^? (readonly)

Returns last highlighted timestamp.

Returns:

(Time, nil) —

last highlighted timestamp



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def last_highlighted_at
  @last_highlighted_at
end

#latest_release ⇒ `Release`^? (readonly)

Returns latest release (list API without namelist).

Returns:

(Release, nil) —

latest release (list API without namelist)

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#license ⇒ `License`^? (readonly)

Returns license information.

Returns:

(License, nil) —

license information



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def license
  @license
end

#name ⇒ `String` (readonly)

Returns internal MOD name (unique identifier).

Returns:

(String) —

internal MOD name (unique identifier)

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#owner ⇒ `String` (readonly)

Returns MOD owner username.

Returns:

(String) —

MOD owner username

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#releases ⇒ `Array<Release>` (readonly)

Returns all releases.

Returns:

(Array<Release>) —

all releases

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#score ⇒ `Float` (readonly)

Returns MOD score/rating.

Returns:

(Float) —

MOD score/rating

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#source_url ⇒ `URI::HTTPS`^? (readonly)

Returns source repository URL.

Returns:

(URI::HTTPS, nil) —

source repository URL



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def source_url
  @source_url
end

#summary ⇒ `String` (readonly)

Returns short description.

Returns:

(String) —

short description

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#tags ⇒ `Array<Tag>` (readonly)

Returns tags.

Returns:

(Array<Tag>) —

tags



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def tags
  @tags
end

#thumbnail ⇒ `URI::HTTPS`^? (readonly)

Returns thumbnail image URL.

Returns:

(URI::HTTPS, nil) —

thumbnail image URL

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#title ⇒ `String` (readonly)

Returns human-readable MOD title.

Returns:

(String) —

human-readable MOD title

# File 'lib/factorix/api/mod_info.rb', line 42

Detail = Data.define(:changelog, :created_at, :updated_at, :last_highlighted_at, :description, :source_url, :homepage, :faq, :tags, :license, :images, :deprecated)

#updated_at ⇒ `Time` (readonly)

Returns last update timestamp.

Returns:

(Time) —

last update timestamp



42
43
44

# File 'lib/factorix/api/mod_info.rb', line 42

def updated_at
  @updated_at
end

Instance Method Details

#deprecated? ⇒ `Boolean`

Check if the MOD is deprecated

Returns:

(Boolean) —

true if deprecated

110	# File 'lib/factorix/api/mod_info.rb', line 110 def deprecated? = deprecated

Class: Factorix::API::MODInfo::Detail

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(created_at:, updated_at:, homepage:, changelog: nil, last_highlighted_at: nil, description: nil, source_url: nil, faq: nil, tags: nil, license: nil, images: nil, deprecated: nil) ⇒ Detail

Instance Attribute Details

#category ⇒ Category (readonly)

#changelog ⇒ String (readonly)

#created_at ⇒ Time (readonly)

#deprecated ⇒ Boolean (readonly)

#description ⇒ String (readonly)

#detail ⇒ Detail? (readonly)

#downloads_count ⇒ Integer (readonly)

#faq ⇒ String (readonly)

#homepage ⇒ URI, String (readonly)

#images ⇒ Array<Image> (readonly)

#last_highlighted_at ⇒ Time? (readonly)

#latest_release ⇒ Release? (readonly)

#license ⇒ License? (readonly)

#name ⇒ String (readonly)

#owner ⇒ String (readonly)

#releases ⇒ Array<Release> (readonly)

#score ⇒ Float (readonly)

#source_url ⇒ URI::HTTPS? (readonly)

#summary ⇒ String (readonly)

#tags ⇒ Array<Tag> (readonly)

#thumbnail ⇒ URI::HTTPS? (readonly)

#title ⇒ String (readonly)

#updated_at ⇒ Time (readonly)

Instance Method Details

#deprecated? ⇒ Boolean

#initialize(created_at:, updated_at:, homepage:, changelog: nil, last_highlighted_at: nil, description: nil, source_url: nil, faq: nil, tags: nil, license: nil, images: nil, deprecated: nil) ⇒ `Detail`

#category ⇒ `Category` (readonly)

#changelog ⇒ `String` (readonly)

#created_at ⇒ `Time` (readonly)

#deprecated ⇒ `Boolean` (readonly)

#description ⇒ `String` (readonly)

#detail ⇒ `Detail`^? (readonly)

#downloads_count ⇒ `Integer` (readonly)

#faq ⇒ `String` (readonly)

#homepage ⇒ `URI`, `String` (readonly)

#images ⇒ `Array<Image>` (readonly)

#last_highlighted_at ⇒ `Time`^? (readonly)

#latest_release ⇒ `Release`^? (readonly)

#license ⇒ `License`^? (readonly)

#name ⇒ `String` (readonly)

#owner ⇒ `String` (readonly)

#releases ⇒ `Array<Release>` (readonly)

#score ⇒ `Float` (readonly)

#source_url ⇒ `URI::HTTPS`^? (readonly)

#summary ⇒ `String` (readonly)

#tags ⇒ `Array<Tag>` (readonly)

#thumbnail ⇒ `URI::HTTPS`^? (readonly)

#title ⇒ `String` (readonly)

#updated_at ⇒ `Time` (readonly)

#deprecated? ⇒ `Boolean`