Upgrade from Ruby Legacy to v4.9.0 or Latest Version

Introduction

This is a major application update. Plivo recommends you always use the latest or an active version of our SDKs for guaranteed security, stability, and uptime. The active SDK versions are designed to handle intermittent and regional failures of API requests. In addition, they offer a host of security features, such as protection against DoS attacks and bot detection for suspicious user agents.

Deprecation notice: We’re deprecating Plivo Ruby SDK legacy versions lower than v4.9.0 on January 31, 2022. If you use a deprecated version of our SDK after that date, your API requests and messaging may fail intermittently. Plivo will no longer provide bug fixes to these versions, and our support team may ask you to upgrade before debugging issues.

Migrate your applications

Ruby version support

The Plivo Ruby SDK supports Ruby 2.0 and higher.

Use the command gem install plivo -v 4.9.0 to upgrade to the active version of the SDK, or gem update plivo to upgrade to the latest version.

After you upgrade to the latest version of the SDK, you should check every program that depends on it and make changes to the syntax for several kinds of operations. Here are examples of how coding differs between the deprecated legacy version of the SDK and the latest active versions.

Import the SDK

Legacy Latest 
require 'plivo'
   
require 'plivo'

Initialize

Legacy Latest 
p = RestAPI.new("<auth_id>","<auth_token>")
   
api = RestClient.new("<auth_id>","<auth_token>")

Access resources

Legacy Latest 
response = p.send_message(params)
   
response = api.messages.create(params)

Send a message

Legacy Latest 
require 'rubygems'
require 'plivo'
include Plivo

AUTH_ID = "<auth_id>"
AUTH_TOKEN = "<auth_token>"

p = RestAPI.new(AUTH_ID, AUTH_TOKEN)
params = {
    'src' => '+12025551212',
    'dst' => '+12025552323',
    'text' => 'Hello, this is a sample text',
    'url' => 'https://<yourdomain>.com/sms status/',
}
response = p.send_message(params)
puts response
   
require 'plivo'
include Plivo

api = RestClient.new('<auth_id>','<auth_token>')
response = api.messages.create(
	src:"+12025551212",
	dst:"+12025552323",
	text:"Hello, this is a sample text",
	url:"https://<yourdomain>.com/sms status/",
)
puts response

Retrieve a message

Legacy Latest 
require 'rubygems'
require 'plivo'
include Plivo

AUTH_ID = '<auth_id>'
AUTH_TOKEN = '<auth_token>'
p = RestAPI.new(AUTH_ID, AUTH_TOKEN)

params = {'record_id' => '<your_message_uuid>'}
response = p.get_message(params)
   
require 'rubygems'
require 'plivo'

include Plivo

api = RestClient.new('<auth_id>','<auth_token>')
response = api.messages.get('<your_message_uuid>')
puts response

List all messages

Legacy Latest 
require 'rubygems'
require 'plivo'
include Plivo

AUTH_ID = "<auth_id>"
AUTH_TOKEN = "<auth_token>"
p = RestAPI.new(AUTH_ID, AUTH_TOKEN)

response = p.get_messages()
puts response

params = {
    'limit' => '5',
    'offset' => '0',
}

response = p.get_messages(params)

puts response
   
require 'plivo'
include Plivo

api = RestClient.new('<auth_id>','<auth_token>')
  response = api.messages.list(
    limit: 5,
    offset: 0,
  )
  puts response