Giter VIP home page Giter VIP logo

goshikimori's Introduction

API Шикимори для Golang

GoDoc Go Report Card

Описание

Пакет предназначен для взаимодействия с API Шикимори.

Зависимости

Установка

go get github.com/seryiza/goshikimori

Использование

OAuth2

Прежде всего, для OAuth2 потребуется создать приложение на самом Шикимори. Для авторизации потребуется название приложения, client id и client secret.

Работа с API

Объект goshikimori.Shikimori предназначен для взаимодействия с API Шикимори. Можно использовать через:

  • HTTP-запросы Shikimori.Get/Post/...:
  // var shiki *goshikimori.Shikimori

  resp, _ := shiki.Get("users/whoami")    // для GET https://shikimori.org/api/users/whoami
  userJSON, _ := ioutil.ReadAll(resp.Body)
  fmt.Println(string(userJSON))
  // => {"id":206253,"nickname":"Seryiza",...,"locale":"ru"}
  • HTTP-запросы с приведением к структурам Shikimori.JSONGet/JSONPost/...:
// var shiki *goshikimori.Shikimori

var im structs.User
err := shiki.JSONGet("users/whoami", &im)
if err != nil {
  panic(err)
}

fmt.Println(im, err)
// => models.User{
//      ID: 206253,
//      Nickname: "Seryiza",
//      ...
//    }

Пример

Также есть примеры в папке examples.

conf := &oauth2.Config{
  ClientID:     "your shikimori client id",
  ClientSecret: "your shikimori client secret",
  RedirectURL:  auth.StandaloneRedirectURL,
  Endpoint:     auth.ShikimoriEndpoint,
}

url := auth.GetAuthCodeURL(conf)
fmt.Println("Enter code from here: ", url)

var code string
if _, err := fmt.Scanln(&code); err != nil {
  panic(err)
}

ctx := context.Background()
ctx = goshikimori.AddTransport(ctx, "your shikimori oauth app name")

tok, err := conf.Exchange(ctx, code)
if err != nil {
  panic(err)
}

client := conf.Client(ctx, tok)
shiki := goshikimori.NewShikimori(client, "1.0")  // 1.0 -- version of Shikimori API

resp, err := shiki.Get("users/whoami")
if err != nil {
  panic(err)
}

user := &structs.User{}
jd := json.NewDecoder(resp.Body)
if err = jd.Decode(user); err != nil {
  panic(err)
}

fmt.Printf("I'm %s", user.Nickname)

Также есть вспомогательные функции helpers (использующие файлы и env-переменные) для написания меньшего кода:

// GetShikimori получает oauth2 конфиг и токен из файлов или env-переменных
// и создает Shikimori из стандартного http клиента
shiki, err := helpers.GetShikimori("1.0")
if err != nil {
  panic(err)
}
// Сохраняем токен в файл, если он изменился
defer helpers.SaveToken(shiki)

user := &structs.User{}
_, err = shiki.JSONGet("users/whoami", user)
if err != nil {
  panic(err)
}

fmt.Printf("I'm %s", user.Nickname)

Тестирование

Тесты также проверяют запрос-ответ от Шикимори. Для корректной работы всех тестов необходимо задать следующие envirement-переменные:

  • SHIKI_APP_NAME -- название OAuth-приложения на Шикимори
  • SHIKI_CLIENTID -- публичный Client ID приложения на Шикимори
  • SHIKI_CLIENTSECRET -- секретный ключ приложения на Шикимори
  • SHIKI_REDIRECT_URL -- url для перенаправления приложения (на Шикимори)
  • SHIKI_TOKEN_FILE -- путь к файлу с json-токеном
  • SHIKI_CONF_FILE -- путь к файлу с json oauth-конфигурацией
  • SHIKI_LOGIN -- псевдоним пользователя
  • SHIKI_PASS -- пароль пользователя (используется при получении токена, если предыдущий был истекшим)

goshikimori's People

Contributors

seryiza avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

goshikimori's Issues

Подключить Travis CI

Поскольку репозиторий толком никто не смотрит, позволю себе сделать такой todo-issue.

Надо подключить Travis CI. Для этого надо почитать про его фичи и особенности, YAML-формат и, возможно, немного изменить часть с helpers.GetShikimori().

Описать структуры Шикимори

Описать все оставшиеся структуры данных.
В порядке приоритета:

Users

  • GET /api/users (User)
  • GET /api/users/:id (UserDetailed)
  • GET /api/users/:id/info (UserBrief)
  • GET /api/users/:id/anime_video_reports (AnimeVideoReport)
  • GET /api/users/:id/anime_rates (AnimeRate) (Shikimori API v1)
  • GET /api/users/:id/manga_rates (MangaRate) (Shikimori API v1)
  • GET /api/users/:id/favourites (Favourites)
  • GET /api/users/:id/unread_messages (UnreadMessages)
  • GET /api/users/:id/history (History)

Styles

  • GET /api/styles/:id (Style)
  • PUT /api/styles/:id (NewStyle)

Animes

  • GET /api/animes (Anime)
  • GET /api/animes/:id (AnimeDetailed)
  • GET /api/animes/:id/roles (Role)
  • GET /api/animes/:id/related (Related)
  • GET /api/animes/:id/screenshots (Screenshot)
  • GET /api/animes/:id/franchise (Franchise)
  • GET /api/animes/:id/external_links (ExternalLinks)

Achievements

  • GET /api/achievements (Achievement)

Studios

  • GET /api/studios (Studio)

Genres

  • GET /api/genres (Genre)

Anime videos

  • POST /api/animes/:anime_id/anime_videos (AnimeVideos)

Characters

  • GET /api/characters/:id (Character)

Videos

  • GET /api/animes/:anime_id/videos (Video)
  • POST /api/animes/:anime_id/videos (NewVideo)

Bans

  • GET /api/bans (Ban)

Clubs

  • GET /api/clubs (Club)
  • todo

Messages

  • GET /api/messages/:id (Message)
  • POST /api/messages/mark_read (MarkRead)
  • POST /api/messages/read_all (ReadAll)
  • POST /api/messages/delete_all (DeleteAll)

Appear

  • POST /api/appear (Appear ids)

Calendar

  • GET /api/calendar (Calendar)

Comments

  • todo

Devices

  • todo

Dialogs

  • GET /api/dialogs (DialogPreview)
  • GET /api/dialogs/:id (Dialog)

Forums

  • todo

Mangas

  • todo

Publishers

  • GET /api/publishers (Publisher)

Ranobe

  • todo

Stats

  • GET /api/stats/active_users (ActiveUsers)

Topics

  • todo

User images

  • todo

Реализация методов API

Список всех методов API 1.0.
Пропущены устаревшие методы.

Необходимый минимум

  • Anime videos
  • Animes
  • Calendars
  • Genres
  • Sessions (как auth/login.go)
  • Styles
  • Users

Может быть позже

  • Achievements
  • Appear
  • Bans
  • Characters
  • Clubs
  • Comments
  • Constants
  • Devices
  • Dialogs
  • Forums
  • Friends
  • Ignores
  • Mangas
  • Messages
  • People
  • Publishers
  • Ranobe
  • Stats
  • Studios
  • Topics
  • User images
  • User rates
  • Videos

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.