Class: Harkness::ComicResource

Inherits:

Resource

• Object
• Resource
• Harkness::ComicResource

Defined in:

lib/harkness/resources/comic.rb

Overview

The comic resource.

Instance Attribute Summary

Attributes inherited from Resource

#client

Instance Method Summary

• #characters(comic_id:) ⇒ Harkness::CharacterDataWrapper

  Get a list of characters for a particular comic.

• #creators(comic_id:) ⇒ Harkness::CreatorDataWrapper

  Get a list of creators for a particular comic.

• #events(comic_id:) ⇒ Harkness::EventDataWrapper

  Get a list of events for a particular comic.

• #list(**params) ⇒ Harkness::ComicDataWrapper

  Get a list of comics.

• #retrieve(comic_id:) ⇒ Harkness::ComicDataWrapper

  Get a single comic.

• #stories(comic_id:) ⇒ Harkness::StoryDataWrapper

  Get a list of stories for a particular comic.

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from Harkness::Resource

Instance Method Details

#characters(comic_id:) ⇒ Harkness::CharacterDataWrapper

Get a list of characters for a particular comic.

Examples:

client.comics.characters(comic_id: 1234)

Parameters:

• comic_id (Integer) —

  the ID of the comic.

Returns:

• (Harkness::CharacterDataWrapper) —

  the top level wrapper around the character API response.

# File 'lib/harkness/resources/comic.rb', line 32

def characters(comic_id:)
  CharacterDataWrapper.from_json(get_request("comics/#{comic_id}/characters").body)
end

#creators(comic_id:) ⇒ Harkness::CreatorDataWrapper

Get a list of creators for a particular comic.

Examples:

client.comics.creators(comic_id: 1234)

Parameters:

• comic_id (Integer) —

  the ID of the comic.

Returns:

• (Harkness::CreatorDataWrapper) —

  the top level wrapper around the creator API response.

# File 'lib/harkness/resources/comic.rb', line 41

def creators(comic_id:)
  CreatorDataWrapper.from_json(get_request("comics/#{comic_id}/creators").body)
end

#events(comic_id:) ⇒ Harkness::EventDataWrapper

Get a list of events for a particular comic.

Examples:

client.comics.events(comic_id: 1234)

Parameters:

• comic_id (Integer) —

  the ID of the comic.

Returns:

• (Harkness::EventDataWrapper) —

  the top level wrapper around the event API response.

# File 'lib/harkness/resources/comic.rb', line 50

def events(comic_id:)
  EventDataWrapper.from_json(get_request("comics/#{comic_id}/events").body)
end

#list(**params) ⇒ Harkness::ComicDataWrapper

Get a list of comics.

Examples:

client.comics.list
client.comics.list(titleStartsWith: "Spider", limit: 10, orderBy: "issueNumber")

Parameters:

• params (Hash) —

  the params to pass to the API request. See the comics documentation from Marvel for valid options.

Returns:

• (Harkness::ComicDataWrapper) —

  the top level wrapper around the comic API response.

# File 'lib/harkness/resources/comic.rb', line 14

def list(**params)
  ComicDataWrapper.from_json(get_request("comics", params: params).body)
end

#retrieve(comic_id:) ⇒ Harkness::ComicDataWrapper

Get a single comic.

Examples:

client.comics.retrieve(comic_id: 1234)

Parameters:

• comic_id (Integer) —

  the ID of the comic.

Returns:

• (Harkness::ComicDataWrapper) —

  the top level wrapper around the comic API response.

# File 'lib/harkness/resources/comic.rb', line 23

def retrieve(comic_id:)
  ComicDataWrapper.from_json(get_request("comics/#{comic_id}").body)
end

#stories(comic_id:) ⇒ Harkness::StoryDataWrapper

Get a list of stories for a particular comic.

Examples:

client.comics.stories(comic_id: 1234)

Parameters:

• comic_id (Integer) —

  the ID of the comic.

Returns:

• (Harkness::StoryDataWrapper) —

  the top level wrapper around the story API response.

# File 'lib/harkness/resources/comic.rb', line 59

def stories(comic_id:)
  StoryDataWrapper.from_json(get_request("comics/#{comic_id}/stories").body)
end