Code Monkey home page Code Monkey logo

vkontakte_on_rails's Introduction

ВКонтакте API + ruby

Это приложение демонстрирует работу с ВКонтакте API в rails. Для авторизации и вызова API-методов используется гем vkontakte_api. Приложение ничего не пишет на ВКонтакте - все методы вызываются только для чтения данных.

скриншот

Авторизация

Дабы не усложнять задачу, было решено не хранить пользователей в БД, а вместо этого хранить их состояние в сессии.

Авторизация происходит в стандартном для oauth2 порядке:

  • пользователь редиректится на страницу ВКонтакте, где ему предлагается дать приложению права на доступ к его данным
  • после согласия пользователь редиректится обратно в приложение, с передачей кода в параметрах
  • приложение запрашивает у ВКонтакте токен доступа и uid текущего пользователя, используя полученный ранее код
  • приложение вызывает методы API, используя токен доступа (хранящийся в сессии)

При выходе данные просто удаляются из сессии.

Вызов методов

Приложение использует только методы получения данных из ВКонтакте. На главной странице для авторизованных пользователей отображается лента новостей (API-метод newsfeed.get), список друзей (friends.get) и групп (groups.get). Также в меню выводится аватар и имя текущего пользователя (метод users.get, в который передается id текущего пользователя из сессии).

Лента новостей приходит в специфическом формате, поэтому ее обработка выделена в отдельный метод MainController#process_feed. Также некоторый функционал вынесен в MainHelper.

Деплой

Прежде всего необходимо зарегистрировать приложение на ВКонтакте с типом "веб-сайт". В результате будут получены ID приложения и защищенный ключ, необходимые для авторизации приложения пользователями.

Теперь можно разместить приложение в любом rack-совместимом окружении, где возможна установка расширений на C. Необходимо лишь указать в переменных окружения 3 параметра:

  • APP_ID - ID приложения
  • APP_SECRET - защищенный ключ
  • REDIRECT_URI - адрес, на который будет возвращен пользователь после подтверждения прав приложения

Первые 2 параметра можно получить на странице редактирования приложения (после создания оного) на ВКонтакте (на странице настройки приложений в разделе "Администрируемые приложения").

Параметр REDIRECT_URI должен содержать путь к экшену SessionsController#callback (в данном примере это http://vkontakte-on-rails.herokuapp.com/callback). Хост данного адреса должен соответствовать базовому домену, заданному в настройках приложения на ВКонтакте, иначе после редиректа пользователя на ВКонтакте он увидит ошибку. Базовый домен в упомянутых настройках не должен содержать протокол - только доменное имя (vkontakte-on-rails.herokuapp.com, а не http://vkontakte-on-rails.herokuapp.com).

vkontakte_on_rails's People

Contributors

7even avatar

Watchers

 avatar  avatar

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.