apple_music 0.1.0 → 0.2.0

data/lib/apple_music/chart.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/chart
+  class Chart
+    attr_reader :chart, :data, :href, :name, :next
+
+    def initialize(props = {})
+      @chart = props['chart'] # required
+      @data = Array(props['data']).map { |attrs| Resource.build(attrs) } # required
+      @href = props['href'] # required
+      @name = props['name'] # required
+      @next = props['next']
+    end
+
+    class << self
+      # e.g. AppleMusic::Chart.list(types: ['songs', 'albums', 'playlists'], genre: 20, limit: 30)
+      # https://developer.apple.com/documentation/applemusicapi/get_catalog_charts
+      def list(**options)
+        raise ParameterMissing, 'required parameter :types is missing' unless options[:types]
+
+        types = options[:types].is_a?(Array) ? options[:types].join(',') : options[:types]
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/charts", options.merge(types: types))
+        ChartResponse.new(response.body['results'] || {})
+      end
+
+      def search(**_options)
+        warn 'WARN: :charts is not searchable resource'
+      end
+    end
+  end
+end

data/lib/apple_music/chart_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/chartresponse
+  class ChartResponse
+    attr_reader :albums, :music_videos, :songs, :playlists
+
+    def initialize(props = {})
+      @albums       = build_chart(props['albums'])&.data || []
+      @music_videos = build_chart(props['music-videos'])&.data || []
+      @songs        = build_chart(props['songs'])&.data || []
+      @playlists    = build_chart(props['playlists'])&.data || []
+    end
+
+    private
+
+    def build_chart(resources)
+      Array(resources).map { |props| Chart.new(props) }.first
+    end
+  end
+end

data/lib/apple_music/config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'jwt'
+require 'openssl'
+
+module AppleMusic
+  class Config
+    ALGORITHM = 'ES256'
+    TOKEN_EXPIRATION_TIME = 60 * 60 * 24 # 1.day
+    DEFAULT_STOREFRONT = 'us'
+
+    attr_accessor :secret_key, :secret_key_path, :team_id, :music_id,
+                  :token_expiration_time, :adapter, :storefront
+
+    def initialize
+      @secret_key_path = ENV['APPLE_MUSIC_SECRET_KEY_PATH']
+      @secret_key = ENV['APPLE_MUSIC_SECRET_KEY']
+      @team_id = ENV['APPLE_MUSIC_TEAM_ID']
+      @music_id = ENV['APPLE_MUSIC_MUSIC_ID']
+      @token_expiration_time = TOKEN_EXPIRATION_TIME
+      @adapter = Faraday.default_adapter
+      @storefront = ENV.fetch('APPLE_MUSIC_STOREFRONT') { DEFAULT_STOREFRONT }
+    end
+
+    def authentication_token
+      private_key = OpenSSL::PKey::EC.new(apple_music_secret_key)
+      JWT.encode(authentication_payload, private_key, ALGORITHM, kid: music_id)
+    end
+
+    private
+
+    def apple_music_secret_key
+      @secret_key ||= File.read(secret_key_path)
+    end
+
+    def authentication_payload(now = Time.now)
+      {
+        iss: team_id,
+        iat: now.to_i,
+        exp: now.to_i + token_expiration_time
+      }
+    end
+  end
+end

data/lib/apple_music/connection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'apple_music/config'
+
+module AppleMusic
+  class ApiError < StandardError; end
+  class ParameterMissing < StandardError; end
+
+  API_URI = 'https://api.music.apple.com/v1/'
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure(&block)
+      block.call(config)
+    end
+
+    private
+
+    def client
+      @client ||= Faraday.new(API_URI) do |conn|
+        conn.response :json, content_type: /\bjson\z/
+        conn.headers['Authorization'] = "Bearer #{config.authentication_token}"
+        conn.adapter config.adapter
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      if client.respond_to?(name)
+        client.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      client.respond_to?(name, include_private)
+    end
+  end
+end

data/lib/apple_music/curator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/curator
+  class Curator < Resource
+    class << self
+      # e.g. AppleMusic::Curator.find(1107687517)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_curator
+      def find(id, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/curators/#{id}", options)
+        Response.new(response.body).data.first
+      end
+
+      # e.g. AppleMusic::Curator.list(ids: [976439448, 1107687517])
+      def list(**options)
+        raise ParameterMissing, 'required parameter :ids is missing' unless options[:ids]
+
+        get_collection_by_ids(options.delete(:ids), options)
+      end
+
+      # e.g. AppleMusic::Curator.get_collection_by_ids([976439448, 1107687517])
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_curators
+      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}/curators", options.merge(ids: ids))
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Curator.get_relationship(976439448, :playlists)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_curator_s_relationship_directly_by_name
+      def get_relationship(id, relationship_type, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/curators/#{id}/#{relationship_type}", options)
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Curator.related_playlists(976439448)
+      def related_playlists(id, **options)
+        get_relationship(id, :playlists, options)
+      end
+
+      def search(term, **options)
+        AppleMusic.search(**options.merge(term: term, types: :curators)).curators
+      end
+    end
+  end
+end
+
+require 'apple_music/curator/attributes'
+require 'apple_music/curator/relationships'

data/lib/apple_music/curator/attributes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Curator < Resource
+    # https://developer.apple.com/documentation/applemusicapi/curator/attributes
+    class Attributes
+      attr_reader :artwork, :editorial_notes, :name, :url
+
+      def initialize(props = {})
+        @artwork = Artwork.new(props['artwork']) # required
+        @editorial_notes = EditorialNotes.new(props['editorialNotes']) if props['editorialNotes']
+        @name = props['name'] # required
+        @url = props['url'] # required
+      end
+    end
+
+    self.attributes_model = self::Attributes
+  end
+end

data/lib/apple_music/curator/relationships.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Curator < Resource
+    # https://developer.apple.com/documentation/applemusicapi/curator/relationships
+    class Curator::Relationships
+      attr_reader :playlists
+
+      def initialize(props = {})
+        @playlists = Relationship.new(props['playlists']).data
+      end
+    end
+
+    self.relationships_model = self::Relationships
+  end
+end

data/lib/apple_music/editorial_notes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/editorialnotes
+  class EditorialNotes
+    attr_reader :short, :standard
+
+    def initialize(props = {})
+      @short = props['short'] # required
+      @standard = props['standard'] # required
+    end
+  end
+end

data/lib/apple_music/error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/error
+  class Error
+    attr_reader :code, :detail, :id, :source, :status, :title
+
+    def initialize(props = {})
+      @code = props['code'] # required
+      @detail = props['detail']
+      @id = props['id'] # required
+      @source = Source.new(props['source']) if props['source']
+      @status = props['status'] # required
+      @title = props['title'] # required
+    end
+
+    # https://developer.apple.com/documentation/applemusicapi/error/source
+    class Source
+      attr_reader :parameter, :pointer
+
+      def initialize(options = {})
+        @parameter = options['parameter']
+        @pointer = options['pointer']
+      end
+    end
+  end
+end

data/lib/apple_music/genre.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/genre
+  class Genre < Resource
+    class << self
+      # e.g. AppleMusic::Genre.find(14)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_genre
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_song
+      def find(id, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/genres/#{id}", options)
+        Response.new(response.body).data.first
+      end
+
+      # e.g. AppleMusic::Genre.list
+      # e.g. AppleMusic::Genre.list(ids: [20, 34])
+      # https://developer.apple.com/documentation/applemusicapi/get_catalog_top_charts_genres
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_genres
+      def list(**options)
+        if options[:ids]
+          ids = options[:ids].is_a?(Array) ? options[:ids].join(',') : options[:ids]
+          options[:ids] = ids
+        end
+
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/genres", options)
+        Response.new(response.body).data
+      end
+
+      def search(**_options)
+        warn 'WARN: :genres is not searchable resource'
+      end
+    end
+  end
+end
+
+require 'apple_music/genre/attributes'

data/lib/apple_music/genre/attributes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Genre < Resource
+    # https://developer.apple.com/documentation/applemusicapi/genre/attributes
+    class Attributes
+      attr_reader :name
+
+      def initialize(props = {})
+        @name = props['name'] # required
+      end
+    end
+
+    self.attributes_model = self::Attributes
+  end
+end

data/lib/apple_music/music_video.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/musicvideo
+  class MusicVideo < Resource
+    class << self
+      # e.g. AppleMusic::MusicVideo.find(401135199)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_music_video
+      def find(id, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/music-videos/#{id}", options)
+        Response.new(response.body).data.first
+      end
+
+      # e.g. AppleMusic::MusicVideo.list(ids: [401135199, 401147268])
+      # e.g. AppleMusic::MusicVideo.list(isrc: 'GBDCE0900012')
+      def list(**options)
+        if options[:ids]
+          get_collection_by_ids(options.delete(:ids), options)
+        elsif options[:isrc]
+          get_collection_by_isrc(options.delete(:isrc), options)
+        else
+          raise ParameterMissing, 'required parameter :ids or :isrc is missing'
+        end
+      end
+
+      # e.g. AppleMusic::MusicVideo.get_collection_by_ids([401135199, 401147268])
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_music_videos_by_id
+      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}/music-videos", options.merge(ids: ids))
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::MusicVideo.get_collection_by_isrc('GBDCE0900012')
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_music_videos_by_isrc
+      def get_collection_by_isrc(isrc, **options)
+        isrc = isrc.is_a?(Array) ? isrc.join(',') : isrc
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/music-videos", options.merge('filter[isrc]': isrc))
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::MusicVideo.get_relationship(401135199, :albums)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_music_video_s_relationship_directly_by_name
+      def get_relationship(id, relationship_type, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/music-videos/#{id}/#{relationship_type}", options)
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::MusicVideo.related_albums(401135199)
+      def related_albums(id, **options)
+        get_relationship(id, :albums, options)
+      end
+
+      # e.g. AppleMusic::MusicVideo.related_artists(401135199)
+      def related_artists(id, **options)
+        get_relationship(id, :artists, options)
+      end
+
+      # e.g. AppleMusic::MusicVideo.related_genres(401135199)
+      def related_genres(id, **options)
+        get_relationship(id, :genres, options)
+      end
+
+      def search(term, **options)
+        AppleMusic.search(**options.merge(term: term, types: 'music-videos')).music_videos
+      end
+    end
+  end
+end
+
+require 'apple_music/music_video/attributes'
+require 'apple_music/music_video/relationships'

data/lib/apple_music/music_video/attributes.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class MusicVideo < Resource
+    # https://developer.apple.com/documentation/applemusicapi/musicvideo/attributes
+    class Attributes
+      attr_reader :album_name, :artist_name, :artwork, :content_rating, :duration_in_millis,
+                  :editorial_notes, :genre_names, :isrc, :name, :play_params, :previews,
+                  :release_date, :track_number, :url, :video_sub_type, :has_hdr, :has_4k
+
+      def initialize(props = {})
+        @album_name = props['albumName']
+        @artist_name = props['artistName'] # required
+        @artwork = Artwork.new(props['artwork']) # required
+        @content_rating = props['contentRating']
+        @duration_in_millis = props['durationInMillis']
+        @editorial_notes = EditorialNotes.new(props['editorialNotes']) if props['editorialNotes']
+        @genre_names = props['genreNames'] # required
+        @isrc = props['isrc'] # required
+        @name = props['name'] # required
+        @play_params = PlayParameters.new(props['playParams']) if props['playParams']
+        @previews = Array(props['previews']).map { |attrs| Preview.new(attrs) } # required
+        @release_date = Date.parse(props['releaseDate']) # required
+        @track_number = props['trackNumber']
+        @url = props['url'] # required
+        @video_sub_type = props['videoSubType']
+        @has_hdr = props['hasHDR'] # required
+        @has_4k = props['has4K'] # required
+      end
+
+      def has_hdr?
+        has_hdr
+      end
+
+      def has_4k?
+        has_4k
+      end
+    end
+
+    self.attributes_model = self::Attributes
+  end
+end