Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philnash/twiml_template
TwiML templates for Rails and Tilt.
https://github.com/philnash/twiml_template
rails ruby sinatra tilt twilio twilio-ruby twiml
Last synced: 2 months ago
JSON representation
TwiML templates for Rails and Tilt.
- Host: GitHub
- URL: https://github.com/philnash/twiml_template
- Owner: philnash
- License: mit
- Created: 2014-11-03T18:07:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-09-15T02:34:45.000Z (over 2 years ago)
- Last Synced: 2024-11-15T22:52:01.383Z (3 months ago)
- Topics: rails, ruby, sinatra, tilt, twilio, twilio-ruby, twiml
- Language: Ruby
- Size: 25.4 KB
- Stars: 17
- Watchers: 4
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# TwimlTemplate
[TwiML](https://www.twilio.com/docs/api/twiml) templates for Tilt.
An easy way to work with TwiML for responding to [Twilio](http://twilio.com) webhooks in Rails or Sinatra applications using template files with a `.twiml` extension.
[](https://travis-ci.org/philnash/twiml_template) [](https://codeclimate.com/github/philnash/twiml_template)
## Example
If you create a template called `hello_world.twiml` with the following code:
```ruby
twiml.say(message: "Hello World!")
```
and rendered it from an application you would get the following response:
```xml
Hello World!
```
See [Rails](#rails) or [Sinatra](#sinatra) below for full instructions.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'twiml_template'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install twiml_template
## Usage
`twiml_template` allows you to use a template with the extension `.twiml` to write TwiML. The template makes a single variable, `twiml` available. `twiml` is an instance of a `TwimlTemplate::Response` which unifies the `twilio-ruby` gem's `Twilio::TwiML::VoiceResponse` and `Twilio::TwiML::MessagingResponse` classes. This means you only need one type of template file, but you can use it for either voice or messaging responses. `twiml_template` passes methods through to objects of each of those classes to generate the response.
If you start writing a voice response, you can only continue writing a voice response. If you start writing a messaging response, you can only continue with a messaging response. This should never cause you a problem (you would never normally write a response with a `` and a `` in it!).
### Rails
By including the `twiml_template` gem in your Rails project Gemfile you will be able to write TwiML templates easily.
Create a controller, like below:
```ruby
class VoiceController < ApplicationController
def index
@name = "World"
end
end
```
Add a route:
```ruby
Rails.application.routes.draw do
get 'voice' => 'voice#index'
# Other routes...
end
```
And then add your TwiML view:
```ruby
twiml.say message: "Hello #{@name}"
```
Save the file as `#{RAILS_ROOT}/app/views/voice/index.twiml`.
Run the app using `rails s` and visit [http://localhost:3000/voice](http://localhost:3000/voice) and you will see:
```xml
Hello World!
```
### Sinatra
Create your application file like below:
```ruby
require 'sinatra'
require 'sinatra/twiml'
helpers Sinatra::TwiML
get '/voice' do
@name = "World!"
twiml :voice
end
```
And then add your TwiML view:
```ruby
twiml.say message: "Hello #{@name}"
```
Save the file as `#{APP_ROOT}/views/voice.twiml`.
Start the app with `ruby app.rb` and visit [http://localhost:4567/voice](http://localhost:4567/voice) and you will see:
```xml
Hello World!
```
## Contributing
1. Fork it ( https://github.com/philnash/twiml_template/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request