tunein metadata request - adaptation for Liquidsoap2

[griffon56]

Hi, I downloaded the Liquidsoap 2 latest official docker image and run t flawlessly on my machine.
Only I get the following error on the tunein.submit function :

At /etc/liquidsoap/tunein2.liq, line 26, char 10-16:                                                                                                             
  x = fst(answer)                                                                                                                                                
                                                                                                                                                                 
Error 5: this value has type                                                                                                                                     
  string (inferred at /etc/liquidsoap/tunein2.liq, line 25, char 11-24)                                                                                          
but it should be a subtype of                                                                                                                                    
  _ * _

def tunein.submit(~partnerid,~partnerkey,~stationid,~commercial=false,m) =
  params = [ ..snip...... ]
  log(level=3, "tunein.submit: title=#{m['title']}; artist=#{m['artist']}; " ^
               "album=#{m['album']}; commercial=#{commercial}")
  url = "http://air.radiotime.com/Playing.ashx?" ^ string.concat(separator="&", params)
  log(level=4, "tunein.submit: url=" ^ url)
  answer = http.get(url)
  x = fst(answer)
  status = fst(x)
  y = fst(status)
 ..snip...
  end
end

Is the error due to the http.get call and the possible missing ocurl library in the official image ? How to check if ocurl is present - if not how to add it ?
I noticed the curl package is installed on the container.
Thanks for your advice

[vitoyucepi]

Hi @griffon56,
Your problem was caused not by curl, but rather because of function http.get definition.
I think the function tunein.submit didn't receive any updates since liquidsoap 1.4.4.
Here are the docs about http.get in 1.4.4.
It returns a sequence(tuple) of status, headers, and data.
To get status you have to get the first item of this sequence using fst(answer).

Since version 2.0.0 http.get has another definition.
Here's a sample that will send a request to ifconfig.me and print the response data and params.

a = http.get('ifconfig.me/all.json')
print('#{a}')
print(a.headers)
print(a.protocol_version)
print(a.status_code)
print(a.status_message)

You have to update the tunein.submit function to fit the signature of http.get.

I've also found some bugs

1. empty status_message;
2. redirect string in the answer.

[griffon56]

Hi @vitoyucepi !
Thanks for your quick feedback. You are so right in your explanations and got me sorted after I fixed the http.get response.

Additionnaly,
The name of the function tunein.submit() had to be changed to tunein() to prevent errrors.
The following line calling the tunein function ...

radio = on_metadata(tunein.submit(partnerid="XXXX",partnerkey="XXXXXX",stationid="sXXXXX"), radio)

... had to be changed to :

radio.on_metadata(tunein(partnerid="XXXX",partnerkey="XXXXXX",stationid="sXXXXX"))

here is the tunein2.liq file working with Liquidsoap2 :

# Submit now playing metadata to tunein.com.
# usage:
#   %include "tunein.liq"
#   s = on_track(tunein.submit(partnerid="ppppid",partnerkey="ppppkey",stationid="s123456"), s)
# Requires parterId, partnerKey and stationId. See http://tunein.com/broadcasters/api/.
# @category Interaction
# @param ~partnerid Set to supplied parterId.
# @param ~partnerkey Set to supplied partnerKey.
# @param ~stationid Set to supplied stationId.
# @param ~commercial Set to true if track is a commercial.  Defaults to false.
def tunein(~partnerid,~partnerkey,~stationid,~commercial=false,m) =
  params = [
    "partnerId=" ^ url.encode(partnerid),
    "partnerKey=" ^ url.encode(partnerkey),
    "id=" ^ url.encode(stationid),
    "title=" ^ url.encode(m["title"]),
    "artist=" ^ url.encode(m["artist"]),
    "album=" ^ url.encode(m["album"]),
    "commercial=#{commercial}"
  ]
  log(level=3, "tunein.submit: title=#{m['title']}; artist=#{m['artist']}; " ^
               "album=#{m['album']}; commercial=#{commercial}")
  url = "http://air.radiotime.com/Playing.ashx?" ^ string.concat(separator="&", params)
  log(level=4, "tunein.submit: url=" ^ url)
  answer = http.get(url)
  code = answer.status_code
  protocol = answer.status_code
  message = answer.status_message
  if code != 200 then
    headers = answer.headers
    log(level=3,"tunein.submit: Response status: #{protocol} #{code} #{message}")
    log(level=4,"Response headers: #{headers}")
  end
end

[vitoyucepi]

Here's my vision of your function.

def url.format(~parameters=[], url_prefix)
  if list.length(parameters) == 0 then
    "#{url_prefix}"
  else
    def encode_parameter(pair)
      "#{url.encode(fst(pair))}=#{url.encode(snd(pair))}"
    end
    encoded_parameters = list.map(encode_parameter, parameters)
    parameters_string = string.concat(separator="&", encoded_parameters)
    "#{url_prefix}?#{parameters_string}"
  end
end 

let tunein = ()

def tunein.log(~level=3, ~label="tunein", message)
  log(level=level, label=label, message)
end 

def tunein.submit(~partnerid, ~partnerkey, ~stationid, ~commercial=false, m)
  params = [ 
    ("partnerId", string_of(partnerid)),
    ("partnerKey", string_of(partnerkey)),
    ("id", string_of(stationid)),
    ("title", m["title"]),
    ("artist", m["artist"]),
    ("album", m["album"]),
    ("commercial", string_of(commercial))
  ] 
  tunein.log("title=#{m['title']}; artist=#{m['artist']}; album=#{m['album']}; commercial=#{commercial}")
  request_url = url.format(parameters=params, "http://air.radiotime.com/Playing.ashx")
  tunein.log(level=4, "url=#{request_url}")
  answer = http.get(request_url)
  if answer.status_code != 200 then
    tunein.log("Response status: #{answer.status_code} #{answer.status_message}")
    tunein.log(level=4, "Response headers: #{answer.headers}")
  end
end

Please note that it logs request_url with all the secrets.
I noticed that the host could return status 200 OK, but the response body will contain an error.