Annonce de la version 7.3.0 du SDK Ruby de Vonage

Le SDK Ruby de Vonage a récemment publié une nouvelle version, v7.3.0. Cette nouvelle version introduit une fonction d'auto-pagination pour les méthodes de liste API, ce qui rend la collecte de vos données à partir des API de Vonage plus rationnelle.

Examinons le raisonnement qui le sous-tend et son fonctionnement.

Pourquoi introduire l'auto-pagination ?

Pourquoi devriez-vous penser à la pagination lorsque vous travaillez avec les API de Vonage, et comment la pagination automatique améliore-t-elle votre expérience ?

Un exemple concret permet de mieux comprendre ce phénomène.

L'API Voice de Vonage permet de d'obtenir les détails de tous vos appels. Lorsque nous faisons cette demande à l'API sans aucun paramètre, elle ne renvoie par défaut que les dix premiers appels. GET à l'API sans aucun paramètre, elle ne renvoie par défaut que les dix premiers.

Que se passe-t-il si vous avez plus de dix appels ? Vous devez continuer à faire des demandes d'API pour chaque page supplémentaire d'enregistrements. Cela signifie que vous devez suivre la page actuelle, le nombre de pages restantes et le nombre d'enregistrements par page. Cela représente peut-être une charge cognitive plus importante que prévu, alors que vous souhaitez simplement obtenir une liste de vos appels.

Heureusement, la version 7.3.0 du SDK Ruby vous décharge de ce travail.

Comme le décrit l'équipe SDK de Vonage dans un billet de blognous croyons fermement que nos SDK doivent avant tout vous faciliter la vie en tant que développeur et vous permettre de faire votre travail aussi facilement que possible. La pagination automatique dans le SDK Ruby est un pas de plus vers ce grand objectif.

Comment cela fonctionne-t-il ?

Lorsque nous introduisons de nouvelles fonctionnalités dans le SDK Ruby, il est essentiel de minimiser l'impact sur les flux de travail de tous ceux qui l'utilisent régulièrement pour accomplir leur travail. Ainsi, l'auto-pagination ne vous demande que très peu d'efforts pour tirer parti de ses améliorations.

Il est désormais possible de demander tous vos enregistrements d'appels téléphoniques en utilisant la même méthode que celle utilisée dans le SDK :

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

Toutefois, à présent, le SDK progressera automatiquement dans toutes les pages d'enregistrements et les ajoutera à la collection d'appels qui vous est renvoyée. Auparavant, cet appel de méthode ne renvoyait que le nombre d'enregistrements par défaut pour l'API (dans ce cas, 10), et vous deviez effectuer d'autres demandes d'API pour rassembler le reste d'entre eux.

Dans certaines situations, vous ne souhaiterez pas renvoyer tous vos enregistrements. Il est possible de désactiver la pagination automatique en passant un argument supplémentaire dans l'appel de la méthode auto_advance: false. Par exemple, si vous souhaitez ne renvoyer que vos cinq premiers appels, votre méthode ressemblerait à ceci :

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

Vous ne devez ajouter l'argument auto_advance dans votre code lorsque vous ne souhaitez pas utiliser le comportement par défaut. Pour la plupart des API, le comportement par défaut est l'avance automatique.

Quelle est la prochaine étape ?

Nous avons d'autres projets passionnants pour le SDK Ruby ! Nous continuons à développer les fonctionnalités du SDK afin de l'aligner sur notre objectif d'être une ressource qui ne se contente pas de faire des requêtes HTTP pour vous, mais qui rend vos tâches plus faciles et plus rationnelles.

La participation de la communauté est toujours la bienvenue. N'hésitez pas à nous rejoindre sur GitHub et sur Communauté Vonage Slack.