vk_music 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e42dd22de66cd8bb8d2d0b70686102d4d50078677736b036b7c383470ff31f2a
-  data.tar.gz: c6d3eb20221b599d48a1e4464b837ef294d926b4bc9fbeb81b348e9ae5c63f90
+  metadata.gz: c25c28560c85999aeffe7b23070762fe875600eb32fde5758c5d02041a9d079b
+  data.tar.gz: 64b80f5fe01c1e8bf19ef95c6660ccbb5043b5fb07257c8590bb93f08af2b7e1
 SHA512:
-  metadata.gz: 515fbb7b67a8a53b0e2bc8ed0ef8f34a4cdda560ad94a4880ff8e9b36fb7d3c023386b6c2fca3d0df59eb19487d5a708d21684ddb3bf25bcbda4b2141506dd63
-  data.tar.gz: 40eac37ca4af3db6eb0d88a7e93277f923565c013207706e0d29e7b14a18354628d9bdb79b8eb71de753571a29a4ed93bbeb0e3adad697a4cdc6cfed3c9598a0
+  metadata.gz: 4bb0b4d69ad1699d760ab30e3e6149b3440318ab7edf2c42e2e17172d18c564f4922fde227089e2dc828658c34689599f93759fa5ea954af350f35747ba32cd2
+  data.tar.gz: 4cb018f20a3cae069616cb1f339703b9f9975f7939a1924225d1840562f30c9f759a21386f00729a499193bd11a3af7339e9b9860ed148cb6f6f3bdae834c0ae

data/lib/vk_music/client.rb

@@ -50,28 +50,42 @@ module VkMusic
     #@!group Loading audios
     
     ##
-    # Search for audio.
+    # @!macro [new] find__options
+    #   @option options [Symbol] :type (:audio) what to search for (you can find available values for this option above).
     #
-    # @note some audios might be removed from search.
+    # Search for audio or playlist.
+    #
+    # @note some audios and playlists might be removed from search.
     #
     # @todo search in group audios.
     #
-    # @overload find(query)
+    # Possible values of +type+ option:
+    # * +:audio+ - search for audios. Returns up to 50 audios.
+    # * +:playlist+ - search for playlists. Returns up to 6 playlists *without* audios (Loaded with +up_to: 0+ option). 
+    #   You can get all the audios of selected playlist calling {Client#playlist} method with gained info.
+    #
+    # @overload find(query, options)
     #   @param query [String] string to search for.
+    #   @macro options_hash_param
+    #   @macro find__options
     #
     # @overload find(options)
     #   @macro options_hash_param
     #   @option options [String] :query string to search for.
+    #   @macro find__options
     #
-    # @return [Array<Audio>] array with audios matching given string. Possibly empty.
-    #   Possibly contains audios without download URL.
-    def find(arg)
+    # @return [Array<Audio>, Array<Playlist>] array with audios or playlists matching given string. 
+    #   Possibly empty. Possibly contains audios or playlists without download URL.
+    def find(*args)
       begin
-        case arg
-          when String
-            query = arg
-          when Hash
-            query = arg[:query].to_s
+        case
+          when (args.size == 1 && String === args[0]) ||
+               (args.size == 2 && String === args[0] && Hash === args[1])
+            options = args[1] || {}
+            query = args[0]
+          when args.size == 1 && Hash === args[0]
+            options = args[0]
+            query = options[:query].to_s
           else
             raise
         end
@@ -79,10 +93,21 @@ module VkMusic
         raise ArgumentError, "Bad arguments", caller
       end
 
+      options[:type] ||= :audio
+
       uri = URI(Constants::URL::VK[:audios])
-      uri.query = Utility.hash_to_params({ "act" => "search", "q" => query.to_s })
 
-      audios__from_page(uri)
+      case options[:type]
+        when :audio
+          uri.query = Utility.hash_to_params({ "act" => "search", "q" => query })
+          audios__from_page(uri)
+        when :playlist
+          uri.query = Utility.hash_to_params({ "q" => query, "tab" => "global" })
+          urls = playlist_urls__from_page(uri)
+          urls.map { |url| playlist(url, up_to: 0, with_url: false) }
+        else
+          raise ArgumentError, "Bad :type option", caller
+      end
     end
     alias search find
     
@@ -130,7 +155,7 @@ module VkMusic
         raise ArgumentError, "Bad arguments", caller
       end
       
-      options[:up_to]    ||= Constants::MAXIMUM_PLAYLIST_SIZE
+      options[:up_to] ||= Constants::MAXIMUM_PLAYLIST_SIZE
       options[:with_url] = true if options[:with_url].nil?
 
       if options[:with_url]
@@ -350,8 +375,8 @@ module VkMusic
           rescue Exception => error
             raise Exceptions::ParseError, "Unable to get user or group ID. Custom ID: #{str}. Error: #{error.message}", caller
           end
-      else
-        raise Exceptions::ParseError, "Unable to convert \"#{str}\" into ID", caller
+        else
+          raise Exceptions::ParseError, "Unable to convert \"#{str}\" into ID", caller
       end
       id
     end
@@ -565,9 +590,9 @@ module VkMusic
         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
+          real_size = footer_match ? footer_match[0].to_i : 0
         else
-          playlist_size = 0
+          real_size = 0
         end
       rescue Exception => error
         raise Exceptions::ParseError, error.message, caller
@@ -577,7 +602,7 @@ module VkMusic
       first_page_audios = audios__from_page(first_page)
       
       # Check whether need to make additional requests
-      options[:up_to] = playlist_size if (options[:up_to] < 0 || options[:up_to] > playlist_size)
+      options[:up_to] = real_size if (options[:up_to] < 0 || options[:up_to] > real_size)
       list = first_page_audios[0, options[:up_to]]
       while list.length < options[:up_to] do
         playlist_page = load__page__playlist(owner_id, playlist_id, access_hash, offset: list.length)
@@ -590,6 +615,7 @@ module VkMusic
         :access_hash => access_hash,
         :title => title,
         :subtitle => subtitle,
+        :real_size => real_size
       })
     end
 
@@ -608,8 +634,8 @@ module VkMusic
         raise Exceptions::ParseError, error.message, caller
       end
       
-      total_count = first_data["totalCount"]
-      options[:up_to] = total_count if (options[:up_to] < 0 || options[:up_to] > total_count)
+      real_size = first_data["totalCount"]
+      options[:up_to] = real_size if (options[:up_to] < 0 || options[:up_to] > real_size)
       list = first_data_audios[0, options[:up_to]]
       while list.length < options[:up_to] do
         json = load__json__playlist_section(owner_id, playlist_id, access_hash,
@@ -625,9 +651,20 @@ module VkMusic
         :access_hash => first_data["access_hash"],
         :title => CGI.unescapeHTML(first_data["title"].to_s),
         :subtitle => CGI.unescapeHTML(first_data["subtitle"].to_s),
+        :real_size => real_size
       })
     end
 
+    # Found playlist on *global* search page
+    def playlist_urls__from_page(obj)
+      page = obj.class == Mechanize::Page ? obj : load__page(obj)
+      begin
+        page.css(".AudioSerp__foundGlobal .AudioPlaylistSlider .al_playlist").map { |elem| elem.attribute("href").to_s }
+      rescue Exception => error
+        raise Exceptions::ParseError, error.message, caller
+      end
+    end
+
     # Load audios from wall using JSON request.
     def wall__json(owner_id, post_id, options)
       if options[:up_to] < 0 || options[:up_to] > 91

data/lib/vk_music/constants.rb

@@ -24,7 +24,8 @@ module VkMusic
         login: "https://m.vk.com/login",
         login_action: "https://login.vk.com",
         wall: "https://m.vk.com/wall",
-        audio_unavailable: "https://m.vk.com/mp3/audio_api_unavailable.mp3"
+        audio_unavailable: "https://m.vk.com/mp3/audio_api_unavailable.mp3",
+        profile_audios: "https://m.vk.com/audios",
       }
 
     end
@@ -63,7 +64,7 @@ module VkMusic
       
       ##
       # Playlist URL regular expression.
-      VK_PLAYLIST_URL_POSTFIX = /.*audio_playlist(-?\d+)_(\d+)(?:(?:(?:&access_hash=)|\/|%2F)([\da-z]+))?/
+      VK_PLAYLIST_URL_POSTFIX = /.*audio_playlist(-?\d+)_(\d+)(?:(?:(?:.*(?=&access_hash=)&access_hash=)|\/|%2F)([\da-z]+))?/
 
       ##
       # Post URL regular expression #1.

data/lib/vk_music/playlist.rb

@@ -24,11 +24,17 @@ module VkMusic
     ##
     # @return [String, nil] playlist subtitle. May be empty.
     attr_reader :subtitle
+
+    ##
+    # @return [Integer, nil] real size of playlist or +nil+ if unknown.
+    attr_reader :real_size
     
     ##
     # @return [String] playlist description in Russian.
     def to_s
-      (@subtitle ? "#{@subtitle} - " : "") + "#{@title} (#{self.length} аудиозаписей)"
+      (@subtitle && !@subtitle.empty? ? "#{@subtitle} - " : "") +
+      @title +
+      (@real_size ? "(#{self.length} из #{@real_size} аудиозаписей загружено)" : " (#{self.length} аудиозаписей)")
     end
 
     ##
@@ -77,11 +83,12 @@ module VkMusic
     #
     # @param list [Array] list of audios in playlist.
     #
-    # @option options [Integer] :id
-    # @option options [Integer] :owner_id
-    # @option options [String] :access_hash
+    # @option options [Integer, nil] :id
+    # @option options [Integer, nil] :owner_id
+    # @option options [String, nil] :access_hash
     # @option options [String] :title
-    # @option options [String] :subtitle
+    # @option options [String, nil] :subtitle
+    # @option options [Integer, nil] :real_size
     def initialize(list, options = {})
       raise ArgumentError, "Bad arguments", caller unless list.class == Array      
       # Saving list
@@ -93,6 +100,7 @@ module VkMusic
       @access_hash = Utility.unless_nil_to String, options[:access_hash]
       @title       = options[:title].to_s
       @subtitle    = Utility.unless_nil_to String, options[:subtitle]
+      @real_size   = Utility.unless_nil_to Integer, options[:real_size]
     end
   
   end

data/lib/vk_music/utility.rb

@@ -39,8 +39,8 @@ module VkMusic
           :post
         when Constants::Regex::VK_URL
           :audios
-      else
-        :find
+        else
+          :find
       end
     end
 

data/test/test_find.rb

@@ -36,8 +36,20 @@ class TestVkMusic < MiniTest::Test
 
   def test_find_bad_arg
     assert_raises(ArgumentError) do
-      CLIENT.search("Good music", query: "or not")
+      CLIENT.search("Good music", "or not")
     end
   end
+
+  def test_find_playlist
+    results = CLIENT.find("OST", type: :playlist)
+    refute_empty(results, "There must be lot of playlists")
+    assert_empty(results[0], "Album must be empty")
+    refute_equal(0, results[0].real_size, "Album must actually have some audios")
+  end
+
+  def test_find_unexisting_playlist
+    results = CLIENT.find("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", type: :playlist)
+    assert_empty(results, "There must be no results for such query")
+  end
   
 end

data/test/test_playlist.rb

@@ -18,6 +18,12 @@ class TestVkMusic < MiniTest::Test
     refute_empty(pl[-1].url, "Audio must have download url")
   end
 
+  def test_big_url
+    pl = CLIENT.playlist("https://m.vk.com/audio?act=audio_playlist256492540_83617715&from=search_owned_playlist&access_hash=b8d408241bcfb60583&back_url=%2Faudios-39786657%3Fq%3Dmashup%26tab%3Downed&back_hash=76ef9186ac6f248a27")
+    refute_empty(pl, "This playlist must not be empty")
+    assert_instance_of(VkMusic::Audio, pl[0], "Playlist members must be of class Audio")
+  end
+
   def test_playlist_small_with_options
     pl = CLIENT.playlist(owner_id: -37661843, playlist_id: 1, access_hash: "0e420c32c8b69e6637", with_url: false)
     refute_empty(pl, "This playlist must not be empty")

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        = "2.0.0"
+  s.version        = "2.1.0"
   s.author         = "Kuznetsov Vladislav"
   s.email          = "fizvlad@mail.ru"
   s.homepage       = "https://github.com/fizvlad/vk-music-rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vk_music
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kuznetsov Vladislav
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize