Class: Mangadex::Manga

Inherits:
MangadexObject show all
Defined in:
lib/mangadex/manga.rb

Instance Attribute Summary

Attributes included from Internal::WithAttributes

#attributes, #id, #relationships, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MangadexObject

#eq?, #hash, #initialize, #inspect

Constructor Details

This class inherits a constructor from Mangadex::MangadexObject

Class Method Details

.all_reading_statusObject



137
138
139
140
141
# File 'lib/mangadex/manga.rb', line 137

def self.all_reading_status
  Mangadex::Internal::Request.get(
    '/manga/status',
  )
end

.attributes_to_inspectObject



173
174
175
# File 'lib/mangadex/manga.rb', line 173

def self.attributes_to_inspect
  [:id, :type, :title, :content_rating, :original_language, :year]
end

.create(**args) ⇒ Object



169
170
171
# File 'lib/mangadex/manga.rb', line 169

def self.create(**args)
  Mangadex::Internal::Request.post('/manga', payload: args)
end

.delete(id) ⇒ Object



163
164
165
166
167
# File 'lib/mangadex/manga.rb', line 163

def self.delete(id)
  Mangadex::Internal::Request.delete(
    '/manga/%{id}' % {id: id},
  )
end

.feed(id, **args) ⇒ Object



92
93
94
95
96
97
# File 'lib/mangadex/manga.rb', line 92

def self.feed(id, **args)
  Mangadex::Internal::Request.get(
    '/manga/%{id}/feed' % {id: id},
    Mangadex::Internal::Definition.chapter_list(args),
  )
end

.follow(id) ⇒ Object



85
86
87
88
89
# File 'lib/mangadex/manga.rb', line 85

def self.follow(id)
  Mangadex::Internal::Request.post(
    '/manga/%{id}/follow' % {id: id},
  )
end

.list(**args) ⇒ Object



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/mangadex/manga.rb', line 25

def self.list(**args)
  to_a = Mangadex::Internal::Definition.converts(:to_a)

  Mangadex::Internal::Request.get(
    '/manga',
    Mangadex::Internal::Definition.validate(args, {
      limit: { accepts: Integer },
      offset: { accepts: Integer },
      title: { accepts: String },
      authors: { accepts: [String] },
      artists: { accepts: [String] },
      year: { accepts: Integer },
      included_tags: { accepts: [String] },
      included_tags_mode: { accepts: %w(OR AND), converts: to_a },
      excluded_tags: { accepts: [String] },
      excluded_tags_mode: { accepts: %w(OR AND), converts: to_a },
      status: { accepts: %w(ongoing completed hiatus cancelled), converts: to_a },
      original_language: { accepts: [String] },
      excluded_original_language: { accepts: [String] },
      available_translated_language: { accepts: [String] },
      publication_demographic: { accepts: %w(shounen shoujo josei seinen none), converts: to_a },
      ids: { accepts: Array },
      content_rating: { accepts: %w(safe suggestive erotica pornographic), converts: to_a },
      created_at_since: { accepts: %r{^\d{4}-[0-1]\d-([0-2]\d|3[0-1])T([0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$} },
      updated_at_since: { accepts: %r{^\d{4}-[0-1]\d-([0-2]\d|3[0-1])T([0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$} },
      order: { accepts: Hash },
      includes: { accepts: Array, converts: to_a },
    }),
  )
end

.random(**args) ⇒ Object



100
101
102
103
104
105
106
107
# File 'lib/mangadex/manga.rb', line 100

def self.random(**args)
  Mangadex::Internal::Request.get(
    '/manga/random',
    Mangadex::Internal::Definition.validate(args, {
      includes: { accepts: Array },
    })
  )
end

.reading_status(id) ⇒ Object



117
118
119
120
121
122
123
124
125
126
127
# File 'lib/mangadex/manga.rb', line 117

def self.reading_status(**args)
  Mangadex::Internal::Request.get(
    '/manga/status',
    Mangadex::Internal::Definition.validate(args, {
      status: {
        accepts: %w(reading on_hold dropped plan_to_read re_reading completed),
        converts: Mangadex::Internal::Definition.converts(:to_a),
      },
    })
  )
end

.tag_listObject



110
111
112
113
114
# File 'lib/mangadex/manga.rb', line 110

def self.tag_list
  Mangadex::Internal::Request.get(
    '/manga/tag'
  )
end

.unfollow(id) ⇒ Object



78
79
80
81
82
# File 'lib/mangadex/manga.rb', line 78

def self.unfollow(id)
  Mangadex::Internal::Request.delete(
    '/manga/%{id}/follow' % {id: id},
  )
end

.update(id, **args) ⇒ Object



158
159
160
# File 'lib/mangadex/manga.rb', line 158

def self.update(id, **args)
  Mangadex::Internal::Request.put('/manga/%{id}' % {id: id}, payload: args)
end

.update_reading_status(id, status) ⇒ Object



144
145
146
147
148
149
150
151
152
153
154
# File 'lib/mangadex/manga.rb', line 144

def self.update_reading_status(id, status)
  Mangadex::Internal::Request.post(
    '/manga/%{id}/status' % {id: id},
    payload: Mangadex::Internal::Definition.validate({status: status}, {
      status: {
        accepts: %w(reading on_hold dropped plan_to_read re_reading completed),
        required: true,
      },
    })
  )
end

.view(id, **args) ⇒ Object



68
69
70
71
72
73
74
75
# File 'lib/mangadex/manga.rb', line 68

def self.view(id, **args)
  Mangadex::Internal::Request.get(
    '/manga/%{id}' % {id: id},
    Mangadex::Internal::Definition.validate(args, {
      includes: { accepts: Array },
    })
  )
end

.volumes_and_chapters(id, **args) ⇒ Object Also known as: aggregate



57
58
59
60
61
62
63
64
65
# File 'lib/mangadex/manga.rb', line 57

def self.volumes_and_chapters(id, **args)
  Mangadex::Internal::Request.get(
    '/manga/%{id}/aggregate' % {id: id},
    Mangadex::Internal::Definition.validate(args, {
      translated_language: { accepts: Array },
      groups: { accepts: Array },
    }),
  )
end

Instance Method Details

#content_ratingObject



182
183
184
185
186
# File 'lib/mangadex/manga.rb', line 182

def content_rating
  return unless attributes&.content_rating.present?

  ContentRating.new(attributes.content_rating)
end