punchblock 1.9.4 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cb4362475b7ff78950c6a3b6c26079e98f5741a
-  data.tar.gz: 6e6bf5c7f14bf24e1ea4ca9cb84b1f8e2365935b
+  metadata.gz: 49f42b835052273a5744b92e6b84779b2782e0cc
+  data.tar.gz: fbcc1abd28ccbf6fbd8ecb200fda82c31ec1ac6c
 SHA512:
-  metadata.gz: b5b5d40cd306d3e292b56189f085165c3a39f2e4f069f7b7298cafee1ad65f7b3a597a1db49c79771f1027b3026d0ee6bb9576020b4114c7e08c4ce19aef6b48
-  data.tar.gz: 93b07c8cc0bdb8472c4b511008e054068c13a79dfa780fe08a3f09ac4b9dbc76b195e55505128291bdef3262461bfb7fb634ba672a8670589c1c6ca3928f664b
+  metadata.gz: 5f6b8381a4bb5f30389ee46854e7a5ce569147721de0af96d4a995cea6ca5a6b3f97ecdf53538ea81c48cda8530476f5568a66b985c14254bd9c5f9254993cf8
+  data.tar.gz: 7af2927dda7105ab22949cecca00725c97906f0df79d3996b662e0460c3e562137ed3f2a4bab3293902cec8c525165fb67d624727bd2708f70a9ac9ec25e6056

data/.gitignore

@@ -12,3 +12,4 @@ vendor
 .rbx/
 *.rbc
 tmp
+coverage

data/.travis.yml

@@ -8,7 +8,6 @@ rvm:
   - ruby-head
 matrix:
   allow_failures:
-    - rvm: rbx-19mode
-    - rvm: jruby-19mode
+    - rvm: ruby-head
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v2.0.0.beta1](https://github.com/adhearsion/punchblock/compare/v1.9.4...v2.0.0.beta1) - [2013-08-20](https://rubygems.org/gems/punchblock/versions/2.0.0.beta1)
+  * Bugfix: Reconnect dead Asterisk streams correctly
+  * Feature: Added FS support for initial timeout and final timeout on Record.
+  * Feature: Compliance with v0.2 of the published Rayo spec (http://xmpp.org/extensions/xep-0327.html)
+  * Feature: Add support for Rayo Prompt component (no support on FS)
+  * Change: Models are now plain ruby objects, not XML nodes, and are imported from/exported to XML when necessary for communicating over XMPP.
+  * Change: `#headers` and AMI `#attributes` now do not have their names modified. A header of `'Call-ID'` will no longer be modified to `:call_id`.
+  * Change: AMI Events/Actions now have `#headers(=)` rather than `#attributes(=)`
+  * Change: Remove event queue
+  * Bugfix: Include AMI response text_body in AMI component complete events
+  * Bugfix: Avoid crashing translators (Asterisk or FreeSWITCH) by instructing them to call back to terminated Call objects
+  * Bugfix: Detect MRCPSynth failure in output component.
+  * Bugfix: Handle AMI errors indicating dead channels correctly
+
 # [v1.9.4](https://github.com/adhearsion/punchblock/compare/v1.9.3...v1.9.4) - [2013-06-08](https://rubygems.org/gems/punchblock/versions/1.9.4)
   * Bugfix: Finish more setup before sending output ref on Asterisk
   * Bugfix: Allow early media TTS on Asterisk in addition to audio playback
@@ -29,6 +43,9 @@
 # [v1.8.2](https://github.com/adhearsion/punchblock/compare/v1.8.1...v1.8.2) - [2013-04-19](https://rubygems.org/gems/punchblock/versions/1.8.2)
   * Bugfix: Input initial timeout was being set as a float rather than an integer
 
+# [v1.8.2](https://github.com/adhearsion/punchblock/compare/v1.8.1...v1.8.2) - [2013-04-19](https://rubygems.org/gems/punchblock/versions/1.8.2)
+  * Bugfix: Input initial timeout was being set as a float rather than an integer
+
 # [v1.8.1](https://github.com/adhearsion/punchblock/compare/v1.8.0...v1.8.1) - [2013-03-25](https://rubygems.org/gems/punchblock/versions/1.8.1)
   * Bugfix: FreeSWITCH was requiring a from attribute on a dial command
   * Bugfix: Asterisk translator now properly checks for existence of the recordings directory

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bluecloth' unless RUBY_PLATFORM =~ /java/
+gem 'activesupport', '~> 3.0' if RUBY_VERSION == "1.9.2"

data/Guardfile

@@ -3,3 +3,7 @@ guard 'rspec', :cli => '--format documentation' do
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }
 end
+
+guard 'rake', task: 'benchmark' do
+  watch(/benchmarks\/*/)
+end

data/README.markdown

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/punchblock.png)](https://rubygems.org/gems/punchblock)
+[![Build Status](https://secure.travis-ci.org/adhearsion/punchblock.png?branch=develop)](http://travis-ci.org/adhearsion/punchblock)
+[![Dependency Status](https://gemnasium.com/adhearsion/punchblock.png?travis)](https://gemnasium.com/adhearsion/punchblock)
+[![Code Climate](https://codeclimate.com/github/adhearsion/punchblock.png)](https://codeclimate.com/github/adhearsion/punchblock)
+[![Coverage Status](https://coveralls.io/repos/adhearsion/punchblock/badge.png?branch=develop)](https://coveralls.io/r/adhearsion/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.
 

data/Rakefile

@@ -35,3 +35,19 @@ task :encodeify do
     end
   end
 end
+
+require 'timeout'
+desc "Run benchmarks"
+task :benchmark do
+  begin
+    Timeout.timeout(120) do
+      glob = File.expand_path("../benchmarks/*.rb", __FILE__)
+      Dir[glob].each { |benchmark| load benchmark }
+    end
+  rescue Exception, Timeout::Error => ex
+    puts "ERROR: Couldn't complete benchmark: #{ex.class}: #{ex}"
+    puts "  #{ex.backtrace.join("\n  ")}"
+
+    exit 1 unless ENV['CI'] # Hax for running benchmarks on Travis
+  end
+end

data/benchmarks/ami_event_name_comparison.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'benchmark/ips'
+
+string = 'FullyBooted'
+FULLY_BOOTED = 'fullybooted'
+
+Benchmark.ips do |ips|
+  ips.report("downcase+compare") { string.downcase == 'fullybooted' }
+  ips.report("casecmp") { string.casecmp('fullybooted') == 0 }
+  ips.report("casecmp w/ constant") { string.casecmp(FULLY_BOOTED) == 0 }
+end

data/benchmarks/channel.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'punchblock/translator/asterisk/channel'
+
+channel_string = 'abc123'
+channel = Punchblock::Translator::Asterisk::Channel.new('abc123')
+
+class Wrapper
+  def initialize(string)
+    @string = string
+  end
+
+  def to_s
+    @string
+  end
+end
+
+wrapper = Wrapper.new 'abc123'
+
+Benchmark.ips do |ips|
+  ips.report("string nesting") { "SIP/#{channel_string}" }
+  ips.report("wrapper nesting") { "SIP/#{wrapper}" }
+  ips.report("delegate nesting") { "SIP/#{channel}" }
+end

data/lib/punchblock/client.rb

@@ -8,7 +8,7 @@ module Punchblock
 
     include HasGuardedHandlers
 
-    attr_reader :connection, :event_queue, :component_registry
+    attr_reader :connection, :component_registry
 
     delegate :run, :stop, :to => :connection
 
@@ -16,11 +16,9 @@ module Punchblock
     # @option options [Connection::XMPP] :connection The Punchblock connection to use for this session
     #
     def initialize(options = {})
-      @event_queue = Queue.new
       @connection = options[:connection]
       @connection.event_handler = lambda { |event| self.handle_event event } if @connection
       @component_registry = ComponentRegistry.new
-      @write_timeout = options[:write_timeout] || 3
     end
 
     def handle_event(event)
@@ -28,7 +26,7 @@ module Punchblock
       if event.source
         event.source.add_event event
       else
-        trigger_handler(:event, event) || event_queue.push(event)
+        trigger_handler :event, event
       end
     end
 
@@ -49,7 +47,6 @@ module Punchblock
     end
 
     def execute_command(command, options = {})
-      async = options.has_key?(:async) ? options.delete(:async) : true
       command.client = self
       if command.respond_to?(:register_handler)
         command.register_handler :internal do |event|
@@ -57,7 +54,6 @@ module Punchblock
         end
       end
       connection.write command, options
-      command.response(@write_timeout).tap { |result| raise result if result.is_a? Exception } unless async
     end
   end
 end

data/lib/punchblock/command/accept.rb

@@ -6,27 +6,6 @@ module Punchblock
       register :accept, :core
 
       include HasHeaders
-
-      ##
-      # Create a Rayo accept command. This is equivalent to a SIP "180 Trying"
-      #
-      # @param [Hash] options
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      #
-      # @return [Command::Accept] a formatted Rayo accept command
-      #
-      # @example
-      #    Accept.new.to_xml
-      #
-      #    returns:
-      #        <accept xmlns="urn:xmpp:rayo:1"/>
-      def self.new(options = {})
-        super().tap do |new_node|
-          new_node.headers = options[:headers]
-        end
-      end
-    end # Accept
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/answer.rb

@@ -6,27 +6,6 @@ module Punchblock
       register :answer, :core
 
       include HasHeaders
-
-      ##
-      # Create a Rayo answer command. This is equivalent to a SIP "200 OK"
-      #
-      # @param [Hash] options
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      #
-      # @return [Command::Answer] a formatted Rayo answer command
-      #
-      # @example
-      #    Answer.new.to_xml
-      #
-      #    returns:
-      #        <answer xmlns="urn:xmpp:rayo:1"/>
-      def self.new(options = {})
-        super().tap do |new_node|
-          new_node.headers = options[:headers]
-        end
-      end
-    end # Answer
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/dial.rb

@@ -7,94 +7,42 @@ module Punchblock
 
       include HasHeaders
 
-      ##
-      # Create a dial command
-      #
-      # @param [Hash] options
-      # @option options [String] :to destination to dial
-      # @option options [String, Optional] :from what to set the Caller ID to
-      # @option options [Integer, Optional] :timeout in milliseconds
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the new call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      # @option options [Join, Hash, Optional] :join a join (or set of join parameters) to
-      #   nest within the dial
-      #
-      # @return [Command::Dial] a formatted Rayo dial command
-      #
-      # @example
-      #    dial :to => 'tel:+14155551212', :from => 'tel:+13035551212'
-      #
-      #    returns:
-      #      <dial to='tel:+13055195825' from='tel:+14152226789' xmlns='urn:xmpp:rayo:1' />
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          options.each_pair { |k,v| new_node.send :"#{k}=", v }
-        end
-      end
-
-      ##
       # @return [String] destination to dial
-      def to
-        read_attr :to
-      end
-
-      ##
-      # @param [String] dial_to destination to dial
-      def to=(dial_to)
-        write_attr :to, dial_to
-      end
+      attribute :to
 
-      ##
       # @return [String] the caller ID
-      def from
-        read_attr :from
-      end
+      attribute :from
 
-      ##
-      # @param [String] dial_from what to set the caller ID to
-      def from=(dial_from)
-        write_attr :from, dial_from
-      end
-
-      ##
       # @return [Integer] timeout in milliseconds
-      def timeout
-        read_attr :timeout, :to_i
-      end
+      attribute :timeout, Integer
 
-      ##
-      # @param [Integer] other timeout in milliseconds
-      def timeout=(other)
-        write_attr :timeout, other
-      end
-
-      ##
       # @return [Join] the nested join
-      #
-      def join
-        element = find_first 'ns:join', :ns => Join.registered_ns
-        Join.new element if element
+      attribute :join, Join
+
+      def inherit(xml_node)
+        if join_element = xml_node.at_xpath('ns:join', ns: Join.registered_ns)
+          self.join = Join.from_xml(join_element)
+        end
+        super
       end
 
-      ##
-      # @param [Hash, Join] other a join or hash of join options
-      #
-      def join=(other)
-        remove_children :join
-        join = Join.new(other) unless other.is_a?(Join)
-        self << join
+      def rayo_attributes
+        {to: to, from: from, timeout: timeout}
       end
 
-      def response=(other)
-        @target_call_id = other.id if other.is_a?(Ref)
+      def rayo_children(root)
+        join.to_rayo(root.parent) if join
         super
       end
 
-      def inspect_attributes # :nodoc:
-        [:to, :from, :join] + super
+      def response=(other)
+        if other.is_a?(Ref)
+          @transport = other.scheme
+          @target_call_id = other.call_id
+          @domain = other.domain
+        end
+        super
       end
-    end # Dial
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/hangup.rb

@@ -6,22 +6,6 @@ module Punchblock
       register :hangup, :core
 
       include HasHeaders
-
-      ##
-      # Create a Rayo hangup command
-      #
-      # @param [Hash] options
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      #
-      # @return [Command::Hangup] a formatted Rayo redirect command
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          new_node.headers = options[:headers]
-        end
-      end
-    end # Hangup
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/join.rb

@@ -7,82 +7,33 @@ module Punchblock
 
       VALID_DIRECTIONS = [:duplex, :send, :recv].freeze
 
-      ##
-      # Create a join command
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :call_id the call ID to join
-      # @option options [String, Optional] :mixer_name the mixer name to join
-      # @option options [Symbol, Optional] :direction the direction in which media should flow
-      # @option options [Symbol, Optional] :media the method by which to negotiate media
-      #
-      # @return [Command::Join] a formatted Rayo join command
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          case options
-          when Nokogiri::XML::Node
-            new_node.inherit options
-          when Hash
-            options.each_pair { |k,v| new_node.send :"#{k}=", v }
-          end
-        end
-      end
-
-      ##
       # @return [String] the call ID to join
-      def call_id
-        read_attr :'call-id'
-      end
+      attribute :call_uri
+      alias :call_id= :call_uri=
 
-      ##
-      # @param [String] other the call ID to join
-      def call_id=(other)
-        write_attr :'call-id', other
-      end
-
-      ##
       # @return [String] the mixer name to join
-      def mixer_name
-        read_attr :'mixer-name'
-      end
+      attribute :mixer_name
 
-      ##
-      # @param [String] other the mixer name to join
-      def mixer_name=(other)
-        write_attr :'mixer-name', other
-      end
-
-      ##
-      # @return [String] the direction in which media should flow
-      def direction
-        read_attr :direction, :to_sym
-      end
-
-      ##
-      # @param [String] other the direction in which media should flow. Can be :duplex, :recv or :send
-      def direction=(direction)
-        if direction && !VALID_DIRECTIONS.include?(direction.to_sym)
-          raise ArgumentError, "Invalid Direction (#{direction}), use: #{VALID_DIRECTIONS*' '}"
+      # @param [#to_sym] other the direction in which media should flow. Can be :duplex, :recv or :send
+      attribute :direction, Symbol
+      def direction=(other)
+        if other && !VALID_DIRECTIONS.include?(other.to_sym)
+          raise ArgumentError, "Invalid Direction (#{other.inspect}), use: #{VALID_DIRECTIONS*' '}"
         end
-        write_attr :direction, direction 
+        super
       end
 
-      ##
-      # @return [String] the method by which to negotiate media
-      def media
-        read_attr :media, :to_sym
-      end
-
-      ##
-      # @param [String] other the method by which to negotiate media. Can be :direct or :bridge
-      def media=(other)
-        write_attr :media, other
-      end
+      # @return [#to_sym] the method by which to negotiate media
+      attribute :media, Symbol
 
-      def inspect_attributes # :nodoc:
-        [:call_id, :mixer_name, :direction, :media] + super
+      def rayo_attributes
+        {
+          'call-uri' => call_uri,
+          'mixer-name' => mixer_name,
+          'direction' => direction,
+          'media' => media
+        }
       end
-    end # Join
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/mute.rb

@@ -4,6 +4,6 @@ module Punchblock
   module Command
     class Mute < CommandNode
       register :mute, :core
-    end # Mute
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/redirect.rb

@@ -7,45 +7,12 @@ module Punchblock
 
       include HasHeaders
 
-      ##
-      # Create a Rayo redirect command
-      #
-      # @param [Hash] options
-      # @option options [String] :to redirect target
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the new call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      #
-      # @return [Command::Redirect] a formatted Rayo redirect command
-      #
-      # @example
-      #    Redirect.new(:to => 'tel:+14045551234').to_xml
-      #
-      #    returns:
-      #        <redirect to="tel:+14045551234" xmlns="urn:xmpp:rayo:1"/>
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          new_node.to = options[:to]
-          new_node.headers = options[:headers]
-        end
-      end
-
-      ##
       # @return [String] the redirect target
-      def to
-        read_attr :to
-      end
-
-      ##
-      # @param [String] redirect_to redirect target
-      def to=(redirect_to)
-        write_attr :to, redirect_to
-      end
+      attribute :to
 
-      def inspect_attributes # :nodoc:
-        [:to] + super
+      def rayo_attributes
+        {'to' => to}
       end
-    end # Redirect
-  end # Command
-end # Punchblock
+    end
+  end
+end

data/lib/punchblock/command/reject.rb

@@ -9,67 +9,27 @@ module Punchblock
 
       VALID_REASONS = [:busy, :decline, :error].freeze
 
-      ##
-      # Create a Rayo reject command
-      #
-      # @param [Hash] options
-      # @option options [Symbol] :reason for rejecting the call. Can be any one of VALID_REASONS. Defaults to :decline
-      # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
-      #   the call. Can be either a hash of key-value pairs, or an array of
-      #   Header objects.
-      #
-      # @return [Command::Reject] a formatted Rayo reject command
-      #
-      # @example
-      #    Reject.new(:reason => :busy).to_xml
-      #
-      #    returns:
-      #        <reject xmlns="urn:xmpp:rayo:1"><busy/></reject
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          case options
-          when Nokogiri::XML::Node
-            new_node.inherit options
-          when Hash
-            options.each_pair { |k,v| new_node.send :"#{k}=", v }
-          end
-        end
-      end
-
-      ##
-      # @return [Symbol] the reason type for rejecting a call
-      #
-      def reason
-        node = reason_node
-        node ? node.name.to_sym : nil
-      end
-
-      ##
-      # Set the reason for rejecting the call
-      #
-      # @param [Symbol] reject_reason Can be any one of :busy, :dclined or :error.
-      #
+      # @return [Symbol] the reason type for rejecting a call. One of :busy, :dclined or :error.
       # @raises ArgumentError if reject_reason is not one of the allowed reasons
-      #
+      attribute :reason, Symbol
       def reason=(reject_reason)
         if reject_reason && !VALID_REASONS.include?(reject_reason.to_sym)
           raise ArgumentError, "Invalid Reason (#{reject_reason}), use: #{VALID_REASONS*' '}"
         end
-        children.each(&:remove)
-        self << RayoNode.new(reject_reason) if reject_reason
+        super
       end
 
-      def inspect_attributes # :nodoc:
-        [:reason] + super
+      def inherit(xml_node)
+        if first_child = xml_node.at_xpath('*')
+          self.reason = first_child.name
+        end
+        super
       end
 
-      private
-
-      def reason_node
-        node_children = children.select { |c| [Nokogiri::XML::Element, Niceogiri::XML::Node].any? { |k| c.is_a?(k) } }
-        node_children.first
+      def rayo_children(root)
+        root.send reason if reason
+        super
       end
-    end # Reject
-  end # Command
-end # Punchblock
+    end
+  end
+end