punchblock 0.8.3 → 0.8.4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # develop
 
+# v0.8.4 - 2012-01-19
+  * Bugfix: End, Ringing & Answered events are allowed to have headers
+  * Feature: Dial commands may have an optional timeout
+
 # v0.8.3 - 2012-01-17
   * Feature: Return an error when trying to execute a command for unknown calls/components or when not understood
   * Feature: Log calls/translator shutting down

data/lib/punchblock/command/dial.rb

@@ -55,6 +55,18 @@ module Punchblock
         write_attr :from, dial_from
       end
 
+      ##
+      # @return [Integer] timeout in milliseconds
+      def timeout
+        read_attr :timeout, :to_i
+      end
+
+      ##
+      # @param [Integer] other timeout in milliseconds
+      def timeout=(other)
+        write_attr :timeout, other
+      end
+
       ##
       # @return [Join] the nested join
       #

data/lib/punchblock/event.rb

@@ -1,5 +1,15 @@
 module Punchblock
   class Event < RayoNode
+    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
   end
 end
 

data/lib/punchblock/event/answered.rb

@@ -2,6 +2,8 @@ module Punchblock
   class Event
     class Answered < Event
       register :answered, :core
+
+      include HasHeaders
     end # End
   end # Event
 end # Punchblock

data/lib/punchblock/event/dtmf.rb

@@ -3,25 +3,6 @@ module Punchblock
     class DTMF < Event
       register :dtmf, :core
 
-      ##
-      # Create a DTMF event
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :signal the DTMF signal received
-      #
-      # @return [Event::DTMF] a formatted Rayo DTMF event
-      #
-      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
-
       def signal
         read_attr :signal
       end

data/lib/punchblock/event/end.rb

@@ -3,24 +3,7 @@ module Punchblock
     class End < Event
       register :end, :core
 
-      ##
-      # Create an End event
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :reason the end reason
-      #
-      # @return [Event::End] a formatted Rayo end event
-      #
-      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
+      include HasHeaders
 
       def reason
         children.select { |c| c.is_a? Nokogiri::XML::Element }.first.name.to_sym

data/lib/punchblock/event/joined.rb

@@ -3,21 +3,6 @@ module Punchblock
     class Joined < Event
       register :joined, :core
 
-      ##
-      # Create a joined event
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :other_call_id the call ID that was joined
-      # @option options [String, Optional] :mixer_name the mixer name that was joined
-      #
-      # @return [Event::Joined] a formatted Rayo joined event
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          options.each_pair { |k,v| new_node.send :"#{k}=", v }
-        end
-      end
-
       ##
       # @return [String] the call ID that was joined
       def other_call_id

data/lib/punchblock/event/offer.rb

@@ -5,29 +5,6 @@ module Punchblock
 
       include HasHeaders
 
-      ##
-      # Create an Offer event
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :to the call targed
-      # @option options [String, Optional] :from the caller ID
-      # @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 [Event::Offer] a formatted Rayo offer event
-      #
-      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
-
       def to
         read_attr :to
       end

data/lib/punchblock/event/ringing.rb

@@ -2,6 +2,8 @@ module Punchblock
   class Event
     class Ringing < Event
       register :ringing, :core
+
+      include HasHeaders
     end # End
   end # Event
 end # Punchblock

data/lib/punchblock/event/unjoined.rb

@@ -3,21 +3,6 @@ module Punchblock
     class Unjoined < Event
       register :unjoined, :core
 
-      ##
-      # Create an unjoined event
-      #
-      # @param [Hash] options
-      # @option options [String, Optional] :other_call_id the call ID that was unjoined
-      # @option options [String, Optional] :mixer_name the mixer name that was unjoined
-      #
-      # @return [Event::Unjoined] a formatted Rayo unjoined event
-      #
-      def self.new(options = {})
-        super().tap do |new_node|
-          options.each_pair { |k,v| new_node.send :"#{k}=", v }
-        end
-      end
-
       ##
       # @return [String] the call ID that was unjoined
       def other_call_id

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.8.3"
+  VERSION = "0.8.4"
 end

data/spec/punchblock/command/dial_spec.rb

@@ -1,11 +1,5 @@
 require 'spec_helper'
 
-%w{
-  blather/client/dsl
-  punchblock/core_ext/blather/stanza
-  punchblock/core_ext/blather/stanza/presence
-}.each { |f| require f }
-
 module Punchblock
   module Command
     describe Dial do
@@ -17,19 +11,20 @@ module Punchblock
       let(:join_params) { {:other_call_id => 'abc123'} }
 
       describe "when setting options in initializer" do
-        subject { Dial.new :to => 'tel:+14155551212', :from => 'tel:+13035551212', :headers => { :x_skill => 'agent', :x_customer_id => 8877 }, :join => join_params }
+        subject { Dial.new :to => 'tel:+14155551212', :from => 'tel:+13035551212', :timeout => 30000, :headers => { :x_skill => 'agent', :x_customer_id => 8877 }, :join => join_params }
 
         it_should_behave_like 'command_headers'
 
-        its(:to)    { should == 'tel:+14155551212' }
-        its(:from)  { should == 'tel:+13035551212' }
-        its(:join)  { should == Join.new(join_params) }
+        its(:to)      { should == 'tel:+14155551212' }
+        its(:from)    { should == 'tel:+13035551212' }
+        its(:timeout) { should == 30000 }
+        its(:join)    { should == Join.new(join_params) }
       end
 
       describe "from a stanza" do
         let :stanza do
           <<-MESSAGE
-<dial to='tel:+14155551212' from='tel:+13035551212' xmlns='urn:xmpp:rayo:1'>
+<dial to='tel:+14155551212' from='tel:+13035551212' timeout='30000' xmlns='urn:xmpp:rayo:1'>
   <join call-id="abc123" />
   <header name="x-skill" value="agent" />
   <header name="x-customer-id" value="8877" />
@@ -41,9 +36,10 @@ module Punchblock
 
         it { should be_instance_of Dial }
 
-        its(:to)    { should == 'tel:+14155551212' }
-        its(:from)  { should == 'tel:+13035551212' }
-        its(:join)  { should == Join.new(join_params) }
+        its(:to)      { should == 'tel:+14155551212' }
+        its(:from)    { should == 'tel:+13035551212' }
+        its(:timeout) { should == 30000 }
+        its(:join)    { should == Join.new(join_params) }
       end
 
       describe "#response=" do

data/spec/punchblock/event/answered_spec.rb

@@ -8,16 +8,33 @@ module Punchblock
       end
 
       describe "from a stanza" do
-        let(:stanza) { '<answered xmlns="urn:xmpp:rayo:1"/>' }
+        let :stanza do
+          <<-MESSAGE
+<answered xmlns='urn:xmpp:rayo:1'>
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
+</answered>
+          MESSAGE
+        end
 
         subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
 
         it { should be_instance_of Answered }
 
         it_should_behave_like 'event'
+        it_should_behave_like 'event_headers'
 
         its(:xmlns) { should == 'urn:xmpp:rayo:1' }
       end
+
+      describe "when setting options in initializer" do
+        subject do
+          Answered.new :headers => { :x_skill => "agent", :x_customer_id => "8877" }
+        end
+
+        it_should_behave_like 'event_headers'
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/event/end_spec.rb

@@ -12,6 +12,9 @@ module Punchblock
           <<-MESSAGE
 <end xmlns="urn:xmpp:rayo:1">
   <timeout />
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
 </end>
           MESSAGE
         end
@@ -21,6 +24,7 @@ module Punchblock
         it { should be_instance_of End }
 
         it_should_behave_like 'event'
+        it_should_behave_like 'event_headers'
 
         its(:reason) { should == :timeout }
         its(:xmlns) { should == 'urn:xmpp:rayo:1' }
@@ -28,10 +32,12 @@ module Punchblock
 
       describe "when setting options in initializer" do
         subject do
-          End.new :reason => :hangup
+          End.new :reason => :hangup,
+                  :headers  => { :x_skill => "agent", :x_customer_id => "8877" }
         end
 
         its(:reason) { should == :hangup }
+        it_should_behave_like 'event_headers'
       end
     end
   end

data/spec/punchblock/event/ringing_spec.rb

@@ -8,16 +8,33 @@ module Punchblock
       end
 
       describe "from a stanza" do
-        let(:stanza) { '<ringing xmlns="urn:xmpp:rayo:1"/>' }
+        let :stanza do
+          <<-MESSAGE
+<ringing xmlns='urn:xmpp:rayo:1'>
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
+</ringing>
+          MESSAGE
+        end
 
         subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
 
         it { should be_instance_of Ringing }
 
         it_should_behave_like 'event'
+        it_should_behave_like 'event_headers'
 
         its(:xmlns) { should == 'urn:xmpp:rayo:1' }
       end
+
+      describe "when setting options in initializer" do
+        subject do
+          Ringing.new :headers => { :x_skill => "agent", :x_customer_id => "8877" }
+        end
+
+        it_should_behave_like 'event_headers'
+      end
     end
   end
 end # Punchblock

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2155905140 !ruby/object:Gem::Requirement
+  requirement: &2152348840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2155905140
+  version_requirements: *2152348840
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2155903300 !ruby/object:Gem::Requirement
+  requirement: &2152347280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.12
   type: :runtime
   prerelease: false
-  version_requirements: *2155903300
+  version_requirements: *2152347280
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2155901420 !ruby/object:Gem::Requirement
+  requirement: &2152345280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155901420
+  version_requirements: *2152345280
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2168536880 !ruby/object:Gem::Requirement
+  requirement: &2152344340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168536880
+  version_requirements: *2152344340
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2168535180 !ruby/object:Gem::Requirement
+  requirement: &2156165100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2168535180
+  version_requirements: *2156165100
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2168531860 !ruby/object:Gem::Requirement
+  requirement: &2156161800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168531860
+  version_requirements: *2156161800
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2168527860 !ruby/object:Gem::Requirement
+  requirement: &2156160660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168527860
+  version_requirements: *2156160660
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2168526320 !ruby/object:Gem::Requirement
+  requirement: &2156158320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168526320
+  version_requirements: *2156158320
 - !ruby/object:Gem::Dependency
   name: ruby_speech
-  requirement: &2168524860 !ruby/object:Gem::Requirement
+  requirement: &2156144520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168524860
+  version_requirements: *2156144520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2168523980 !ruby/object:Gem::Requirement
+  requirement: &2156142420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2168523980
+  version_requirements: *2156142420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168522200 !ruby/object:Gem::Requirement
+  requirement: &2156139000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -133,10 +133,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2168522200
+  version_requirements: *2156139000
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2168516560 !ruby/object:Gem::Requirement
+  requirement: &2156137680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2168516560
+  version_requirements: *2156137680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2168515600 !ruby/object:Gem::Requirement
+  requirement: &2156134180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2168515600
+  version_requirements: *2156134180
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2168475680 !ruby/object:Gem::Requirement
+  requirement: &2156132420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168475680
+  version_requirements: *2156132420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2168496000 !ruby/object:Gem::Requirement
+  requirement: &2156131300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168496000
+  version_requirements: *2156131300
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152431080 !ruby/object:Gem::Requirement
+  requirement: &2156129300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152431080
+  version_requirements: *2156129300
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2152427440 !ruby/object:Gem::Requirement
+  requirement: &2156120240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152427440
+  version_requirements: *2156120240
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2152370940 !ruby/object:Gem::Requirement
+  requirement: &2156117560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,10 +210,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152370940
+  version_requirements: *2156117560
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2152361220 !ruby/object:Gem::Requirement
+  requirement: &2156075180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -221,7 +221,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152361220
+  version_requirements: *2156075180
 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
@@ -364,7 +364,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 243839831400829248
+      hash: -2039809251711287548
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: