Git Product home page Git Product logo

apple_music's Introduction

AppleMusic

This is a ruby wrapper for the Apple Music API.

Installation

Add this line to your application's Gemfile:

gem 'apple_music'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apple_music

Usage

AppleMusic gem was designed with usability as its primary goal:

e.g. Search Artists

artist = AppleMusic::Artist.search('Men I Trust').first # AppleMusic::Artist object
artist.genre_names # ['Electronic']
artist.id # "886240553"
albums = AppleMusic::Artist.related_albums(886240553).map(&:name) # ["Oncle Jazz", "Headroom"...

e.g. Search Albums

albums = AppleMusic::Album.search('BILL EVANS') # AppleMusic::Album object
tracks = AppleMusic::Album.related_tracks(albums[0].id)
tracks.first.name # "Waltz for Debby"

e.g. Search Songs

songs = AppleMusic::Song.search('Document', storefront: :jp) # AppleMusic::Song object
songs[0].artist_name # "TENDRE"
songs[0].album_name # "NOT IN ALMIGHTY"

Features

Currently, it work in progress, so it can use apis which does not need user token.

Albums

Feature Status Docs Code
Get a Catalog Album ✅ 🔗 :octocat:
Get a Catalog Album's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Albums ✅ 🔗 :octocat:
Get Multiple Catalog Albums by UPC ✅ 🔗 :octocat:
Get a Library Album ⛔ 🔗
Get a Library Album's Relationship Directly by Name ⛔ 🔗
Get Multiple Library Albums ⛔ 🔗
Get All Library Albums ⛔ 🔗

Artists

Feature Status Docs Code
Get a Catalog Artist ✅ 🔗 :octocat:
Get Multiple Catalog Artists ✅ 🔗 :octocat:
Get a Catalog Artist's Relationship Directly by Name ✅ 🔗 :octocat:
Get a Library Artist ⛔ 🔗
Get All Library Artists ⛔ 🔗
Get Multiple Library Artists ⛔ 🔗
Get a Library Artist's Relationship Directly by Name ⛔ 🔗

Songs

Feature Status Docs Code
Get a Catalog Song ✅ 🔗 :octocat:
Get Multiple Catalog Songs by ID ✅ 🔗 :octocat:
Get Multiple Catalog Songs by ISRC ✅ 🔗 :octocat:
Get a Catalog Song's Relationship Directly by Name ✅ 🔗 :octocat:
Get a Library Song ⛔ 🔗
Get All Library Songs ⛔ 🔗
Get Multiple Library Songs ⛔ 🔗
Get a Library Song's Relationship Directly by Name ⛔ 🔗

Music Videos

Feature Status Docs Code
Get a Catalog Music Video ✅ 🔗 :octocat:
Get a Catalog Music Video's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Music Videos by ID ✅ 🔗 :octocat:
Get Multiple Catalog Music Videos by ISRC ✅ 🔗 :octocat:
Get a Library Music Video ⛔ 🔗
Get a Library Music Video's Relationship Directly by Name ⛔ 🔗
Get Multiple Library Music Videos ⛔ 🔗
Get All Library Music Videos ⛔ 🔗

Playlists

Feature Status Docs Code
Get a Catalog Playlist ✅ 🔗 :octocat:
Get a Catalog Playlist's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Playlists ✅ 🔗 :octocat:
Get a Library Playlist ⛔ 🔗
Get a Library Playlist's Relationship Directly by Name ⛔ 🔗
Get Multiple Library Playlists ⛔ 🔗
Get All Library Playlists ⛔ 🔗

Apple Music Stations

Feature Status Docs Code
Get a Catalog Station ✅ 🔗 :octocat:
Get Multiple Catalog Stations ✅ 🔗 :octocat:

Search

Feature Status Docs Code
Search for Catalog Resources ✅ 🔗 :octocat:
Get Catalog Search Hints ✅ 🔗 :octocat:
Search for Library Resources ⛔ 🔗

Ratings

Feature Status Docs Code
Get a Personal Album Rating ⛔ 🔗
Get a Personal Music Video Rating ⛔ 🔗
Get a Personal Playlist Rating ⛔ 🔗
Get a Personal Song Rating ⛔ 🔗
Get a Personal Station Rating ⛔ 🔗
Get Multiple Personal Album Ratings ⛔ 🔗
Get Multiple Personal Music Video Ratings ⛔ 🔗
Get Multiple Personal Playlist Ratings ⛔ 🔗
Get Multiple Personal Song Ratings ⛔ 🔗
Get Multiple Personal Station Ratings ⛔ 🔗
Add a Personal Album Rating ⛔ 🔗
Add a Personal Music Video Rating ⛔ 🔗
Add a Personal Playlist Rating ⛔ 🔗
Add a Personal Song Rating ⛔ 🔗
Add a Personal Station Rating ⛔ 🔗
Delete a Personal Album Rating ⛔ 🔗
Delete a Personal Music Video Rating ⛔ 🔗
Delete a Personal Playlist Rating ⛔ 🔗
Delete a Personal Song Rating ⛔ 🔗
Delete a Personal Station Rating ⛔ 🔗
Get a Personal Library Music Video Rating ⛔ 🔗
Get a Personal Library Playlist Rating ⛔ 🔗
Get a Personal Library Song Rating ⛔ 🔗
Get Multiple Personal Library Music Video Ratings ⛔ 🔗
Get Multiple Personal Library Playlist Ratings ⛔ 🔗
Get Multiple Personal Library Songs Ratings ⛔ 🔗
Add a Personal Library Music Video Rating ⛔ 🔗
Add a Personal Library Playlist Rating ⛔ 🔗
Add a Personal Library Song Rating ⛔ 🔗
Delete a Personal Library Music Video Rating ⛔ 🔗
Delete a Personal Library Playlist Rating ⛔ 🔗
Delete a Personal Library Song Rating ⛔ 🔗

Charts

Feature Status Docs Code
Get Catalog Charts ✅ 🔗 :octocat:

Music Genres

Feature Status Docs Code
Get a Catalog Genre ✅ 🔗 :octocat:
Get a Catalog Genre's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Genres ✅ 🔗 :octocat:
Get Catalog Top Charts Genres ✅ 🔗 :octocat:

Curators

Feature Status Docs Code
Get a Catalog Curator ✅ 🔗 :octocat:
Get a Catalog Curator's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Curators ✅ 🔗 :octocat:
Get a Catalog Apple Curator ⛔ 🔗
Get a Catalog Apple Curator's Relationship Directly by Name ⛔ 🔗
Get Multiple Catalog Apple Curators ⛔ 🔗

Recommendations

Feature Status Docs Code
Get a Recommendation ⛔ 🔗
Get Multiple Recommendations ⛔ 🔗
Get Default Recommendations ⛔ 🔗

Activities

Feature Status Docs Code
Get a Catalog Activity ✅ 🔗 :octocat:
Get a Catalog Activity's Relationship Directly by Name ✅ 🔗 :octocat:
Get Multiple Catalog Activities ✅ 🔗 :octocat:

History

Feature Status Docs Code
Get Heavy Rotation Content ⛔ 🔗
Get Recently Played Resources ⛔ 🔗
Get Recently Played Stations ⛔ 🔗
Get Recently Added Resources ⛔ 🔗

Storefronts and Localization

Feature Status Docs Code
Get a User's Storefront ✅ 🔗 :octocat:
Get a Storefront ✅ 🔗 :octocat:
Get Multiple Storefronts ✅ 🔗 :octocat:
Get All Storefronts ✅ 🔗 :octocat:

Configuration

NOTE It's necessary to prepare an TEAM_ID, MUSIC_ID, and a secret file in advance. Please confirm Apple Developer Website.

It can be set by either an ENV variable or an config/initializers/apple_music.rb:

AppleMusic.configure do |config|
  config.secret_key_path = './AuthKey_MUSIC_ID.p8' # or ENV['APPLE_MUSIC_SECRET_KEY_PATH']
  config.team_id         = 'YOUR TEAM_ID'          # or ENV['APPLE_MUSIC_TEAM_ID']
  config.music_id        = 'YOUR MUSIC_ID'         # or ENV['APPLE_MUSIC_MUSIC_ID']
  config.storefront      = 'jp'                    # or ENV['APPLE_MUSIC_STOREFRONT'] ('us' by default)
end

License

MIT

apple_music's People

Contributors

dependabot[bot] avatar homologist avatar shiroemons avatar sjaveed avatar yhirano55 avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

yut148 kumabook virgiledelplace venables homologist sjaveed gabriel shcyiza rightsup arkadiyayvazyan natanio

apple_music's Issues

undefined method `configure' for AppleMusic:Module

I have added gem in rails 6 app.
& created a file in config/initializers named apple_music.rb with settings

AppleMusic.configure do |config|
  config.secret_key_path = ENV['APPLE_MUSIC_SECRET_KEY_PATH']
  config.team_id         = ENV['APPLE_MUSIC_TEAM_ID']
  config.music_id        = ENV['APPLE_MUSIC_MUSIC_ID']
  config.storefront      = 'us' 
end

but gives error saying

undefined method `configure' for AppleMusic:Module

Handle re-intializing a new client when the auth token expires

Problem:
I was seeing that after having my server running a while, search results for songs that had been returning results were suddenly an empty array. Inspecting the API's results before the gem returned them showed a 401 error.

Looking at the gem's connection.rb, the client is being memoized with the config.authentication_token which expires after a day.

One suggestion is to improve the handling of API responses to alert when the request is no longer authenticated. This would have helped me see the real problem immediately.

Another suggestion is to check if the token is expired and initialize a new client with a fresh token.

TypeError: no implicit conversion of nil into String 

TypeError: no implicit conversion of nil into String
  from apple_music (c78cf4ffa6fe) lib/apple_music/song/attributes.rb:30:in `parse'
  from apple_music (c78cf4ffa6fe) lib/apple_music/song/attributes.rb:30:in `initialize'
  from apple_music (c78cf4ffa6fe) lib/apple_music/resource.rb:37:in `new'
  from apple_music (c78cf4ffa6fe) lib/apple_music/resource.rb:37:in `initialize'
  from apple_music (c78cf4ffa6fe) lib/apple_music/resource.rb:27:in `new'
  from apple_music (c78cf4ffa6fe) lib/apple_music/resource.rb:27:in `build'
  from apple_music (c78cf4ffa6fe) lib/apple_music/relationship.rb:20:in `block in build_list'
  from apple_music (c78cf4ffa6fe) lib/apple_music/relationship.rb:20:in `map'
  from apple_music (c78cf4ffa6fe) lib/apple_music/relationship.rb:20:in `build_list'
  from apple_music (c78cf4ffa6fe) lib/apple_music/relationship.rb:11:in `initialize'
  from apple_music (c78cf4ffa6fe) lib/apple_music/search_result.rb:16:in `new'
  from apple_music (c78cf4ffa6fe) lib/apple_music/search_result.rb:16:in `initialize'
  from apple_music (c78cf4ffa6fe) lib/apple_music/search.rb:20:in `new'
  from apple_music (c78cf4ffa6fe) lib/apple_music/search.rb:20:in `search'
  from apple_music (c78cf4ffa6fe) lib/apple_music.rb:35:in `search'
  from apple_music (c78cf4ffa6fe) lib/apple_music/song.rb:74:in `search'

ArgumentError: wrong number of arguments (given 3, expected 2) when calling relationships

Context:
ruby: 3.0.4
rails: 6.1

the issue

ArgumentError: wrong number of arguments (given 3, expected 2)
from /usr/local/bundle/gems/apple_music-0.3.1/lib/apple_music/album.rb:47:in `get_relationship'

Same happens when calling ::Apple::Artist.related_albums(artist.id) for instance

PS: If you need that feature now you can call
AppleMusic::Album.get_relationship(raw.id, :artists) to get the related artists of an album for instance

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.