notu 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efbddd2bb568278da60c542fd1046d39a61d200bf1ca1a20614e7135ac07e66f
-  data.tar.gz: 4c14831c8b1526a402cf47870e64d17fb5e3ffa4b04d0f2ecaefb30d493de4e3
+  metadata.gz: 43f1b5f5623c11b9b3ecf2bb19a64a65681ff6b4414a06eb26967d4655095d27
+  data.tar.gz: 4b581b8a75c6211194c3d0564edbd11c88b83fe66623fc1890fe3af7b54e148d
 SHA512:
-  metadata.gz: 60c8869371be7e6b80a4b8f8b26ebfa2406f63cb576d7788cf6aeacb6d963c3f4d534455a5ae33bca7ea0a33236a0bb6ab529980fc3697ba302062e764f96d0c
-  data.tar.gz: 8343035fb3d9a5ce7e9bba05676f13b0265ace6f514e2e492aa5280eeae0ddc25990eb553adf39f698f66767f4da2d5a5d55523e6b04d2fef428cb47129ece3b
+  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 @@
-4.0.0
+5.0.0

data/lib/notu/api.rb

@@ -2,20 +2,20 @@ module Notu
 
   class Api
 
-    DEFAULT_KEY = '91f5d6a201de58e0c0a0d858573dddf0'.freeze
+    DEFAULT_API_KEY = '91f5d6a201de58e0c0a0d858573dddf0'.freeze
     FORMAT = 'json'.freeze
     HOST = 'ws.audioscrobbler.com'.freeze
     VERSION = '2.0'.freeze
 
-    attr_reader :key
+    attr_reader :api_key
 
-    def initialize(key: DEFAULT_KEY)
-      @key = key.try(:squish).presence || raise(Error.new('API key must be specified'))
+    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: key, format: FORMAT)
+      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

data/lib/notu/loved_tracks.rb

@@ -4,11 +4,11 @@ module Notu
 
     include Enumerable
 
-    attr_reader :library
+    attr_reader :user_api
 
-    def initialize(library)
-      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
-      @library = library
+    def initialize(user_api)
+      raise ArgumentError.new("#{self.class}#user_api must be specified") unless user_api
+      @user_api = user_api
     end
 
     def each
@@ -16,7 +16,7 @@ module Notu
       pages_count = nil
       page = 1
       loop do
-        json = JsonDocument.get(library.url(limit: 50, method: 'user.getLovedTracks', page:))
+        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

data/lib/notu/recent_tracks.rb

@@ -4,11 +4,11 @@ module Notu
 
     include Enumerable
 
-    attr_reader :library
+    attr_reader :user_api
 
-    def initialize(library)
-      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
-      @library = library
+    def initialize(user_api)
+      raise ArgumentError.new("#{self.class}#user_api must be specified") unless user_api
+      @user_api = user_api
     end
 
     def each
@@ -16,7 +16,7 @@ module Notu
       pages_count = nil
       page = 1
       loop do
-        json = JsonDocument.get(library.url(limit: 50, method: 'user.getRecentTracks', page:))
+        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

data/lib/notu/{most_played_tracks.rb → top_tracks.rb}

@@ -1,16 +1,16 @@
 module Notu
 
-  class MostPlayedTracks
+  class TopTracks
 
     include Enumerable
 
     PERIODS = %w(overall 7day 1month 3month 6month 12month).freeze
 
-    attr_reader :library, :period
+    attr_reader :period, :user_api
 
-    def initialize(library, options = {})
-      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
-      @library = library
+    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
@@ -20,7 +20,7 @@ module Notu
       pages_count = nil
       page = 1
       loop do
-        json = JsonDocument.get(library.url(limit: 50, method: 'user.getTopTracks', page:))
+        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
@@ -38,7 +38,7 @@ module Notu
 
     def period=(value)
       string_value = value.to_s
-      raise ArgumentError.new("Notu::MostPlayedTracks#period is invalid: #{value.inspect}") unless PERIODS.include?(string_value)
+      raise ArgumentError.new("#{self.class.name}#period is invalid: #{value.inspect}") unless PERIODS.include?(string_value)
       @period = string_value
     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

@@ -20,8 +20,8 @@ require "#{lib_path}/parse_error"
 require "#{lib_path}/api"
 require "#{lib_path}/http_download"
 require "#{lib_path}/json_document"
-require "#{lib_path}/library"
 require "#{lib_path}/loved_tracks"
-require "#{lib_path}/most_played_tracks"
 require "#{lib_path}/recent_tracks"
+require "#{lib_path}/top_tracks"
 require "#{lib_path}/track"
+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")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notu
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
@@ -190,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: []
@@ -204,13 +204,13 @@ files:
 - lib/notu/error.rb
 - lib/notu/http_download.rb
 - lib/notu/json_document.rb
-- lib/notu/library.rb
 - lib/notu/loved_tracks.rb
-- lib/notu/most_played_tracks.rb
 - lib/notu/network_error.rb
 - lib/notu/parse_error.rb
 - lib/notu/recent_tracks.rb
+- lib/notu/top_tracks.rb
 - lib/notu/track.rb
+- lib/notu/user_api.rb
 - notu.gemspec
 homepage: https://github.com/alexistoulotte/notu
 licenses:

data/lib/notu/library.rb

@@ -1,30 +0,0 @@
-module Notu
-
-  class Library
-
-    attr_reader :api, :username
-
-    def initialize(username:, api: Api.new)
-      @api = api.presence || raise(Error.new('API must be specified'))
-      @username = username.try(:squish).presence || raise(Error.new('Username must be specified'))
-    end
-
-    def loved_tracks
-      LovedTracks.new(self)
-    end
-
-    def most_played_tracks(options = {})
-      MostPlayedTracks.new(self, options)
-    end
-
-    def recent_tracks
-      RecentTracks.new(self)
-    end
-
-    def url(params = {})
-      api.url((params || {}).symbolize_keys.merge(user: username))
-    end
-
-  end
-
-end