punchblock 0.12.0 → 1.0.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.0.0](https://github.com/adhearsion/punchblock/compare/v0.12.0...v1.0.0) - [2012-04-11](https://rubygems.org/gems/punchblock/versions/1.0.0)
+  * Stable release :D
+  * Bugfix: Any issue in compiling an output document into executable elements on Asterisk should return an unrenderable doc error
+
 # [v0.12.0](https://github.com/adhearsion/punchblock/compare/v0.11.0...v0.12.0) - [2012-03-30](https://rubygems.org/gems/punchblock/versions/0.12.0)
   * API Change: `#call_id` and `#mixer_name` attributes changed to `#target_call_id` and `#target_mixer_name`
   * API Change: `#other_call_id` attributes changed to `#call_id` to better align with Rayo

data/LICENSE.txt

@@ -1,6 +1,4 @@
-Copyright (C) 2011 Ben Klang
-Copyright (C) 2011 Ben Langfeld
-Copyright (C) 2011 Jason Goecke
+Copyright (C) 2012 Adhearsion Foundation Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,31 +1,34 @@
-PUNCHBLOCK
-==========
+# Punchblock
+Punchblock is a middleware library for telephony applications. Like Rack is to Rails and Sinatra, Punchblock provides a consistent API on top of several underlying third-party call control protocols.
 
-Punchblock is a middleware library for telephony applications.  Like Rack is to
-Rails and Sinatra, Punchblock provides a consistent API on top of several
-underlying third-party call control protocols.
+In the same spirit that inspired Rack, the Punchblock library is envisioned to be the single library for call control wiring. Frameworks and applications may take advantage of Punchblock's single API to write powerful code for managing calls. Punchblock is not and will not be an application framework; rather it only surfaces the various protocols and presents a consistent interface to its consumers.
 
-Design
-------
+## Installation
+    gem install punchblock
 
-In the same spirit that inspired Rack, the Punchblock library is envisioned to
-be the single library for call control wiring. Frameworks and applications may
-take advantage of Punchblock's single API to write powerful code for managing
-calls. Punchblock is not and will not be an application framework; rather it
-only surfaces the various protocols and presents a consistent interface to its
-consumers.
+## Usage
 
-Supported Protocols
--------------------
+The best available usage documentation available for Punchblock is by example, in Adhearsion.
 
-Punchblock is still in very early stages so this list
-is what we plan to support:
+## Supported Protocols
 
-* Rayo (Tropo, Voxeo Prism)
-* AGI/AMI (Asterisk)
-* EventSocket (FreeSWITCH, maybe)
+* Rayo
+* Asterisk (AMI & AsyncAGI)
 
-Installation
-------------
+## Links:
+* [Source](https://github.com/adhearsion/punchblock)
+* [Documentation](http://rdoc.info/github/adhearsion/punchblock/master/frames)
+* [Bug Tracker](https://github.com/adhearsion/punchblock/issues)
 
-	gem install punchblock
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Adhearsion Foundation Inc. MIT licence (see LICENSE for details).

data/lib/punchblock.rb

@@ -43,7 +43,7 @@ module Punchblock
 
   ##
   # This exception may be raised if a transport error is detected.
-  TransportError = Class.new StandardError
+  Error = Class.new StandardError
 
   BASE_RAYO_NAMESPACE     = 'urn:xmpp:rayo'
   BASE_ASTERISK_NAMESPACE = 'urn:xmpp:rayo:asterisk'

data/lib/punchblock/protocol_error.rb

@@ -3,7 +3,7 @@
 module Punchblock
   ##
   # This exception may be raised if a transport error is detected.
-  class ProtocolError < StandardError
+  class ProtocolError < Error
     attr_accessor :name, :text, :call_id, :component_id
 
     def setup(name = nil, text = nil, call_id = nil, component_id = nil)

data/lib/punchblock/translator/asterisk/component.rb

@@ -12,6 +12,8 @@ module Punchblock
         autoload :StopByRedirect
 
         class Component
+          OptionError = Class.new Punchblock::Error
+
           include Celluloid
 
           attr_reader :id, :call

data/lib/punchblock/translator/asterisk/component/input.rb

@@ -18,10 +18,10 @@ module Punchblock
             initial_timeout = @component_node.initial_timeout || -1
             @inter_digit_timeout = @component_node.inter_digit_timeout || -1
 
-            return with_error 'option error', 'A grammar document is required.' unless @component_node.grammar
-            return with_error 'option error', 'A mode value other than DTMF is unsupported on Asterisk.' unless @component_node.mode == :dtmf
-            return with_error 'option error', 'An initial timeout value that is negative (and not -1) is invalid.' unless initial_timeout >= -1
-            return with_error 'option error', 'An inter-digit timeout value that is negative (and not -1) is invalid.' unless @inter_digit_timeout >= -1
+            raise OptionError, 'A grammar document is required.' unless @component_node.grammar
+            raise OptionError, 'A mode value other than DTMF is unsupported on Asterisk.' unless @component_node.mode == :dtmf
+            raise OptionError, 'An initial timeout value that is negative (and not -1) is invalid.' unless initial_timeout >= -1
+            raise OptionError, 'An inter-digit timeout value that is negative (and not -1) is invalid.' unless @inter_digit_timeout >= -1
 
             send_ref
 
@@ -42,6 +42,8 @@ module Punchblock
                 component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
               end
             end
+          rescue OptionError => e
+            with_error 'option error', e.message
           end
 
           def process_dtmf(digit)

data/lib/punchblock/translator/asterisk/component/output.rb

@@ -9,6 +9,8 @@ module Punchblock
         class Output < Component
           include StopByRedirect
 
+          UnrenderableDocError = Class.new OptionError
+
           def setup
             @media_engine = @call.translator.media_engine
           end
@@ -16,30 +18,18 @@ module Punchblock
           def execute
             @call.answer_if_not_answered
 
-            return with_error 'option error', 'An SSML document is required.' unless @component_node.ssml
-
-            return with_error 'option error', 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
+            raise OptionError, 'An SSML document is required.' unless @component_node.ssml
+            raise OptionError, 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
 
             [:start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
-              return with_error 'option error', "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
+              raise OptionError, "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
             end
 
             case @media_engine
             when :asterisk, nil
-              return with_error 'option error', "A voice value is unsupported on Asterisk." if @component_node.voice
-
-              @execution_elements = @component_node.ssml.children.map do |node|
-                case node
-                when RubySpeech::SSML::Audio
-                  lambda { current_actor.play_audio! node.src }
-                when String
-                  return unrenderable_doc_error if node.include?(' ')
-                  lambda { current_actor.play_audio! node }
-                else
-                  return unrenderable_doc_error
-                end
-              end.compact
+              raise OptionError, "A voice value is unsupported on Asterisk." if @component_node.voice
 
+              @execution_elements = collect_executable_elements
               @pending_actions = @execution_elements.count
 
               send_ref
@@ -73,6 +63,26 @@ module Punchblock
                 output_component.send_complete_event! success_reason
               end
             end
+          rescue UnrenderableDocError => e
+            with_error 'unrenderable document error', e.message
+          rescue OptionError => e
+            with_error 'option error', e.message
+          end
+
+          def collect_executable_elements
+            @component_node.ssml.children.map do |node|
+              case node
+              when RubySpeech::SSML::Audio
+                lambda { current_actor.play_audio! node.src }
+              when String
+                raise UnrenderableDocError, 'The provided document could not be rendered.' if node.include?(' ')
+                lambda { current_actor.play_audio! node }
+              else
+                raise UnrenderableDocError, 'The provided document could not be rendered.'
+              end
+            end.compact
+          rescue
+            raise UnrenderableDocError, 'The provided document could not be rendered.'
           end
 
           def process_playback_completion
@@ -99,10 +109,6 @@ module Punchblock
 
           private
 
-          def unrenderable_doc_error
-            with_error 'unrenderable document error', 'The provided document could not be rendered.'
-          end
-
           def escaped_doc
             @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
           end

data/lib/punchblock/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Punchblock
-  VERSION = "0.12.0"
+  VERSION = "1.0.0"
 end

data/spec/punchblock/translator/asterisk/component/output_spec.rb

@@ -414,6 +414,18 @@ module Punchblock
                   end
                 end
 
+                context 'with a string (not SSML)' do
+                  let :command_options do
+                    { :text => 'Foo Bar' }
+                  end
+
+                  it "should return an unrenderable document error" do
+                    subject.execute
+                    error = ProtocolError.new.setup 'unrenderable document error', 'The provided document could not be rendered.'
+                    original_command.response(0.1).should be == error
+                  end
+                end
+
                 context 'with multiple audio SSML nodes' do
                   let(:audio_filename1) { 'http://foo.com/bar.mp3' }
                   let(:audio_filename2) { 'http://foo.com/baz.mp3' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2151918560 !ruby/object:Gem::Requirement
+  requirement: &2151853680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2151918560
+  version_requirements: *2151853680
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2151917300 !ruby/object:Gem::Requirement
+  requirement: &2151852020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.12
   type: :runtime
   prerelease: false
-  version_requirements: *2151917300
+  version_requirements: *2151852020
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2151916200 !ruby/object:Gem::Requirement
+  requirement: &2151864820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151916200
+  version_requirements: *2151864820
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2151915240 !ruby/object:Gem::Requirement
+  requirement: &2151861640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2151915240
+  version_requirements: *2151861640
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2151926340 !ruby/object:Gem::Requirement
+  requirement: &2151860660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2151926340
+  version_requirements: *2151860660
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2151923420 !ruby/object:Gem::Requirement
+  requirement: &2151875260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151923420
+  version_requirements: *2151875260
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2151921440 !ruby/object:Gem::Requirement
+  requirement: &2151879400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151921440
+  version_requirements: *2151879400
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2151932640 !ruby/object:Gem::Requirement
+  requirement: &2152058520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2151932640
+  version_requirements: *2152058520
 - !ruby/object:Gem::Dependency
   name: ruby_speech
-  requirement: &2155995300 !ruby/object:Gem::Requirement
+  requirement: &2152083720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *2155995300
+  version_requirements: *2152083720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2155999080 !ruby/object:Gem::Requirement
+  requirement: &2152086540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2155999080
+  version_requirements: *2152086540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156017820 !ruby/object:Gem::Requirement
+  requirement: &2152093960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -133,10 +133,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2156017820
+  version_requirements: *2152093960
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2156036260 !ruby/object:Gem::Requirement
+  requirement: &2152106160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2156036260
+  version_requirements: *2152106160
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156029000 !ruby/object:Gem::Requirement
+  requirement: &2152101260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2156029000
+  version_requirements: *2152101260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156042480 !ruby/object:Gem::Requirement
+  requirement: &2151949040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156042480
+  version_requirements: *2151949040
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156036860 !ruby/object:Gem::Requirement
+  requirement: &2151961660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156036860
+  version_requirements: *2151961660
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2155891280 !ruby/object:Gem::Requirement
+  requirement: &2151959840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155891280
+  version_requirements: *2151959840
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2155887920 !ruby/object:Gem::Requirement
+  requirement: &2151958260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155887920
+  version_requirements: *2151958260
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156050140 !ruby/object:Gem::Requirement
+  requirement: &2152122840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,7 +210,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156050140
+  version_requirements: *2152122840
 description: Like Rack is to Rails and Sinatra, Punchblock provides a consistent API
   on top of several underlying third-party call control protocols.
 email: punchblock@adhearsion.com
@@ -359,7 +359,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3649265375268061365
+      hash: -3970210055497843172
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: