Contents

# 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

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
apple_music-0.3.1	lib/apple_music/chart.rb
apple_music-0.3.0	lib/apple_music/chart.rb
apple_music-0.2.0	lib/apple_music/chart.rb