vk_music_loader 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11cfe23b6159ba7d08706798eab0e8a0f28c37f3
-  data.tar.gz: 683f6784ac82fe6a11833d2a64016a3a4e83a53f
+  metadata.gz: 9487bed8735df5dec33b4295a2d70b28cec9d7f1
+  data.tar.gz: 3320b8a52fcf60e408c0aa412ab5f9508d87d8f8
 SHA512:
-  metadata.gz: 1794e5ae7fa4c128e2975d36231d30d46b69faff7e276359acbbab5188062db6aa0e186898f0f1ebb7b85ac4672a45d72d98b1e25dba5c3f90d5d33a722a0d0f
-  data.tar.gz: 463449e9f906f3a3bb1700f0c27651f5370b5cd5225c1857909c8d88553b70d765aeb0c6ee09e1465e9efa3723da5e689d51ef24eba1c11ead3b37031ab66687
+  metadata.gz: 8da45f9d965ef76e98dc6e088354389d76c9bf47de021e3c740ecd16a4ac8aadc2810ff58d79775dff019c3d2ae87856e34acdef9a0b5107bac21f219b2af160
+  data.tar.gz: c852c6fc59de8494da3d92917d3be15f15d1b447e97a4de9d80ceae21ef2e76e5c10611d40dfa53c0a43ec2d0756bf82d5ac58694127520378ac0c94299c23e7

data/README.md

@@ -1,22 +1,46 @@
-# VkMusicLoader
+# VK Music Loader
 
+<a href="https://vk.com"><img src="https://cdn2.iconfinder.com/data/icons/vkontakte-3/154/api-vk-vkontakte-programming-128.png" align="left" hspace="10" vspace="6" width="50" height="50"></a>
+
+**VK Music Loader** is a simple CLI Ruby gem to download music from VK (ВКонта́кте) using easy and convenient way of authorization  - [Implicit Flow](https://new.vk.com/dev/implicit_flow_user)
+This gem aimed at Ruby 2.0 or later.
 
 ## Installation
 
-```
-gem install vk_music_loader
+```sh
+$ gem install vk_music_loader
 ```
 
 ## Usage
 
-```
-vk_music_loader -id user_or_group_id [-app your_standalone_app_id] [-folder folder_path_to_download_music]
+To login you will need [create Standalone Application](https://new.vk.com/editapp?act=create) or use the author's application (default APP ID: `5377636`)
+
+```sh
+$ vk_music_loader -id USER_OR_GROUP_ID
+$ vk_music_loader -q QUERY_SEARCH
+  [ -app (or -app, --app, -application, --application) your_standalone_app_id (default: 5377636) ]
+  [ -count (or count, -count, --count, c, -c, --c) count_of_songs ]
+  [ -folder (or -folder, --folder, path, -path, --path, -p) folder_path_to_download_music (default: 'music') ]
+  [ -random (or  --random, shuffle, -shuffle, --shuffle, -r) shuffle_download_flag (default: false) ]
 ```
 
+If the song is already in the folder, it will not be downloaded.
+## Usage examples
+```sh
+# Download all music from VK Public:
+$ vk_music_loader -id -45172096
+
+# Download 20 first songs from user in specified folder:
+$ vk_music_loader -id 243556640 -с 20 -p '/Volumes/FLASHKA/music_in_da_bass_car'
+
+# Download 4 random Eminem Song:
+$ vk_music_loader -q 'Eminem' -c 4 -r
+```
+![](https://github.com/m1neral/vk_music_loader/blob/gh-wiki/wiki_src/record.gif)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vk_music_loader.
+Bug reports and pull requests are welcome on GitHub at https://github.com/m1neral/vk_music_loader.
 
 
 ## License

data/bin/vk_music_loader

@@ -2,10 +2,4 @@
 
 require 'vk_music_loader'
 
-opts = Slop.parse do |o|
-  o.integer 'app', '-app', '--app', '-application', '-application', default: 5377636 # author's application (you can use it)
-  o.integer 'id', '-id', '--id', '-user-id', '--user-id', '-group-id', '--group-id'
-  o.string 'folder', '-folder', '--folder', 'path', '-path', '--path', default: 'audio'
-end
-
-VkMusicLoader.call(opts)
+VkMusicLoader.call

data/lib/vk_music_loader.rb

@@ -14,8 +14,25 @@ require 'vk_music_loader/authorizer'
 require 'vk_music_loader/songs_downloader'
 
 module VkMusicLoader
-  def self.call(opts)
-    auth_token = Authorizer.new(opts[:app]).perform
-    SongsDownloader.new(auth_token, opts[:id], opts[:folder]).perform
+  def self.call
+    begin
+      opts = Slop.parse uppress_errors: true do |o|
+        o.integer 'app', '-app', '--app', '-application', '-application', default: 5377636 # author's application (you can use it)
+        o.integer 'id', '-id', '--id', '-user-id', '--user-id', '-group-id', '--group-id'
+        o.string 'query', '-query', '--query', '-q', 'search', '-search', '--search'
+        o.integer 'count', '-count', '--count', 'c', '-c', '--c'
+        o.string 'folder', '-folder', '--folder', 'path', '-path', '--path', '-p', default: 'audio'
+        o.bool 'random', '-random', '--random', 'shuffle', '-shuffle', '--shuffle', '-r'
+      end
+
+      if opts[:id] || opts[:query]
+        auth_token = VkMusicLoader::Authorizer.new(opts[:app]).perform
+        VkMusicLoader::SongsDownloader.new(auth_token, opts).perform
+      else
+        puts 'No user id or group id or query'
+      end
+    rescue Slop::Error => e
+      puts e.message
+    end
   end
 end

data/lib/vk_music_loader/authorizer.rb

@@ -1,6 +1,14 @@
 module VkMusicLoader
   class Authorizer
-    AUTH_FILE_PATH = File.expand_path('~') + '/.vk_auth_data'
+    AUTH_FILE_PATH = File.expand_path('~') + '/.vk_music_loader/auth_data'
+
+    AUTHORIZE_API_PATH = 'https://oauth.vk.com/authorize'
+    QUERY_PARAMS = {
+        scope: 'audio',
+        redirect_uri: 'http://oauth.vk.com/blank.html',
+        display: 'page',
+        response_type: 'token'
+    }
 
     def initialize(app_id)
       @app_id = app_id
@@ -14,15 +22,30 @@ module VkMusicLoader
 
     attr_reader :app_id
 
-    def get_auth_params_from_browser_bar
-      Launchy.open("https://oauth.vk.com/authorize?client_id=#{app_id}&scope=audio&redirect_uri=http://oauth.vk.com/blank.html&display=page&response_type=token")
+    def query_params
+      QUERY_PARAMS.merge(client_id: app_id)
+    end
+
+    def build_uri
+      uri = URI(AUTHORIZE_API_PATH)
+      uri.query = URI.encode_www_form(query_params)
+      uri
+    end
+
+    def get_auth_params_from_browser_bar(uri)
       ARGV.clear
+
+      Launchy.open(uri)
       puts 'Paste full URL from browser bar and press ENTER: '
       CGI.parse(URI(gets.chomp.strip).fragment)
     end
 
     def save_auth_params_to_file
-      auth_params = get_auth_params_from_browser_bar
+      auth_params = get_auth_params_from_browser_bar(build_uri)
+
+      dir_path = File.dirname(AUTH_FILE_PATH)
+      Dir.mkdir(dir_path) unless File.exists?(dir_path)
+
       auth_file = File.open(AUTH_FILE_PATH, 'w')
       auth_file.puts(Time.new + auth_params['expires_in'].first.to_i)
       auth_file.puts(auth_params['access_token'].first)

data/lib/vk_music_loader/songs_downloader.rb

@@ -1,49 +1,103 @@
 module VkMusicLoader
   class SongsDownloader
-    def initialize(auth_token, user_id, audio_folder_path)
+    API_AUDIO_METHOD_PATHS = {
+        get: 'https://api.vk.com/method/audio.get',
+        search: 'https://api.vk.com/method/audio.search'
+    }
+
+    QUERY_PARAMS = {
+        v: '5.53'
+    }
+
+    def initialize(auth_token, opts)
       @auth_token = auth_token
-      @user_id = user_id
-      @audio_folder_path = audio_folder_path
+      @opts = opts
     end
 
     def perform
-      download_songs(get_playlist(auth_token))
+      raw_playlist = get_raw_playlist
+
+      if raw_playlist['error']
+        puts raw_playlist['error']['error_msg']
+      else
+        download_songs(get_milled_playlist(raw_playlist))
+      end
     end
 
     private
 
-    attr_reader :auth_token, :user_id, :audio_folder_path
+    attr_reader :auth_token, :opts
+
+    def query_params
+      merged_query_params = QUERY_PARAMS.merge(access_token: auth_token)
+      merged_query_params[:owner_id] = opts[:id] unless opts[:query]
+      merged_query_params[:q] = opts[:query] unless opts[:id]
+      merged_query_params[:count] = 300 if opts[:query]
+      # In other cases, do not set the number of audios, because bug: https://new.vk.com/bugs?act=show&id=5502832_1
 
-    def get_playlist(auth_token)
-      http = Net::HTTP.new('api.vk.com', 443)
+      merged_query_params
+    end
+
+    def audio_method_path
+      if opts[:id]
+        API_AUDIO_METHOD_PATHS[:get]
+      elsif opts[:query]
+        API_AUDIO_METHOD_PATHS[:search]
+      end
+    end
+
+    def build_uri
+      uri = URI(audio_method_path)
+      uri.query = URI.encode_www_form(query_params)
+      uri
+    end
+
+    def build_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
 
-      req = Net::HTTP::Get.new("https://api.vk.com/method/audio.get?owner_id=#{user_id}&v=5.50&access_token=#{auth_token}")
-      res = http.request(req)
+    def get_raw_playlist
+      uri = build_uri
+      req = Net::HTTP::Get.new(uri)
+      res = build_http(uri).request(req)
 
       JSON.parse(res.body)
     end
 
+    def get_milled_playlist(raw_playlist)
+      songs = raw_playlist['response']['items']
+      songs_count = opts[:count] || songs.count
+
+      opts[:random] ? songs.sample(songs_count) : songs.take(songs_count)
+    end
+
     def download_songs(playlist)
-      Dir.mkdir(audio_folder_path) unless File.exists?(audio_folder_path)
+      Dir.mkdir(opts[:folder]) unless File.exists?(opts[:folder])
 
-      songs = playlist['response']['items']
+      downloads_count = 0
 
-      songs.each do |song|
+      playlist.each do |song|
         song_url = URI.parse(song['url'])
-        file_name = "#{song['artist']} - #{song['title']}.mp3"
-        file_path = "#{audio_folder_path}/#{file_name}"
+        file_name = "#{song['artist']} - #{song['title']}".slice(0, 100).gsub(/[\x00\/\\:\*\?\"<>\|]/, '_') + '.mp3'
+        file_path = "#{opts[:folder]}/#{file_name}"
 
         unless File.file?(file_path)
           File.open(file_path, 'w') do |f|
             f.write Net::HTTP.get(song_url)
             f.close
 
+            downloads_count += 1
             puts "Downloaded: #{file_name}"
           end
         end
       end
+
+      puts "-----> Downloaded #{downloads_count} songs in #{opts[:folder]}"
+      puts "-----> The other #{playlist.count - downloads_count} songs have been already downloaded" if
+          playlist.count - downloads_count > 0
     end
   end
 end

data/lib/vk_music_loader/trash.rb

@@ -1,4 +1,3 @@
-
 require 'rubygems'
 require 'time'
 require 'cgi'
@@ -12,11 +11,22 @@ require 'launchy'
 require '../vk_music_loader/authorizer'
 require '../vk_music_loader/songs_downloader'
 
-opts = Slop.parse do |o|
-  o.integer 'app', '-app', '--app', '-application', '-application', default: 5377636 # author's application (you can use it)
-  o.integer 'id', '-id', '--id', '-user-id', '--user-id', '-group-id', '--group-id'
-  o.string 'folder', '-folder', '--folder', 'path', '-path', '--path', default: 'audio'
-end
+begin
+  opts = Slop.parse uppress_errors: true do |o|
+    o.integer 'app', '-app', '--app', '-application', '-application', default: 5377636 # author's application (you can use it)
+    o.integer 'id', '-id', '--id', '-user-id', '--user-id', '-group-id', '--group-id'
+    o.string 'query', '-query', '--query', '-q', 'search', '-search', '--search'
+    o.integer 'count', '-count', '--count', 'c', '-c', '--c'
+    o.string 'folder', '-folder', '--folder', 'path', '-path', '--path', '-p', default: 'audio'
+    o.bool 'random', '-random', '--random', 'shuffle', '-shuffle', '--shuffle', '-r'
+  end
 
-auth_token = VkMusicLoader::Authorizer.new(opts[:app]).perform
-VkMusicLoader::SongsDownloader.new(auth_token, opts[:id], opts[:folder]).perform
+  if opts[:id] || opts[:query]
+    auth_token = VkMusicLoader::Authorizer.new(opts[:app]).perform
+    VkMusicLoader::SongsDownloader.new(auth_token, opts).perform
+  else
+    puts 'No user id or group id or query'
+  end
+rescue Slop::Error => e
+  puts e.message
+end

data/lib/vk_music_loader/version.rb

@@ -1,3 +1,3 @@
 module VkMusicLoader
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vk_music_loader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anatoly Ryabov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.4'
 description: Download your VK playlist in one command
 email:
 - a.ryabov1993@gmail.com