vk_music 2.2.1 → 3.0.0

data/lib/vk_music/constants.rb

@@ -1,17 +1,14 @@
 module VkMusic
-
   ##
   # Constants.
   module Constants
-    
     ##
-    # Web user agent.
-    DEFAULT_USER_AGENT = "Mozilla/5.0 (Linux; Android 5.1.1; Redmi 3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.132 Mobile Safari/537.36 OPR/54.2.2672.49907"
+    # Default web user agent.
+    DEFAULT_USER_AGENT = "" # Using empty user agent confuses VK and it returnes MP3
 
     ##
     # Different URLs
     module URL
-
       ##
       # Hash with URLs to VK pages which are used by library.
       VK = {
@@ -27,55 +24,43 @@ module VkMusic
         audio_unavailable: "https://m.vk.com/mp3/audio_api_unavailable.mp3",
         profile_audios: "https://m.vk.com/audios",
       }
-
     end
 
     ##
     # Regular expressions
     module Regex
-
       ##
       # VK user or group ID.
       VK_ID_STR = /^-?\d+$/
-
       ##
       # VK user or group ID.
       VK_ID = /-?\d+/
-
       ##
       # VK prefixed user or group ID.
       VK_PREFIXED_ID_STR = /^(?:id|club|group|public|event)(\d+)$/
-
       ##
       # VK custom ID regular expression.
       VK_CUSTOM_ID = /^\w+$/
-
       ##
       # VK URL regular expression.
       VK_URL = /(?:https?:\/\/)?(?:m\.|www\.)?vk\.com\/([\w\-]+)/
-
       ##
       # +href+ attribute with VK ID regular expression.
       VK_HREF_ID_CONTAINING = /(?:audios|photo|write|owner_id=|friends\?id=)(-?\d+)/
-      
       ##
       # VK audios page regular expression.
       VK_AUDIOS_URL_POSTFIX = /^audios(-?\d+)$/
-      
       ##
       # Playlist URL regular expression.
       VK_PLAYLIST_URL_POSTFIX = /.*(?:audio_playlist|album\/)(-?\d+)_(\d+)(?:(?:(?:.*(?=&access_hash=)&access_hash=)|\/|%2F|_)([\da-z]+))?/
-
       ##
       # Post URL regular expression #1.
       VK_POST_URL_POSTFIX = /.*post(-?\d+)_(\d+)/
-
       ##
       # Post URL regular expression #2.
       VK_WALL_URL_POSTFIX = /.*wall(-?\d+)_(\d+)/
-
     end
-    
+
     ##
     # Names used in VK login form.
     VK_LOGIN_FORM_NAMES = {
@@ -86,7 +71,5 @@ module VkMusic
     ##
     # Maximum amount of audios in VK playlist.
     MAXIMUM_PLAYLIST_SIZE = 10000
-    
   end
-
 end

data/lib/vk_music/exceptions.rb

@@ -1,32 +1,21 @@
 module VkMusic
-
   ##
   # Exceptions.
   module Exceptions
-
     ##
     # General class for all the errors.
     class VkMusicError < RuntimeError; end
-
     ##
     # Failed to login.
     class LoginError < VkMusicError; end
-
     ##
-    # Failed to get request. _Only_ thron when Mechanize failed to load page
+    # Failed to get request. _Only_ thrown when Mechanize failed to load page
     class RequestError < VkMusicError; end
-
     ##
     # Parse error. Request is OK, but something went wrong while parsing reply.
     #   It might be missing playlist/post as well.
     class ParseError < VkMusicError; end
-
-    ##
-    # Unable to login.
-    class LoginError < VkMusicError; end
-    
   end
 
   include Exceptions
-  
 end

data/lib/vk_music/link_decoder.rb

@@ -1,9 +1,7 @@
 module VkMusic
-
   ##
   # Module containing link decoding utilities.
   module LinkDecoder
-
     ##
     # JS code which creates function to unmask audio URL.
     js_code = <<~HEREDOC
@@ -90,19 +88,15 @@ module VkMusic
     ##
     # JS context with unmasking link.
     @@js_context = ExecJS.compile(js_code)
-    
+
     ##
     # Unmask audio download URL.
-    #
     # @param link [String] encoded link to audio. Usually looks like "https://m.vk.​com/mp3/audio_api_unavailable.mp3?extra=...".
     # @param client_id [Integer] ID of user which got this link. ID is required for decoding.
-    #
     # @return [String] audio download URL, which can be used only from current IP.
     def self.unmask_link(link, client_id)
-      Utility.debug("Unmasking link.")
+      VkMusic.debug("Unmasking link.")
       @@js_context.call("vk_unmask_link", link.to_s, client_id.to_i)
     end
-
   end
-  
 end

data/lib/vk_music/playlist.rb

@@ -1,34 +1,32 @@
 module VkMusic
-
   ##
   # VK playlist.
   class Playlist
     include Enumerable
-    
+
     ##
     # @return [Integer, nil] playlist ID.
     attr_reader :id
-
     ##
     # @return [Integer, nil] owner of playlist ID.
     attr_reader :owner_id
-
     ##
     # @return [String, nil] access hash which should be part of link for some playlists.
     attr_reader :access_hash
-
     ##
     # @return [String] playlist title.
     attr_reader :title
-
     ##
     # @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
-    
+
+    ##
+    # @!visibility private
+    attr_reader :list
+
     ##
     # @return [String] playlist description in Russian.
     def to_s
@@ -36,7 +34,6 @@ module VkMusic
       @title +
       (@real_size ? "(#{self.length} из #{@real_size} аудиозаписей загружено)" : " (#{self.length} аудиозаписей)")
     end
-
     ##
     # @return [String] Same to {#to_s}, but also outputs list of audios.
     def pp
@@ -48,61 +45,53 @@ module VkMusic
     def to_a
       @list.dup
     end
-    
+
     ##
-    # @see Array#each
+    # @!visibility private
     def each(&block)
       @list.each(&block)
     end
-
     ##
-    # @see Array#length
+    # @return [Integer] amount of audios. This can be less than real size as not all audios might be loaded.
     def length
       @list.length
     end
     alias size length
-
-    ##
-    # @see Array#empty?
-    def empty?
-      @list.empty?
-    end
-    
     ##
     # Access audios from playlist.
-    #
     # @param index [Integer] index of audio (starting from 0).
-    # 
     # @return [Audio, nil] audio or +nil+ if out of range.
     def [](index)
       @list[index]
     end
-  
+    ##
+    # @return [Boolean] whether no audios loaded for this playlist.
+    def empty?
+      @list.empty?
+    end
+
     ##
     # Initialize new playlist.
     #
     # @param list [Array] list of audios in playlist.
-    #
-    # @option options [Integer, nil] :id
-    # @option options [Integer, nil] :owner_id
-    # @option options [String, nil] :access_hash
-    # @option options [String] :title
-    # @option options [String, nil] :subtitle
-    # @option options [Integer, nil] :real_size
-    def initialize(list, options = {})
-      raise ArgumentError, "Bad arguments", caller unless list.class == Array      
+    # @param id [Integer, nil]
+    # @param owner_id [Integer, nil]
+    # @param access_hash [String, nil]
+    # @param title [String]
+    # @param subtitle [String, nil]
+    # @param real_size [Integer, nil]
+    def initialize(list, id: nil, owner_id: nil, access_hash: nil, title: "", subtitle: nil, real_size: nil)
+      raise ArgumentError unless list.is_a?(Array)
       # Saving list
       @list = list.dup
-      
+
       # Setting up attributes
-      @id          = Utility.unless_nil_to Integer, options[:id]
-      @owner_id    = Utility.unless_nil_to Integer, options[:owner_id]
-      @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]
+      @id = id
+      @owner_id = owner_id
+      @access_hash = access_hash
+      @title = title
+      @subtitle = subtitle
+      @real_size = real_size
     end
-  
   end
-  
 end

data/lib/vk_music/utility.rb

@@ -1,20 +1,18 @@
-module VkMusic
+require_relative "utility/log"
 
+module VkMusic
   ##
   # Utility methods.
   module Utility
-  
     ##
     # Turn amount of seconds into string.
-    #
     # @param s [Integer] amount of seconds.
-    #
     # @return [String] formatted string.
     def self.format_seconds(s)
-      s = s.to_i # Require integer      
+      s = s.to_i # Require integer
       "#{(s / 60).to_s.rjust(2, "0")}:#{(s % 60).to_s.rjust(2, "0")}";
     end
-    
+
     ##
     # Guess type of request by from string.
     #
@@ -23,12 +21,9 @@ module VkMusic
     # * +:post+ - if string match post URL.
     # * +:audios+ - if string match user or group URL.
     # * +:find+ - in rest of cases.
-    #
     # @param str [String] request from user for some audios.
-    #
     # @return [Symbol]
     def self.guess_request_type(str)
-      # Guess what type of request is this. Returns Symbol: :find, :playlist, :audios
       case str
         when Constants::Regex::VK_PLAYLIST_URL_POSTFIX
           :playlist
@@ -43,9 +38,7 @@ module VkMusic
 
     ##
     # Turn hash into URL query string.
-    #
     # @param hash [Hash]
-    #
     # @return [String]
     def self.hash_to_params(hash = {})
       qs = ""
@@ -61,56 +54,9 @@ module VkMusic
       qs
     end
 
-    ##
-    # Utility loggers
-    @@loggers = {
-      debug: Logger.new(STDOUT),
-      warn: Logger.new(STDERR)
-    }
-    @@loggers[:debug].level = Logger::DEBUG
-    @@loggers[:warn].level = Logger::WARN
-
-    ##
-    # Send warning.
-    def self.warn(*args)
-      @@loggers[:warn].warn(args.join("\n"))
-    end
-
-    ##
-    # Send debug message.
-    def self.debug(*args)
-      @@loggers[:debug].debug(args.join("\n")) if $DEBUG
-    end
-
-    ##
-    # Function to turn values into given class unless nil provided
-    #
-    # Supported types:
-    # * +String+
-    # * +Integer+
-    #
-    # @param new_class [Class] class to transform to.
-    # @param obj [Object] object to check.
-    #
-    # @return object transformed to given class or +nil+ if object was +nil+ already.
-    def self.unless_nil_to(new_class, obj)
-      case
-        when obj.nil?
-          nil
-        when String <= new_class
-          obj.to_s
-        when Integer <= new_class
-          obj.to_i
-        else
-          raise ArgumentError, "Bad arguments", caller
-      end
-    end
-
     ##
     # Get content of text children of provided Node.
-    #
     # @param node [Nokogiri::Xml::Node]
-    #
     # @return [String]
     def self.plain_text(node)
       node.children.select(&:text?).map(&:text).join ""
@@ -118,9 +64,7 @@ module VkMusic
 
     ##
     # Turn human readable track length to its size in seconds.
-    #
-    # @param str [String] string in format "(HH:MM:SS)" or something alike.
-    #
+    # @param str [String] string in format "HH:MM:SS" or something alike (+/d++ Regex selector is used).
     # @return [Integer] amount of seconds.
     def self.parse_duration(str)
       str.scan(/\d+/)
@@ -128,7 +72,5 @@ module VkMusic
          .reverse
          .each_with_index.reduce(0) { |m, arr| m + arr[0] * 60**arr[1] }
     end
-    
   end
-  
 end

data/lib/vk_music/utility/log.rb

@@ -0,0 +1,51 @@
+module VkMusic
+  ##
+  # @!group Logger
+
+  ##
+  # Default logger
+  @@logger = Logger.new(defined?($LOG_FILE) ? $LOGFILE : STDOUT,
+    formatter: Proc.new do |severity, datetime, progname, msg|
+      "[#{datetime}] #{severity}#{progname ? " - #{progname}" : ""}:\t #{msg}\n"
+    end
+  )
+  @@logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+
+  ##
+  # Setup new logger.
+  # @param new_logger [Logger, nil]
+  def self.logger=(new_logger)
+    @@logger = new_logger
+  end
+  ##
+  # Access current logger.
+  # @return [Logger, nil]
+  def self.logger
+    @@logger
+  end
+
+  ##
+  # Log message.
+  def self.log(severity, message = nil, progname = nil)
+    @@logger.log(severity, message, progname) if @@logger
+  end
+
+  ##
+  # Log warn message.
+  def self.warn(message = nil, progname = nil)
+    @@logger.log(Logger::WARN, message, progname)
+  end
+  ##
+  # Log info message.
+  def self.info(message = nil, progname = nil)
+    @@logger.log(Logger::INFO, message, progname)
+  end
+  ##
+  # Log debug message.
+  def self.debug(message = nil, progname = nil)
+    @@logger.log(Logger::DEBUG, message, progname)
+  end
+
+  ##
+  # @!endgroup
+end