plivo 0.3.19 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f17b3110741fa96e01482d33428105adf80494
-  data.tar.gz: 523a1d10dcd6460ead4d1211f6c068a3a3e6e53c
+  metadata.gz: 6472d23802b39086fb94ce313553e668bd3f210b
+  data.tar.gz: b620b7efeb18cbd2680d5701ba1054e23a0e3874
 SHA512:
-  metadata.gz: c97730771de4bb3abdfd55d8c5e3705455ae059d57e4f976a4a35c86abdb02eb401b061c45d1bd045ff87d21bbaa16b6956326cafc635e44d19c8e6e0e8cdf39
-  data.tar.gz: 063f82c22953e7fa294a1b9bec40b7eeb39dc13e51b3f1eaaeb5b492d51b88abc153d166ac8bad59b910397e0105c45261c1e07a7b0abb9c7d06c7e34b1984a5
+  metadata.gz: c5bbacc139403864cf9ee636063d8eb9717a9b8b175a4265d08cdaa85c3813f678a97573940a2c8d90c15d364c535578932331b817b7278f96c0ccdaa6c81f2b
+  data.tar.gz: a2ec84374d288f88cba292e667193810f51c6565be8c5457ee8deb952eb1c6f160f62205fb5d85532dc0d542c3880fe4552d79eb20c63bf0afa0e97bf3c648ac

data/.gitignore

@@ -0,0 +1,14 @@
+.idea/
+.DS_STORE
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+pkg/
+doc/
+spec/reports/
+tmp/
+bin/
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+cache: bundler
+bundler_args: --without development
+rvm:
+  - ruby-head
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1
+  - 2.0.0

data/AUTHORS.md

@@ -0,0 +1,4 @@
+# Authors
+- [Sreyantha Chary](https://sreyanth.com?ref=github/plivo-python) ([@sreyanth](https://github.com/sreyanth))
+- Kritarth ([@kritarth3010](https://github.com/kritarth3010))
+- Abhishek ([@abhishek-plivo](https://github.com/abhishek-plivo))

data/CHANGELOG.md

@@ -0,0 +1,158 @@
+# Change Log
+
+## [4.20.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.20.0) (2021-08-04)
+- Added continue speak XML element support.
+
+## [4.19.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.19.0) (2021-07-19)
+- Add support for Voice MultiPartyCall APIs (includes retry) and XML, validate voice UTs
+
+## [4.18.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.18.0) (2021-07-13)
+- Power pack ID has been included to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message).
+- Support for filtering messages by Power pack ID has been added to the [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages).
+
+## [4.17.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.17.1) (2021-06-18)
+- **WARNING**: Remove total_count field from meta data for list MDR response
+
+## [4.17.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.17.0) (2021-06-15)
+- Added stir verification param as part of Get CDR and live call APIs response.
+
+## [4.16.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.16.0) (2021-02-08)
+- Add support for Regulatory Compliance APIs.
+
+## [4.15.2](https://github.com/plivo/plivo-ruby/releases/tag/v4.15.2) (2021-01-27)
+- Fix Call API resource - Set answer_method as Optional param.
+
+## [4.15.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.15.1) (2021-01-06)
+- Fix Search Phone Numbers API using City Attribute.
+
+## [4.15.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.15.0) (2020-11-17)
+- Add number_priority support for Powerpack API.
+
+## [4.14.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.14.0) (2020-10-30)
+- Change lookup API endpoint and response.
+
+## [4.13.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.13.0) (2020-09-30)
+- Add support for Lookup API
+
+## [4.12.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.12.0) (2020-09-24)
+- Add "public_uri" optional param support for Application API.
+
+## [4.11.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.11.0) (2020-08-25)
+- Add Powerpack for mms
+
+## [4.10.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.10.0) (2020-09-04)
+- Add ConferenceUuid & CallState for Get Details of a Call API 
+- Upgrade faraday & faraday_middleware dependencies
+
+## [4.9.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.9.1) (2020-08-19)
+- Internal changes in Phlo for MultiPartyCall component
+
+## [4.9.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.9.0) (2020-07-23)
+- Add retries to multiple regions for voice requests.
+
+## [4.8.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.8.1) (2020-06-05)
+- Fix Record a Conference API response.
+
+## [4.8.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.8.0) (2020-05-28)
+- Add JWT helper functions.
+
+## [4.7.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.7.1) (2020-05-06)
+- Fix Send MMS with existing media_ids.
+
+## [4.7.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.7.0) (2020-04-29)
+- Add V3 signature helper functions.
+
+## [4.6.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.6.1) (2020-04-02)
+- Add nil check for API requests.
+
+## [4.6.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.6.0) (2020-03-31)
+- Add application cascade delete support.
+
+## [4.5.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.5.0) (2020-03-30)
+- Add Tollfree support for Powerpack
+
+## [4.4.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.4.0) (2020-03-27)
+- Add post call quality feedback API support.
+
+## [4.3.5](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.5) (2019-12-28)
+- Add Media support
+
+## [4.3.4](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.4) (2019-12-20)
+- Add Powerpack support
+
+## [4.3.3](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.3) (2019-12-04)
+- Add MMS support
+
+## [4.3.2](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.2) (2019-11-13)
+- Add GetInput XML support
+
+## [4.3.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.1) (2019-10-16)
+- Add SSML support
+
+## [4.3.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.0) (2019-03-12)
+- Add PHLO support
+- Add Multi-Party Call triggers
+
+## [4.2-beta1](https://github.com/plivo/plivo-ruby/releases/tag/v4.2-beta1) (2019-03-11)
+- Add PHLO support
+- Add Multi-Party Call triggers
+
+## [4.1.8](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.8) (2019-02-27)
+- Fix log_incoming_messages having no effect while application creation
+
+## [4.1.7](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.7) (2019-02-20)
+- Fix responses for all API resources(responses were returning a hash).
+
+## [4.1.6](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.6) (2018-11-26)
+- Fix bignum deprecated warning in Ruby 2.4+.
+
+## [4.1.5](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.5) (2018-11-21)
+- Add hangup party details to CDR. CDR filtering allowed by hangup_source and hangup_cause_code.
+- Add sub-account cascade delete support.
+
+## [4.1.4](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.4) (2018-10-29)
+- Add live calls filtering by from, to numbers and call_direction.
+
+## [4.1.3](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.3) (2018-10-01)
+- Added Trackable parameter in messages.
+
+## [4.1.2](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.2) (2018-09-18)
+- Added parent_call_uuid parameter to filter calls.
+- Queued status added for filtering calls in queued status.
+- Added log_incoming_messages parameter to application create and update.
+
+## [4.1.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.1) (2018-08-08)
+- Upgraded version of faraday_middleware to 0.12.2 which parses YAML safely
+
+## [4.1.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.0) (2018-02-26)
+- Add Address and Identity resources
+- Change a few functions in number-related methods to support the verification flows
+
+## [4.0.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.0.0) (2018-01-18)
+- Now supports timeout & proxy (in a non-deprecated way) settings
+- A bug fixed (#55)
+
+## [4.0.0.beta.2](https://github.com/plivo/plivo-ruby/releases/tag/v4.0.0.beta.2) (2017-10-24)
+- The new SDK works with Ruby >= 2. Tested against 2.0.0, 2.1, 2.2.0, 2.3.0, 2.4.0, 2.5-dev.
+- JSON serialization and deserialization is now handled by the SDK
+- The API interfaces are consistent and guessable
+- Handles pagination automatically when listing all objects of a resource
+
+## [v0.3.19](https://github.com/plivo/plivo-ruby/tree/v0.3.19) (2015-11-24)
+- Add `modify_number` function
+
+## [0.3.17](https://github.com/plivo/plivo-ruby/tree/v0.3.17) (2015-07-21)
+- Add support for `digitsMatchBLeg` in Dial XML
+- `stop_speak_member` function added
+
+## Other changes
+- 2013-10-23 Added `stop_speak()`
+- 2013-09-25 Added `relayDTMF` to `<Conference>` and `async` to `<DTMF>`
+- 2013-08-17 Fix unicode characters only for speak element.
+- 2013-08-12 Fix unicode characters only for speak APIs.
+- 2013-07-26 Added `XPlivoSignature` header validation.
+- 2013-07-21 Added outgoing carrier and carrier routing apis.
+- 2013-07-20 Added `recordWhenAlone` to `<Conference>`.
+- 2013-07-14 Unicode character support in XML and API.
+- 2013-03-15 Added `min_silence` to `<Wait>`.
+- 2013-02-23 Pricing API added.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake', '~> 10.1'
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
+  gem 'json'
+end

data/Jenkinsfile

@@ -0,0 +1,7 @@
+#!groovy
+
+@Library('plivo_standard_libs@sdks') _
+
+sdksPipeline ([
+	buildContainer: 'plivo/jenkins-ci/plivo-rubysdk:master'
+])

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2018, Plivo Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,48 +1,179 @@
-# Plivo Ruby Library
+# plivo-ruby
 
-[![Gem Version](https://badge.fury.io/rb/plivo.png)](http://badge.fury.io/rb/plivo) 
-[![Dependency Status](https://gemnasium.com/plivo/plivo-ruby.png)](https://gemnasium.com/plivo/plivo-ruby)
+[![Build Status](https://travis-ci.org/plivo/plivo-ruby.svg?branch=4.0)](https://travis-ci.org/plivo/plivo-ruby)
 
-## Description
+The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
 
-The Plivo Ruby library simplifies the process of making REST calls and generating RESTXML.
+## Installation
+Add this line to your application's Gemfile:
 
-See [Plivo Documentation](http://www.plivo.com/docs/) for more information.
+```ruby
+gem 'plivo', '>= 4.20.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plivo
+
+For features in beta, use the beta branch:
+
+    $ gem install plivo --pre
+
+If you have the `0.3.19` version (a.k.a legacy) already installed, you may have to first uninstall it before installing the new version.
+
+## Getting started
+
+### Authentication
+To make the API requests, you need to create a `RestClient` and provide it with authentication credentials (which can be found at [https://console.plivo.com/dashboard/](https://console.plivo.com/dashboard/)).
+
+We recommend that you store your credentials in the `PLIVO_AUTH_ID` and the `PLIVO_AUTH_TOKEN` environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:
+
+```ruby
+client = RestClient.new;
+```
+
+Alternatively, you can specifiy the authentication credentials while initializing the `RestClient`.
+
+```ruby
+client = RestClient.new('your_auth_id', 'your_auth_token');
+```
+
+### The basics
+The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
+
+```ruby
+client.resources.create(params); # Create
+client.resources.get(resource_identifier); # Get
+client.resources.update(resource_identifier, params); # Update
+client.resources.delete(resource_identifier); # Delete
+client.resources.list; # List all resources, max 20 at a time
+```
+
+You can also use the `resource` directly to update and delete it. For example,
 
+```ruby
+resource = client.resources.get(resource_identifier);
+resource.update(params); # update the resource
+resource.delete(); # Delete the resource
+```
+
+Also, using `client.resources.list` would list the first 20 resources by default (which is the first page, with `limit` as 20, and `offset` as 0). To get more, you will have to use `limit` and `offset` to get the second page of resources.
+
+To list all resources, you can simply use the following pattern that will handle the pagination for you automatically, so you won't have to worry about passing the right `limit` and `offset` values.
+
+```ruby
+client.resources.each do |resource|
+  puts resource.id
+end
+```
+
+## Examples
+
+### Send a message
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+client = RestClient.new
+message_created = client.messages.create(
+  'your_source_number',
+  %w[your_destination_number_1 your_destination_number_2],
+  'Hello, world!'
+)
+```
+
+### Make a call
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+client = RestClient.new
+call_made = client.calls.create(
+  'your_source_number',
+  ['your_destination_number'],
+  'https://answer.url'
+)
+```
 
-## GEM Installation
+### Lookup a number
 
-    $ sudo gem install plivo
+```ruby
+require 'rubygems'
+require 'plivo'
 
+include Plivo
 
-## Manual Installation
+client = RestClient.new
+resp = client.lookup.get('<number-here>')
+```
 
-To use the rake command to build the gem and
+### Generate Plivo XML
 
-**Download the source and run:**
-    $ sudo gem install /path/to/plivo/gem
+```ruby
+require 'rubygems'
+require 'plivo'
 
-to finish the installation
+include Plivo::XML
 
-### Requirements
+response = Response.new
+response.addSpeak('Hello, world!')
+puts response.to_xml # Prints the XML string
 
+xml_response = PlivoXML.new(response)
+puts xml_response.to_xml # Prints XML along with XML version & encoding details
 ```
-gem "rest-client", "~> 1.6.7"
-gem "json", "~> 1.6.6"
-gem "htmlentities", "~> 4.3.1"
+This generates the following XML:
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<Response>
+  <Speak>Hello, world!</Speak>
+</Response>
 ```
 
-## Usage
+### Run a PHLO
 
-To use the Plivo Ruby library, you will need to specify the AUTH_ID and AUTH_TOKEN, before you can make REST requests.
+```ruby
+require 'rubygems'
+require 'plivo'
 
-See [Plivo Documentation](http://www.plivo.com/docs/) for more information.
+include Plivo
 
-## Files
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
 
-**lib/plivo.rb:** include this library in your code
+client = Phlo.new(AUTH_ID, AUTH_TOKEN)
 
-# License
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = Phlo.new
+
+# run a phlo:
+begin
+    #parameters set in PHLO - params
+    params = {
+       from: '9999999999',
+       to: '0000000000'
+    }
+    response = phlo.run(params)
+    puts response
+  rescue PlivoRESTError => e
+    puts 'Exception: ' + e.message
+  end
+```
 
+### More examples
+Refer to the [Ruby API Reference](https://api-reference.plivo.com/latest/ruby/introduction/overview) for more examples. Also refer to the [guide to setting up dev environment](https://developers.plivo.com/getting-started/setting-up-dev-environment/) on [Plivo Developers Portal](https://developers.plivo.com) to setup a Sinatra server & use it to test out your integration in under 5 minutes.
 
-The Plivo Ruby library is distributed under the MPL 1.1 License
+## Reporting issues
+Report any feedback or problems with this version by [opening an issue on Github](https://github.com/plivo/plivo-ruby/issues).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/ci/config.yml

@@ -0,0 +1,7 @@
+---
+parent: central
+serviceName: plivo-ruby
+language: ruby-sdk
+build:
+  command: |
+      gem build plivo.gemspec

data/examples/conference_bridge.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = Phlo.new
+#
+
+# provide the phlo_id in params
+begin
+  phlo = client.phlo.get('11a5f5cf-b6cd-419b-8ada-e41ef073de74')
+  conference_bridge = phlo.conference_bridge('b24d49ea-fb62-4612-9d98-4565c67f0bdc')
+  puts conference_bridge
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "name"=>"Conference_1",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 1. member leaves the call [HANGUP]:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).hangup
+
+begin
+  response = conference_bridge.member('0000000000').hangup
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 2. Mute a member in the conference bridge:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).mute
+
+begin
+  response = conference_bridge.member('0000000000').mute
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 3. Unmute a member in the conference bridge:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).unmute
+
+begin
+  response = conference_bridge.member('0000000000').unmute
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }

data/examples/jwt.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'MADADADADADADADADADA'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+begin
+  acctkn = Plivo::Token::AccessToken.new(
+    AUTH_ID,
+    AUTH_TOKEN,
+    '{username}',
+    '{uid}'
+  )
+  # update token validity (from, lifetime)
+  acctkn.update_validity(Time.now, 300)
+  # add voice grants (incoming, outgoing)
+  acctkn.add_voice_grants(Plivo::Token::VoiceGrants.new(true, true))
+  puts acctkn.to_jwt
+
+  # update token validity (from, nil, till)
+  acctkn.update_validity(Time.now, nil, Time.now + 300)
+  # add voice grants (incoming, outgoing)
+  acctkn.add_voice_grants(Plivo::Token::VoiceGrants.new(true, true))
+  puts acctkn.to_jwt
+rescue ValidationError => e
+  puts 'Exception: ' + e.message
+end
+
+# Sample Response:
+#

data/examples/lookup.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "plivo"
+
+include Plivo
+include Plivo::Exceptions
+
+AUTH_ID = ""
+AUTH_TOKEN = ""
+
+client = RestClient.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = RestClient.new
+
+begin
+  resp = client.lookup.get(
+    "<insert-number-here>",
+    "carrier"
+  )
+  puts resp
+rescue PlivoRESTError => e
+  puts "Exception: " + e.message
+end