vk_music 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ce8368cee1e94e3f1351753ba42167f2310148d22c96d274fa0056cda2e06d
-  data.tar.gz: ff35c242aaf9eecdc529eb478346a6e7883d1eb437d7f4fe163d36ebc893092a
+  metadata.gz: 3e95f75b40e89ac4f7d51056b3412f343e171a92431ebab522a998120df7f2d8
+  data.tar.gz: 03613c0cd92fd68728c25f04442c8d8f7c24276b52c7e2af4c4c448a319c9c10
 SHA512:
-  metadata.gz: c08525601176055fb0c94f666f28a654cea22f196db413d4e9bd0a425e716bcc1752e1f4f9e6de87772d105db41629aa5bb149de5b8cfaa42f020f57038a4d4a
-  data.tar.gz: 7ccd31000b153925a63b69c6d796bfa9d58adf2c8b2fc1ed86c99024f913590bfcba32bb29b27c89c61cb630d6a540f55a4417051d8145601c2d7a5e732e4d9c
+  metadata.gz: c32a1cabae2d9307e074132ccc69edf174df097d5fbf4c9a2fc596f33ca58f1cbbf49dab2c9ddbf21200e9f76326ab7926c1c68fc8b0dc81837c9faf1e9273f4
+  data.tar.gz: b836b42444769bde9ea746aafa62300800d0d4c5e673b8c6ce6c4ff060ce20d152a8fd6b18189d1c63dce3d0203def9aab42d20fc2c4db181489906f8dcced01

data/Gemfile

@@ -1,8 +1,10 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in vk_music.gemspec
-gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vk_music.gemspec
+gemspec
 
 gem "logger", "~> 1.4"
 
 gem "mechanize", "~> 2.7"
+
+gem "pry", "~> 0.12.2"

data/Gemfile.lock

@@ -1,60 +1,66 @@
-PATH
-  remote: .
-  specs:
-    vk_music (2.2.1)
-      execjs (~> 2.7)
-      json (~> 2.0)
-      logger (~> 1.4)
-      mechanize (~> 2.7)
-      net-http-persistent (= 2.9.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    execjs (2.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    json (2.2.0)
-    logger (1.4.1)
-    mechanize (2.7.6)
-      domain_name (~> 0.5, >= 0.5.1)
-      http-cookie (~> 1.0)
-      mime-types (>= 1.17.2)
-      net-http-digest_auth (~> 1.1, >= 1.1.1)
-      net-http-persistent (>= 2.5.2)
-      nokogiri (~> 1.6)
-      ntlm-http (~> 0.1, >= 0.1.1)
-      webrobots (>= 0.0.9, < 0.2)
-    mime-types (3.3)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    mini_portile2 (2.4.0)
-    minitest (5.12.2)
-    net-http-digest_auth (1.4.1)
-    net-http-persistent (2.9.4)
-    nokogiri (1.10.4-x64-mingw32)
-      mini_portile2 (~> 2.4.0)
-    ntlm-http (0.1.1)
-    rake (10.5.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-    webrobots (0.1.2)
-    yard (0.9.20)
-
-PLATFORMS
-  x64-mingw32
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  logger (~> 1.4)
-  mechanize (~> 2.7)
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  vk_music!
-  yard (~> 0.9)
-
-BUNDLED WITH
-   2.0.2
+PATH
+  remote: .
+  specs:
+    vk_music (3.0.0)
+      execjs (~> 2.7)
+      json (~> 2.0)
+      logger (~> 1.4)
+      mechanize (~> 2.7)
+      net-http-persistent (= 2.9.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    execjs (2.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.2.0)
+    logger (1.4.1)
+    mechanize (2.7.6)
+      domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0)
+      mime-types (>= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (>= 2.5.2)
+      nokogiri (~> 1.6)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (2.9.4)
+    nokogiri (1.10.7-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    ntlm-http (0.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    webrobots (0.1.2)
+    yard (0.9.20)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  logger (~> 1.4)
+  mechanize (~> 2.7)
+  minitest (~> 5.0)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  vk_music!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -1,81 +1,87 @@
-# VkMusic
-
-*vk_music* gem is a library to work with audios on popular Russian social network [vk.com](https://www.vk.com "vk.com"). VK disabled their public API for audios, so it is now necessary to use parsers instead.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'vk_music'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install vk_music
-
-## Usage
-
-You can take a look on documentation [here](https://www.rubydoc.info/gems/vk_music/).
-
-### 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("Acid Spit - Mega Drive")
-puts audios[0]     # Basic information about audio
-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.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.playlist("https://vk.com/audio?z=audio_playlist121570739_7", up_to: 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.audios(owner_id: 8024985)
-group_playlist = client.audios(owner_id: -4790861) # Group and public id starts with '-'
-```
-You can set how many audios you actually need as well:
-```ruby
-user_playlist = client.audios(owner_id: 8024985, up_to: 10)
-```
-
-### Audios from post
-You can load up to 10 audios attached to some post. Those audios will be returned as array:
-```ruby
-audios = client.post("https://vk.com/wall-4790861_5453")
-```
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/fizvlad/vk-music-rb/issues.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# VkMusic
+
+*vk_music* gem is a library to work with audios on popular Russian social network [vk.com](https://www.vk.com "vk.com"). VK disabled their public API for audios, so it is now necessary to use parsers instead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vk_music'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vk_music
+
+## Usage
+
+You can take a look on documentation [here](https://www.rubydoc.info/gems/vk_music/).
+
+### 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("Acid Spit - Mega Drive")
+puts audios[0]     # Basic information about audio
+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.playlist(url: "https://vk.com/audio?z=audio_playlist-37661843_1/0e420c32c8b69e6637")
+last_audios = playlist.first(10) # => Array<Audio>
+client.update_urls(last_audios) # We have to manually retrieve URLs for playlists
+urls = last_audios.map(&:url) # URLs for every audio
+```
+
+### User or group audios
+You can load audios from user or group page. Those audios will be returned as playlist. To do it simply pass user or group id:
+
+```ruby
+playlist = client.audios(owner_id: 8024985)
+last_audios = playlist.first(10) # => Array<Audio>
+client.update_urls(last_audios) # We have to manually retrieve URLs for playlists
+urls = last_audios.map(&:url) # URLs for every audio
+```
+You can set how many audios you actually need as well:
+
+```ruby
+user_playlist = client.audios(url: "vk.com/id8024985", up_to: 10)
+```
+
+### Audios from post
+You can load up to 10 audios attached to some post. Those audios will be returned as array:
+
+```ruby
+audios = client.post(url: "https://vk.com/wall-4790861_5453")
+urls = audios.map(&:url) # URLs for every audio
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fizvlad/vk-music-rb/issues.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -1,14 +1,10 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "vk_music"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vk_music"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/lib/vk_music.rb

@@ -1,18 +1,18 @@
-require "cgi"
-require "logger"
-require "mechanize"
-require "execjs"
-require "json"
-
-require "vk_music/version"
-require "vk_music/constants"
-require "vk_music/exceptions"
-require "vk_music/utility"
-require "vk_music/link_decoder"
-require "vk_music/audio"
-require "vk_music/playlist"
-require "vk_music/client"
-
-##
-# Main module.
-module VkMusic; end
+require "cgi"
+require "logger"
+require "mechanize"
+require "execjs"
+require "json"
+
+require_relative "vk_music/version"
+require_relative "vk_music/constants"
+require_relative "vk_music/exceptions"
+require_relative "vk_music/utility"
+require_relative "vk_music/link_decoder"
+require_relative "vk_music/audio"
+require_relative "vk_music/playlist"
+require_relative "vk_music/client"
+
+##
+# Main module.
+module VkMusic; end

data/lib/vk_music/audio.rb

@@ -1,43 +1,30 @@
-##
-# @!macro [new] options_hash_param
-#   @param options [Hash] hash with options.
-
 module VkMusic
-
   ##
   # Class representing VK audio.
   class Audio
-  
     ##
     # @return [Integer, nil] ID of audio.
     attr_reader :id
-
     ##
     # @return [Integer, nil] ID of audio owner.
     attr_reader :owner_id
-    
     ##
     # @return [String, nil] part of secret hash which used when using +act=reload_audio+.
     attr_reader :secret_1, :secret_2
-    
     ##
     # @return [String] name of artist.
     attr_reader :artist
-    
     ##
     # @return [String] title of song.
     attr_reader :title
-
     ##
     # @return [Integer] duration of track in seconds.
     attr_reader :duration
-
     ##
-    # Access decoded download URL.
+    # Read decoded download URL.
     #
     # If link was already decoded, returns cached value. Else decodes existing link.
     # If no link can be provided, returns +nil+.
-    #
     # @return [String, nil] decoded download URL or +nil+ if not available.
     def url
       if url_cached?
@@ -45,18 +32,15 @@ module VkMusic
       elsif @url_encoded && @client_id
         @url = VkMusic::LinkDecoder.unmask_link(@url_encoded, @client_id)
       else
-        @url # nil
+        @url # => nil
       end
     end
-
     ##
     # @return [String, nil] encoded download URL.
     attr_reader :url_encoded
-
     ##
     # @return [Integer, nil] user ID which should be use for decoding.
     attr_reader :client_id
-
     ##
     # @return [String, nil] full ID of audio or +nil+ if some of components are missing.
     def full_id
@@ -69,25 +53,22 @@ module VkMusic
     def url_cached?
       !!(@url)
     end
-
     ##
     # @return [Boolean] whether able to get download URL without web requests.
     def url_available?
       !!(url_cached? || (@url_encoded && @client_id))
     end
-
     ##
     # @return [Boolean] whether it's possible to get download URL with {Client#from_id}.
     def url_accessable?
       !!(@id && @owner_id && @secret_1 && @secret_2)
     end
-    
+
     ##
     # @return [String] information about audio.
     def to_s
       "#{@artist} - #{@title} [#{Utility.format_seconds(@duration)}]"
     end
-
     ##
     # @return [String] extended information about audio.
     def pp
@@ -103,76 +84,53 @@ module VkMusic
     end
 
     ##
-    # Update audio URLs.
-    #
-    # @overload update_url(decoded_url)
-    #   Simply save download URL.
-    #   @param decoded_url [String]
-    #
-    # @overload update_url(audio)
-    #   Copy URLs from this audio (no checks applied).
-    #   @param audio [Audio]
-    #
-    # @overload update_url(options)
-    #   @macro options_hash_param
-    #   @option options [String, nil] :url decoded download URL.
-    #   @option options [String, nil] :url_encoded decoded download URL.
-    #   @option options [String, nil] :client_id decoded download URL.
-    #
+    # Update audio from another audio or from provided hash.
+    # @param from [Audio, nil]
+    # @param url [String, nil]
+    # @param url_encoded [String, nil]
+    # @param client_id [String, nil]
     # @return [self]
-    def update_url(arg)
-      case arg
-        when String
-          @url = arg
-        when Audio
-          # Only save URL if it's already decoded and cached
-          @url = arg.url if arg.url_cached?
-          @url_encoded = arg.url_encoded
-          @client_id = arg.client_id
-        when Hash
-          @url_encoded = Utility.unless_nil_to String, options[:url_encoded]
-          @url         = Utility.unless_nil_to String, options[:url]
-          @client_id   = Utility.unless_nil_to Integer, options[:client_id]
-        else
-          raise ArgumentError, "Bad arguments", caller
+    def update(from: nil, url: nil, url_encoded: nil, client_id: nil)
+      if from
+        url_encoded = from.url_encoded
+        url = from.url_cached? ? from.url : nil
+        client_id = from.client_id
       end
+
+      @url_encoded = url_encoded unless url_encoded.nil?
+      @url = url unless url.nil?
+      @client_id = client_id unless client_id.nil?
       self
     end
-  
+
     ##
     # Initialize new audio.
-    #
-    # @macro options_hash_param
-    #
-    # @option options [Integer, nil] :id
-    # @option options [Integer, nil] :owner_id
-    # @option options [String, nil] :secret_1
-    # @option options [String, nil] :secret_2
-    # @option options [String] :artist
-    # @option options [String] :title
-    # @option options [Integer] :duration
-    # @option options [String, nil] :url_encoded
-    # @option options [String, nil] :url
-    # @option options [Integer, nil] :client_id
-    def initialize(options = {})
-      @id          = Utility.unless_nil_to Integer, options[:id]
-      @owner_id    = Utility.unless_nil_to Integer, options[:owner_id]
-      @secret_1    = Utility.unless_nil_to String, options[:secret_1]
-      @secret_2    = Utility.unless_nil_to String, options[:secret_2]
-      @artist      = options[:artist].to_s.strip
-      @title       = options[:title].to_s.strip
-      @duration    = options[:duration].to_i
-      @url_encoded = Utility.unless_nil_to String, options[:url_encoded]
-      @url         = Utility.unless_nil_to String, options[:url]
-      @client_id   = Utility.unless_nil_to Integer, options[:client_id]
+    # @param id [Integer, nil]
+    # @param owner_id [Integer, nil]
+    # @param secret_1 [String, nil]
+    # @param secret_2 [String, nil]
+    # @param artist [String]
+    # @param title [String]
+    # @param duration [Integer]
+    # @param url_encoded [String, nil]
+    # @param url [String, nil]
+    # @param client_id [Integer, nil]
+    def initialize(id: nil, owner_id: nil, secret_1: nil, secret_2: nil, artist: "", title: "", duration: 0, url_encoded: nil, url: nil, client_id: nil)
+      @id = id
+      @owner_id = owner_id
+      @secret_1 = secret_1
+      @secret_2 = secret_2
+      @artist = artist.strip
+      @title = title.strip
+      @duration = duration
+      @url_encoded = url_encoded
+      @url = url
+      @client_id = client_id
     end
-    
     ##
     # Initialize new audio from Nokogiri HTML node.
-    #
     # @param node [Nokogiri::XML::Node] node, which match following CSS selector: +.audio_item.ai_has_btn+
     # @param client_id [Integer]
-    #
     # @return [Audio]
     def self.from_node(node, client_id)
       input = node.at_css("input")
@@ -180,54 +138,49 @@ module VkMusic
         url_encoded = input.attribute("value").to_s
         url_encoded = nil if url_encoded == Constants::URL::VK[:audio_unavailable] || url_encoded.empty?
         id_array = node.attribute("data-id").to_s.split("_")
-        
-        new({
-          :id => id_array[1].to_i,
-          :owner_id => id_array[0].to_i,
-          :artist => node.at_css(".ai_artist").text.strip,
-          :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 => nil,
-          :client_id => client_id
-        })
+
+        new(
+          id: id_array[1].to_i,
+          owner_id: id_array[0].to_i,
+          artist: node.at_css(".ai_artist").text.strip,
+          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: nil,
+          client_id: client_id
+        )
       else
         # Probably audios from some post
-        new({
-          :artist => node.at_css(".medias_audio_artist").text.strip,
-          :title => Utility.plain_text(node.at_css(".medias_audio_title")).strip,
-          :duration => Utility.parse_duration(node.at_css(".medias_audio_dur").text)
-        })
+        new(
+          artist: node.at_css(".medias_audio_artist").text.strip,
+          title: Utility.plain_text(node.at_css(".medias_audio_title")).strip,
+          duration: Utility.parse_duration(node.at_css(".medias_audio_dur").text)
+        )
       end
     end
-    
     ##
     # Initialize new audio from VK data array.
-    #
     # @param data [Array]
     # @param client_id [Integer]
-    #
     # @return [Audio]
     def self.from_data(data, client_id)
       url_encoded = data[2].to_s
       url_encoded = nil if url_encoded.empty?
-      
+
       secrets = data[13].to_s.split("/")
 
-      new({
-        :id => data[0].to_i,
-        :owner_id => data[1].to_i,
-        :secret_1 => secrets[3],
-        :secret_2 => secrets[5],
-        :artist => CGI.unescapeHTML(data[4]),
-        :title => CGI.unescapeHTML(data[3]),
-        :duration => data[5].to_i,
-        :url_encoded => url_encoded,
-        :url => nil,
-        :client_id => client_id
-      })
+      new(
+        id: data[0].to_i,
+        owner_id: data[1].to_i,
+        secret_1: secrets[3],
+        secret_2: secrets[5],
+        artist: CGI.unescapeHTML(data[4]),
+        title: CGI.unescapeHTML(data[3]),
+        duration: data[5].to_i,
+        url_encoded: url_encoded,
+        url: nil,
+        client_id: client_id
+      )
     end
-  
   end
-  
 end