vkontakte_api 1.0 → 1.0.1

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 1.0 (в разработке)
+## 1.0.1 (13.08.2012)
+
+* Пространство имен `leads`
+* Удалены пространства имен `activity`, `offers` и `questions`
+
+## 1.0 (20.07.2012)
 
 * Новые пространства имен
 * rails-генератор конфиг-файла

data/README.md

@@ -76,13 +76,22 @@ VkontakteApi.upload(url: url, photo: ['/path/to/file.jpg', 'image/jpeg'])
 
 ##### Сайт
 
-Авторизация сайтов проходит в 2 шага: сначала пользователь перенаправляется на страницу ВКонтакте для подтверждения запрошенных у него прав сайта на доступ к его данным. Со списком возможных прав можно ознакомиться [здесь](http://vk.com/developers.php?oid=-1&p=%D0%9F%D1%80%D0%B0%D0%B2%D0%B0_%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0_%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D0%B9). Допустим, нужно получить доступ к друзьям (`friends`) и фотографиям (`photos`) пользователя.
+Авторизация сайтов проходит в 2 шага. Сначала пользователь перенаправляется на страницу ВКонтакте для подтверждения запрошенных у него прав сайта на доступ к его данным. Со списком возможных прав можно ознакомиться [здесь](http://vk.com/developers.php?oid=-1&p=%D0%9F%D1%80%D0%B0%D0%B2%D0%B0_%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0_%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D0%B9). Допустим, нужно получить доступ к друзьям (`friends`) и фотографиям (`photos`) пользователя.
+
+В соответствии с [рекомендациями](http://tools.ietf.org/html/draft-ietf-oauth-v2-30#section-10.12) в протоколе OAuth2 для защиты от [CSRF](http://ru.wikipedia.org/wiki/%D0%9F%D0%BE%D0%B4%D0%B4%D0%B5%D0%BB%D0%BA%D0%B0_%D0%BC%D0%B5%D0%B6%D1%81%D0%B0%D0%B9%D1%82%D0%BE%D0%B2%D1%8B%D1%85_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%BE%D0%B2), нужно передать параметр `state`, содержащий случайное значение. На данный момент по непонятным причинам ВКонтакте игнорирует этот параметр, если в `scope` не указан `notify`.
 
 ``` ruby
-redirect_to VkontakteApi.authorization_url(scope: [:friends, :photos])
+session[:state] = Digest::MD5.hexdigest(rand.to_s)
+redirect_to VkontakteApi.authorization_url(scope: [:notify, :friends, :photos], state: session[:state])
 ```
 
-После подтверждения пользователь перенаправляется на указанный в настройках `redirect_uri`, причем в параметрах будет передан код, по которому можно получить токен доступа. `vkontakte_api` предоставляет метод `VkontakteApi.authorize`, который делает запрос к ВКонтакте, получает токен и создает клиент; нужно лишь передать ему код:
+После подтверждения пользователь перенаправляется на указанный в настройках `redirect_uri`, причем в параметрах будет передан код, по которому можно получить токен доступа, а также переданный ранее `state`. Если `state` не совпадает с тем, который был использован при отправлении пользователя на ВКонтакте, то скорее всего это попытка CSRF-атаки - стоит отправить пользователя на повторную авторизацию.
+
+``` ruby
+redirect_to login_url, alert: 'Ошибка авторизации' if params[:state] != session[:state]
+```
+
+`vkontakte_api` предоставляет метод `VkontakteApi.authorize`, который делает запрос к ВКонтакте, получает токен и создает клиент; нужно лишь передать ему код:
 
 ``` ruby
 @vk = VkontakteApi.authorize(code: params[:code])
@@ -151,6 +160,10 @@ vk.friends.get(uid: 1, fields: [:first_name, :last_name, :photo])
 
 Таким образом, в rails-приложении с настройками по умолчанию в production записываются только ответы сервера при ошибках; в development также логгируются URL-ы запросов.
 
+### Пример использования
+
+[Здесь](http://vkontakte-on-rails.herokuapp.com/) можно посмотреть пример использования `vkontakte_api` в rails-приложении (используются только читающие методы *.get - приложение ничего не пишет на ВКонтакте, только читает). Исходный код можно посмотреть [тут](https://github.com/7even/vkontakte_on_rails).
+
 ## Настройка
 
 Глобальные параметры `vkontakte_api` задаются в блоке `VkontakteApi.configure` следующим образом:

data/lib/vkontakte_api/namespaces.yml

@@ -1,4 +1,5 @@
 - users
+- likes
 - friends
 - groups
 - photos
@@ -13,16 +14,13 @@
 - storage
 - notes
 - pages
-- activity
-- offers
-- questions
+- stats
 - subscriptions
+- leads
 - messages
-- likes
 - status
 - polls
 - account
 - board
-- auth
-- stats
 - fave
+- auth

data/lib/vkontakte_api/version.rb

@@ -1,4 +1,4 @@
 module VkontakteApi
   # Library version.
-  VERSION = '1.0'
+  VERSION = '1.0.1'
 end

data/spec/vkontakte_api/api_spec.rb

@@ -6,7 +6,7 @@ describe VkontakteApi::API do
     
     @connection = Faraday.new do |builder|
       builder.response :mashify
-      builder.response :json, :preserve_raw => true
+      builder.response :oj, :preserve_raw => true
       builder.adapter  :test do |stub|
         stub.get('/apiMethod') do
           [200, {}, Oj.dump(@result)]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vkontakte_api
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday