vk_music 3.1.7 → 4.1.0

data/lib/vk_music/playlist.rb

@@ -1,97 +1,44 @@
-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
-      (@subtitle && !@subtitle.empty? ? "#{@subtitle} - " : "") +
-      @title +
-      (@real_size ? "(#{self.length} из #{@real_size} аудиозаписей загружено)" : " (#{self.length} аудиозаписей)")
-    end
-    ##
-    # @return [String] Same to {#to_s}, but also outputs list of audios.
-    def pp
-      "#{to_s}:\n#{@list.map(&:pp).join("\n")}"
-    end
-
-    ##
-    # @return [Array<Audio>] Returns duplicate of array of playlist audios.
-    def to_a
-      @list.dup
-    end
-
-    ##
-    # @!visibility private
-    def each(&block)
-      @list.each(&block)
-    end
-    ##
-    # @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
-    ##
-    # 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.
-    # @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 = id
-      @owner_id = owner_id
-      @access_hash = access_hash
-      @title = title
-      @subtitle = subtitle
-      @real_size = real_size
-    end
-  end
-end
+# frozen_string_literal: true
+
+module VkMusic
+  # Class representing VK playlist
+  class Playlist
+    extend Forwardable
+    include Enumerable
+
+    # @return [Integer, nil] playlist ID
+    attr_reader :id
+    # @return [Integer, nil] playlist owner 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
+    # @return [Array] audios array
+    attr_reader :audios
+
+    # Initialize new playlist
+    # @param audios [Array] list of audios in playlist
+    # @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(audios, id: nil, owner_id: nil, access_hash: nil, title: '', subtitle: nil, real_size: nil)
+      @audios = audios.dup
+      @id = id
+      @owner_id = owner_id
+      @access_hash = access_hash
+      @title = title.to_s.strip
+      @subtitle = subtitle
+      @real_size = real_size
+    end
+
+    def_delegators :@audios, :each, :length, :size, :[], :empty?
+  end
+end

data/lib/vk_music/request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VkMusic
+  # Bunch of different web requests
+  module Request
+    # VK root URL
+    VK_ROOT = 'https://m.vk.com'
+    public_constant :VK_ROOT
+  end
+end
+
+require_relative 'request/base'
+Dir[File.join(__dir__, 'request', '*.rb')].each { |file| require_relative file }

data/lib/vk_music/request/artist.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Artist audios page request
+    class Artist < Base
+      # Initialize new request
+      # @param name [String]
+      # @param client_id [Integer]
+      def initialize(name, client_id)
+        @client_id = client_id
+        super("#{VK_ROOT}/artist/#{name}/top_audios", {}, 'GET', {})
+      end
+
+      def_delegators :@parser, :audios
+
+      private
+
+      def after_call
+        @parser = WebParser::Artist.new(@response, client_id: @client_id)
+      end
+    end
+  end
+end

data/lib/vk_music/request/audios_reload.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Audios reload
+    class AudiosReload < Base
+      # Initialize new request
+      # @param ids [Array<String>]
+      # @param client_id [Integer]
+      def initialize(ids, client_id)
+        @client_id = client_id
+        super(
+          "#{VK_ROOT}/audio",
+          { act: 'reload_audio', ids: ids.join(','), utf8: true },
+          'GET',
+          {}
+        )
+      end
+
+      def_delegators :@parser, :audios
+
+      private
+
+      def after_call
+        @parser = WebParser::AudiosReload.new(@response.body, client_id: @client_id)
+      end
+    end
+  end
+end

data/lib/vk_music/request/base.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Base class for most of requests
+    class Base
+      extend Forwardable
+
+      # @return [String]
+      attr_reader :path
+      # @return [Hash]
+      attr_reader :data
+      # @return [String]
+      attr_reader :method
+      # @return [Hash]
+      attr_reader :headers
+      # @return [Mechanize::File?]
+      attr_reader :response
+
+      # Initialize new request
+      # @param path [String]
+      # @param data [Hash]
+      # @param method [String]
+      # @param headers [Hash]
+      def initialize(path, data = {}, method = 'GET', headers = {})
+        @path = path
+        @data = data
+        @method = method.upcase
+        @headers = headers
+
+        @response = nil
+      end
+
+      # @param agent [Mechanize]
+      # @return [self]
+      def call(agent)
+        before_call
+
+        log
+        @response = case method
+        when 'GET' then get(agent)
+        when 'POST' then post(agent)
+        else raise(ArgumentError, "unsupported method #{method}")
+        end
+
+        after_call
+
+        self
+      end
+
+      private
+
+      def log
+        VkMusic.log.debug('request') do
+          "#{method} to '#{path}', with data: #{data}, headers: #{headers}"
+        end
+      end
+
+      def get(agent)
+        uri = URI(path)
+        uri.query = URI.encode_www_form(data)
+        agent.get(uri, [], nil, headers)
+      end
+
+      def post(agent)
+        uri = URI(path)
+        agent.post(uri, data, headers)
+      end
+
+      def before_call; end
+
+      def after_call; end
+    end
+  end
+end

data/lib/vk_music/request/login.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Logging in request
+    class Login < Base
+      # Initialize new request
+      def initialize
+        super("#{VK_ROOT}/login", {}, 'GET', {})
+        @success = false
+      end
+
+      # @return [Boolean]
+      def success?
+        !!@success
+      end
+
+      # Send login form
+      def send_form(login, password, agent)
+        form = @parser.login_form
+        form['email'] = login
+        form['pass'] = password
+        page = agent.submit(form)
+
+        @success = (page.uri.to_s == 'https://m.vk.com/feed')
+      end
+
+      private
+
+      def after_call
+        @parser = WebParser::Login.new(@response)
+      end
+    end
+  end
+end

data/lib/vk_music/request/my_page.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Logging in request
+    class MyPage < Base
+      # Initialize new request
+      def initialize
+        super("#{VK_ROOT}/id0", {}, 'GET', {})
+      end
+
+      def_delegators :@parser, :id, :name
+
+      private
+
+      def after_call
+        @parser = WebParser::MyPage.new(@response)
+      end
+    end
+  end
+end

data/lib/vk_music/request/playlist.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Playlist in web-mobile request
+    class Playlist < Base
+      # Initialize new request
+      # @param owner_id [Integer]
+      # @param playlist_id [Integer]
+      # @param access_hash [String, nil]
+      # @param client_id [Integer]
+      def initialize(owner_id, playlist_id, access_hash, client_id)
+        @client_id = client_id
+        super(
+          "#{VK_ROOT}/audio",
+          { act: "audio_playlist#{owner_id}_#{playlist_id}", access_hash: access_hash },
+          'GET',
+          {}
+        )
+      end
+
+      def_delegators :@parser, :audios, :title, :subtitle, :real_size
+
+      private
+
+      def after_call
+        @parser = WebParser::Playlist.new(@response.body)
+      end
+    end
+  end
+end

data/lib/vk_music/request/playlist_section.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Playlist in web-mobile request
+    class PlaylistSection < Base
+      # Initialize new request
+      # @param owner_id [Integer]
+      # @param playlist_id [Integer]
+      # @param access_hash [String, nil]
+      # @param offset [Integer]
+      # @param client_id [Integer]
+      def initialize(owner_id, playlist_id, access_hash, offset, client_id)
+        @client_id = client_id
+        super(
+          "#{VK_ROOT}/audio",
+          {
+            act: 'load_section', type: 'playlist', offset: offset, utf8: true,
+            owner_id: owner_id, playlist_id: playlist_id, access_hash: access_hash.to_s
+          },
+          'GET',
+          {}
+        )
+      end
+
+      def_delegators :@parser, :audios, :title, :subtitle, :real_size, :more?
+
+      private
+
+      def after_call
+        @parser = WebParser::PlaylistSection.new(@response, client_id: @client_id)
+      end
+    end
+  end
+end

data/lib/vk_music/request/post.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # Post page
+    class Post < Base
+      # Initialize new request
+      def initialize(owner_id, post_id, client_id)
+        @client_id = client_id
+        super("#{VK_ROOT}/wall#{owner_id}_#{post_id}", {}, 'GET', {})
+      end
+
+      def_delegators :@parser, :audios
+
+      private
+
+      def after_call
+        @parser = WebParser::Post.new(@response, client_id: @client_id)
+      end
+    end
+  end
+end

data/lib/vk_music/request/profile.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module VkMusic
+  module Request
+    # User or group page
+    class Profile < Base
+      # Initialize new request
+      def initialize(profile_id: nil, profile_custom_path: nil)
+        profile_path =
+          profile_custom_path ||
+          "#{profile_id.negative? ? 'club' : 'id'}#{profile_id.abs}"
+        super("#{VK_ROOT}/#{profile_path}", {}, 'GET', {})
+      end
+
+      def_delegators :@parser, :id, :last_post_id
+
+      private
+
+      def after_call
+        @parser = WebParser::Profile.new(@response)
+      end
+    end
+  end
+end