punchblock 0.5.1 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # develop
 
+# v0.6.0
+  * API change: Punchblock consumers now need to instantiate both a Connection and a Client (see the punchblock-console gem for an example)
+  * Feature: Added a Connection for Asterisk, utilising RubyAMI to open an AMI connection to Asterisk, and allowing AMI actions to be executed. AMI events are handled by the client event handler.
+  * Deprecation: The punchblock-console and the associated DSL are now deprecated and the punchblock-console gem should be used instead
+
 # v0.5.1
   API change: Connections now raise a Punchblock::Connection::Connected instance as an event, rather than the class itself
 

data/LICENSE.txt

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

data/bin/punchblock-console

@@ -7,12 +7,20 @@ require 'pry'
 require 'logger'
 require 'optparse'
 
+puts <<-DEPRECATION
+********************
+WARNING: This utility is deprecated and will be removed from a future version of Punchblock without further notice. You should use the punchblock-console gem instead.
+********************
+DEPRECATION
+
 include Punchblock
 
 Thread.abort_on_exception = true
 
 options = { :username => 'usera@127.0.0.1', :password => '1', :wire_log_file => 'log/rayo-wire.log', :transport_log_file => 'log/rayo-transport.log', :auto_reconnect => false }
 
+connection_class = Connection::XMPP
+
 option_parser = OptionParser.new do |opts|
   opts.banner = "Usage: punchblock-console [-u usera@127.0.0.1] [-p abc123]"
   opts.on("-u", "--username USERNAME", String, "Specify the XMPP JID to connect to") do |u|
@@ -30,6 +38,11 @@ option_parser = OptionParser.new do |opts|
   opts.on("--transport-log-file log/transportlog.log", String, "Specify the file to which the transport log should be written") do |tlf|
     options[:transport_log_file] = tlf
   end
+  opts.on("--asterisk", "Use Asterisk") do |tlf|
+    connection_class = Connection::Asterisk
+    options[:host] = '127.0.0.1'
+    options[:port] = 5038
+  end
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -53,8 +66,9 @@ options[:wire_logger].debug "Starting up..."
 options[:transport_logger] = Logger.new options.delete(:transport_log_file)
 options[:transport_logger].level = Logger::DEBUG
 options[:transport_logger].debug "Starting up..."
+options[:logger] = options[:wire_logger]
 
-connection = Connection::XMPP.new options
+connection = connection_class.new options
 client = Client.new :connection => connection
 
 [:INT, :TERM].each do |signal|
@@ -87,6 +101,10 @@ Thread.new do
       puts "Waiting for a call..."
       next
     end
+    unless event.call_id
+      puts "Ad-hoc event: #{event.inspect}"
+      next
+    end
     puts "#{event.class} event for call: #{event.call_id}"
     case event
     when Event::Offer

data/lib/punchblock.rb

@@ -34,15 +34,17 @@ module Punchblock
   autoload :MediaNode
   autoload :ProtocolError
   autoload :RayoNode
+  autoload :Translator
 
   ##
   # This exception may be raised if a transport error is detected.
   TransportError = Class.new StandardError
 
-  BASE_RAYO_NAMESPACE   = 'urn:xmpp:rayo'
-  BASE_TROPO_NAMESPACE  = 'urn:xmpp:tropo'
-  RAYO_VERSION          = '1'
-  RAYO_NAMESPACES       = {:core => [BASE_RAYO_NAMESPACE, RAYO_VERSION].compact.join(':')}
+  BASE_RAYO_NAMESPACE     = 'urn:xmpp:rayo'
+  BASE_TROPO_NAMESPACE    = 'urn:xmpp:tropo'
+  BASE_ASTERISK_NAMESPACE = 'urn:xmpp:rayo:asterisk'
+  RAYO_VERSION            = '1'
+  RAYO_NAMESPACES         = {:core => [BASE_RAYO_NAMESPACE, RAYO_VERSION].compact.join(':')}
 
   [:ext, :record, :output, :input].each do |ns|
     RAYO_NAMESPACES[ns] = [BASE_RAYO_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
@@ -53,6 +55,11 @@ module Punchblock
     RAYO_NAMESPACES[ns] = [BASE_TROPO_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_TROPO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
   end
+
+  [:agi, :ami].each do |ns|
+    RAYO_NAMESPACES[ns] = [BASE_ASTERISK_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
+    RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_ASTERISK_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
+  end
 end
 
 require 'punchblock/event'

data/lib/punchblock/command/reject.rb

@@ -26,8 +26,12 @@ module Punchblock
       #
       def self.new(options = {})
         super().tap do |new_node|
-          new_node.reason = options[:reason] || :decline
-          new_node.headers = options[:headers]
+          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
 

data/lib/punchblock/component.rb

@@ -2,6 +2,7 @@ module Punchblock
   module Component
     extend ActiveSupport::Autoload
 
+    autoload :Asterisk
     autoload :Input
     autoload :Output
     autoload :Record

data/lib/punchblock/component/asterisk.rb

@@ -0,0 +1,10 @@
+module Punchblock
+  module Component
+    module Asterisk
+      extend ActiveSupport::Autoload
+
+      autoload :AGI
+      autoload :AMI
+    end
+  end # Command
+end # Punchblock

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

@@ -0,0 +1,11 @@
+module Punchblock
+  module Component
+    module Asterisk
+      module AGI
+        extend ActiveSupport::Autoload
+
+        autoload :Command
+      end # AGI
+    end # Asterisk
+  end # Component
+end # Punchblock

data/lib/punchblock/component/asterisk/agi/command.rb

@@ -0,0 +1,157 @@
+module Punchblock
+  module Component
+    module Asterisk
+      module AGI
+        class Command < ComponentNode
+          register :command, :agi
+
+          def self.new(options = {})
+            super().tap do |new_node|
+              options.each_pair { |k,v| new_node.send :"#{k}=", v }
+            end
+          end
+
+          def name
+            read_attr :name
+          end
+
+          def name=(other)
+            write_attr :name, other
+          end
+
+          ##
+          # @return [Array[String]] array of values of params
+          #
+          def params_array
+            params.map &:value
+          end
+
+          ##
+          # @return [Array[Param]] params
+          #
+          def params
+            find('//ns:param', :ns => self.class.registered_ns).map do |i|
+              Param.new i
+            end
+          end
+
+          ##
+          # @param [Hash, Array] params A hash of key-value param pairs, or an array of Param objects
+          #
+          def params=(params)
+            find('//ns:param', :ns => self.class.registered_ns).each &:remove
+            [params].flatten.each { |i| self << Param.new(i) } if params.is_a? Array
+          end
+
+          def inspect_attributes # :nodoc:
+            [:name, :params_array] + super
+          end
+
+          class Param < RayoNode
+            ##
+            # @param [String] name
+            # @param [String] value
+            #
+            def self.new(value)
+              super(:param).tap do |new_node|
+                case value
+                when Nokogiri::XML::Node
+                  new_node.inherit value
+                else
+                  new_node.value = value
+                end
+              end
+            end
+
+            # The Header's value
+            # @return [String]
+            def value
+              read_attr :value
+            end
+
+            # Set the Header's value
+            # @param [String] value the new value for the param
+            def value=(value)
+              write_attr :value, value
+            end
+
+            def inspect_attributes # :nodoc:
+              [:value] + super
+            end
+          end
+
+          class Complete
+            class Success < Event::Complete::Reason
+              register :success, :agi_complete
+
+              def self.new(options = {})
+                super().tap do |new_node|
+                  case options
+                  when Nokogiri::XML::Node
+                    new_node.inherit options
+                  else
+                    options.each_pair { |k,v| new_node.send :"#{k}=", v }
+                  end
+                end
+              end
+
+              def node_with_name(name)
+                n = if self.class.registered_ns
+                  find_first "ns:#{name}", :ns => self.class.registered_ns
+                else
+                  find_first name
+                end
+
+                unless n
+                  self << (n = RayoNode.new(name, self.document))
+                  n.namespace = self.class.registered_ns
+                end
+                n
+              end
+
+              def code_node
+                node_with_name 'code'
+              end
+
+              def result_node
+                node_with_name 'result'
+              end
+
+              def data_node
+                node_with_name 'data'
+              end
+
+              def code
+                code_node.text.to_i
+              end
+
+              def code=(other)
+                code_node.content = other
+              end
+
+              def result
+                result_node.text.to_i
+              end
+
+              def result=(other)
+                result_node.content = other
+              end
+
+              def data
+                data_node.text
+              end
+
+              def data=(other)
+                data_node.content = other
+              end
+
+              def inspect_attributes
+                [:code, :result, :data]
+              end
+            end
+          end # Complete
+        end # Command
+      end # AGI
+    end # Asterisk
+  end # Component
+end # Punchblock

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

@@ -0,0 +1,12 @@
+module Punchblock
+  module Component
+    module Asterisk
+      module AMI
+        extend ActiveSupport::Autoload
+
+        autoload :Action
+      end
+    end
+  end # Command
+end # Punchblock
+

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

@@ -0,0 +1,144 @@
+require 'punchblock/key_value_pair_node'
+
+module Punchblock
+  module Component
+    module Asterisk
+      module AMI
+        class Action < ComponentNode
+          register :action, :ami
+
+          def self.new(options = {})
+            super().tap do |new_node|
+              options.each_pair { |k,v| new_node.send :"#{k}=", v }
+            end
+          end
+
+          def name
+            read_attr :name
+          end
+
+          def name=(other)
+            write_attr :name, other
+          end
+
+          ##
+          # @return [Hash] hash of key-value pairs of params
+          #
+          def params_hash
+            params.inject({}) do |hash, param|
+              hash[param.name] = param.value
+              hash
+            end
+          end
+
+          ##
+          # @return [Array[Param]] params
+          #
+          def params
+            find('//ns:param', :ns => self.class.registered_ns).map do |i|
+              Param.new i
+            end
+          end
+
+          ##
+          # @param [Hash, Array] params A hash of key-value param pairs, or an array of Param objects
+          #
+          def params=(params)
+            find('//ns:param', :ns => self.class.registered_ns).each &:remove
+            if params.is_a? Hash
+              params.each_pair { |k,v| self << Param.new(k, v) }
+            elsif params.is_a? Array
+              [params].flatten.each { |i| self << Param.new(i) }
+            end
+          end
+
+          def inspect_attributes # :nodoc:
+            [:name] + super
+          end
+
+          class Param < RayoNode
+            include KeyValuePairNode
+          end
+
+          class Complete
+            class Success < Event::Complete::Reason
+              register :success, :ami_complete
+
+              def self.new(options = {})
+                super().tap do |new_node|
+                  case options
+                  when Nokogiri::XML::Node
+                    new_node.inherit options
+                  else
+                    options.each_pair { |k,v| new_node.send :"#{k}=", v }
+                  end
+                end
+              end
+
+              def message_node
+                mn = if self.class.registered_ns
+                  find_first 'ns:message', :ns => self.class.registered_ns
+                else
+                  find_first 'message'
+                end
+
+                unless mn
+                  self << (mn = RayoNode.new('message', self.document))
+                  mn.namespace = self.class.registered_ns
+                end
+                mn
+              end
+
+              def message
+                message_node.text
+              end
+
+              def message=(other)
+                message_node.content = other
+              end
+
+              ##
+              # @return [Hash] hash of key-value pairs of attributes
+              #
+              def attributes_hash
+                attributes.inject({}) do |hash, attribute|
+                  hash[attribute.name] = attribute.value
+                  hash
+                end
+              end
+
+              ##
+              # @return [Array[Attribute]] attributes
+              #
+              def attributes
+                find('//ns:attribute', :ns => self.class.registered_ns).map do |i|
+                  Attribute.new i
+                end
+              end
+
+              ##
+              # @param [Hash, Array] attributes A hash of key-value attribute pairs, or an array of Attribute objects
+              #
+              def attributes=(attributes)
+                find('//ns:attribute', :ns => self.class.registered_ns).each &:remove
+                if attributes.is_a? Hash
+                  attributes.each_pair { |k,v| self << Attribute.new(k, v) }
+                elsif attributes.is_a? Array
+                  [attributes].flatten.each { |i| self << Attribute.new(i) }
+                end
+              end
+
+              def inspect_attributes
+                [:message, :attributes_hash]
+              end
+            end
+
+            class Attribute < RayoNode
+              include KeyValuePairNode
+            end
+          end # Complete
+        end # Action
+      end # AMI
+    end # Asterisk
+  end # Component
+end # Punchblock