apple_music 0.1.0 → 0.2.0

data/lib/apple_music.rb

@@ -1,6 +1,42 @@
 # frozen_string_literal: true
 
+require 'date'
+
+require 'apple_music/connection'
 require 'apple_music/version'
 
 module AppleMusic # :nodoc:
+  autoload :Activity,       'apple_music/activity'
+  autoload :Album,          'apple_music/album'
+  autoload :AppleCurator,   'apple_music/apple_curator'
+  autoload :Artist,         'apple_music/artist'
+  autoload :Artwork,        'apple_music/artwork'
+  autoload :Chart,          'apple_music/chart'
+  autoload :ChartResponse,  'apple_music/chart_response'
+  autoload :Curator,        'apple_music/curator'
+  autoload :EditorialNotes, 'apple_music/editorial_notes'
+  autoload :Error,          'apple_music/error'
+  autoload :Genre,          'apple_music/genre'
+  autoload :MusicVideo,     'apple_music/music_video'
+  autoload :PlayParameters, 'apple_music/play_parameters'
+  autoload :Playlist,       'apple_music/playlist'
+  autoload :Preview,        'apple_music/preview'
+  autoload :Relationship,   'apple_music/relationship'
+  autoload :Resource,       'apple_music/resource'
+  autoload :Response,       'apple_music/response'
+  autoload :Search,         'apple_music/search'
+  autoload :SearchResult,   'apple_music/search_result'
+  autoload :Song,           'apple_music/song'
+  autoload :Station,        'apple_music/station'
+  autoload :Storefront,     'apple_music/storefront'
+
+  class << self
+    def search(**options)
+      Search.search(**options)
+    end
+
+    def search_hint(**options)
+      Search.search_hint(**options)
+    end
+  end
 end

data/lib/apple_music/activity.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/activity
+  class Activity < Resource
+    class << self
+      # e.g. AppleMusic::Activity.find(976439514)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_activity
+      def find(id, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/activities/#{id}", options)
+        Response.new(response.body).data.first
+      end
+
+      # e.g. AppleMusic::Activity.list(ids: [976439514, 976439503])
+      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::Activity.get_collection_by_ids([976439514, 976439503])
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_activities
+      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}/activities", options.merge(ids: ids))
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Activity.get_relationship(976439514, :playlists)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_activity_s_relationship_directly_by_name
+      def get_relationship(id, relationship_type, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/activities/#{id}/#{relationship_type}", options)
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Activity.related_playlists(976439514)
+      def related_playlists(id, **options)
+        get_relationship(id, :playlists, options)
+      end
+
+      def search(term, **options)
+        AppleMusic.search(**options.merge(term: term, types: :activities)).activities
+      end
+    end
+  end
+end
+
+require 'apple_music/activity/attributes'
+require 'apple_music/activity/relationships'

data/lib/apple_music/activity/attributes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Activity < Resource
+    # https://developer.apple.com/documentation/applemusicapi/activity/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/activity/relationships.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Activity < Resource
+    # https://developer.apple.com/documentation/applemusicapi/activity/relationships
+    class 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/album.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/album
+  class Album < Resource
+    class << self
+      # e.g. AppleMusic::Album.find(310730204)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_album
+      def find(id, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/albums/#{id}", options)
+        Response.new(response.body).data.first
+      end
+
+      # e.g. AppleMusic::Album.list(ids: [310730204, 19075891])
+      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::Album.get_collection_by_ids([310730204, 19075891])
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_albums
+      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}/albums", options.merge(ids: ids))
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Album.get_relationship(310730204, :artists)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_album_s_relationship_directly_by_name
+      def get_relationship(id, relationship_type, **options)
+        storefront = Storefront.lookup(options.delete(:storefront))
+        response = AppleMusic.get("catalog/#{storefront}/albums/#{id}/#{relationship_type}", options)
+        Response.new(response.body).data
+      end
+
+      # e.g. AppleMusic::Album.related_artists(310730204)
+      def related_artists(id, **options)
+        get_relationship(id, :artists, options)
+      end
+
+      # e.g. AppleMusic::Album.related_genres(310730204)
+      def related_genres(id, **options)
+        get_relationship(id, :genres, options)
+      end
+
+      # e.g. AppleMusic::Album.related_tracks(310730204)
+      def related_tracks(id, **options)
+        get_relationship(id, :tracks, options)
+      end
+
+      def search(term, **options)
+        AppleMusic.search(**options.merge(term: term, types: :albums)).albums
+      end
+    end
+  end
+end
+
+require 'apple_music/album/attributes'
+require 'apple_music/album/relationships'

data/lib/apple_music/album/attributes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Album < Resource
+    # https://developer.apple.com/documentation/applemusicapi/album/attributes
+    class Attributes
+      attr_reader :album_name, :artist_name, :artwork, :content_rating,
+                  :copyright, :editorial_notes, :genre_names, :is_complete,
+                  :is_single, :name, :play_params, :record_label, :release_date,
+                  :track_count, :url, :is_mastered_for_itunes
+
+      def initialize(props = {})
+        @album_name = props['albumName'] # required
+        @artist_name = props['artistName'] # required
+        @artwork = Artwork.new(props['artwork']) if props['artwork']
+        @content_rating = props['contentRating']
+        @copyright = props['copyright']
+        @editorial_notes = EditorialNotes.new(props['editorialNotes']) if props['editorialNotes']
+        @genre_names = props['genreNames'] # required
+        @is_complete = props['isComplete'] # required
+        @is_single = props['isSingle'] # required
+        @name = props['name'] # required
+        @play_params = PlayParameters.new(props['playParams']) if props['playParams']
+        @record_label = props['recordLabel'] # required
+        @release_date = begin # required
+                          Date.parse(props['releaseDate'])
+                        rescue ArgumentError
+                          Date.parse("#{props['releaseDate']}/01/01")
+                        end
+        @track_count = props['trackCount'] # required
+        @url = props['url'] # required
+        @is_mastered_for_itunes = props['isMasteredForItunes'] # required
+      end
+
+      def complete?
+        is_complete
+      end
+
+      def single?
+        is_single
+      end
+
+      def mastered_for_itunes?
+        is_mastered_for_itunes
+      end
+    end
+
+    self.attributes_model = self::Attributes
+  end
+end

data/lib/apple_music/album/relationships.rb

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

data/lib/apple_music/apple_curator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/applecurator
+  class AppleCurator < Resource
+  end
+end
+
+require 'apple_music/apple_curator/attributes'
+require 'apple_music/apple_curator/relationships'

data/lib/apple_music/apple_curator/attributes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class AppleCurator < Resource
+    # https://developer.apple.com/documentation/applemusicapi/applecurator/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/apple_curator/relationships.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class AppleCurator < Resource
+    # https://developer.apple.com/documentation/applemusicapi/applecurator/relationships
+    class 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/artist.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/artist
+  class Artist < Resource
+    class << self
+      # e.g. AppleMusic::Artist.find(178834)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_artist
+      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
+
+      # e.g. AppleMusic::Artist.list(ids: [178834, 462006])
+      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::Artist.get_collection_by_ids([178834, 462006])
+      # https://developer.apple.com/documentation/applemusicapi/get_multiple_catalog_artists
+      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
+
+      # e.g. AppleMusic::Artist.get_relationship(178834, :albums)
+      # https://developer.apple.com/documentation/applemusicapi/get_a_catalog_artist_s_relationship_directly_by_name
+      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
+
+      # e.g. AppleMusic::Artist.related_albums(178834)
+      def related_albums(id, **options)
+        get_relationship(id, :albums, options)
+      end
+
+      # e.g. AppleMusic::Artist.related_genres(178834)
+      def related_genres(id, **options)
+        get_relationship(id, :genres, options)
+      end
+
+      # e.g. AppleMusic::Artist.related_playlists(178834)
+      def related_playlists(id, **options)
+        get_relationship(id, :playlists, options)
+      end
+
+      # e.g. AppleMusic::Artist.related_station(178834)
+      def related_station(id, **options)
+        get_relationship(id, :station, options).first
+      end
+
+      def search(term, **options)
+        AppleMusic.search(**options.merge(term: term, types: :artists)).artists
+      end
+    end
+  end
+end
+
+require 'apple_music/artist/attributes'
+require 'apple_music/artist/relationships'

data/lib/apple_music/artist/attributes.rb

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

data/lib/apple_music/artist/relationships.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  class Artist < Resource
+    # https://developer.apple.com/documentation/applemusicapi/artist/relationships
+    class Relationships
+      attr_reader :albums, :genres, :music_videos, :playlists, :station
+
+      def initialize(props = {})
+        @albums = Relationship.new(props['albums']).data
+        @genres = Relationship.new(props['genres']).data
+        @music_videos = Relationship.new(props['musicVideos']).data
+        @playlists = Relationship.new(props['playlists']).data
+        @station = Relationship.new(props['station']).data.first
+      end
+    end
+
+    self.relationships_model = self::Relationships
+  end
+end

data/lib/apple_music/artwork.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AppleMusic
+  # https://developer.apple.com/documentation/applemusicapi/artwork
+  class Artwork
+    attr_reader :bg_color, :height, :width,
+                :text_color1, :text_color2, :text_color3,
+                :text_color4, :url
+
+    def initialize(props = {})
+      @bg_color = props['bgColor']
+      @height = props['height'] # required
+      @width = props['width'] # required
+      @text_color1 = props['textColor1']
+      @text_color2 = props['textColor2']
+      @text_color3 = props['textColor3']
+      @text_color4 = props['textColor4']
+      @url = props['url'] # required
+    end
+
+    def image_url(options = {})
+      @image_url ||= begin
+        width = options[:width] || self.width
+        height = options[:height] || self.height
+        size = options[:size] || "#{width}x#{height}"
+        url.gsub('{w}x{h}', size)
+      end
+    end
+  end
+end