vk_music 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 630c70ebe99cfb32de3d536247332448eba5100ed50e22b625942dd0bfae1ad1
-  data.tar.gz: 449db24fadc1762ebe302a7cd67ac302495b2d05987df3bcbaf105bf6a242ce4
+  metadata.gz: 75c5a7995475caabd8779990209db2cca18f9fb17227680e4f5925cd0fb93480
+  data.tar.gz: afb4818c76ea686851bb191154d46a09458655d14b9253659a93edbb4e83ebba
 SHA512:
-  metadata.gz: aa5706ff7955649611171b4b7fa6fdfabaad1b58c64b8fb2d4a2f594e83b5472d57f989377a4814517f489238e04fe7c2801a4b941e01edd945967256041b424
-  data.tar.gz: 39efc44662fb545306547b83e234b7804fc48d9079c84d0eca6d4276fa4a705ef83f2a6c348a42055c70c4c1ea42d789562d9f8e182bbee6bee092d099246f03
+  metadata.gz: f1c85be3faff79c6a5c6a00604c6108f76d5121384282783c4451334dd0653b9e0d9cd2e9690ed76e259c4646299283385406281e0a3c3b87e94506365ef1b9b
+  data.tar.gz: f3caed90799b89082654ddbdb048fdbf9df791add1c7b88710a48e96a69e9ee8e6096bd53d5a631da4498738b3a6c006149af3f43aff98c73b7840998722693b

data/README.md

@@ -12,45 +12,56 @@
 ## Installation
 
 Simpliest way to install gem:
-``
+```
 gem install vk_music
-``
+```
 
 Alternatively, you can build gem from sources with following command:
-``
+```
 gem build vk_music.gemspec
-``
+```
 
 ... and install it:
-``
-gem install vk_music-0.0.1.gem
-``
+```
+gem install vk_music-*.gem
+```
 
 
 ## Usage
 
 ### Logging in
 Firstly, it is required to create new *VkMusic::Client* and provide login credentials:
-```
+```ruby
 client = VkMusic::Client.new(username: "+71234567890", password: "password")
 ```
 
 ### Searching for audios
 You can search audios by name with following method:
-```
+```ruby
 audios = client.find_audio("Acid Spit - Mega Drive")
 puts audios[0]     # Basic information about audio
-puts audios[0].url # Download this audio using its URL
+puts audios[0].url # URL to access audio. Notice that it is only accessible from your IP
 ```
 
 ### Parsing playlists
 You can load all the audios from playlist using following method:
-```
+```ruby
 playlist = client.get_playlist("https://vk.com/audio?z=audio_playlist-37661843_1/0e420c32c8b69e6637")
 ```
 It is only possible to load up to 100 audios from playlist per request, so you can reduce amount of requests by setting up how many audios from playlist you actually need.
 For example, following method will perform only one HTML request:
-```
+```ruby
 playlist = client.get_playlist("https://vk.com/audio?z=audio_playlist121570739_7", 100)
 urls = playlist.map(&:url) # URLs for every audio
 ```
+
+### User or group audios
+You can load first 100 audios from user or group page. Those audios will be returned as playlist. To do it simply pass user or group id:
+```ruby
+user_playlist = client.get_audios("8024985")
+group_playlist = client.get_audios("-4790861") # Group and public id starts with '-'
+```
+You can set how many audios you actually need as well:
+```ruby
+user_playlist = client.get_audios("8024985", 10)
+```

data/Rakefile

@@ -1,6 +1,23 @@
+require "io/console"
+
 desc "Build gem file"
 task :build do
-  `gem build vk_music.gemfile`
+  puts `gem build vk_music.gemspec`
 end
 
-# TODO: Test task
+desc "Run tests"
+task :test do
+  puts "Running tests require login credetionals"
+  
+  print "Login:    "
+  username = STDIN.gets.chomp
+  
+  print "Password: "
+  password = STDIN.noecho(&:gets).chomp
+  puts
+  
+  Dir[ "test/test*.rb" ].each do |file|
+    puts "\n\nRunning #{file}:"
+    puts `ruby -w #{file} #{username} #{password}`
+  end
+end

data/lib/vk_music/audio.rb

@@ -37,7 +37,22 @@ module VkMusic
         :title => node.at_css(".ai_title").text.strip,
         :duration => node.at_css(".ai_dur").attribute("data-dur").to_s.to_i,
         :url_encoded => url_encoded,
-        :url => url_encoded ? VkMusic.unmask_link(url_encoded, client_id) : "",
+        :url => url_encoded ? VkMusic.unmask_link(url_encoded, client_id) : nil,
+      })
+    end
+    
+    def self.from_data_array(data, client_id)
+      url_encoded = data[2]
+      url_encoded = nil if url_encoded == ""
+      
+      new({
+        :id => data[0],
+        :owner_id => data[1],
+        :artist => data[4],
+        :title => data[3],
+        :duration => data[5],
+        :url_encoded => url_encoded,
+        :url => url_encoded ? VkMusic.unmask_link(url_encoded, client_id) : nil,
       })
     end
   

data/lib/vk_music/client.rb

@@ -1,4 +1,5 @@
 require "mechanize"
+require "json"
 
 module VkMusic
 
@@ -22,8 +23,8 @@ module VkMusic
     
     def find_audio(query)
       uri = URI(VK_URL[:audios])
-      uri.query = URI.encode_www_form("act" => "search", "q" => query.to_s)
-      load_audios_from(uri)
+      uri.query = URI.encode_www_form({ "act" => "search", "q" => query.to_s })
+      load_audios_from_page(uri)
     end
     
     def get_playlist(url, up_to = nil)
@@ -31,18 +32,25 @@ module VkMusic
 
       # Load first page and get info
       first_page = load_playlist_page(owner_id: owner_id, id: id, access_hash: access_hash, offset: 0)
-      title = first_page.at_css(".audioPlaylist__title").text.strip
-      subtitle = first_page.at_css(".audioPlaylist__subtitle").text.strip
       
-      footer_node = first_page.at_css(".audioPlaylist__footer")
-      if footer_node
-        footer_match = footer_node.text.strip.match(/^\d+/)
-        playlist_size = footer_match ? footer_match[0].to_i : 0
-      else
-        playlist_size = 0
+      # Trying to parse out essential data
+      begin
+        title = first_page.at_css(".audioPlaylist__title").text.strip
+        subtitle = first_page.at_css(".audioPlaylist__subtitle").text.strip
+        
+        footer_node = first_page.at_css(".audioPlaylist__footer")
+        if footer_node
+          footer_match = footer_node.text.strip.match(/^\d+/)
+          playlist_size = footer_match ? footer_match[0].to_i : 0
+        else
+          playlist_size = 0
+        end
+      rescue Exception => error
+        raise PlaylistParseError, "unable to parse playlist page. Redirected to #{first_page.uri.to_s}. Error: #{error.message}", caller
       end
+      # Now we can be sure we are on correct page
       
-      first_page_audios = load_audios_from(first_page)
+      first_page_audios = load_audios_from_page(first_page)
       
       # Check whether need to make additional requests
       up_to = playlist_size if (up_to.nil? || up_to < 0 || up_to > playlist_size)
@@ -52,7 +60,7 @@ module VkMusic
         list = first_page_audios
         loop do
           playlist_page = load_playlist_page(owner_id: owner_id, id: id, access_hash: access_hash, offset: list.length)
-          list.concat(load_audios_from(playlist_page)[0, up_to - list.length])
+          list.concat(load_audios_from_page(playlist_page)[0, up_to - list.length])
           break if list.length == up_to
         end        
       end
@@ -66,24 +74,80 @@ module VkMusic
       })
     end
     
+    def get_audios(id, up_to = nil)
+      Warning.warn("Current implementation of method VkMusic::Client#get_audios is only able to load first 100 audios from user page.\n") if (up_to && up_to > 100)
+      # NOTICE: this method is only able to load first 100 audios
+      
+      # Trying to parse out audios
+      begin
+        first_json = load_playlist_json_section(id: id.to_s, playlist_id: -1, offset: 0)
+        first_data = first_json["data"][0]
+        first_data_audios = load_audios_from_data(first_data)
+      rescue Exception => error
+        raise AudiosSectionParseError, "unable to load or parse audios section: #{error.message}", caller
+      end
+      
+      #total_count = first_data["totalCount"] # NOTICE: not used due to restrictions dexcribed above
+      total_count = first_data_audios.length
+      up_to = total_count if (up_to.nil? || up_to < 0 || up_to > total_count)
+      list = first_data_audios[0, up_to]      
+      
+      # It turns out user audios are just playlist with id -1
+      Playlist.new(list, {
+        :id => first_data["id"],
+        :owner_id => first_data["owner_id"],
+        :access_hash => first_data["access_hash"],
+        :title => first_data["title"],
+        :subtitle => first_data["subtitle"],
+      })
+    end
+    
     private
     # Loading pages
     def load_page(url)
       uri = URI(url) if url.class != URI      
       @agent.get(uri)
     end
+    def load_json(url)
+      page = load_page(url)
+      JSON.parse(page.body.strip)
+    end
+    
     def load_playlist_page(options)
       uri = URI(VK_URL[:audios])
-      uri.query = URI.encode_www_form("act" => "audio_playlist#{options[:owner_id]}_#{options[:id]}", "access_hash" => options[:access_hash].to_s, "offset" => options[:offset].to_i)
+      uri.query = URI.encode_www_form({
+        "act" => "audio_playlist#{options[:owner_id]}_#{options[:id]}",
+        "access_hash" => options[:access_hash].to_s,
+        "offset" => options[:offset].to_i
+      })
       load_page(uri)
     end
+    def load_playlist_json_section(options)
+      uri = URI(VK_URL[:audios])
+      uri.query = URI.encode_www_form({
+        "act" => "load_section",
+        "owner_id" => options[:id],
+        "playlist_id" => options[:playlist_id],
+        "type" => "playlist",
+        "offset" => options[:offset].to_i,
+        "utf8" => true
+      })
+      begin
+        load_json(uri)
+      rescue Exception => error
+        raise AudiosSectionParseError, "unable to load or parse audios section: #{error.message}", caller
+      end
+    end
     
     
     # Loading audios
-    def load_audios_from(obj)
+    def load_audios_from_page(obj)
       page = obj.class == Mechanize::Page ? obj : load_page(obj)
       page.css(".audio_item.ai_has_btn").map { |elem| Audio.from_node(elem, @id) }
     end 
+    def load_audios_from_data(data)
+      data["list"].map { |audio_data| Audio.from_data_array(audio_data, @id) }
+    end
     
     
     def login(username, password)

data/lib/vk_music/exceptions.rb

@@ -4,4 +4,16 @@ module VkMusic
     # Unable to login
   end
   
+  class PlaylistParseError < RuntimeError
+    # Unable to find playlist or got permission error
+  end
+  
+  class AudiosParseError < RuntimeError
+    # Unable to find user/group or got permission error
+  end
+  
+  class AudiosSectionParseError < AudiosParseError
+    # Unable to load or parse audios section
+  end
+  
 end

data/lib/vk_music/playlist.rb

@@ -21,6 +21,10 @@ module VkMusic
     def [](index)
       @list[index]
     end
+    
+    def empty?
+      @list.empty?
+    end
   
     def initialize(list, options = {})
       # Arguments check

data/test/test_login.rb

@@ -1,12 +1,29 @@
 require "minitest/autorun"
 require_relative "../lib/vk_music.rb"
 
-class Example < MiniTest::Test
+class TestVkMusic < MiniTest::Test
+
   def test_bad_data
-    assert_raises(VkMusic::LoginError) {
-      client = VkMusic::Client.new(username: "login", password: "password")
-    }
+    assert_raises(VkMusic::LoginError) do
+      VkMusic::Client.new(username: "login", password: "password")
+    end
+  end
+  
+  def test_empty_data
+    assert_raises(VkMusic::LoginError) do
+      VkMusic::Client.new(username: "", password: "")
+    end
+  end
+  
+  def test_good_data
+    begin
+      client = VkMusic::Client.new(username: ARGV[0], password: ARGV[1])
+    rescue VkMusic::LoginError
+      puts "Unable to login! Please check provided credetionals"
+    end
+    refute_nil(client, "Client not defined")
+    refute_nil(client.name, "User name undefined")
+    refute_nil(client.id, "User id undefined")
   end
   
-  # TODO: any way to test correct login?
 end

data/test/test_playlist.rb

@@ -0,0 +1,52 @@
+require "minitest/autorun"
+require_relative "../lib/vk_music.rb"
+
+begin
+  CLIENT = VkMusic::Client.new(username: ARGV[0], password: ARGV[1])
+rescue VkMusic::LoginError
+  puts "Unable to login! Please check provided credetionals"
+  exit
+end
+
+class TestVkMusic < MiniTest::Test
+
+  def test_playlist_small
+    pl = CLIENT.get_playlist("https://vk.com/audio?z=audio_playlist-37661843_1/0e420c32c8b69e6637")
+    refute_empty(pl, "This playlist must not be empty")
+    assert_instance_of(VkMusic::Audio, pl[0], "Playlist members must be of class Audio")
+    refute_empty(pl[0].url, "Audio must have download url")
+    refute_empty(pl[-1].url, "Audio must have download url")
+  end
+  
+  def test_playlist_large
+    pl = CLIENT.get_playlist("https://vk.com/audio?z=audio_playlist121570739_7")
+    refute_empty(pl, "This playlist must not be empty")
+    refute_empty(pl[0].url, "Audio must have download url")
+    refute_empty(pl[-1].url, "Audio must have download url")
+  end
+  
+  def test_playlist_empty
+    pl = CLIENT.get_playlist("https://vk.com/audios437727675?section=playlists&z=audio_playlist437727675_2")
+    assert_empty(pl, "This playlist must be empty")
+  end
+  
+  def test_playlist_dont_exist    
+    assert_raises(VkMusic::PlaylistParseError) do
+      CLIENT.get_playlist("https://m.vk.com/audio?act=audio_playlist437727675_300")
+    end
+  end
+  
+  def test_playlist_no_access    
+    assert_raises(VkMusic::PlaylistParseError) do
+      CLIENT.get_playlist("https://m.vk.com/audio?act=audio_playlist1_1")
+    end
+  end
+  
+  def test_playlist_with_upper_limit
+    pl = CLIENT.get_playlist("https://vk.com/audio?z=audio_playlist121570739_7", 113)
+    assert_equal(113, pl.length, "Size of result must match given limit") # This playlist got more audios
+    refute_empty(pl[0].url, "Audio must have download url")
+    refute_empty(pl[-1].url, "Audio must have download url")
+  end
+  
+end

data/test/test_search.rb

@@ -0,0 +1,30 @@
+require "minitest/autorun"
+require_relative "../lib/vk_music.rb"
+
+begin
+  CLIENT = VkMusic::Client.new(username: ARGV[0], password: ARGV[1])
+rescue VkMusic::LoginError
+  puts "Unable to login! Please check provided credetionals"
+  exit
+end
+
+class TestVkMusic < MiniTest::Test
+
+  def test_search
+    results = CLIENT.find_audio("Rick Astley")
+    refute_empty(results, "There must be some music of Rick Astley")
+    assert_instance_of(VkMusic::Audio, results[0], "Results of search must be of class Audio")
+    refute_empty(results[0].url, "Audio must have download url")
+  end
+  
+  def test_search_no_query
+    results = CLIENT.find_audio("")
+    assert_empty(results, "There must be no results for empty query")
+  end
+  
+  def test_search_no_results
+    results = CLIENT.find_audio("I'm pretty sure no one ever would name a song like this 282E8EE")
+    assert_empty(results, "There must be no results for such query")
+  end
+  
+end

data/test/test_user_or_group_audios.rb

@@ -0,0 +1,62 @@
+require "minitest/autorun"
+require_relative "../lib/vk_music.rb"
+
+begin
+  CLIENT = VkMusic::Client.new(username: ARGV[0], password: ARGV[1])
+rescue VkMusic::LoginError
+  puts "Unable to login! Please check provided credetionals"
+  exit
+end
+
+class TestVkMusic < MiniTest::Test
+
+  def test_user
+    pl = CLIENT.get_audios("8024985")
+    assert_instance_of(VkMusic::Playlist, pl, "User audios must be returned as a playlist (cause it is actually is playlist)")
+    refute_empty(pl, "There must be some music")
+    assert_instance_of(VkMusic::Audio, pl[0], "Results must be of class Audio")
+    refute_empty(pl[0].url, "Audio must have download url")
+  end
+
+  def test_incorrect_id
+    assert_raises(VkMusic::AudiosParseError) do
+      CLIENT.get_audios("42424242424242424242424242")
+    end
+  end
+  
+  def test_user_with_locked_audios
+    assert_raises(VkMusic::AudiosParseError) do
+      CLIENT.get_audios("152719703")
+    end
+  end
+  
+  def test_user_with_empty_audios
+    pl = CLIENT.get_audios("437727675")
+    assert_empty(pl, "This user got no audios")
+  end
+  
+  def test_group
+    pl = CLIENT.get_audios("-4790861")
+    refute_empty(pl, "There must be some music")
+    refute_empty(pl[0].url, "Audio must have download url")
+  end
+  
+  def test_group_with_upper_limit_1
+    pl = CLIENT.get_audios("-72589944", 10)
+    assert_equal(10, pl.length, "Size of result must match given limit") # This group got more audios
+    refute_empty(pl[0].url, "Audio must have download url")
+  end
+  
+  def test_group_with_upper_limit_2
+    pl = CLIENT.get_audios("-72589944", 200)
+    assert(pl.size <= 200, "Size of result must match given limit")
+    refute_empty(pl[0].url, "Audio must have download url")
+    refute_empty(pl[-1].url, "Audio must have download url")
+  end
+  
+  def test_group_with_no_audios
+    pl = CLIENT.get_audios("-52298374")
+    assert_empty(pl, "This group got no audios")
+  end
+  
+end

data/vk_music.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.name           = "vk_music"
   s.summary        = "Provides interface to work with VK music via HTTP requests"
   s.description    = "Library to work with audios on popular Russian social network vk.com. VK disabled their public API for audios, so it is now necessary to use parsers instead."
-  s.version        = "0.0.2"
+  s.version        = "0.1.1"
   s.author         = "Kuznetsov Vladislav"
   s.email          = "fizvlad@mail.ru"
   s.homepage       = "https://github.com/fizvlad/vk-music-rb"
@@ -15,4 +15,5 @@ Gem::Specification.new do |s|
   
   s.add_runtime_dependency "mechanize", "~>2.7"
   s.add_runtime_dependency "duktape",   "~>2.3"
+  s.add_runtime_dependency "json",      "~>2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vk_music
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Kuznetsov Vladislav
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Library to work with audios on popular Russian social network vk.com.
   VK disabled their public API for audios, so it is now necessary to use parsers instead.
 email: fizvlad@mail.ru
@@ -57,6 +71,9 @@ files:
 - lib/vk_music/playlist.rb
 - lib/vk_music/utility.rb
 - test/test_login.rb
+- test/test_playlist.rb
+- test/test_search.rb
+- test/test_user_or_group_audios.rb
 - vk_music.gemspec
 homepage: https://github.com/fizvlad/vk-music-rb
 licenses:
@@ -84,3 +101,6 @@ specification_version: 4
 summary: Provides interface to work with VK music via HTTP requests
 test_files:
 - test/test_login.rb
+- test/test_playlist.rb
+- test/test_search.rb
+- test/test_user_or_group_audios.rb