Awesome

NCLua HTTP

Quem conhece e utiliza meus projetos de TV Digital como o NCLua SOAP, já deve saber da existência, há algum tempo, do módulo "http". Tal módulo é utilizado para a realização de requisições utilizando o protocolo HTTP. Como o mesmo ficava escondido dentro dos outros projetos, resolvi tratá-lo como um projeto separado.

A norma ABNT do Ginga-NCL (NBR 15606-2) define uma classe "tcp" para realização de requisições utilizando o protocolo de mesmo nome, a partir de scripts NCLua (scripts Lua embutidos em documentos NCL). Porém, a norma não define nenhuma implementação para o protocolo HTTP. Este é um protocolo de camada de aplicação, que é trafegado utilizando TCP. Logo, para realizar requisições HTTP, o desenvolvedor de aplicações NCLua precisa compreender tal protocolo, saber o formato das mensagens, quais cabeçalhos devem ser incluídos na mensagem de requisição, e saber o formato da mensagem de resposta para poder separar o resultado do cabeçalho da resposta. Logo, a realização de requisições HTTP em NCLua não é trivial como ocorre em linguagens como Java, Delphi, PHP e outras, onde o desenvolvedor apenas chama funções, informando a URL da página e parâmetros a serem enviados a ela.

Por este motivo, foi desenvolvido o módulo NCLua HTTP. O mesmo depende do módulo TCP, disponibilizado pela PUC-Rio (já incluso como dependência).

O módulo TCP trabalha com chamadas assíncronas, tornando mais difícil para o programador obter o retorno da requisição, pois ele não pode simplesmente chamar uma função para realizar uma requisição e receber o retorno, como exemplificado abaixo:

response = send_request(host, request)

O módulo NCLua HTTP facilita o envio de requisições, encapsulando todo o gerenciamento das requisições assíncronas do protocolo TCP no Ginga-NCL. No entanto, a chamada ainda não é tão simples como o exemplo apresentado, mas já facilita muito o uso e deixa o programador livre de conhecer os detalhes do protocolo HTTP.

O módulo também permite a realização de requisições que requerem autenticação básica. Para realizar tal autenticação, os dados de login e senha devem ser codificados utilizando o esquema base64. Para isso, foi utilizado o módulo base64 disponível no Lua Users.

Documentação

A documentação do projeto foi gerada utilizando luadoc e está disponível na pasta doc.

Exemplo de uso

A seguir é demonstrado um exemplo simples de uso do módulo, que envia uma requisição GET a uma página em um servidor Web. O exemplo está disponível no arquivo para download, estando todo comentado. A linha package.path define onde pacotes lua devem ser procurados. No exemplo abaixo, está considerando-se que o arquivo do exemplo e os arquivos do módulo estão na mesma pasta.

package.path = package.path .. ';./?.lua'
local ncluahttp = require "ncluahttp"

function callback(header, body)
  if body then
     print("\n\n\n", body, "\n\n\n")
  end
end

ncluahttp.request("http://manoelcampos.com.br/dtv/arquivo.txt", callback)