punchblock 0.5.1 → 0.6.0

data/lib/punchblock/component/input.rb

@@ -209,7 +209,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:mode, :terminator, :max_digits, :recognizer, :initial_timeout, :inter_digit_timeout, :term_timeout, :complete_timeout, :incomplete_timeout, :sensitivity, :min_confidence, :choices] + super
+        [:mode, :terminator, :max_digits, :recognizer, :initial_timeout, :inter_digit_timeout, :term_timeout, :complete_timeout, :incomplete_timeout, :sensitivity, :min_confidence, :grammar] + super
       end
 
       class Grammar < RayoNode
@@ -316,5 +316,5 @@ module Punchblock
         end
       end # Complete
     end # Input
-  end # Command
+  end # Component
 end # Punchblock

data/lib/punchblock/connection.rb

@@ -2,6 +2,7 @@ module Punchblock
   module Connection
     extend ActiveSupport::Autoload
 
+    autoload :Asterisk
     autoload :Connected
     autoload :XMPP
   end

data/lib/punchblock/connection/asterisk.rb

@@ -0,0 +1,31 @@
+require 'ruby_ami'
+
+module Punchblock
+  module Connection
+    class Asterisk
+      attr_reader :ami_client, :translator
+      attr_accessor :event_handler
+
+      def initialize(options = {})
+        @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.handle_ami_event! event })
+        @translator = Translator::Asterisk.new @ami_client, self
+      end
+
+      def run
+        ami_client.start
+      end
+
+      def stop
+        ami_client.stop
+      end
+
+      def write(command, options)
+        translator.execute_command! command, options
+      end
+
+      def handle_event(event)
+        event_handler.call event
+      end
+    end
+  end
+end

data/lib/punchblock/core_ext/celluloid.rb

@@ -0,0 +1,11 @@
+module Celluloid
+  class Actor
+    attr_reader :subject
+  end
+
+  class ActorProxy
+    def actor_subject
+      @actor.subject
+    end
+  end
+end

data/lib/punchblock/event.rb

@@ -5,10 +5,10 @@ end
 
 %w{
   answered
+  asterisk
   complete
   dtmf
   end
-  info
   joined
   offer
   ringing

data/lib/punchblock/event/asterisk.rb

@@ -0,0 +1,9 @@
+module Punchblock
+  class Event
+    module Asterisk
+      extend ActiveSupport::Autoload
+
+      autoload :AMI
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Punchblock
+  class Event
+    module Asterisk
+      module AMI
+        extend ActiveSupport::Autoload
+
+        autoload :Event
+      end
+    end
+  end # Command
+end # Punchblock

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

@@ -0,0 +1,66 @@
+require 'punchblock/key_value_pair_node'
+
+module Punchblock
+  class Event
+    module Asterisk
+      module AMI
+        class Event < Punchblock::Event
+          register :event, :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 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 # :nodoc:
+            [:name, :attributes_hash] + super
+          end
+
+          class Attribute < RayoNode
+            include KeyValuePairNode
+          end
+        end
+      end
+    end
+  end # Command
+end # Punchblock

data/lib/punchblock/event/complete.rb

@@ -17,6 +17,11 @@ module Punchblock
         end
       end
 
+      def reason=(other)
+        children.map &:remove
+        self << other
+      end
+
       def recording
         element = find_first('//ns:recording', :ns => RAYO_NAMESPACES[:record_complete])
         if element
@@ -32,6 +37,17 @@ module Punchblock
       end
 
       class Reason < 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
+
         def name
           super.to_sym
         end
@@ -56,6 +72,10 @@ module Punchblock
           text.strip
         end
 
+        def details=(other)
+          self << other
+        end
+
         def inspect_attributes # :nodoc:
           [:details] + super
         end

data/lib/punchblock/event/dtmf.rb

@@ -3,6 +3,25 @@ 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,10 +3,33 @@ 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
+
       def reason
         children.select { |c| c.is_a? Nokogiri::XML::Element }.first.name.to_sym
       end
 
+      def reason=(other)
+        self << Nokogiri::XML::Element.new(other.to_s, self.document)
+      end
+
       def inspect_attributes # :nodoc:
         [:reason] + super
       end

data/lib/punchblock/event/offer.rb

@@ -5,6 +5,29 @@ 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/header.rb

@@ -1,47 +1,7 @@
+require 'punchblock/key_value_pair_node'
+
 module Punchblock
   class Header < RayoNode
-    ##
-    # @param [String] name
-    # @param [String] value
-    #
-    def self.new(name, value = '')
-      super(:header).tap do |new_node|
-        case name
-        when Nokogiri::XML::Node
-          new_node.inherit name
-        else
-          new_node.name = name
-          new_node.value = value
-        end
-      end
-    end
-
-    # The Header's name
-    # @return [Symbol]
-    def name
-      read_attr(:name).gsub('-', '_').to_sym
-    end
-
-    # Set the Header's name
-    # @param [Symbol] name the new name for the header
-    def name=(name)
-      write_attr :name, name.to_s.gsub('_', '-')
-    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 header
-    def value=(value)
-      write_attr :value, value
-    end
-
-    def inspect_attributes # :nodoc:
-      [:name, :value] + super
-    end
-  end
+    include KeyValuePairNode
+  end # Header
 end # Punchblock

data/lib/punchblock/key_value_pair_node.rb

@@ -0,0 +1,50 @@
+module KeyValuePairNode
+  def self.included(klass)
+    klass.class_exec do
+      ##
+      # @param [String] name
+      # @param [String] value
+      #
+      def self.new(name, value = '')
+        super(self.name.split('::').last.downcase.to_sym).tap do |new_node|
+          case name
+          when Nokogiri::XML::Node
+            new_node.inherit name
+          else
+            new_node.name = name
+            new_node.value = value
+          end
+          new_node.name = new_node.name.downcase
+        end
+      end
+    end
+  end
+
+  # The Header's name
+  # @return [Symbol]
+  def name
+    read_attr(:name).gsub('-', '_').to_sym
+  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('_', '-')
+  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:
+    [:name, :value] + super
+  end
+end

data/lib/punchblock/rayo_node.rb

@@ -67,7 +67,7 @@ module Punchblock
     end
 
     def inspect
-      "#<#{self.class} #{inspect_attributes.map { |c| "#{c}=#{self.__send__(c).inspect}" rescue nil }.compact * ', '}>"
+      "#<#{self.class} #{inspect_attributes.map { |c| "#{c}=#{self.__send__(c).inspect rescue nil}" }.compact * ', '}>"
     end
 
     def eql?(o, *fields)

data/lib/punchblock/ref.rb

@@ -5,6 +5,12 @@ module Punchblock
   class Ref < RayoNode
     register :ref, :core
 
+    def self.new(options = {})
+      super().tap do |new_node|
+        options.each_pair { |k,v| new_node.send :"#{k}=", v }
+      end
+    end
+
     ##
     # @return [String] the command ID
     #

data/lib/punchblock/translator.rb

@@ -0,0 +1,7 @@
+module Punchblock
+  module Translator
+    extend ActiveSupport::Autoload
+
+    autoload :Asterisk
+  end
+end