twiml_template 1.0.2 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4af309b6c6736f4f9eed4acc24e27837c8188b21
-  data.tar.gz: a241212990c005205f5d97f39d8529710e0a9101
+SHA256:
+  metadata.gz: 70c352b6849e64cf30ea1e3dab35d060fdc961e635c5380c12f444d768662fd6
+  data.tar.gz: 9e9bb460a33f6dc7fcca759f2dad6a30cc69059f8c277f0ac3dfaede7de7942b
 SHA512:
-  metadata.gz: b09e1cc323cb3d876a6a773df7c05f0331811a140ed77f5e2c0ef1ebb30a154c0815bfbddb0dcfbfb7edfaae8b23609d4afd1f80a969bc12514ba27be1f17ef9
-  data.tar.gz: aacea298860c0dc5e3e54df8e6f5e91ec86a53c2f5ecc70ef83de78147b01e77e3956887a833984f87d7f8f3dadf02082f19345ec817d7d639845c2a5bd062b6
+  metadata.gz: 821ae351940fc9480100d601626466cc9d499c9bb6f6fd464a6e38e61fb17b66efba15cb89ba7f2d5ef89dfdbbbb5081ae522e46c97d10bc127eeca74fea684c
+  data.tar.gz: 2db082586c4f781174b1ccff270c476bc418f9bd89c3225a038746e2a34c1976af97c6e74a6592f0b6adbbe2975428e1ad6f069671b56f5e4c270091fef36d66

data/.travis.yml

@@ -1,12 +1,27 @@
 language: ruby
-before_install: gem install bundler
+sudo: required
+dist: trusty
+before_install:
+  - gem update --system
+  - gem install bundler
 install:
   - bundle install --retry=3
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+  - jruby-18mode
   - jruby-19mode
-  - rbx
+  - jruby-head
+  - rbx-3
+matrix:
+  allow_failures:
+  - rvm: rbx-3
+  - rvm: ruby-head
+  - rvm: jruby-head
+addons:
+  apt:
+    packages:
+      - haveged

data/README.md

@@ -2,10 +2,29 @@
 
 [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.
+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.
 
 [![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)
 
+## 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
+<?xml version="1.0" encoding="UTF-8"?>
+<Response>
+  <Say>Hello World!</Say>
+</Response>
+```
+
+See [Rails](#rails) or [Sinatra](#sinatra) below for full instructions.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +35,7 @@ gem 'twiml_template'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -24,6 +43,10 @@ Or install it yourself as:
 
 ## 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 `<Say>` and a `<Message>` in it!).
+
 ### Rails
 
 By including the `twiml_template` gem in your Rails project Gemfile you will be able to write TwiML templates easily.
@@ -51,7 +74,7 @@ end
 And then add your TwiML view:
 
 ```ruby
-  twiml.Say "Hello #{@name}"
+  twiml.say message: "Hello #{@name}"
 ```
 
 Save the file as `#{RAILS_ROOT}/app/views/voice/index.twiml`.
@@ -84,7 +107,7 @@ end
 And then add your TwiML view:
 
 ```ruby
-  twiml.Say "Hello #{@name}"
+  twiml.say "Hello #{@name}"
 ```
 
 Save the file as `#{APP_ROOT}/views/voice.twiml`.

data/Rakefile

@@ -7,5 +7,5 @@ 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
+  t.ruby_opts << '-r rubygems' if defined? Gem
 end

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

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

data/lib/tilt/twiml.rb

@@ -9,7 +9,7 @@ module Tilt
 
     def evaluate(scope, locals, &block)
       return super(scope, locals, &block) if data.respond_to?(:to_str)
-      twiml = ::Twilio::TwiML::Response.new do |response|
+      ::TwimlTemplate::Response.new do |response|
         data.call(response)
       end.to_xml
     end
@@ -20,7 +20,7 @@ module Tilt
 
     def precompiled_preamble(locals)
       return super if locals.include? :twiml
-      "::Twilio::TwiML::Response.new do |twiml|\n#{super}"
+      "::TwimlTemplate::Response.new do |twiml|\n#{super}"
     end
 
     def precompiled_postamble(locals)

data/lib/twiml_template/response.rb

@@ -0,0 +1,45 @@
+module TwimlTemplate
+  class Response
+    MESSAGING_VERBS = [:message, :redirect]
+    VOICE_VERBS = [:say, :play, :dial, :gather, :pause, :enqueue, :hangup, :leave, :record, :redirect, :reject, :sms, :connect, :autopilot, :pay, :start]
+
+    def initialize
+      @voice_response = Twilio::TwiML::VoiceResponse.new
+      @messaging_response = Twilio::TwiML::MessagingResponse.new
+
+      yield(self) if block_given?
+    end
+
+    def to_xml
+      twiml_response = @messaging_response || @voice_response
+      twiml_response.to_xml
+    end
+
+    def method_missing(method, *args, &block)
+      if (respond_to?(method))
+        if (MESSAGING_VERBS.include?(method.to_sym) && @messaging_response)
+          if ((MESSAGING_VERBS - VOICE_VERBS).include?(method.to_sym))
+            @voice_response = nil
+          end
+          @messaging_response.send(method.to_sym, *args, &block)
+        end
+        if (VOICE_VERBS.include?(method.to_sym) && @voice_response)
+          if ((VOICE_VERBS - MESSAGING_VERBS).include?(method.to_sym))
+            @messaging_response = nil
+          end
+          @voice_response.send(method.to_sym, *args, &block)
+        end
+      else
+        raise ArgumentError.new("Method `#{method}` doesn't exist.")
+      end
+      return @messaging_response || @voice_response
+    end
+
+    def respond_to?(method, include_private = false)
+      verbs = []
+      verbs = verbs | MESSAGING_VERBS if @messaging_response
+      verbs = verbs | VOICE_VERBS if @voice_response
+      verbs.include?(method.to_sym) || super
+    end
+  end
+end

data/lib/twiml_template/version.rb

@@ -1,3 +1,3 @@
 module TwimlTemplate
-  VERSION = "1.0.2"
+  VERSION = "2.0.0.pre"
 end

data/lib/twiml_template.rb

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

data/spec/custom_assertions.rb

@@ -0,0 +1,22 @@
+require 'minitest/assertions'
+require 'minitest/spec'
+require 'equivalent-xml'
+require 'nokogiri'
+
+module Minitest::Assertions
+  def assert_equivalent_xml(expected, actual)
+    expected = parse(expected) unless expected.is_a?(Nokogiri::XML::Document)
+    actual = parse(actual) unless actual.is_a?(Nokogiri::XML::Document)
+    assert EquivalentXml.equivalent?(expected, actual, opts = { :element_order => true, :normalize_whitespace => false }), "Expected XML to be equivalent. Expected:\n\n#{expected.to_s} \n\nReceived:\n\n#{actual.to_s}"
+  end
+
+  private
+
+  def parse(string)
+    Nokogiri::XML::Document.parse(string.to_s, &:noblanks)
+  end
+end
+
+module Minitest::Expectations
+  String.infect_an_assertion :assert_equivalent_xml, :must_be_equivalent_xml
+end

data/spec/sinatra/twiml_spec.rb

@@ -24,6 +24,6 @@ describe Sinatra::TwiML do
 
   it "renders simple template" do
     response = get("/hello")
-    response.body.strip.must_equal twiml_response
+    response.body.strip.must_be_equivalent_xml(twiml_response)
   end
 end

data/spec/sinatra/views/hello.twiml

@@ -1 +1 @@
-twiml.Say "Hello #{name}!"
+twiml.say message: "Hello #{name}!"

data/spec/spec_helper.rb

@@ -5,3 +5,4 @@ Bundler.setup
 
 require 'minitest/autorun'
 require 'minitest/mock'
+require_relative './custom_assertions.rb'

data/spec/tilt/twiml_spec.rb

@@ -14,13 +14,13 @@ describe Tilt::TwiML do
     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
+      template = Tilt::TwiML.new { |t| "twiml.say message: 'Hello World!'" }
+      template.render.must_be_equivalent_xml 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 }
+      template = Tilt::TwiML.new { |t| "twiml.say message: 'Hello World!'" }
+      3.times { template.render.must_be_equivalent_xml twiml_response }
     end
   end
 
@@ -33,44 +33,33 @@ describe Tilt::TwiML do
 
     it "passes locals" do
       template = Tilt::TwiML.new do |t|
-        "twiml.Say 'Hello ' + name + '!'"
+        "twiml.say message: 'Hello ' + name + '!'"
       end
-      template.render(Object.new, :name => 'Joe').must_equal twiml_response
+      template.render(Object.new, :name => 'Joe').must_be_equivalent_xml twiml_response
     end
 
     it "evaluates in an object scope" do
       template = Tilt::TwiML.new do |t|
-        "twiml.Say 'Hello ' + @name + '!'"
+        "twiml.say message: 'Hello ' + @name + '!'"
       end
       scope = Object.new
       scope.instance_variable_set :@name, 'Joe'
-      template.render(scope).must_equal twiml_response
+      template.render(scope).must_be_equivalent_xml twiml_response
     end
 
     it "passes a block for yield" do
       template = Tilt::TwiML.new do |t|
-        "twiml.Say 'Hello ' + yield + '!'"
+        "twiml.say message: 'Hello ' + yield + '!'"
       end
-      3.times { template.render { 'Joe' }.must_equal twiml_response }
+      3.times { template.render { 'Joe' }.must_be_equivalent_xml twiml_response }
     end
 
     it "takes block style templates" do
       template =
         Tilt::TwiML.new do |t|
-          lambda { |twiml| twiml.Say('Hello Joe!') }
+          lambda { |twiml| twiml.say(message: 'Hello Joe!') }
         end
-      template.render.must_equal twiml_response
+      template.render.must_be_equivalent_xml 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/spec/twiml_template/response_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+require 'twiml_template/response'
+
+describe TwimlTemplate::Response do
+  let(:response) { TwimlTemplate::Response.new }
+
+  describe 'with a messaging response' do
+    describe 'with a simple response' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Message>Hello World!</Message></Response>"
+      end
+
+      it 'generates successfully' do
+        response.message(body: "Hello World!")
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+
+      [:message, :redirect].each do |verb|
+        it "responds to #{verb}" do
+          response.must_respond_to(verb)
+        end
+      end
+    end
+
+    describe 'with a nested response' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Message><Body>Hello World!</Body></Message></Response>"
+      end
+
+      it 'generates successfully' do
+        response.message do |msg|
+          msg.body "Hello World!"
+        end
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+    end
+
+    describe 'with multiple commands' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Message>Hello World!</Message><Redirect>http://example.com</Redirect></Response>"
+      end
+
+      it 'generates successfully' do
+        response.message(body: "Hello World!")
+        response.redirect("http://example.com")
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+    end
+  end
+
+  describe 'with a voice response' do
+    describe 'with a simple response' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Say>Hello World!</Say></Response>"
+      end
+
+      it 'generates successfully' do
+        response.say(message: "Hello World!")
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+
+      (TwimlTemplate::Response::MESSAGING_VERBS | TwimlTemplate::Response::VOICE_VERBS).each do |verb|
+        it "responds to #{verb}" do
+          response.must_respond_to(verb)
+        end
+      end
+    end
+
+    describe 'with a nested response' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Gather><Say>Hello World!</Say></Gather></Response>"
+      end
+
+      it 'generates successfully' do
+        response.gather do |gather|
+          gather.say message: "Hello World!"
+        end
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+    end
+
+    describe 'with multiple commands' do
+      let :twiml do
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response>" \
+        "<Say>Hello World!</Say><Play>http://tunes.com</Play></Response>"
+      end
+
+      it 'generates successfully' do
+        response.say(message: "Hello World!")
+        response.play(url: "http://tunes.com")
+        response.to_xml.must_be_equivalent_xml twiml
+      end
+    end
+  end
+
+  describe 'with a mixed response' do
+    it 'should raise an error' do
+      proc do
+        response.say(message: "Hello")
+        response.message(" World!")
+      end.must_raise ArgumentError
+    end
+
+    it 'should allow a redirect and a message' do
+      proc do
+        response.redirect("http://example.com")
+        response.message(body: "Hello World!")
+      end.must_be_silent
+    end
+
+    it 'should allow a redirect and a voice verb' do
+      proc do
+        response.redirect("http://example.com")
+        response.say(message: "Hello World!")
+      end.must_be_silent
+    end
+  end
+end

data/twiml_template.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version  = '>= 1.9.3'
 
   spec.add_dependency "tilt", ">= 1.3", "< 3"
-  spec.add_dependency "twilio-ruby", ">= 3.0", "< 5.0"
+  spec.add_dependency "twilio-ruby", ">= 5.28", "< 6.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", ">= 1.7", "< 3.0"
   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"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiml_template
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0.pre
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -36,34 +36,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.28'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.28'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +126,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: An easy way to work with TwiML for responding to Twilio webhooks in Rails
   or Sinatra applications using template files.
 email:
@@ -139,11 +159,14 @@ files:
 - lib/tilt/twiml.rb
 - lib/twiml_template.rb
 - lib/twiml_template/railtie.rb
+- lib/twiml_template/response.rb
 - lib/twiml_template/version.rb
+- spec/custom_assertions.rb
 - spec/sinatra/twiml_spec.rb
 - spec/sinatra/views/hello.twiml
 - spec/spec_helper.rb
 - spec/tilt/twiml_spec.rb
+- spec/twiml_template/response_spec.rb
 - twiml_template.gemspec
 homepage: https://github.com/philnash/twiml_template
 licenses:
@@ -160,17 +183,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: TwiML templates for Rails and Tilt.
 test_files:
+- spec/custom_assertions.rb
 - spec/sinatra/twiml_spec.rb
 - spec/sinatra/views/hello.twiml
 - spec/spec_helper.rb
 - spec/tilt/twiml_spec.rb
+- spec/twiml_template/response_spec.rb