Class: AppleMusic::Artist

Inherits:
Resource show all
Defined in:
lib/apple_music/artist.rb,
lib/apple_music/artist/attributes.rb,
lib/apple_music/artist/relationships.rb

Overview

developer.apple.com/documentation/applemusicapi/artist

Defined Under Namespace

Classes: Attributes, Relationships

Constant Summary

Constants inherited from Resource

Resource::RESOURCE_MAP

Instance Attribute Summary

Attributes inherited from Resource

#attributes, #href, #id, #relationships, #type

Class Method Summary collapse

Methods inherited from Resource

build, #initialize

Constructor Details

This class inherits a constructor from AppleMusic::Resource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class AppleMusic::Resource

Class Method Details

.find(id, **options) ⇒ Object

e.g. AppleMusic::Artist.find(178834) developer.apple.com/documentation/applemusicapi/get_a_catalog_artist



9
10
11
12
13
 
# File 'lib/apple_music/artist.rb', line 9

def find(id, **options)
  storefront = Storefront.lookup(options.delete(:storefront))
  response = AppleMusic.get("catalog/#{storefront}/artists/#{id}", options)
  Response.new(response.body).data.first
end

.get_collection_by_ids(ids, **options) ⇒ Object

e.g. AppleMusic::Artist.get_collection_by_ids([178834, 462006]) developer.apple.com/documentation/applemusicapi/get_multiple_catalog_artists



24
25
26
27
28
29
 
# File 'lib/apple_music/artist.rb', line 24

def get_collection_by_ids(ids, **options)
  ids = ids.is_a?(Array) ? ids.join(',') : ids
  storefront = Storefront.lookup(options.delete(:storefront))
  response = AppleMusic.get("catalog/#{storefront}/artists", options.merge(ids: ids))
  Response.new(response.body).data
end

.get_relationship(id, relationship_type, **options) ⇒ Object

e.g. AppleMusic::Artist.get_relationship(178834, :albums) developer.apple.com/documentation/applemusicapi/get_a_catalog_artist_s_relationship_directly_by_name



33
34
35
36
37
 
# File 'lib/apple_music/artist.rb', line 33

def get_relationship(id, relationship_type, **options)
  storefront = Storefront.lookup(options.delete(:storefront))
  response = AppleMusic.get("catalog/#{storefront}/artists/#{id}/#{relationship_type}", options)
  Response.new(response.body).data
end

.list(**options) ⇒ Object

e.g. AppleMusic::Artist.list(ids: [178834, 462006])

Raises:



16
17
18
19
20
 
# File 'lib/apple_music/artist.rb', line 16

def list(**options)
  raise ParameterMissing, 'required parameter :ids is missing' unless options[:ids]

  get_collection_by_ids(options.delete(:ids), options)
end

.related_albums(id, **options) ⇒ Object

e.g. AppleMusic::Artist.related_albums(178834)



40
41
42
 
# File 'lib/apple_music/artist.rb', line 40

def related_albums(id, **options)
  get_relationship(id, :albums, options)
end

.related_genres(id, **options) ⇒ Object

e.g. AppleMusic::Artist.related_genres(178834)



45
46
47
 
# File 'lib/apple_music/artist.rb', line 45

def related_genres(id, **options)
  get_relationship(id, :genres, options)
end

.related_playlists(id, **options) ⇒ Object

e.g. AppleMusic::Artist.related_playlists(178834)



50
51
52
 
# File 'lib/apple_music/artist.rb', line 50

def related_playlists(id, **options)
  get_relationship(id, :playlists, options)
end

.related_station(id, **options) ⇒ Object

e.g. AppleMusic::Artist.related_station(178834)



55
56
57
 
# File 'lib/apple_music/artist.rb', line 55

def related_station(id, **options)
  get_relationship(id, :station, options).first
end

.search(term, **options) ⇒ Object 



59
60
61
 
# File 'lib/apple_music/artist.rb', line 59

def search(term, **options)
  AppleMusic.search(**options.merge(term: term, types: :artists)).artists
end