Anunciamos o lançamento do SDK Ruby da Vonage, versão 7.3.0

O SDK do Vonage Ruby lançou recentemente uma nova versão, a v7.3.0. Essa nova versão traz um recurso de paginação automática para os métodos de lista da API, o que torna a coleta de dados das APIs da Vonage mais ágil.

Vamos explorar o raciocínio por trás disso e como funciona.

Por que introduzir a paginação automática?

Por que você deve levar em conta a paginação ao trabalhar com as APIs da Vonage, e como a paginação automática melhora sua experiência?

Podemos entender isso melhor analisando um exemplo da vida real.

A Voice API da Vonage permite obter detalhes de todas as suas chamadas. Quando fazemos essa GET solicitação à API sem nenhum parâmetro, ela retorna, por padrão, apenas as dez primeiras.

O que acontece se você tiver mais de dez chamadas? Você deve continuar fazendo solicitações de API subsequentes para cada página adicional de registros. Isso significa acompanhar a página atual, o número de páginas restantes e o número de registros por página. Talvez isso represente uma carga cognitiva maior do que o esperado, quando tudo o que você quer é uma lista das suas chamadas.

Felizmente, com a versão 7.3.0 do SDK do Ruby, essa tarefa já não é mais de sua responsabilidade.

Conforme descrito pela equipe do SDK da Vonage em uma postagem no blog, acreditamos firmemente que nossos SDKs devem, acima de tudo, facilitar a vida dos desenvolvedores e permitir que realizem seu trabalho da maneira mais simples possível. A paginação automática no SDK para Ruby é mais um passo em direção a esse grande objetivo.

Como isso funciona?

À medida que introduzimos novos recursos no SDK do Ruby, é fundamental que o impacto nos fluxos de trabalho de todos aqueles que o utilizam regularmente para realizar suas tarefas seja mínimo. Por isso, a paginação automática exige que você faça muito pouco para aproveitar suas melhorias.

Agora é possível solicitar todos os seus registros de chamadas telefônicas usando o mesmo método de chamada que você vem utilizando no SDK:

client = Vonage::Client.new
client.applications.list

No entanto, agora o SDK percorrerá automaticamente todas as páginas de registros e as adicionará à coleção de chamadas retornadas a você. Anteriormente, essa chamada de método retornava apenas o número padrão de registros da API (neste caso, 10), e você precisava fazer mais solicitações à API para coletar o restante deles.

Há situações em que você não vai querer retornar todos os seus registros. É possível desativar a paginação automática passando um argumento adicional na chamada do método auto_advance: false. Por exemplo, se você quiser retornar apenas as cinco primeiras chamadas, seu método ficaria assim:

client = Vonage::Client.new
client.applications.list(page_size: 5, auto_advance: false)

Você só precisa adicionar o auto_advance argumento no seu código quando você especificamente não quiser o comportamento padrão. Para a maioria das APIs, o comportamento padrão é avançar automaticamente.

E agora?

Temos mais planos empolgantes em andamento para o Ruby SDK! Continuamos aprimorando os recursos do SDK para alinhá-lo ainda mais ao nosso objetivo de ser um recurso que não apenas faça solicitações HTTP para você, mas, acima de tudo, torne suas tarefas mais fáceis e eficientes.

Sempre incentivamos a participação da comunidade. Fique à vontade para se juntar a nós no GitHub e no Slack da Comunidade Vonage.