tmtm/habrahabr_api

Официальный клиент для работы с API сайтов habrahabr.ru и geektimes.ru

Monday, November 21, 2016
by Rpsl
Repository
14 Watchers
77 Stars
70 Installations

PHP
1 Dependents
0 Suggesters
9 Forks
2 Open issues
15 Versions
9 % Grown

The README.md

Habrahabr Api Client

, _(*1)

Хабрахабр - самое крупное в Рунете сообщество людей, занятых в индустрии высоких технологий. Уникальная аудитория, свежая информация, конструктивное общение и коллективное творчество - всё это делает Хабрахабр самым оригинальным IT-проектом в России., _(*2)

Установка

Через composer:

$ composer require tmtm/habrahabr_api

или добавить, _(*3)

"tmtm/habrahabr_api": "0.1.*"

в секцию require файла composer.json., _(*4)

Быстрый старт

Перед началом работы с API Хабрахабра потребуется пройти несколько несложных этапов., _(*5)

Получение идентификатора приложения, _(*6)

Воспользовавшись этой формой на Хабрахабре, нужно кратко описать суть нового приложения и цель, для которой ему нужен API., _(*7)

Через некоторое время будет получен идентификатор и секрет нового приложения. Держите секрет в секрете и никому его не давайте!, _(*8)
Получение токена пользователя, _(*9)

Каждое приложение может работать с API Хабра только от имени установившего его пользователя., _(*10)

Для получения токена можно воспользоваться следующим простым способом. Перейдите по следующей ссылке, _(*11)

https://habrahabr.ru/auth/o/login/?client_id=КЛИЕНТ&response_type=token&redirect_uri=САЙТ, _(*12)

поставив адрес сайта приложения вместо САЙТ и полученный на первом шаге идентификатор вместо КЛИЕНТ., _(*13)

После нажатия кнопки "Разрешить", Хабр выполнит перенаправление на САЙТ, добавив в конец адреса строку #token=..., которая и будет содержать требуемый токен., _(*14)

Создание тестового приложения, _(*15)

Дошедший до этого шага ужее имеет всю мощь API Хабрахабра. Теперь самое время воспользоваться библиотеку. Для начала инициализируем адаптер:, _(*16)

$adapter = new \Habrahabr\Api\HttpAdapter\CurlAdapter();
$adapter->setEndpoint('API_ENDPOINT');
$adapter->setToken('OAUTH_TOKEN');
$adapter->setClient('OAUTH_CLIENT');

$client = new Habrahabr\Api\Client($adapter);
# Доступ к ресурсу может быть получен через метод состоящий из `get` и названия ресурса
$User = $client->getUserResource()->getUser('me');

Описание API ресурсов и методы

CommentsResource - Ресурс работы с комментариями, _(*17)
- getCommentsForPost($post_id) - Возвращает список комментариев к посту по номеру
- postComment($post_id, $text, $comment_id = 0) - Добавление комментария к посту по номеру
- votePlus($comment_id) - Положительное голосование за комментарий
- voteMinus($comment_id) - Отрицательное голосование за комментарий
CompanyResource - Ресурс работы с компаниями, _(*18)
- getCompanyPosts($alias, $page = 1) - Возвращает посты компании по алиасу компании
- getCompanyInfo($alias) - Возвращает профиль компании по алиасу компании
- getList($page = 1) - Возвращает список компаний
FeedResource - Ресурс работы с "основной" лентой постов, _(*19)
- getFeedHabred($page = 1) - Возвращает "Захабренные" посты из "основной" лентой постов
- getFeedUnhabred($page = 1) - Возвращает "Отхабренные" посты из "основной" лентой постов
- getFeedNew($page = 1) - Возвращает "Новые" посты из "основной" лентой постов
FlowResource - Ресурс работы с потоками, _(*20)
- getFlows() - Возвращает список потоков
- getFeedInteresting($alias, $page = 1) - Возвращает "Интересные" посты из потока
- getFeedAll($alias, $page = 1) - Возвращает "Все" посты посты из потока
- getFeedBest($alias, $page = 1) - Возвращает "Лучшие" посты из потока
HubResource - Ресурс работы с хабами, _(*21)
- getHubInfo($alias) - Возвращает информацию о хабе по алиасу
- getFeedHabred($alias, $page = 1) - Возвращает "Захабренные" посты связаные с хабом
- getFeedUnhabred($alias, $page = 1) - Возвращает "Отхабренные" посты связаные с хабом
- getFeedNew($alias, $page = 1) - Возвращает "Новые" посты связаные с хабом
- getHubList($page = 1) - Возвращает список хабов
- subscribeHub($alias) - Подписаться на хаб
- unsubscribeHub($alias) - Отписаться от хаба
PostResource - Ресурс работы с постами, _(*22)
- getPost($post_id) - Возвращает пост по номеру
- getMeta($posts_id) - Получить мета-информацию постов (не более 30 постов за раз)
- votePlus($post_id) - Положительное голосование за пост (Этот метод может быть предоставлен дополнительно, по запросу)
- voteMinus($post_id) - Отрицательное голосование за пост (Этот метод может быть предоставлен дополнительно, по запросу)
- voteNeutral($post_id) - Нейтральное голосование за пост (Этот метод может быть предоставлен дополнительно, по запросу)
- addPostToFavorite($post_id) - Добавить пост в избранное
- removePostFromFavorite($post_id) - Удалить пост из избранного
- increaseCount($post_id) - Увеличить счетчик просмотров поста
PollResource - Ресурс работы с опросами, _(*23)
- getPoll($poll_id) - Возвращает опрос по номеру
- vote($poll_id, $votes = []) - Голосование в опросе за один или несколько варинатов ответа (Этот метод может быть предоставлен дополнительно, по запросу)
SearchResource - Ресурс работы с поиском, _(*24)
- searchPosts($q, $page = 1) - Поиск произвольного запроса по постам
- searchUsers($q, $page = 1) - Поиск произвольного запроса по пользователям
- searchHubs($q) - Поиск произвольного запроса по хабам
TrackerResource - Ресурс работы с трекером, _(*25)
- push($title, $text) - Отправить сообщение в трекер на вкладку "Приложения"
- getCounters() - Возвращает счетчики новых сообщений из трекера, элементы не отмечаются как просмотренные
- getPostsFeed() - Возвращает список постов из трекера,, элементы не отмечаются как просмотренные
- getSubscribersFeed() - Возвращает список подписчиков из трекера, элементы не отмечаются как просмотренные
- getMentions() - Возвращает список упоминаний из трекера, элементы не отмечаются как просмотренные
- getAppsFeed() - Возвращает список сообщений приложений из трекера, элементы не отмечаются как просмотренные
UserResource - Ресурс работы с пользователями, _(*26)
- getUserCurrent() - Возвращает профиль пользователя API ключа
- getUser($login) - Возвращает профиль пользователя по логину
- getUsersList() - Возвращает список пользователей
- getUserComments($login, $page = 1) - Возвращает комментарии пользователя по логину
- getUserPosts($login, $page = 1) - Возвращает посты пользователя по логину
- getUserHubs($login) - Возвращает хабы на которые подписан пользователь
- getUserCompanies($login) - Возвращает компании в которых работает пользователь
- getUserFollowers($login, $page = 1) - Возвращает список подписчиков пользователя по логину
- getUserFollowed($login, $page = 1) - Возвращает список на кого подписан пользователь по логину
- voteKarmaPlus($login) - Плюсовать карму пользователя по логину (Этот метод может быть предоставлен дополнительно, по запросу)
- voteKarmaMinus($login) - Минусовать карму пользователя по логину (Этот метод может быть предоставлен дополнительно, по запросу)
- getUserFavoritesPost($login, $page = 1) - Возвращает список "избранных" постов пользователя по логину
- getUserFavoritesComments($login, $page = 1) - Возвращает список "избранных" комментариев пользователя по логину
SettingsResource - Ресурс работы с настройками профиля, _(*27)
- acceptAgreement() - Принять соглашение

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

Для начала установить --dev зависимости. После чего запустить:, _(*28)

$ vendor/bin/phpunit

Для проведения тестирования на рабочем API, необходимо скопировать файл phpunit.xml.dist в phpunit.xml И добавить в него секцию содержащую ключи для работы с API:, _(*29)

<php>
    <env name="ENDPOINT" value="https://api.habrahabr.ru/v1"/>
    <env name="TOKEN" value="ВАШ_OAUTH_TOKEN"/>
    <env name="CLIENT" value="ВАШ_OAUTH_CLIENT"/>
</php>

Лицензия

Библиотека доступна на условиях лицензии MIT: http://www.opensource.org/licenses/mit-license.php, _(*30)

Альтернативные адаптеры:

habrahabr-guzzle

Реализации на других языках:

Python: habrahabr-api-python
Python: habrahabr-python deprecated

The Versions

21/11 2016

dev-master

9999999-dev

Официальный клиент для работы с API сайтов habrahabr.ru и geektimes.ru

library habrahabr_api

Официальный клиент для работы с API сайтов habrahabr.ru и geektimes.ru

tmtm/habrahabr_api

The README.md

Habrahabr Api Client

Установка

Через composer:

Быстрый старт

Описание API ресурсов и методы

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

Лицензия

Альтернативные адаптеры:

Реализации на других языках:

The Versions

dev-master

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.5

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.4

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.3

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.2

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.1

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.1.0

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.0.8

The Requires

The Development Requires

by GitHub Contributors

by dotzero

by Rpsl

v0.0.7

The Requires

The Development Requires

by GitHub Contributors

by Rpsl

v0.0.6.2

The Requires

by Rpsl

v0.0.6.1

The Requires

by Rpsl

v0.0.6

The Requires

by Rpsl

v0.0.5

The Requires

by Rpsl

v0.0.4