vkontakte_api 1.1 → 1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d37878c023a9ef41c525a2e80d94a1116bf7cdf4
+  data.tar.gz: d6bee0ae8a1dfa7a74d74e26327f5cf880214e9b
+SHA512:
+  metadata.gz: 100e3698409e4c1c76ac1adbbb75609675b92c965905e5218b32cc5f1dae49d0f69783db01bb7ca5729e724bae8e4718e0f3ffc7cb8ec8cc86a87a7e0d399301
+  data.tar.gz: 43b9a423fd114d904b395f34fdf510eb72a48657722b2a88c2e15f82bdb8544b6aa2180fe8eb225a3e28aec20b12bbf3bc31cabb788f1f34739f62457d7ada19

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 .yardoc/*
+spec/support/credentials.yml

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-  # - ruby-head
+  - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.2 (14.07.2013)
+
+* Повтор запроса при определенных ошибках
+* Корректная работа метода `messages.send`
+* Поддержка параметров `captcha_sid` и `captcha_img` при ошибке 14
+
 ## 1.1 (18.12.2012)
 
 * Передача `redirect_uri` при получении токена

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vkontakte_api.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-## vkontakte_api [![Build Status](https://secure.travis-ci.org/7even/vkontakte_api.png)](http://travis-ci.org/7even/vkontakte_api) [![Dependency Status](https://gemnasium.com/7even/vkontakte_api.png)](https://gemnasium.com/7even/vkontakte_api) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/7even/vkontakte_api)
+## vkontakte_api [![Build Status](https://secure.travis-ci.org/7even/vkontakte_api.png)](http://travis-ci.org/7even/vkontakte_api) [![Gem Version](https://badge.fury.io/rb/vkontakte_api.png)](http://badge.fury.io/rb/vkontakte_api) [![Dependency Status](https://gemnasium.com/7even/vkontakte_api.png)](https://gemnasium.com/7even/vkontakte_api) [![Code Climate](https://codeclimate.com/github/7even/vkontakte_api.png)](https://codeclimate.com/github/7even/vkontakte_api)
 
 `vkontakte_api` - ruby-адаптер для ВКонтакте API. Он позволяет вызывать методы API, загружать файлы на сервера ВКонтакте, а также поддерживает все 3 доступных способа авторизации (при этом позволяя использовать стороннее решение).
 
@@ -6,7 +6,7 @@
 
 ``` ruby
 # Gemfile
-gem 'vkontakte_api', '~> 1.0'
+gem 'vkontakte_api', '~> 1.2'
 ```
 
 или просто
@@ -78,7 +78,7 @@ 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`) пользователя.
 
-В соответствии с [рекомендациями](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`.
+В соответствии с [рекомендациями](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`, содержащий случайное значение.
 
 ``` ruby
 session[:state] = Digest::MD5.hexdigest(rand.to_s)
@@ -181,6 +181,8 @@ vk.friends.get(uid: 1, fields: [:first_name, :last_name, :photo])
 # VkontakteApi::Error: VKontakte returned an error 7: 'Permission to perform this action is denied' after calling method 'friends.get' with parameters {"uid"=>"1", "fields"=>"first_name,last_name,photo"}.
 ```
 
+Особый случай ошибки - 14: необходимо ввести код с captcha. В этом случае можно получить параметры капчи методами `VkontakteApi::Error#captcha_sid` и `VkontakteApi::Error#captcha_img` - например, [так](https://github.com/7even/vkontakte_api/issues/10#issuecomment-11666091).
+
 ### Логгирование
 
 `vkontakte_api` логгирует служебную информацию о запросах при вызове методов. По умолчанию все пишется в `STDOUT`, но в настройке можно указать любой другой совместимый логгер, например `Rails.logger`.
@@ -197,7 +199,9 @@ vk.friends.get(uid: 1, fields: [:first_name, :last_name, :photo])
 
 ### Пример использования
 
-[Здесь](http://vkontakte-on-rails.herokuapp.com/) можно посмотреть пример использования `vkontakte_api` в rails-приложении (используются только читающие методы *.get - приложение ничего не пишет на ВКонтакте, только читает). Исходный код можно посмотреть [тут](https://github.com/7even/vkontakte_on_rails).
+Пример использования `vkontakte_api` совместно с `eventmachine` можно посмотреть [здесь](https://github.com/7even/vkontakte_on_em).
+
+Также был написан [пример использования с rails](https://github.com/7even/vkontakte_on_rails), но он больше не работает из-за отсутствия прав на вызов метода `newsfeed.get`.
 
 ## Настройка
 
@@ -226,6 +230,8 @@ VkontakteApi.configure do |config|
       password: 'bar'
     }
   }
+  # максимальное количество повторов запроса при ошибках
+  config.max_retries = 2
   
   # логгер
   config.logger        = Rails.logger
@@ -256,14 +262,11 @@ $ rails generate vkontakte_api:install
 
 ## Roadmap
 
-* метод, возвращающий права текущего токена в читабельной форме (используя `getUserSettings` и кэшируя результат)
-* сохранение параметра `expires_at` токена в объекте `VkontakteApi::Client` после авторизации через `VkontakteApi.authorize`
-* метод `VkontakteApi::Client#offline?`, проверяющий, является ли токен бесконечным, используя значение `VkontakteApi::Client#expires_at`
-* `POST`-запросы по умолчанию
-* логгирование тела `POST`-запроса
+* настраиваемый retry запроса при стандартных исключениях
+* CLI-интерфейс с автоматической авторизацией
 
 ## Участие в разработке
 
 Если вы хотите поучаствовать в разработке проекта, форкните репозиторий, положите свои изменения в отдельную ветку, покройте их спеками и отправьте мне pull request.
 
-`vkontakte_api` тестируется под MRI `1.8.7`, `1.9.2` и `1.9.3`. Если в одной из этих сред что-то работает неправильно, либо вообще не работает, то это следует считать багом, и написать об этом в [issues на Github](https://github.com/7even/vkontakte_api/issues).
+`vkontakte_api` тестируется под MRI `1.9.2`, `1.9.3` и `2.0.0`. Если в одной из этих сред что-то работает неправильно, либо вообще не работает, то это следует считать багом, и написать об этом в [issues на Github](https://github.com/7even/vkontakte_api/issues).

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 
 desc 'Fires up the console with preloaded vkontakte_api'
 task :console do
-  sh 'pry -I ./lib/ -r ./lib/vkontakte_api.rb'
+  sh 'pry -I ./lib -r ./lib/vkontakte_api'
 end
 
 require 'rspec/core/rake_task'
@@ -10,4 +10,4 @@ RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = '--color --format doc'
 end
 
-task :default => :spec
+task default: :spec

data/lib/vkontakte_api/api.rb

@@ -14,7 +14,7 @@ module VkontakteApi
       # @return [Hashie::Mash] Mashed server response.
       def call(method_name, args = {}, token = nil)
         flat_arguments = Utils.flatten_arguments(args)
-        connection(:url => URL_PREFIX, :token => token).send(VkontakteApi.http_verb, method_name, flat_arguments).body
+        connection(url: URL_PREFIX, token: token).send(VkontakteApi.http_verb, method_name, flat_arguments).body
       end
       
       # Faraday connection.
@@ -30,9 +30,10 @@ module VkontakteApi
           builder.request  :oauth2, token unless token.nil?
           builder.request  :multipart
           builder.request  :url_encoded
+          builder.request  :retry, VkontakteApi.max_retries
           builder.response :vk_logger
           builder.response :mashify
-          builder.response :oj, :preserve_raw => true
+          builder.response :oj, preserve_raw: true
           builder.adapter  VkontakteApi.adapter
         end
       end

data/lib/vkontakte_api/authorization.rb

@@ -5,12 +5,12 @@ module VkontakteApi
   module Authorization
     # Authorization options.
     OPTIONS = {
-      :client => {
-        :site          => 'https://oauth.vk.com',
-        :authorize_url => '/authorize',
-        :token_url     => '/access_token'
+      client: {
+        site:          'https://oauth.vk.com',
+        authorize_url: '/authorize',
+        token_url:     '/access_token'
       },
-      :client_credentials => {
+      client_credentials: {
         'auth_scheme' => 'request_body'
       }
     }

data/lib/vkontakte_api/client.rb

@@ -5,23 +5,23 @@ module VkontakteApi
     
     # Access rights and their respective number representation.
     SCOPE = {
-      :notify         => 1,
-      :friends        => 2,
-      :photos         => 4,
-      :audio          => 8,
-      :video          => 16,
-      :offers         => 32,
-      :questions      => 64,
-      :pages          => 128,
-      :status         => 1024,
-      :notes          => 2048,
-      :messages       => 4096,
-      :wall           => 8192,
-      :ads            => 32768,
-      :docs           => 131072,
-      :groups         => 262144,
-      :notifications  => 524288,
-      :stats          => 1048576
+      notify:        1,
+      friends:       2,
+      photos:        4,
+      audio:         8,
+      video:         16,
+      offers:        32,
+      questions:     64,
+      pages:         128,
+      status:        1024,
+      notes:         2048,
+      messages:      4096,
+      wall:          8192,
+      ads:           32768,
+      docs:          131072,
+      groups:        262144,
+      notifications: 524288,
+      stats:         1048576
     }
     
     # An access token needed by authorized requests.

data/lib/vkontakte_api/configuration.rb

@@ -13,6 +13,7 @@ module VkontakteApi
       :adapter,
       :http_verb,
       :faraday_options,
+      :max_retries,
       :logger,
       :log_requests,
       :log_errors,
@@ -31,11 +32,14 @@ module VkontakteApi
     # Default HTTP verb for API methods.
     DEFAULT_HTTP_VERB = :post
     
+    # Default max retries count.
+    DEFAULT_MAX_RETRIES = 2
+    
     # Logger default options.
     DEFAULT_LOGGER_OPTIONS = {
-      :requests  => true,
-      :errors    => true,
-      :responses => false
+      requests:  true,
+      errors:    true,
+      responses: false
     }
     
     # A global configuration set via the block.
@@ -54,6 +58,7 @@ module VkontakteApi
       @adapter         = DEFAULT_ADAPTER
       @http_verb       = DEFAULT_HTTP_VERB
       @faraday_options = {}
+      @max_retries     = DEFAULT_MAX_RETRIES
       @logger          = ::Logger.new(STDOUT)
       @log_requests    = DEFAULT_LOGGER_OPTIONS[:requests]
       @log_errors      = DEFAULT_LOGGER_OPTIONS[:errors]

data/lib/vkontakte_api/error.rb

@@ -4,6 +4,12 @@ module VkontakteApi
     # An error code.
     # @return [Fixnum]
     attr_reader :error_code
+    # Captcha identifier (only for "Captcha needed" errors).
+    # @return [String]
+    attr_reader :captcha_sid
+    # Captcha image URL (only for "Captcha needed" errors).
+    # @return [String]
+    attr_reader :captcha_img
     
     # An exception is initialized by the data from response mash.
     # @param [Hash] data Error data.
@@ -17,6 +23,9 @@ module VkontakteApi
       @access_token = request_params.delete('access_token')
       @oauth        = request_params.delete('oauth')
       @params       = request_params
+      
+      @captcha_sid  = data.captcha_sid
+      @captcha_img  = data.captcha_img
     end
     
     # A full description of the error.

data/lib/vkontakte_api/logger.rb

@@ -33,4 +33,4 @@ module VkontakteApi
   end
 end
 
-Faraday.register_middleware :response, :vk_logger => VkontakteApi::Logger
+Faraday.register_middleware :response, vk_logger: VkontakteApi::Logger

data/lib/vkontakte_api/namespaces.yml

@@ -27,3 +27,6 @@
 - auth
 - ads
 - orders
+- search
+- apps
+- utils

data/lib/vkontakte_api/resolver.rb

@@ -10,17 +10,17 @@ module VkontakteApi
       
       if Resolver.namespaces.include?(method_name)
         # called from Client
-        Namespace.new(method_name, :resolver => resolver)
+        Namespace.new(method_name, resolver: resolver)
       else
         # called from Namespace or one-level method
-        Method.new(method_name, :resolver => resolver).call(args.first || {}, &block)
+        Method.new(method_name, resolver: resolver).call(args.first || {}, &block)
       end
     end
     
     # A `Hashie::Mash` structure holding the name and token of current instance.
     # @return [Hashie::Mash]
     def resolver
-      @resolver ||= Hashie::Mash.new(:name => @name, :token => token)
+      @resolver ||= Hashie::Mash.new(name: @name, token: token)
     end
     
     class << self
@@ -35,6 +35,14 @@ module VkontakteApi
         
         @namespaces
       end
+      
+      # When this module is included, it undefines the `:send` instance method in the `base_class`
+      # so it can be resolved via `method_missing`.
+      def included(base_class)
+        base_class.class_eval do
+          undef_method :send
+        end
+      end
     end
   end
 end

data/lib/vkontakte_api/version.rb

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

data/spec/integration_spec.rb

@@ -18,33 +18,35 @@ describe "Integration" do
     end
     
     it "get users" do
-      user = @vk.users.get(:uid => 1).first
-      user.uid.should        == 1
-      user.last_name.should_not  be_empty
+      user = @vk.users.get(uid: 1).first
+      user.uid.should == 1
+      user.last_name.should_not be_empty
       user.first_name.should_not be_empty
     end
   end
   
-  describe "authorized requests" do
-    before(:each) do
-      @vk = VK::Client.new(ENV['TOKEN'])
-    end
-    
-    it "get groups" do
-      groups = @vk.groups.get
-      groups.should include(1)
-    end
-  end if ENV['TOKEN']
-  
-  describe "requests with camelCase and predicate methods" do
-    before(:each) do
-      @vk = VK::Client.new(ENV['TOKEN'])
+  if MechanizedAuthorization.on?
+    describe "authorized requests" do
+      before(:each) do
+        @vk = MechanizedAuthorization.client
+      end
+      
+      it "get groups" do
+        groups = @vk.groups.get
+        groups.should include(1)
+      end
     end
     
-    it "convert method names to vk.com format" do
-      @vk.is_app_user?.should be_true
+    describe "requests with camelCase and predicate methods" do
+      before(:each) do
+        @vk = MechanizedAuthorization.client
+      end
+      
+      it "convert method names to vk.com format" do
+        @vk.is_app_user?.should be_true
+      end
     end
-  end if ENV['TOKEN']
+  end
   
   describe "requests with array arguments" do
     before(:each) do
@@ -52,7 +54,7 @@ describe "Integration" do
     end
     
     it "join arrays with a comma" do
-      users = @vk.users.get(:uids => [1, 2, 3], :fields => %w[first_name last_name screen_name])
+      users = @vk.users.get(uids: [1, 2, 3], fields: %w[first_name last_name screen_name])
       users.first.screen_name.should_not be_empty
     end
   end
@@ -63,7 +65,7 @@ describe "Integration" do
     end
     
     it "map the result with a block" do
-      users = @vk.users.get(:uid => 1) do |user|
+      users = @vk.users.get(uid: 1) do |user|
         "#{user.last_name} #{user.first_name}"
       end
       
@@ -74,7 +76,7 @@ describe "Integration" do
   describe "authorization" do
     context "with a scope" do
       it "returns a correct url" do
-        VK.authorization_url(:scope => %w[friends groups]).should include('scope=friends%2Cgroups')
+        VK.authorization_url(scope: %w[friends groups]).should include('scope=friends%2Cgroups')
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'vkontakte_api'
 require 'pry'
+require 'awesome_print'
+require_relative './support/mechanized_authorization'
 
 RSpec::Matchers.define :log_requests do
   match do |logger|

data/spec/support/mechanized_authorization.rb

@@ -0,0 +1,57 @@
+require 'mechanize'
+
+module MechanizedAuthorization
+  class << self
+    def client
+      @client ||= begin
+        agent = Mechanize.new
+        
+        configure
+        agent.get VkontakteApi.authorization_url(scope: [:friends, :groups], type: :client)
+        
+        agent.page.form_with(action: /login.vk.com/) do |form|
+          form.email = settings.email
+          form.pass  = settings.password
+        end.submit
+        
+        # uri.fragment: access_token=ee6b952fa432c70&expires_in=86400&user_id=123456
+        params = agent.page.uri.fragment.split('&').inject({}) do |hash, pair|
+          key, value = pair.split('=')
+          hash[key] = value
+          hash
+        end
+        token = params['access_token']
+        
+        VkontakteApi::Client.new(token)
+      end
+    end
+    
+    def on?
+      !off?
+    end
+    
+  private
+    def off?
+      ENV['NO_AUTH'] || !File.exists?(credentials_path)
+    end
+    
+    def configure
+      VkontakteApi.configure do |config|
+        config.app_id     = settings.app_id
+        config.app_secret = settings.app_secret
+      end
+    end
+    
+    def settings
+      @settings ||= Hashie::Mash.new(settings_hash)
+    end
+    
+    def settings_hash
+      YAML.load_file(credentials_path)
+    end
+    
+    def credentials_path
+      File.expand_path('../credentials.yml', __FILE__)
+    end
+  end
+end