vkontakte_client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7caa5eb916dc2794f24440aabd7b58090b89fdf2230a363d3e949a3403ca8a0
+  data.tar.gz: f781826918653d3a1d65c7ef1c841c36881e0dab8d4f75715483068dced00a96
+SHA512:
+  metadata.gz: 65976cc3532beec29405f2a92d1ccb0cb6a759d171ec72f98e6aec2989647e32a909b4d76f620699530a42ff7610aba95c5b3bb3ca68a9ee014f7309b7daad5e
+  data.tar.gz: 908def64e9eeb7d8566f3db6dce54733e9e811f2a5adde8b3db8731039ecdaa52d811c948edc5cf26dd10957387ed1658706e3c61abe7c6fde59c06eca9fd3fa

data/.gitignore

@@ -0,0 +1,3 @@
+/**/Gemfile.lock
+/**/.byebug_history
+/**/gems.locked

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Metrics/AbcSize:
+  Max: 36
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/BlockLength:
+  Max: 57
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 33
+
+Style/AsciiComments:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010-2021 Anton Maminov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Vkontakte Client
+
+Ruby library for authorization of client applications and for access to the VK API
+
+## Usage
+
+``` ruby
+require 'vkontakte_client'
+```
+
+## Application registration
+
+You must register your application in order to use all the capabilities of API VKontakte.
+
+Open the page “Managed apps” in the left menu, then press “Create an app”. You will be directed to the page <https://vk.com/editapp?act=create>.
+
+You need to choose _Standalone-app_.
+
+After confirming the action, you will be redirected to the page with information about the app. Open the page "Settings" in the left-hand menu and you will see the field "ID applications", in which a number will be located. For example, `5490057`. This number is the application identification, a.k.a. `API_ID`, `APP_ID`, `client_id`, and you will need it for your future work.
+
+### Initialize Vkontakte client
+
+With client authorization, the access key to the API `access_token`.
+The constructor takes only one argument - the VK application ID - `CLIENT_ID`.
+
+``` ruby
+vk = Vkontakte::Client.new(CLIENT_ID)
+```
+
+### Login and password authorization
+
+In general, for API identification, a special access key is used which is called `access_token`. This token is a string of numbers and Latin letters which you send to the server along with the request.
+
+This library supports the [Implicit flow](https://vk.com/dev/implicit_flow_user) way to obtain an OAuth 2.0 access key:
+th 2.0:
+
+The `login!` method takes the following arguments:
+
+* `email`: user login
+* `pass`: user password
+* `permissions`: requeste [application permissions](https://vk.com/dev/permissions)
+
+``` ruby
+vk.login!(email, pass, permissions: 'friends')
+```
+
+### API Requests
+
+After successful authorization, you can [make requests to the API](http://vk.com/dev/api_requests) using the method name from the [API function list](http://vk.com/dev/methods).
+
+The parameters of the corresponding API method are passed as `Hash`.
+Note that a method like `friends.get` needs to be passed as `friends_get`.
+
+``` ruby
+vk.api.friends_get(fields: 'online', order: 'name', name_case: 'dat')
+```
+
+To avoid errors, you can pre-check the status of the user using the `account.getInfo` method.
+
+```ruby
+vk.api.account_getInfo
+```
+
+### Token Authorization
+
+It is useful to save the received `access_token` (and, if necessary, the `user_id`) to reuse them
+
+``` ruby
+access_token = vk.access_token
+user_id = vk.user_id
+```
+
+``` ruby
+api = Vkontakte::API.new(access_token)
+api.friends_get(fields: 'online', order: 'name', name_case: 'dat')
+```
+
+## Contributing
+
+1. Fork it (<https://github.com/mamantoha/vkontakte_client/fork>)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Copyright: 2010-2021 Anton Maminov (anton.maminov@gmail.com)
+
+This library is distributed under the MIT license. Please see the LICENSE file.

data/README.ru.md

@@ -0,0 +1,79 @@
+# Vkontakte Client
+
+Библиотека для авторизация клиентских приложений и для доступа к API ВКонтакте
+
+## Использование
+
+``` ruby
+require 'vkontakte_client'
+```
+
+## Регистрация приложения
+
+Вам необходимо зарегистрировать свое приложение, чтобы использовать все возможности API ВКонтакте.
+
+Откройте страницу «Управление» в левом меню, затем нажмите «Создать приложение» — Вы попадете на страницу <https://vk.com/editapp?act=create>
+
+Нужно выбрать Standalone-приложение.
+
+После подтверждения действия Вы попадете на страницу с информацией о приложении.
+Откройте вкладку "Настройки" в меню слева. Вы увидите поле "ID приложения", в котором будет указано число, например, 5490057.
+Это число — идентификатор приложения, он же `API_ID`, `APP_ID`, `CLIENT_ID`, оно потребуется Вам в дальнейшей работе.
+
+### Создание клиента
+
+При клиентской авторизации ключ доступа к API `access_token` выдаётся приложению без необходимости раскрытия секретного ключа приложения.
+Конструктор получает только один аргумент - идентификатор приложения ВКонтакте - `CLIENT_ID`.
+
+``` ruby
+vk = Vkontakte::Client.new(CLIENT_ID)
+```
+
+### Авторизация по логину и паролю
+
+Для работы с большинством методов API Вам необходимо передавать в запросе `access_token` — специальный ключ доступа.
+
+Эта библиотека поддерживаем [Implicit flow](https://vk.com/dev/implicit_flow_user) способ получения ключа доступа по OAuth 2.0:
+
+Метод `login!` принимает следующие аргументы:
+
+* `email`: логин пользователя
+* `pass`: пароль
+* `permissions`: запрашиваемые [права доступа приложения](https://vk.com/dev/permissions)
+
+``` ruby
+vk.login!(email, pass, permissions: 'friends')
+```
+
+### Вызов методов
+
+После успешной авторизации Вы можете [осуществлять запросы к API](http://vk.com/dev/api_requests) используя название метода из [списка функций API](http://vk.com/dev/methods).
+
+Параметры соответствующего метода API передаются как `Hash`.
+Следует заметить что метод вида `friends.get` нужно передавать как `friends_get`.
+
+``` ruby
+vk.api.friends_get(fields: 'online', order: 'name', name_case: 'dat')
+```
+
+Чтобы избежать появления ошибок, Вы можете предварительно проверять состояние пользователя методом `account.getInfo`.
+
+```ruby
+vk.api.account_getInfo
+```
+
+### Авторизация по токену
+
+Полезно сохранить полученный токен (и, при необходимости, id пользователя)
+
+``` ruby
+access_token = vk.access_token
+user_id = vk.user_id
+```
+
+чтобы использовать их повторно
+
+``` ruby
+api = Vkontakte::API.new(access_token)
+api.friends_get(fields: 'online', order: 'name', name_case: 'dat')
+```

data/examples/accept_all_requests.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'vkontakte_client'
+
+puts Vkontakte::VERSION
+
+if $PROGRAM_NAME == __FILE__
+  CLIENT_ID = '5987497'
+
+  email = ARGV[0]
+  pass  = ARGV[1]
+
+  vk = Vkontakte::Client.new(CLIENT_ID)
+
+  vk.login!(email, pass, open_captcha: true, permissions: 'friends')
+  vk_api = vk.api
+  puts "Access token: #{vk.access_token}"
+
+  friend_ids = vk_api.friends_getRequests(need_viewed: 1, out: 0)['items']
+  puts "You have #{friend_ids.size} friends requests."
+
+  friend_ids.each_slice(100) do |user_ids|
+    user_ids.each do |user_id|
+      print "Accept user with id `#{user_id}`"
+      begin
+        vk_api.friends_add(user_id: user_id)
+        puts ' - OK'
+      rescue Vkontakte::API::Error => e
+        vk_api.account_banUser(user_id: user_id) if e.error_code == 177
+        puts ' - Skip'
+      end
+    end
+  end
+end

data/examples/add_suggestions.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'vkontakte_client'
+
+puts Vkontakte::VERSION
+
+if $PROGRAM_NAME == __FILE__
+  CLIENT_ID = '5987497'
+
+  email = ARGV[0]
+  pass  = ARGV[1]
+
+  vk = Vkontakte::Client.new(CLIENT_ID)
+  vk.login!(email, pass, permissions: 'friends', open_captcha: true)
+
+  suggestions = vk.api.friends_getSuggestions(filter: 'mutual')['items']
+  suggestions.each do |user|
+    sleep 1
+
+    puts "Add [#{user['id']}] #{user['first_name']} #{user['last_name']}"
+    vk.api.friends_add(user_id: user['id'])
+  rescue Vkontakte::API::Error => e
+    puts e.message
+
+    case e.error_code
+    when 1
+      puts 'Come back tomorrow'
+      break
+    when 175, 176
+      next
+    else
+      sleep 60
+      retry
+    end
+  end
+
+end

data/examples/ban_news_from_all_friends.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'vkontakte_client'
+
+puts Vkontakte::VERSION
+
+if $PROGRAM_NAME == __FILE__
+  CLIENT_ID = '5987497'
+
+  email = ARGV[0]
+  pass  = ARGV[1]
+
+  vk = Vkontakte::Client.new(CLIENT_ID)
+
+  # proxy = Vkontakte::Proxy.new(:socks, 'localhost', 9050)
+  # vk = Vkontakte::Client.new(CLIENT_ID, proxy: proxy)
+
+  vk.login!(email, pass, open_captcha: true, permissions: 'friends,wall')
+  vk_api = vk.api
+  puts "Access token: #{vk.access_token}"
+
+  banned_ids = vk_api.newsfeed_getBanned['members']
+
+  my_friends = []
+  fr_count = 5000
+  fr_offset = 0
+  puts 'Get friends'
+  loop do
+    fr = vk.api.friends_get(count: fr_count, offset: fr_offset * fr_count)['items']
+    break if fr.empty?
+
+    my_friends << fr
+    fr_offset += 1
+  end
+  my_friends.flatten!
+
+  my_requests = []
+  fr_count = 1000
+  fr_offset = 0
+  puts 'Received applications to friends'
+  loop do
+    fr = vk.api.friends_getRequests(count: fr_count, offset: fr_offset * fr_count, out: 0)['items']
+    break if fr.empty?
+
+    my_requests << fr
+    fr_offset += 1
+  end
+
+  fr_count = 1000
+  fr_offset = 0
+  puts 'Get requests sent by the me'
+  loop do
+    fr = vk.api.friends_getRequests(count: fr_count, offset: fr_offset * fr_count, out: 1)['items']
+    break if fr.empty?
+
+    my_requests << fr
+    fr_offset += 1
+  end
+
+  my_requests.flatten!
+
+  all_users = (my_friends | my_requests) - banned_ids
+
+  puts "Clean news feed from #{all_users.size} new users"
+  all_users.each_slice(100) do |user_ids|
+    vk_api.newsfeed_addBan(user_ids: user_ids.join(','))
+  end
+  puts "#{vk_api.newsfeed_getBanned['members'].size} are banned."
+end

data/examples/friends_of_friends.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'pp'
+require 'vkontakte_client'
+require 'pry'
+
+puts Vkontakte::VERSION
+
+if $PROGRAM_NAME == __FILE__
+  CLIENT_ID = '5987497'
+
+  email = ARGV[0]
+  pass  = ARGV[1]
+
+  vk = Vkontakte::Client.new(CLIENT_ID, timeout: 500)
+  vk.login!(email, pass, open_captcha: true, permissions: 'friends,wall')
+
+  current_user = vk.api.users_get.first
+
+  second_circle = {}
+  second_circle.default = 0
+  # [uid, uid, ...]
+
+  my_friends = []
+  fr_count = 5000
+  fr_offset = 0
+  loop do
+    fr = vk.api.friends_get(order: 'hints', count: fr_count, offset: fr_offset * fr_count)['items']
+    break if fr.empty?
+
+    my_friends << fr
+    fr_offset += 1
+  end
+  my_friends.flatten!
+
+  good_friends = 0
+  bad_friends = 0
+
+  fr_count = 1000
+  fr_offset = 0
+  friends_requests = []
+
+  loop do
+    fr = vk.api.friends_getRequests(out: 1, count: fr_count, offset: fr_offset * fr_count)['items']
+    break if fr.empty?
+
+    friends_requests << fr
+    fr_offset += 1
+  end
+  friends_requests.flatten!
+
+  parse_friends_count = 30
+  puts "You have #{my_friends.count} friends"
+  puts "#{friends_requests.count} people already receive request"
+
+  my_friends[0...parse_friends_count].each_with_index do |uid, index|
+    begin
+      print "Parsing your friends: #{index + 1} of #{parse_friends_count}. Good: #{good_friends}. Bad: #{bad_friends}\r"
+      friends = vk.api.friends_get(user_id: uid)['items']
+      good_friends += 1
+    rescue Vkontakte::API::Error
+      # Permission to perform this action is denied by user
+      bad_friends += 1
+      next
+    end
+    friends.each { |f| second_circle[f] += 1 }
+  end
+
+  puts "\nComplete"
+
+  second_circle.reject! { |uid, count| my_friends.include?(uid) || friends_requests.include?(uid) || current_user['id'] == uid || count < 2 }
+
+  puts "Total people in 2nd circle: #{second_circle.size}"
+
+  sorted_second_circle = second_circle.sort { |a, b| b[1] <=> a[1] } # <-- Hash sorting by value
+
+  # sorted_second_circle           # => [['uid1', 1], ['uid2', 2], ['uid3', 3]]
+  # sorted_second_circle.transpose # => [["uid1", "uid2", "uid3"], [1, 2, 3]]
+
+  common_friends = vk.api.users_get(user_ids: sorted_second_circle[0...99].transpose[0].join(',').to_s)
+
+  puts 'Getting common friends.'
+  common_friends = []
+  sorted_second_circle.each_slice(300) do |ids|
+    sleep 1
+    cf =  vk.api.users_get(user_ids: ids.transpose[0].join(',').to_s)
+    break if cf.empty?
+
+    common_friends << cf
+  end
+
+  common_friends.flatten!
+  puts "Total common friends: #{common_friends.size}"
+
+  sorted_second_circle.each do |uid, count|
+    sleep 1
+    user = vk.api.users_get(user_id: uid).first
+
+    next if  user['deactivated']
+
+    friend = common_friends.find { |f| f['id'] == uid }
+
+    next unless friend
+
+    puts "[#{count}]: [#{friend['id']}] #{friend['first_name']} #{friend['last_name']}"
+    vk.api.friends_add(user_id: friend['id'])
+  rescue Vkontakte::API::Error => e
+    puts e.message
+
+    case e.error_code
+    when 1
+      puts 'Come back tomorrow'
+      break
+    when 175, 176
+      next
+    else
+      sleep 60
+      retry
+    end
+  end
+
+end