punchblock 1.5.3 → 1.6.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.6.0](https://github.com/adhearsion/punchblock/compare/v1.5.3...v1.6.0) - [2012-11-14](https://rubygems.org/gems/punchblock/versions/1.6.0)
+  * Feature: Set dial headers on FreeSWITCH originate command (SIP only)
+  * Feature: Set dial headers on Asterisk originate command (SIP only)
+  * Bugfix: Headers were being re-written downcased and with underscores
+  * Bugfix: Ensure all numeric component attributes are written as the correct type
+
 # [v1.5.3](https://github.com/adhearsion/punchblock/compare/v1.5.2...v1.5.3) - [2012-11-01](https://rubygems.org/gems/punchblock/versions/1.5.3)
   * Doc: Add link to docs for unrenderable doc error
 

data/lib/punchblock/component/asterisk/ami/action.rb

@@ -28,7 +28,7 @@ module Punchblock
           #
           def params_hash
             params.inject({}) do |hash, param|
-              hash[param.name] = param.value
+              hash[param.name.downcase.gsub('-', '_').to_sym] = param.value
               hash
             end
           end
@@ -104,7 +104,7 @@ module Punchblock
               #
               def attributes_hash
                 attributes.inject({}) do |hash, attribute|
-                  hash[attribute.name] = attribute.value
+                  hash[attribute.name.downcase.gsub('-', '_').to_sym] = attribute.value
                   hash
                 end
               end

data/lib/punchblock/component/input.rb

@@ -48,7 +48,7 @@ module Punchblock
       # @param [Integer] other the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH
       #
       def max_silence=(other)
-        write_attr :'max-silence', other
+        write_attr :'max-silence', other.to_i
       end
 
       ##
@@ -62,7 +62,7 @@ module Punchblock
       # @param [Float] min_confidence with which to consider a response acceptable
       #
       def min_confidence=(min_confidence)
-        write_attr 'min-confidence', min_confidence
+        write_attr 'min-confidence', min_confidence.to_f
       end
 
       ##
@@ -118,7 +118,7 @@ module Punchblock
       # @param [Float] other Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.
       #
       def sensitivity=(other)
-        write_attr :sensitivity, other
+        write_attr :sensitivity, other.to_f
       end
 
       ##
@@ -132,7 +132,7 @@ module Punchblock
       # @param [Integer] timeout Indicates the amount of time preceding input which may expire before a timeout is triggered.
       #
       def initial_timeout=(other)
-        write_attr :'initial-timeout', other
+        write_attr :'initial-timeout', other.to_f
       end
 
       ##
@@ -146,7 +146,7 @@ module Punchblock
       # @param [Integer] timeout Indicates (in the case of DTMF input) the amount of time between input digits which may expire before a timeout is triggered.
       #
       def inter_digit_timeout=(other)
-        write_attr :'inter-digit-timeout', other
+        write_attr :'inter-digit-timeout', other.to_i
       end
 
       ##

data/lib/punchblock/component/output.rb

@@ -98,7 +98,7 @@ module Punchblock
       # @param [Integer] other Indicates some offset through which the output should be skipped before rendering begins.
       #
       def start_offset=(other)
-        write_attr :'start-offset', other
+        write_attr :'start-offset', other.to_i
       end
 
       ##
@@ -126,7 +126,7 @@ module Punchblock
       # @param [Integer] other Indicates the duration of silence that should space repeats of the rendered document.
       #
       def repeat_interval=(other)
-        write_attr :'repeat-interval', other
+        write_attr :'repeat-interval', other.to_i
       end
 
       ##
@@ -140,7 +140,7 @@ module Punchblock
       # @param [Integer] other Indicates the number of times the output should be played.
       #
       def repeat_times=(other)
-        write_attr :'repeat-times', other
+        write_attr :'repeat-times', other.to_i
       end
 
       ##
@@ -154,7 +154,7 @@ module Punchblock
       # @param [Integer] other Indicates the maximum amount of time for which the output should be allowed to run before being terminated. Includes repeats.
       #
       def max_time=(other)
-        write_attr :'max-time', other
+        write_attr :'max-time', other.to_i
       end
 
       def inspect_attributes

data/lib/punchblock/component/record.rb

@@ -41,7 +41,7 @@ module Punchblock
       # @param [Integer] timeout Controls the length of a period of silence after callers have spoken to conclude they finished.
       #
       def final_timeout=(timeout)
-        write_attr :'final-timeout', timeout
+        write_attr :'final-timeout', timeout.to_i
       end
 
       ##
@@ -69,7 +69,7 @@ module Punchblock
       # @param [Integer] timeout Controls how long the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
       #
       def initial_timeout=(timeout)
-        write_attr :'initial-timeout', timeout
+        write_attr :'initial-timeout', timeout.to_i
       end
 
       ##
@@ -83,7 +83,7 @@ module Punchblock
       # @param [Integer] other Indicates the maximum duration for the recording.
       #
       def max_duration=(other)
-        write_attr :'max-duration', other
+        write_attr :'max-duration', other.to_i
       end
 
       ##

data/lib/punchblock/event/asterisk/ami/event.rb

@@ -28,7 +28,7 @@ module Punchblock
           #
           def attributes_hash
             attributes.inject({}) do |hash, attribute|
-              hash[attribute.name] = attribute.value
+              hash[attribute.name.downcase.gsub('-', '_').to_sym] = attribute.value
               hash
             end
           end

data/lib/punchblock/has_headers.rb

@@ -7,7 +7,7 @@ module Punchblock
     #
     def headers_hash
       headers.inject({}) do |hash, header|
-        hash[header.name] = header.value
+        hash[header.name.downcase.gsub('-', '_').to_sym] = header.value
         hash
       end
     end

data/lib/punchblock/key_value_pair_node.rb

@@ -16,7 +16,6 @@ module KeyValuePairNode
             new_node.name = name
             new_node.value = value
           end
-          new_node.name = new_node.name.downcase
         end
       end
     end
@@ -25,13 +24,13 @@ module KeyValuePairNode
   # The Header's name
   # @return [Symbol]
   def name
-    read_attr(:name).gsub('-', '_').to_sym
+    read_attr :name
   end
 
   # Set the Header's name
   # @param [Symbol] name the new name for the param
   def name=(name)
-    write_attr :name, name.to_s.gsub('_', '-')
+    write_attr :name, name
   end
 
   # The Header's value

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

@@ -61,9 +61,9 @@ module Punchblock
                      :application => 'AGI',
                      :data        => 'agi:async',
                      :channel     => channel,
-                     :callerid    => dial_command.from,
-                     :variable    => "punchblock_call_id=#{id}"
+                     :callerid    => dial_command.from
                    }
+          params[:variable] = variable_for_headers dial_command.headers
           params[:timeout] = dial_command.timeout unless dial_command.timeout.nil?
 
           originate_action = Punchblock::Component::Asterisk::AMI::Action.new :name => 'Originate',
@@ -297,6 +297,18 @@ module Punchblock
             accumulator
           end
         end
+
+        def variable_for_headers(headers)
+          variables = { :punchblock_call_id => id }
+          header_counter = 51
+          headers.each do |header|
+            variables["SIPADDHEADER#{header_counter}"] = "\"#{header.name}: #{header.value}\""
+            header_counter += 1
+          end
+          variables.inject([]) do |a, (k, v)|
+            a << "#{k}=#{v}"
+          end.join(',')
+        end
       end
     end
   end

data/lib/punchblock/translator/freeswitch/call.rb

@@ -139,6 +139,9 @@ module Punchblock
           options[:origination_caller_id_number] = "'#{cid_number}'" if cid_number.present?
           options[:origination_caller_id_name] = "'#{cid_name}'" if cid_name.present?
           options[:originate_timeout] = dial_command.timeout/1000 if dial_command.timeout
+          dial_command.headers.each do |header|
+            options["sip_h_#{header.name}"] = "'#{header.value}'"
+          end
           opts = options.inject([]) do |a, (k, v)|
             a << "#{k}=#{v}"
           end.join(',')

data/lib/punchblock/version.rb

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

data/spec/punchblock/command/dial_spec.rb

@@ -28,8 +28,8 @@ module Punchblock
           <<-MESSAGE
 <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" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </dial>
           MESSAGE
         end
@@ -38,6 +38,8 @@ module Punchblock
 
         it { should be_instance_of Dial }
 
+        it_should_behave_like 'event_headers'
+
         its(:to)      { should be == 'tel:+14155551212' }
         its(:from)    { should be == 'tel:+13035551212' }
         its(:timeout) { should be == 30000 }

data/spec/punchblock/component/asterisk/ami/action_spec.rb

@@ -34,14 +34,14 @@ module Punchblock
             it_should_behave_like 'event'
 
             its(:name)    { should be == 'Originate' }
-            its(:params)  { should be == [Action::Param.new(:channel, 'SIP/101test'),
-                                      Action::Param.new(:context, 'default'),
-                                      Action::Param.new(:exten, '8135551212'),
-                                      Action::Param.new(:priority, '1'),
-                                      Action::Param.new(:callerid, '3125551212'),
-                                      Action::Param.new(:timeout, '30000'),
-                                      Action::Param.new(:variable, 'var1=23|var2=24|var3=25'),
-                                      Action::Param.new(:async, '1')
+            its(:params)  { should be == [Action::Param.new('Channel', 'SIP/101test'),
+                                      Action::Param.new('Context', 'default'),
+                                      Action::Param.new('Exten', '8135551212'),
+                                      Action::Param.new('Priority', '1'),
+                                      Action::Param.new('Callerid', '3125551212'),
+                                      Action::Param.new('Timeout', '30000'),
+                                      Action::Param.new('Variable', 'var1=23|var2=24|var3=25'),
+                                      Action::Param.new('Async', '1')
                                      ]}
 
             its(:params_hash) { should be == {:channel   => 'SIP/101test',
@@ -112,7 +112,7 @@ module Punchblock
 
                 its(:name)            { should be == :success }
                 its(:message)         { should be == "Originate successfully queued" }
-                its(:attributes)      { should be == [Attribute.new(:channel, 'SIP/101-3f3f'), Attribute.new(:state, 'Ring')]}
+                its(:attributes)      { should be == [Attribute.new('Channel', 'SIP/101-3f3f'), Attribute.new('State', 'Ring')]}
                 its(:attributes_hash) { should be == {:channel => 'SIP/101-3f3f', :state => 'Ring'} }
 
                 describe "when setting options in initializer" do

data/spec/punchblock/event/answered_spec.rb

@@ -14,8 +14,8 @@ module Punchblock
           <<-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" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </answered>
           MESSAGE
         end
@@ -35,7 +35,7 @@ module Punchblock
           Answered.new :headers => { :x_skill => "agent", :x_customer_id => "8877" }
         end
 
-        it_should_behave_like 'event_headers'
+        it_should_behave_like 'command_headers'
       end
     end
   end

data/spec/punchblock/event/asterisk/ami/event_spec.rb

@@ -30,7 +30,7 @@ module Punchblock
             it_should_behave_like 'event'
 
             its(:name)            { should be == 'Newchannel' }
-            its(:attributes)      { should be == [Event::Attribute.new(:channel, 'SIP/101-3f3f'), Event::Attribute.new(:state, 'Ring'), Event::Attribute.new(:callerid, '101'), Event::Attribute.new(:uniqueid, '1094154427.10')]}
+            its(:attributes)      { should be == [Event::Attribute.new('Channel', 'SIP/101-3f3f'), Event::Attribute.new('State', 'Ring'), Event::Attribute.new('Callerid', '101'), Event::Attribute.new('Uniqueid', '1094154427.10')]}
             its(:attributes_hash) { should be == {:channel => 'SIP/101-3f3f', :state => 'Ring', :callerid => '101', :uniqueid => '1094154427.10'} }
           end
 

data/spec/punchblock/event/end_spec.rb

@@ -15,8 +15,8 @@ module Punchblock
 <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" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </end>
           MESSAGE
         end
@@ -39,7 +39,7 @@ module Punchblock
         end
 
         its(:reason) { should be == :hangup }
-        it_should_behave_like 'event_headers'
+        it_should_behave_like 'command_headers'
       end
     end
   end

data/spec/punchblock/event/offer_spec.rb

@@ -16,8 +16,8 @@ module Punchblock
     to='tel:+18003211212'
     from='tel:+13058881212'>
   <!-- Signaling (e.g. SIP) Headers -->
-  <header name="x-skill" value="agent" />
-  <header name="x-customer-id" value="8877" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </offer>
           MESSAGE
         end
@@ -40,7 +40,7 @@ module Punchblock
                     :headers  => { :x_skill => "agent", :x_customer_id => "8877" }
         end
 
-        it_should_behave_like 'event_headers'
+        it_should_behave_like 'command_headers'
 
         its(:to)    { should be == 'tel:+18003211212' }
         its(:from)  { should be == 'tel:+13058881212' }

data/spec/punchblock/event/ringing_spec.rb

@@ -14,8 +14,8 @@ module Punchblock
           <<-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" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </ringing>
           MESSAGE
         end
@@ -35,7 +35,7 @@ module Punchblock
           Ringing.new :headers => { :x_skill => "agent", :x_customer_id => "8877" }
         end
 
-        it_should_behave_like 'event_headers'
+        it_should_behave_like 'command_headers'
       end
     end
   end

data/spec/punchblock/header_spec.rb

@@ -4,43 +4,8 @@ require 'spec_helper'
 
 module Punchblock
   describe Header do
-    it 'will auto-inherit nodes' do
-      n = parse_stanza "<header name='boo' value='bah' />"
-      h = Header.new n.root
-      h.name.should be == :boo
-      h.value.should be == 'bah'
-    end
+    let(:element_name) { 'header' }
 
-    it 'has a name attribute' do
-      n = Header.new :boo, 'bah'
-      n.name.should be == :boo
-      n.name = :foo
-      n.name.should be == :foo
-    end
-
-    it "substitutes - for _ on the name attribute when reading" do
-      n = parse_stanza "<header name='boo-bah' value='foo' />"
-      h = Header.new n.root
-      h.name.should be == :boo_bah
-    end
-
-    it "substitutes _ for - on the name attribute when writing" do
-      h = Header.new :boo_bah, 'foo'
-      h.to_xml.should be == '<header name="boo-bah" value="foo"/>'
-    end
-
-    it 'has a value attribute' do
-      n = Header.new :boo, 'en'
-      n.value.should be == 'en'
-      n.value = 'de'
-      n.value.should be == 'de'
-    end
-
-    it 'can determine equality' do
-      a = Header.new :boo, 'bah'
-      a.should be == Header.new(:boo, 'bah')
-      a.should_not be == Header.new(:bah, 'bah')
-      a.should_not be == Header.new(:boo, 'boo')
-    end
+    it_should_behave_like 'key_value_pairs'
   end
 end # Punchblock

data/spec/punchblock/translator/asterisk/call_spec.rb

@@ -215,6 +215,27 @@ module Punchblock
             end
           end
 
+          context 'with headers specified' do
+            let :dial_command_options do
+              { :headers => {'X-foo' => 'bar', 'X-doo' => 'dah'} }
+            end
+
+            it 'includes the headers in the Originate AMI action' do
+              expected_action = Punchblock::Component::Asterisk::AMI::Action.new(:name => 'Originate',
+                                                                                 :params => {
+                                                                                   :async       => true,
+                                                                                   :application => 'AGI',
+                                                                                   :data        => 'agi:async',
+                                                                                   :channel     => 'SIP/1234',
+                                                                                   :callerid    => 'sip:foo@bar.com',
+                                                                                   :variable    => "punchblock_call_id=#{subject.id},SIPADDHEADER51=\"X-foo: bar\",SIPADDHEADER52=\"X-doo: dah\""
+                                                                                 }).tap { |a| a.request! }
+
+              translator.expects(:execute_global_command!).once.with expected_action
+              subject.dial dial_command
+            end
+          end
+
           it 'sends the call ID as a response to the Dial' do
             subject.dial dial_command
             dial_command.response

data/spec/punchblock/translator/freeswitch/call_spec.rb

@@ -290,6 +290,17 @@ module Punchblock
             end
           end
 
+          context 'with headers specified' do
+            let :dial_command_options do
+              { :headers => {'X-foo' => 'bar', 'X-doo' => 'dah'} }
+            end
+
+            it 'includes the headers in the originate command' do
+              stream.expects(:bgapi).once.with "originate {return_ring_ready=true,origination_uuid=#{subject.id},origination_caller_id_number='#{from}',sip_h_X-foo='bar',sip_h_X-doo='dah'}#{to} &park()"
+              subject.dial dial_command
+            end
+          end
+
           it 'sends the call ID as a response to the Dial' do
             subject.dial dial_command
             dial_command.response

data/spec/spec_helper.rb

@@ -55,47 +55,36 @@ shared_examples_for 'command_headers' do
 end
 
 shared_examples_for 'event_headers' do
-  its(:headers) { should be == [Punchblock::Header.new(:x_skill, 'agent'), Punchblock::Header.new(:x_customer_id, '8877')]}
+  its(:headers) { should be == [Punchblock::Header.new('X-skill', 'agent'), Punchblock::Header.new('X-customer-id', '8877')]}
   its(:headers_hash) { should be == {:x_skill => 'agent', :x_customer_id => '8877'} }
 end
 
 shared_examples_for 'key_value_pairs' do
   it 'will auto-inherit nodes' do
     n = parse_stanza "<#{element_name} name='boo' value='bah' />"
-    h = class_name.new n.root
-    h.name.should be == :boo
+    h = described_class.new n.root
+    h.name.should be == 'boo'
     h.value.should be == 'bah'
   end
 
   it 'has a name attribute' do
-    n = class_name.new :boo, 'bah'
-    n.name.should be == :boo
+    n = described_class.new :boo, 'bah'
+    n.name.should be == 'boo'
     n.name = :foo
-    n.name.should be == :foo
-  end
-
-  it "substitutes - for _ on the name attribute when reading" do
-    n = parse_stanza "<#{element_name} name='boo-bah' value='foo' />"
-    h = class_name.new n.root
-    h.name.should be == :boo_bah
-  end
-
-  it "substitutes _ for - on the name attribute when writing" do
-    h = class_name.new :boo_bah, 'foo'
-    h.to_xml.should be == "<#{element_name} name=\"boo-bah\" value=\"foo\"/>"
+    n.name.should be == 'foo'
   end
 
   it 'has a value param' do
-    n = class_name.new :boo, 'en'
+    n = described_class.new :boo, 'en'
     n.value.should be == 'en'
     n.value = 'de'
     n.value.should be == 'de'
   end
 
   it 'can determine equality' do
-    a = class_name.new :boo, 'bah'
-    a.should be == class_name.new(:boo, 'bah')
-    a.should_not be == class_name.new(:bah, 'bah')
-    a.should_not be == class_name.new(:boo, 'boo')
+    a = described_class.new :boo, 'bah'
+    a.should be == described_class.new(:boo, 'bah')
+    a.should_not be == described_class.new(:bah, 'bah')
+    a.should_not be == described_class.new(:boo, 'boo')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
@@ -515,7 +515,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3789580734338132722
+      hash: 1883502262727865241
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -524,7 +524,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: punchblock
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Punchblock is a telephony middleware library