notu 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e13444a530e59b3049d159ff447ba19c9525be2a861563e47dbe2fed586d728
-  data.tar.gz: b982c666ad9eac6e8fe23be668f7e3270fe528c0f1511fb0db63ebb46ddd0028
+  metadata.gz: 43f1b5f5623c11b9b3ecf2bb19a64a65681ff6b4414a06eb26967d4655095d27
+  data.tar.gz: 4b581b8a75c6211194c3d0564edbd11c88b83fe66623fc1890fe3af7b54e148d
 SHA512:
-  metadata.gz: 1864ecdf4fdccd1629f11c6f789bb354736512c026a55825544087474e4ef0b4c5e73aae863efbed1c8a9cfd84bb06cf9538388068049ed324d36ed4f753c834
-  data.tar.gz: 6c3f3c4041d49547898cad9ef090e2d54711cac2b304ad9e30d829917709302ab6b09aef9272fa4662a6edf7615189d88aca0cc4470bf5f10dd7d394a80e4f17
+  metadata.gz: e6fae0ce54a0bce085f50531e859e9438a90745884271222600559b90dafcd39a5d0cbf270d80f959703f6108d268a1fe314f96d788a40ad818d26984f5c5c98
+  data.tar.gz: f2c0d4527a7eb783dcf728fa490d6a89669257ff3b628b9287ba54fd135f6ecf293a6fc2f5ab69e06314d176cd561586ead4938c057e087dbe3edd9e387b7aa4

data/README.mdown

@@ -1,6 +1,6 @@
 # Notu
 
-API to get Last.fm tracks (most played, loved, etc.).
+API to get Last.fm tracks (top, loved, etc.).
 
 ## Installation
 
@@ -15,17 +15,17 @@ Then, just run `bundle install`.
 ## Example
 
 ```ruby
-library = Notu::Library.new(username: 'johndoe')
+user_api = Notu::UserApi.new(username: 'johndoe')
 
-library.loved_tracks.each do |track|
+user_api.loved_tracks.each do |track|
   puts track.artist
 end
 
-library.most_played_tracks(period: 'last_month').each do |track|
+user_api.top_tracks(period: '3month').each do |track|
   puts "#{track.artist}: #{track.plays_count}"
 end
 
-library.played_tracks.each do |track|
+user_api.recent_tracks.each do |track|
   puts track.title
 end
 ```

data/VERSION

@@ -1 +1 @@
-3.0.0
+5.0.0

data/lib/notu/api.rb

@@ -0,0 +1,25 @@
+module Notu
+
+  class Api
+
+    DEFAULT_API_KEY = '91f5d6a201de58e0c0a0d858573dddf0'.freeze
+    FORMAT = 'json'.freeze
+    HOST = 'ws.audioscrobbler.com'.freeze
+    VERSION = '2.0'.freeze
+
+    attr_reader :api_key
+
+    def initialize(api_key: DEFAULT_API_KEY)
+      @api_key = api_key.try(:squish).presence || raise(Error.new('API key must be specified'))
+    end
+
+    def url(params = {})
+      params = (params || {}).symbolize_keys
+      params.merge!(api_key:, format: FORMAT)
+      query_string = params.map { |name, value| "#{CGI.escape(name.to_s)}=#{CGI.escape(value.to_s)}" }.join('&')
+      "https://#{HOST}/#{VERSION}?#{query_string}"
+    end
+
+  end
+
+end

data/lib/notu/json_document.rb

@@ -0,0 +1,11 @@
+module Notu
+
+  module JsonDocument
+
+    def self.get(url, options = {})
+      JSON.parse(HttpDownload.get(url, options))
+    end
+
+  end
+
+end

data/lib/notu/loved_tracks.rb

@@ -2,25 +2,33 @@ module Notu
 
   class LovedTracks
 
-    include Listing
+    include Enumerable
+
+    attr_reader :user_api
+
+    def initialize(user_api)
+      raise ArgumentError.new("#{self.class}#user_api must be specified") unless user_api
+      @user_api = user_api
+    end
 
     def each
       return unless block_given?
-      page_urls.each do |url|
-        document = HtmlDocument.get(url)
-        (document / 'table.chartlist tbody tr').each do |element|
-          artist = (element / 'td.chartlist-artist a').first.try(:text) || next
-          title = (element / 'td.chartlist-name a').first.try(:text) || next
+      pages_count = nil
+      page = 1
+      loop do
+        json = JsonDocument.get(user_api.url(limit: 50, method: 'user.getLovedTracks', page:))
+        pages_count = json['lovedtracks']['@attr']['totalPages'].to_i
+        json['lovedtracks']['track'].each do |track_json|
+          artist = track_json['artist']['name'] || next
+          title = track_json['name'] || next
           yield(Track.new(artist:, title:))
         end
+        page += 1
+        break if page > pages_count
       end
       nil
     end
 
-    def path
-      'loved'
-    end
-
   end
 
 end

data/lib/notu/recent_tracks.rb

@@ -0,0 +1,34 @@
+module Notu
+
+  class RecentTracks
+
+    include Enumerable
+
+    attr_reader :user_api
+
+    def initialize(user_api)
+      raise ArgumentError.new("#{self.class}#user_api must be specified") unless user_api
+      @user_api = user_api
+    end
+
+    def each
+      return unless block_given?
+      pages_count = nil
+      page = 1
+      loop do
+        json = JsonDocument.get(user_api.url(limit: 50, method: 'user.getRecentTracks', page:))
+        pages_count = json['recenttracks']['@attr']['totalPages'].to_i
+        json['recenttracks']['track'].each do |track_json|
+          artist = track_json['artist']['#text'] || next
+          title = track_json['name'] || next
+          yield(Track.new(artist:, title:))
+        end
+        page += 1
+        break if page > pages_count
+      end
+      nil
+    end
+
+  end
+
+end

data/lib/notu/top_tracks.rb

@@ -0,0 +1,47 @@
+module Notu
+
+  class TopTracks
+
+    include Enumerable
+
+    PERIODS = %w(overall 7day 1month 3month 6month 12month).freeze
+
+    attr_reader :period, :user_api
+
+    def initialize(user_api, options = {})
+      raise ArgumentError.new("#{self.class}#user_api must be specified") unless user_api
+      @user_api = user_api
+      options = options.symbolize_keys.reverse_merge(period: PERIODS.first)
+      self.period = options[:period]
+    end
+
+    def each
+      return unless block_given?
+      pages_count = nil
+      page = 1
+      loop do
+        json = JsonDocument.get(user_api.url(limit: 50, method: 'user.getTopTracks', page:))
+        pages_count = json['toptracks']['@attr']['totalPages'].to_i
+        json['toptracks']['track'].each do |track_json|
+          artist = track_json['artist']['name'] || next
+          title = track_json['name'] || next
+          plays_count = track_json['playcount'] || next
+          yield(Track.new(artist:, plays_count:, title:))
+        end
+        page += 1
+        break if page > pages_count
+      end
+      nil
+    end
+
+    private
+
+    def period=(value)
+      string_value = value.to_s
+      raise ArgumentError.new("#{self.class.name}#period is invalid: #{value.inspect}") unless PERIODS.include?(string_value)
+      @period = string_value
+    end
+
+  end
+
+end

data/lib/notu/user_api.rb

@@ -0,0 +1,30 @@
+module Notu
+
+  class UserApi < Api
+
+    attr_reader :username
+
+    def initialize(username:, api_key: DEFAULT_API_KEY)
+      super(api_key:)
+      @username = username.try(:squish).presence || raise(Error.new('Username must be specified'))
+    end
+
+    def loved_tracks
+      LovedTracks.new(self)
+    end
+
+    def recent_tracks
+      RecentTracks.new(self)
+    end
+
+    def top_tracks(options = {})
+      TopTracks.new(self, options)
+    end
+
+    def url(params = {})
+      super((params || {}).symbolize_keys.merge(user: username))
+    end
+
+  end
+
+end

data/lib/notu.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext'
 require 'byebug' if ENV['DEBUGGER']
 require 'cgi'
 require 'net/https'
-require 'nokogiri'
 
 lib_path = "#{__dir__}/notu"
 
@@ -18,12 +17,11 @@ require "#{lib_path}/error"
 require "#{lib_path}/network_error"
 require "#{lib_path}/parse_error"
 
-require "#{lib_path}/html_document"
+require "#{lib_path}/api"
 require "#{lib_path}/http_download"
-require "#{lib_path}/library"
-require "#{lib_path}/listing"
+require "#{lib_path}/json_document"
 require "#{lib_path}/loved_tracks"
-require "#{lib_path}/most_played_tracks"
-require "#{lib_path}/played_tracks"
+require "#{lib_path}/recent_tracks"
+require "#{lib_path}/top_tracks"
 require "#{lib_path}/track"
-require "#{lib_path}/unknown_username_error"
+require "#{lib_path}/user_api"

data/notu.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.email = 'al@alweb.org'
   s.homepage = 'https://github.com/alexistoulotte/notu'
   s.summary = 'API for Last.fm'
-  s.description = 'API to get Last.fm tracks (most played, loved, etc.)'
+  s.description = 'API to get Last.fm tracks (top, loved, etc.)'
   s.license = 'MIT'
 
   s.files = %x(git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)').split("\n")
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 3.1.0'
 
   s.add_dependency 'activesupport', '>= 7.0.0', '< 8.0.0'
-  s.add_dependency 'nokogiri', '>= 1.6.0', '< 1.14.0'
 
   s.add_development_dependency 'byebug', '>= 3.2.0', '< 12.0.0'
   s.add_development_dependency 'rake', '>= 10.3.0', '< 14.0.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notu
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,26 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 8.0.0
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.14.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +190,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: API to get Last.fm tracks (most played, loved, etc.)
+description: API to get Last.fm tracks (top, loved, etc.)
 email: al@alweb.org
 executables: []
 extensions: []
@@ -220,18 +200,17 @@ files:
 - README.mdown
 - VERSION
 - lib/notu.rb
+- lib/notu/api.rb
 - lib/notu/error.rb
-- lib/notu/html_document.rb
 - lib/notu/http_download.rb
-- lib/notu/library.rb
-- lib/notu/listing.rb
+- lib/notu/json_document.rb
 - lib/notu/loved_tracks.rb
-- lib/notu/most_played_tracks.rb
 - lib/notu/network_error.rb
 - lib/notu/parse_error.rb
-- lib/notu/played_tracks.rb
+- lib/notu/recent_tracks.rb
+- lib/notu/top_tracks.rb
 - lib/notu/track.rb
-- lib/notu/unknown_username_error.rb
+- lib/notu/user_api.rb
 - notu.gemspec
 homepage: https://github.com/alexistoulotte/notu
 licenses:

data/lib/notu/html_document.rb

@@ -1,19 +0,0 @@
-module Notu
-
-  module HtmlDocument
-
-    def self.get(url, options = {})
-      parse(HttpDownload.get(url, options))
-    end
-
-    def self.parse(data)
-      data = data.gsub(/ /i, ' ').gsub(/\s+/, ' ')
-      document = Nokogiri::HTML.parse(data, nil, 'UTF-8')
-      raise ParseError.new('Invalid HTML document') if (document / 'head').empty?
-      document
-    end
-    private_class_method :parse
-
-  end
-
-end

data/lib/notu/library.rb

@@ -1,59 +0,0 @@
-module Notu
-
-  class Library
-
-    HOST = 'www.last.fm'.freeze
-
-    attr_reader :username
-
-    def initialize(options = {})
-      @semaphore = Mutex.new
-      options = options.symbolize_keys
-      self.username = options[:username]
-    end
-
-    def loved_tracks
-      LovedTracks.new(self)
-    end
-
-    def most_played_tracks(options = {})
-      MostPlayedTracks.new(self, options)
-    end
-
-    def played_tracks
-      PlayedTracks.new(self)
-    end
-
-    def url(options = {})
-      options = options.symbolize_keys
-      path = options[:path].presence
-      query = options[:query].presence
-      query = options[:query].map { |name, value| "#{CGI.escape(name.to_s)}=#{CGI.escape(value.to_s)}" }.join('&') if options[:query].is_a?(Hash)
-      "https://#{HOST}/user/#{username}".tap do |url|
-        if path.present?
-          url << '/' unless path.starts_with?('/')
-          url << path
-        end
-        if query.present?
-          url << '?' << query
-        end
-      end
-    end
-
-    private
-
-    def username=(value)
-      @semaphore.synchronize do
-        @username = value.to_s.strip.downcase
-        raise UnknownUsernameError.new(value) if username !~ /^[a-z0-9_]+$/
-        begin
-          HtmlDocument.get(url)
-        rescue
-          raise UnknownUsernameError.new(value)
-        end
-      end
-    end
-
-  end
-
-end

data/lib/notu/listing.rb

@@ -1,32 +0,0 @@
-module Notu
-
-  module Listing
-
-    include Enumerable
-
-    attr_reader :library
-
-    def initialize(library)
-      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
-      @library = library
-    end
-
-    def page_urls
-      (1..pages_count).map do |index|
-        library.url(path:, query: params.merge('page' => index))
-      end
-    end
-
-    def pages_count
-      document = HtmlDocument.get(library.url(path:, query: params))
-      [1, (document / 'ul.pagination-list li.pagination-page').text.split(/\s+/).map(&:to_i)].flatten.compact.max
-    end
-
-    def params
-      # to be overriden
-      {}
-    end
-
-  end
-
-end

data/lib/notu/most_played_tracks.rb

@@ -1,54 +0,0 @@
-module Notu
-
-  class MostPlayedTracks
-
-    include Listing
-
-    PERIODS = {
-      '7 days' => 'LAST_7_DAYS',
-      '30 days' => 'LAST_30_DAYS',
-      '90 days' => 'LAST_90_DAYS',
-      '365 days' => 'LAST_365_DAYS',
-      'Overall' => '',
-    }.freeze
-
-    attr_reader :period
-
-    def initialize(library, options = {})
-      super(library)
-      options = options.stringify_keys.reverse_merge('period' => PERIODS.keys.first)
-      self.period = options['period']
-    end
-
-    def each
-      return unless block_given?
-      page_urls.each do |url|
-        document = HtmlDocument.get(url)
-        (document / 'table.chartlist tbody tr').each do |element|
-          artist = (element / 'td.chartlist-artist a').first.try(:text) || next
-          title = (element / 'td.chartlist-name a').first.try(:text) || next
-          plays_count = (element / 'td.chartlist-bar .chartlist-count-bar-value').text.gsub(/[^\d]/, '').presence || next
-          yield(Track.new(artist:, plays_count:, title:))
-        end
-      end
-      nil
-    end
-
-    def params
-      { 'date_preset' => PERIODS[period] }
-    end
-
-    def path
-      'library/tracks'
-    end
-
-    private
-
-    def period=(value)
-      raise ArgumentError.new("Notu::MostPlayedTracks#period is invalid: #{value.inspect}") unless PERIODS.key?(value.to_s)
-      @period = value.to_s
-    end
-
-  end
-
-end

data/lib/notu/played_tracks.rb

@@ -1,26 +0,0 @@
-module Notu
-
-  class PlayedTracks
-
-    include Listing
-
-    def each
-      return unless block_given?
-      page_urls.each do |url|
-        document = HtmlDocument.get(url)
-        (document / 'table.chartlist tbody tr').each do |element|
-          artist = (element / 'td.chartlist-artist a').first.try(:text) || next
-          title = (element / 'td.chartlist-name a').first.try(:text) || next
-          yield(Track.new(artist:, title:))
-        end
-      end
-      nil
-    end
-
-    def path
-      'library'
-    end
-
-  end
-
-end

data/lib/notu/unknown_username_error.rb

@@ -1,14 +0,0 @@
-module Notu
-
-  class UnknownUsernameError < Error
-
-    attr_reader :username
-
-    def initialize(username)
-      @username = username
-      super("No such Last.fm username: #{self.username.inspect}")
-    end
-
-  end
-
-end