Burgestrand/spotify

module Spotify
  # Public utility helper methods.
  module Util
    module_function

    # Retrieves the associated value of an enum from a given symbol, raising an error if it does not exist.
    #
    # @example retrieving a value
    #    Spotify::Util.enum_value!(:ok, "error value") # => 0
    #
    # @example failing to retrieve a value
    #    Spotify::Util.enum_value!(:moo, "connection rule") # => ArgumentError, invalid connection rule: :moo
    #
    # @api public
    # @param [Symbol] symbol
    # @param [#to_s] type used as error message when the symbol does not resolve
    # @raise [ArgumentError] when the symbol does not exist as an enum value
    # @return [Integer]
    def enum_value!(symbol, type)
      Spotify::API.enum_value(symbol) or raise ArgumentError, "invalid #{type}: #{symbol.inspect}"
    end

    # @see platform
    # @api public
    # @return [Boolean] true if on Linux
    def linux?
      platform == :linux
    end

    # @api public
    # @return [Symbol] platform as either :mac, :windows, or :linux
    def platform
      case FFI::Platform::OS
      when /darwin/ then :mac
      when /linux/  then :linux
      when /windows/  then :windows
      else
        $stderr.puts "[WARN] You are running the Spotify gem on an unknown platform. (#{__FILE__}:#{__LINE__})"
        $stderr.puts "[WARN] Platform: #{FFI::Platform::OS}"
        :unknown
      end
    end
  end
end