vk_music 3.1.4 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745b91709f47cb2b6b5bcaa013824a51f836977ecbe4cd1259a74d4a6f56e8c8
-  data.tar.gz: 9a7a2e9998adcd73a0c87d2934c6e763e8c76fdedcf08f757543497395e64322
+  metadata.gz: 1a54709405afad78ce1cfc55e5487ecb55d8a7930e3ef511997175eb01995c9a
+  data.tar.gz: dc49da61941078903e7b3da469631ba7d4eb266260ceed882a1b811e11d3ddaf
 SHA512:
-  metadata.gz: 1bd33552a23e56c0372500fc1edc20736afed079f650d4405650a91a48d01300269aeb37f51935c2c9916c4ee52449b7abb29949e7b32eb572e4641ac0e05e13
-  data.tar.gz: a252e563da14bcf249e72ab997414dbdb14388fa2308f24afc99f0507d6c003bfd5f80e0335db8df30b8d1eb7300036c2380ad99fd47cf402083238891c4ba17
+  metadata.gz: dc27e9b56575d82481157b0cbde9d4ad742fd002f117601c8b8461422cb956bd18654f477499459480c1b298f768452ff01586017a0121865b8cc446feb1c444
+  data.tar.gz: 21a10dc20607098e432f9da31172c74d83f59b2e2cb41879d9aaaa25f3907c3bffbbc2440195f121178a5d349aed7f7f69cf7ccf1f8913d8cf82920f32012e94

data/.env.example

@@ -0,0 +1,3 @@
+# VkMusic spcification loads ENV variables from .env files
+VK_LOGIN=+79991234567
+VK_PASSWORD=password

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1.52.0
+      with:
+        ruby-version: 2.7.2
+    - name: Install dependencies
+      run: bundle install
+    - name: Run rubocop
+      run: bundle exec rake rubocop
+    - name: Run yarddoc
+      run: bundle exec rake yard

data/.gitignore

@@ -1,8 +1,14 @@
+/.env
+/.byebug_history
 /.bundle/
+/.legacy/
 /.yardoc
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
+/spec/.cookies
+/spec/cassetes/*
+!/spec/cassetes/README.md
 /tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.7
+  EnabledByDefault: true
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: false
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+Layout/EndOfLine:
+  Enabled: false
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Lint/ConstantResolution:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+Style/Copyright:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/MissingElse:
+  Enabled: false
+Style/StringHashKeys:
+  Enabled: false
+Style/ImplicitRuntimeError:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: false

data/Gemfile

@@ -1,10 +1,38 @@
-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"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vk_music.gemspec
+gemspec
+
+group :test, :development do
+  # Debugging console
+  gem 'pry'
+
+  # Another debugging console
+  gem 'byebug'
+
+  # The thing, forcing you to write good code
+  gem 'rubocop', require: false
+
+  # Rake tasks
+  gem 'rake', require: false
+
+  # Testing
+  gem 'rspec', require: false
+
+  # Docs
+  gem 'yard', require: false
+
+  # .env support
+  gem 'dotenv'
+
+  # Save web requests for fast and reliable testing
+  gem 'vcr'
+
+  # Stub web requests
+  gem 'webmock'
+
+  # Test coverage
+  gem 'simplecov', require: false, group: :test
+end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    vk_music (3.1.3)
+    vk_music (4.0.1)
       execjs (~> 2.7)
-      json (~> 2.0)
+      json (~> 2.3)
       logger (~> 1.4)
       mechanize (~> 2.7)
       net-http-persistent (= 2.9.4)
@@ -11,14 +11,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
     execjs (2.7.0)
+    hashdiff (1.0.1)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    json (2.3.0)
-    logger (1.4.1)
+    json (2.3.1)
+    logger (1.4.2)
     mechanize (2.7.6)
       domain_name (~> 0.5, >= 0.5.1)
       http-cookie (~> 1.0)
@@ -28,42 +37,84 @@ GEM
       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)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.1104)
     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.8)
-      mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.8-x64-mingw32)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     ntlm-http (0.1.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.9.5)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrobots (0.1.2)
-    yard (0.9.20)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  logger (~> 1.4)
-  mechanize (~> 2.7)
-  minitest (~> 5.0)
-  pry (~> 0.12.2)
-  rake (~> 13.0)
+  byebug
+  dotenv
+  pry
+  rake
+  rspec
+  rubocop
+  simplecov
+  vcr
   vk_music!
-  yard (~> 0.9)
+  webmock
+  yard
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,94 +1,113 @@
-# 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
-```
-
-### Recommended audios and etc
-You can load audios from recommended sections, novices and VK charts:
-
-```ruby
-audios = client.block(url: "https://m.vk.com/audio?act=block&block=PUlQVA8GR0R3W0tMF2teRGpJUVQPGVpfdF1YRwMGXUpkXktMF2tYUWRHS0IXDlpKZFpcVA8FFg")
-```
-
-
-## 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).
+![Gem](https://img.shields.io/gem/v/vk_music) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/fizvlad/vk-music-rb/Ruby) ![Lines of code](https://img.shields.io/tokei/lines/github/fizvlad/vk-music-rb) ![Gem](https://img.shields.io/gem/dtv/vk_music)
+
+# VkMusic
+
+*vk_music* gem is a library to work with audios on popular Russian social network
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vk_music'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it using `gem`:
+
+```
+$ gem install vk_music
+```
+
+## Usage
+
+You can take a look on documentation at [rubydoc](https://www.rubydoc.info/gems/vk_music/).
+
+### Logging in
+
+Firstly, it is required to create new `VkMusic::Client` instance and provide login credentials:
+
+```ruby
+client = VkMusic::Client.new(username: "+79991234567", password: "password")
+```
+
+### Search
+
+You can search audios using `Client#find`:
+
+```ruby
+audios = client.find("Acid Spit - Mega Drive")
+```
+
+You can also search for playlists using same method:
+
+```ruby
+playlists = client.find("Jazz", type: :playlist)
+```
+
+### Playlists
+
+You can load playlist audios with `Client#playlist`
+
+```ruby
+playlist = client.playlist(url: "link")
+```
+
+### User or group audios
+
+You can load profile audios with `Client#audios`
+
+```ruby
+playlist = client.audios(owner_id: 8024985)
+```
+
+### Wall audios
+
+You can load audios from profile wall with `Client#wall`
+
+```ruby
+playlist = client.wall(owner_id: 8024985)
+```
+
+### 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: "link")
+```
+
+### Getting audio URL
+
+To get audio URL you should go through following chain:
+1. Get audio ID
+2. Get audio encrypted URL
+3. Get audio decrypted URL
+
+Usually most of audios already go with ID. Getting encrypted URL requires additional request to web, so it is performed with `Client#update_urls`, which will mutate provided array of audios:
+
+```ruby
+client.update_urls(audios_array)
+```
+
+After this you can get decrypted URL using `Audio#url`
+
+## Development
+
+Feel free to add features. However, please make sure all your code is covered with tests.
+
+### Testing
+
+This gem uses `rspec` and `vcr` for easy testing. *Be careful*, though, running `rspec` in clean repo may result in lot of requests to web and rate limiting or ban
+
+## 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).