twiml_template 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f90ef5352b1a656e01def52b0e9957530b91be9e
+  data.tar.gz: a3645b36b5ba6a3109b8f7927ccfdeb08dd32e99
+SHA512:
+  metadata.gz: 8804cf2316db6d4e5dc79ccf5196b1f065eb717341addbb385bcbe4cffccc38b236ddb3b38ee8a478cfb84b63585579ad1271a23b32f3b630dfbbffb816f2ea8
+  data.tar.gz: 5542483ad83bbd71108132043b10a4c8064acb9ae3457301bdd3d344e6b4b8a46c7f4bcdf94ab5efb598d13b7ae54454e05fd86990306373bdf14ec6e8585e5a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install: gem install bundler
+install:
+  - bundle install --retry=3
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twiml_template.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phil Nash
+
+MIT License
+
+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

@@ -0,0 +1,107 @@
+# 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.
+
+[![Build Status](https://travis-ci.org/philnash/twiml_template.svg)](https://travis-ci.org/philnash/twiml_template)[![Code Climate](https://codeclimate.com/github/philnash/twiml_template/badges/gpa.svg)](https://codeclimate.com/github/philnash/twiml_template)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twiml_template'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twiml_template
+
+## Usage
+
+### 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 "Hello #{@name}"
+```
+
+Save the file as `#{RAILS_ROOT}/app/controller/voice/index.twiml`.
+
+Run the app using `rails s` and visit [http://localhost:3000/voice](http://localhost:3000/voice) and you will see:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<Response>
+  <Say>Hello World!</Say>
+</Response>
+```
+
+### 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 "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
+<?xml version="1.0" encoding="UTF-8"?>
+<Response>
+  <Say>Hello World!</Say>
+</Response>
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+task :default => [:spec]
+
+desc 'Run tests (default)'
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.ruby_opts = ['-Ispec']
+  t.ruby_opts << '-rubygems' if defined? Gem
+end

data/lib/action_view/template/handlers/twiml.rb

@@ -0,0 +1,13 @@
+require 'twilio-ruby'
+
+module ActionView
+   module Template::Handlers
+    class TwiML
+      def self.call(template)
+        "self.output_buffer = ::Twilio::TwiML::Response.new do |twiml|;" +
+        template.source +
+        ";end.to_xml;"
+      end
+    end
+  end
+end

data/lib/sinatra/twiml.rb

@@ -0,0 +1,10 @@
+require 'tilt/twiml'
+
+module Sinatra
+  module TwiML
+    def twiml(template = nil, options = {}, locals = {}, &block)
+      options[:default_content_type] = :xml
+      render_ruby(:twiml, template, options, locals, &block)
+    end
+  end
+end

data/lib/tilt/twiml.rb

@@ -0,0 +1,36 @@
+require 'twilio-ruby'
+require 'tilt'
+
+module Tilt
+  class TwiML < Template
+    self.default_mime_type = 'text/xml'
+
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      return super(scope, locals, &block) if data.respond_to?(:to_str)
+      twiml = ::Twilio::TwiML::Response.new do |response|
+        data.call(response)
+      end.to_xml
+    end
+
+    def precompiled_template(local_keys)
+      data.to_str
+    end
+
+    def precompiled_preamble(locals)
+      return super if locals.include? :twiml
+      "::Twilio::TwiML::Response.new do |twiml|\n#{super}"
+    end
+
+    def precompiled_postamble(locals)
+      "end.to_xml"
+    end
+  end
+
+  if defined? register_lazy
+    register_lazy 'Tilt::TwiML', 'tilt/twiml', 'twiml'
+  else
+    register TwiML, '.twiml'
+  end
+end

data/lib/twiml_template.rb

@@ -0,0 +1,5 @@
+require 'twiml_template/version'
+
+if defined? Rails
+  require 'twiml_template/railtie'
+end

data/lib/twiml_template/railtie.rb

@@ -0,0 +1,17 @@
+require 'action_view/template/handlers/twiml'
+
+module TwiML
+  class Railtie < Rails::Railtie
+    initializer "twiml.configure_templates" do |app|
+      config.after_initialize do
+        Mime::Type.register "text/xml", :twiml
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Template.register_template_handler(
+            :twiml,
+            ActionView::Template::Handlers::TwiML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/twiml_template/version.rb

@@ -0,0 +1,3 @@
+module TwimlTemplate
+  VERSION = "1.0.0"
+end

data/spec/sinatra/twiml_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/twiml'
+
+class TwiMLApp < Sinatra::Base
+  set :root, File.dirname(__FILE__)
+  helpers Sinatra::TwiML
+
+  get "/hello" do
+    twiml :hello, locals: {name: 'Joe'}
+  end
+end
+
+describe Sinatra::TwiML do
+  include Rack::Test::Methods
+
+  let(:app) { TwiMLApp }
+
+  let :twiml_response do
+    "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+    "<Say>Hello Joe!</Say></Response>"
+  end
+
+  it "renders simple template" do
+    response = get("/hello")
+    response.body.strip.must_equal twiml_response
+  end
+end

data/spec/sinatra/views/hello.twiml

@@ -0,0 +1 @@
+twiml.Say "Hello #{name}!"

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'bundler'
+Bundler.setup
+
+require 'minitest/autorun'
+require 'minitest/mock'

data/spec/tilt/twiml_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'tilt/twiml'
+
+describe Tilt::TwiML do
+  it "registers for '.twiml' files" do
+    Tilt['test.twiml'].must_equal Tilt::TwiML
+    Tilt['test.xml.twiml'].must_equal Tilt::TwiML
+  end
+
+  describe 'simple rendering' do
+    let :twiml_response do
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+      "<Say>Hello World!</Say></Response>"
+    end
+
+    it "prepares and evaluates the template on #render" do
+      template = Tilt::TwiML.new { |t| "twiml.Say 'Hello World!'" }
+      template.render.must_equal twiml_response
+    end
+
+    it "can be rendered more than once" do
+      template = Tilt::TwiML.new { |t| "twiml.Say 'Hello World!'" }
+      3.times { template.render.must_equal twiml_response }
+    end
+  end
+
+  describe 'rendering with locals/scopes' do
+
+    let :twiml_response do
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+      "<Say>Hello Joe!</Say></Response>"
+    end
+
+    it "passes locals" do
+      template = Tilt::TwiML.new do |t|
+        "twiml.Say 'Hello ' + name + '!'"
+      end
+      template.render(Object.new, :name => 'Joe').must_equal twiml_response
+    end
+
+    it "evaluates in an object scope" do
+      template = Tilt::TwiML.new do |t|
+        "twiml.Say 'Hello ' + @name + '!'"
+      end
+      scope = Object.new
+      scope.instance_variable_set :@name, 'Joe'
+      template.render(scope).must_equal twiml_response
+    end
+
+    it "passes a block for yield" do
+      template = Tilt::TwiML.new do |t|
+        "twiml.Say 'Hello ' + yield + '!'"
+      end
+      3.times { template.render { 'Joe' }.must_equal twiml_response }
+    end
+
+    it "takes block style templates" do
+      template =
+        Tilt::TwiML.new do |t|
+          lambda { |twiml| twiml.Say('Hello Joe!') }
+        end
+      template.render.must_equal twiml_response
+    end
+
+    it "allows nesting raw XML" do
+      subtemplate = '<Number>+447712345678</Number>'
+      template = Tilt::TwiML.new { "twiml.Dial { twiml << yield }" }
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+                 "<Dial><Number>+447712345678</Number></Dial></Response>"
+      3.times do
+        template.render { subtemplate }.must_equal expected
+      end
+    end
+
+  end
+end

data/twiml_template.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twiml_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name                   = "twiml_template"
+  spec.version                = TwimlTemplate::VERSION
+  spec.authors                = ["Phil Nash"]
+  spec.email                  = ["philnash@gmail.com"]
+  spec.summary                = %q{TwiML templates for Rails and Tilt.}
+  spec.description            = %q{An easy way to work with TwiML for responding to Twilio webhooks in Rails or Sinatra applications using template files.}
+  spec.homepage               = "https://github.com/philnash/twiml_template"
+  spec.license                = "MIT"
+
+  spec.files                  = `git ls-files -z`.split("\x0")
+  spec.executables            = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files             = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths          = ["lib"]
+  spec.required_ruby_version  = '>= 1.9.3'
+
+  spec.add_dependency "tilt", ">= 1.3", "< 2.0"
+  spec.add_dependency "twilio-ruby", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "sinatra", ">= 1.3"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: twiml_template
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phil Nash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: An easy way to work with TwiML for responding to Twilio webhooks in Rails
+  or Sinatra applications using template files.
+email:
+- philnash@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/action_view/template/handlers/twiml.rb
+- lib/sinatra/twiml.rb
+- lib/tilt/twiml.rb
+- lib/twiml_template.rb
+- lib/twiml_template/railtie.rb
+- lib/twiml_template/version.rb
+- spec/sinatra/twiml_spec.rb
+- spec/sinatra/views/hello.twiml
+- spec/spec_helper.rb
+- spec/tilt/twiml_spec.rb
+- twiml_template.gemspec
+homepage: https://github.com/philnash/twiml_template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: TwiML templates for Rails and Tilt.
+test_files:
+- spec/sinatra/twiml_spec.rb
+- spec/sinatra/views/hello.twiml
+- spec/spec_helper.rb
+- spec/tilt/twiml_spec.rb
+has_rdoc: