README.md

Sync Quickstart for Ruby

This application should give you a ready-made starting point for writing your own real-time apps with Sync. Before we begin, we need to collect all the config values we need to run the application:

Config Values	Description
Service Instance SID	A service instance where all the data for our application is stored and scoped. Generate one using the command below.
Account SID	Your primary Twilio account identifier - find this in the console here.
API Key	Used to authenticate - generate one here in the console.
API Secret	Used to authenticate - just like the above, you can use the console to generate one here.

Temporary: Generating a Service Instance

During the Sync developer preview, you will need to generate Sync service instances via API until the Console GUI is available. Using the API key pair you generated above, generate a service instance via REST API with this command:

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

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 in a secure location, or possibly your ~/.bash_profile.

Setting Up The Ruby (Sinatra) Application

This application uses the lightweight Sinatra Framework. Begin by creating a configuration file for your application:

cp .env.example .env

Edit .env with the four configuration parameters we gathered from above.

Next, we need to install our depenedencies:

bundle install

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

bundle exec ruby app.rb

Your application should now be running at http://localhost:4567. Open this page in a couple browsers or tabs, and start playing!

License

MIT