Class: Shikimori::API::V1

Inherits:

Object

• Object
• Shikimori::API::V1

Includes:

Achievements, Animes, Appear, Bans, Calendars, Characters, Clubs, Comments, Constants, Dialogs, Favorites, Forums, Friends, Genres, Ignores, Mangas, Messages, People, Publishers, Ranobe, Reviews, Stats, Studios, Styles, TopicIgnores, Topics, UserImages, UserRates, Users, Videos

Defined in:

lib/shikimori/api/v1.rb,
lib/shikimori/api/v1/bans.rb,
lib/shikimori/api/v1/clubs.rb,
lib/shikimori/api/v1/stats.rb,
lib/shikimori/api/v1/users.rb,
lib/shikimori/api/v1/animes.rb,
lib/shikimori/api/v1/appear.rb,
lib/shikimori/api/v1/forums.rb,
lib/shikimori/api/v1/genres.rb,
lib/shikimori/api/v1/mangas.rb,
lib/shikimori/api/v1/people.rb,
lib/shikimori/api/v1/ranobe.rb,
lib/shikimori/api/v1/styles.rb,
lib/shikimori/api/v1/topics.rb,
lib/shikimori/api/v1/videos.rb,
lib/shikimori/api/v1/dialogs.rb,
lib/shikimori/api/v1/friends.rb,
lib/shikimori/api/v1/ignores.rb,
lib/shikimori/api/v1/reviews.rb,
lib/shikimori/api/v1/studios.rb,
lib/shikimori/api/v1/comments.rb,
lib/shikimori/api/v1/messages.rb,
lib/shikimori/api/v1/calendars.rb,
lib/shikimori/api/v1/constants.rb,
lib/shikimori/api/v1/favorites.rb,
lib/shikimori/api/v1/characters.rb,
lib/shikimori/api/v1/publishers.rb,
lib/shikimori/api/v1/user_rates.rb,
lib/shikimori/api/v1/user_images.rb,
lib/shikimori/api/v1/achievements.rb,
lib/shikimori/api/v1/topic_ignores.rb

Overview

Methods for first version of shikimori’s API

Defined Under Namespace

Modules: Achievements, Animes, Appear, Bans, Calendars, Characters, Clubs, Comments, Constants, Dialogs, Favorites, Forums, Friends, Genres, Ignores, Mangas, Messages, People, Publishers, Ranobe, Reviews, Stats, Studios, Styles, TopicIgnores, Topics, UserImages, UserRates, Users, Videos

Constant Summary

Constants included from Topics

Topics::TOPIC_TYPES_MAP

Instance Attribute Summary

• #base_url ⇒ Object readonly

  Returns the value of attribute base_url.

• #rest ⇒ Object readonly

  Returns the value of attribute rest.

Instance Method Summary

• #initialize(base_url:, rest:) ⇒ V1 constructor

  A new instance of V1.

Methods included from Videos

#anime_videos, #create_anime_video, #delete_anime_video

Methods included from Users

#sign_out, #user, #user_anime_rates, #user_bans, #user_clubs, #user_favorites, #user_friends, #user_history, #user_info, #user_manga_rates, #user_messages, #user_unread_messages, #users, #whoami

Methods included from UserRates

#cleanup_user_rates, #create_user_rate, #delete_user_rate, #increment_user_rate, #reset_user_rates, #update_user_rate, #user_rate

Methods included from UserImages

#create_user_image

Methods included from Topics

#create_topic, #delete_topic, #hot_topics, #topic, #topics, #topics_updates, #update_topic

Methods included from TopicIgnores

#create_topic_ignore, #delete_topic_ignore

Methods included from Styles

#create_style, #preview_style, #style, #update_style

Methods included from Studios

#studios

Methods included from Stats

#active_users

Methods included from Reviews

#create_review, #delete_review, #update_review

Methods included from Ranobe

#ranobe, #ranobe_external_links, #ranobe_franchise, #ranobe_related, #ranobe_roles, #ranobe_similar, #ranobe_topics, #ranobes

Methods included from Publishers

#publishers

Methods included from People

#people, #person

Methods included from Messages

#create_message, #delete_all_messages, #delete_message, #message, #read_all_messages, #update_message

Methods included from Mangas

#manga, #manga_external_links, #manga_franchise, #manga_related, #manga_roles, #manga_similar, #manga_topics, #mangas

Methods included from Ignores

#create_ignore, #delete_ignore

Methods included from Genres

#genres

Methods included from Friends

#create_friend, #delete_friend

Methods included from Forums

#forums

Methods included from Favorites

#create_favorite, #delete_favorite, #reorder_favorite

Methods included from Dialogs

#delete_dialog, #dialog, #dialogs

Methods included from Constants

#anime_constants, #club_constants, #manga_constants, #smileys_constants, #user_rate_constants

Methods included from Comments

#comment, #comments, #create_comment, #delete_comment, #update_comment

Methods included from Clubs

#club, #club_animes, #club_characters, #club_clubs, #club_collections, #club_images, #club_mangas, #club_members, #club_ranobe, #clubs, #join_club, #leave_club, #update_club

Methods included from Characters

#character, #characters

Methods included from Calendars

#calendar

Methods included from Bans

#bans

Methods included from Appear

#create_appear

Methods included from Animes

#anime, #anime_external_links, #anime_franchise, #anime_related, #anime_roles, #anime_screenshots, #anime_similar, #anime_topics, #animes

Methods included from Achievements

#achievements

Constructor Details

#initialize(base_url:, rest:) ⇒ V1

Returns a new instance of V1.

# File 'lib/shikimori/api/v1.rb', line 71

def initialize(base_url:, rest:)
  @rest = rest
  @base_url = base_url
end

Instance Attribute Details

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.

# File 'lib/shikimori/api/v1.rb', line 69

def base_url
  @base_url
end

#rest ⇒ Object (readonly)

Returns the value of attribute rest.

# File 'lib/shikimori/api/v1.rb', line 69

def rest
  @rest
end