twiliodeved / sdk-starter-ruby

Demo application showcasing Twilio API usage in Ruby

Twilio SDK Starter Application for Ruby

This sample project demonstrates how to use Twilio APIs in a Ruby web application. Once the app is up and running, check out the home page to see which demos you can run. You'll find examples for Chat, Notify, and Sync.

Let's get started!

Configure the sample application

To run the application, you'll need to gather your Twilio account credentials and configure them in a file named .env. To create this file from an example template, do the following in your Terminal.

cp .env.example .env

Open .env in your favorite text editor and configure the following values.

Configure account information

Every sample in the demo requires some basic credentials from your Twilio account. Configure these first.

Config Value	Description
TWILIO_ACCOUNT_SID	Your primary Twilio account identifier - find this in the console here.
TWILIO_API_KEY	Used to authenticate - generate one here.
TWILIO_API_SECRET	Used to authenticate - just like the above, you'll get one here.

A Note on API Keys

When you generate an API key pair at the URLs above, your API Secret will only be shown once - make sure to save this information in a secure location, or possibly your ~/.bash_profile.

Configure Development vs Production Settings

By default, this application will run in production mode - stack traces will not be visible in the web browser. If you would like to run this application in development locally, change the APP_ENV variable in your .env file.

APP_ENV=development

For more about development vs production, visit Sinatra's configuration page.

Configure product-specific settings

Depending on which demos you'd like to run, you may need to configure a few more values in your .env file.

Configuring Twilio Sync

Twilio Sync works out of the box, using default settings per account. Once you have your API keys configured, run the application (see below) and open a browser!

Configuring Twilio Chat

In addition to the above, you'll need to generate a Chat Service in the Twilio Console. Put the result in your .env file.

Config Value	Where to get one.
TWILIO_CHAT_SERVICE_SID	Generate one in the Twilio Chat console

With this in place, run the application (see below) and open a browser!

Configuring Twilio Notify

You will need to create a Notify Service and add at least one credential on the Mobile Push Credential screen (such as Apple Push Notification Service or Firebase Cloud Messaging for Android) to send notifications using Notify.

Config Value	Where to get one.
TWILIO_NOTIFICATION_SERVICE_SID	Generate one in the Notify Console and put this in your .env file.
A Push Credential	Generate one with Apple or Google and configure it as a Notify credential.

Once you've done that, run the application (see below) and open a browser!

Run the sample application

Now that the application is configured, we need to install our dependencies with Bundler.

bundle install

Now we should be all set! Run the application using the bundle exec command.

bundle exec ruby app.rb

Your application should now be running at http://localhost:4567/.

Check your config values, and follow the links to the demo applications!

Running the SDK Starter Kit with ngrok

If you are going to connect to this SDK Starter Kit with a mobile app (and you should try it out!), your phone won't be able to access localhost directly. You'll need to create a publicly accessible URL using a tool like ngrok to send HTTP/HTTPS traffic to a server running on your localhost. Use HTTPS to make web connections that retrieve a Twilio access token.

ngrok http 4567

License

MIT

sdk-starter-ruby's Issues

Chat client version is 1.0

It looks like the chat client has hit 1.0

https://www.twilio.com/docs/api/chat/sdks

Does it affect this demo, other than the library?

Preview curl not working

When running the curl

curl -X POST https://preview.twilio.com/Sync/Services \
 -d 'FriendlyName=MySyncServiceInstance' \
 -u 'SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_api_secret'

The following message was received

{"code": 20404, "message": "The requested resource /Sync/Services was not found", "more_info": "https://www.twilio.com/docs/errors/20404", "status": 404}%

Getting an error when running chat

I double checked and triple checked all my keys and everything looks good. Any ideas?

{
    "message": "The authorization with Token failed",
    "code": 2016,
    "user_error": false,
    "params": {
        "description": "Could not authenticate fpa token"
    }
}

Sample code for chat not working

I'm reviewing the sample Chat app

The Video conference is working, but the chat app is not. The app logs onto Twilio:

Logging in...
You have been assigned a random username of: terrance
Attempting to join "general" chat channel...

Then there is an error in the JavaScript console:

index.html:1 Uncaught (in promise) 
Object
body
:
Object
description
:
"Not Found"
status
:
404
__proto__
:
Object
__defineGetter__
:
__defineGetter__()
__defineSetter__
:
__defineSetter__()
__lookupGetter__
:
__lookupGetter__()
__lookupSetter__
:
__lookupSetter__()
constructor
:
Object()
hasOwnProperty
:
hasOwnProperty()
isPrototypeOf
:
isPrototypeOf()
propertyIsEnumerable
:
propertyIsEnumerable()
toLocaleString
:
toLocaleString()
toString
:
toString()
valueOf
:
valueOf()
get __proto__
:
__proto__()
set __proto__
:
__proto__()