ruby-asterisk 0.1.0 → 0.2.0

data/lib/ruby-asterisk/request.rb

@@ -1,32 +1,31 @@
 module RubyAsterisk
+  ##
+  #
+  # Class responsible of building commands structure
+  #
   class Request
     attr_accessor :action, :action_id, :parameters, :response_data
 
-    def initialize(action,parameters={})
+    def initialize(action, parameters = {})
       self.action = action
-      self.action_id = self.generate_action_id
+      self.action_id = Request.generate_action_id
       self.parameters = parameters
-      self.response_data = ""
+      self.response_data = ''
     end
 
     def commands
-      _commands=["Action: "+self.action+"\r\n","ActionID: "+self.action_id+"\r\n"]
-      self.parameters.each do |key,value|
-        _commands<<key+": "+value+"\r\n" unless value.nil?
+      _commands = ["Action: #{self.action}\r\n", "ActionID: #{self.action_id}\r\n"]
+      self.parameters.each do |key, value|
+        _commands<<"#{key.to_s}: #{value.to_s}\r\n" unless value.nil?
       end
-      _commands[_commands.length-1]<<"\r\n"
+      _commands[_commands.length - 1] << "\r\n"
       _commands
-    end 
+    end
 
     protected
 
-    def generate_action_id
-      if RUBY_VERSION.start_with?("1.9")
-        Random.rand(999).to_s
-      else
-        rand(999).to_s
-      end
+    def self.generate_action_id
+      Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond).to_s(36)
     end
-
   end
 end

data/lib/ruby-asterisk/response.rb

@@ -1,33 +1,38 @@
+require 'ruby-asterisk/response_parser'
+
 module RubyAsterisk
+  ##
+  #
+  # Class for response coming from Asterisk
+  #
   class Response
-    attr_accessor :type, :success, :action_id, :message, :data, :raw_response
+    attr_accessor :type, :action_id, :message, :data, :raw_response
 
     def initialize(type,response)
       self.raw_response = response
       self.type = type
-      self.success = self._parse_successfull(response)
-      self.action_id = self._parse_action_id(response)
-      self.message = self._parse_message(response)
-      self.data = self._parse_data(response)
+      self.action_id = self._parse_action_id
+      self.message = self._parse_message
+      self.data = self._parse_response
     end
 
-    protected
-
-    def _parse_successfull(response)
-      response.include?("Response: Success")
+    def success
+      self.raw_response.include?("Response: Success")
     end
 
-    def _parse_action_id(response)
-      self._parse(response,"ActionID:")
+    protected
+
+    def _parse_action_id
+      self._parse("ActionID:")
     end
 
-    def _parse_message(response)
-      self._parse(response,"Message:")
+    def _parse_message
+      self._parse("Message:")
     end
 
-    def _parse(response,field)
+    def _parse(field)
       _value = nil
-      response.each_line do |line|
+      self.raw_response.each_line do |line|
         if line.start_with?(field)
           _value = line[line.rindex(":")+1..line.size].strip
         end
@@ -35,128 +40,9 @@ module RubyAsterisk
       _value
     end
 
-    def _parse_data(response)
-      case self.type
-        when "CoreShowChannels"
-          self._parse_data_core_show_channels(response)
-        when "ParkedCalls"
-          self._parse_data_parked_calls(response)
-        when "Originate"
-          self._parse_originate(response)
-        when "MeetMeList"
-          self._parse_meet_me_list(response)
-        when "Status"
-          self._parse_status(response)
-        when "ExtensionState"
-          self._parse_extension_state(response)
-        when "SKINNYdevices"
-          self._parse_skinny_devices(response)
-        when "SKINNYlines"
-          self._parse_skinny_lines(response)
-        when "Command"
-          response
-        when "QueuePause"
-          self._parse_queue_pause(response)
-        when "Pong"
-          self._parse_pong(response)
-        when "Events"
-          self._parse_event_mask(response)
-        when "SIPpeers"
-          self._parse_sip_peers(response)
-      end
-
-    end
-
-    def _parse_sip_peers(response)
-      self._parse_objects(response, :peers, "Event: PeerEntry")
-    end
-
-    def _parse_meet_me_list(response)
-      self._parse_objects(response,:rooms,"Event: MeetmeList")
-    end
-
-    def _parse_originate(response)
-      self._parse_objects(response,:dial,"Event: Dial")
-    end
-
-    def _parse_data_parked_calls(response)
-      self._parse_objects(response,:calls,"Event: ParkedCall")
-    end
-
-    def _parse_data_core_show_channels(response)
-      self._parse_objects(response,:channels,"Event: CoreShowChannel","Event: CoreShowChannelsComplete")
+    def _parse_response
+      ResponseParser.parse(self.raw_response, self.type)
     end
 
-    def _parse_extension_state(response)
-      _data = self._parse_objects(response,:hints,"Response:")
-      self._convert_status(_data)
-    end
-    
-    def _parse_skinny_devices(response)
-      self._parse_objects(response,:skinnydevs,"Event: DeviceEntry")
-    end
-
-    def _parse_skinny_lines(response)
-      self._parse_objects(response,:skinnylines,"Event: LineEntry")
-    end
-    
-    def _parse_queue_pause(response)
-      _data = self._parse_objects(response,:queue_pause,"Response:")
-    end
-    
-    def _parse_pong(response)
-      _data = self._parse_objects(response,:pong, "Response:")
-    end
-    
-    def _parse_event_mask(response)
-      _data = self._parse_objects(response, :event_mask, "Ping:")
-    end
-
-    def _parse_status(response)
-      self._parse_objects(response, :status, "Event: Status")
-    end
-
-    def _convert_status(_data)
-      _data[:hints].each do |hint|
-        case hint["Status"]
-          when "-1"
-            hint["DescriptiveStatus"] = "Extension not found"
-          when "0"
-            hint["DescriptiveStatus"] = "Idle"
-          when "1"
-            hint["DescriptiveStatus"] = "In Use"
-          when "2"
-            hint["DescriptiveStatus"] = "Busy"
-          when "4"
-            hint["DescriptiveStatus"] = "Unavailable"
-          when "8"
-            hint["DescriptiveStatus"] = "Ringing"
-          when "16"
-            hint["DescriptiveStatus"] = "On Hold"
-        end
-      end
-      _data
-    end
-
-    def _parse_objects(response,symbol_name,search_for,stop_with=nil)
-       _data = { symbol_name => [] }
-      parsing = false
-      object = nil
-      response.each_line do |line|
-        line.strip!
-        if line.strip.empty? or (!stop_with.nil? and line.start_with?(stop_with))
-          parsing = false
-        elsif line.start_with?(search_for)
-          _data[symbol_name] << object unless object.nil?
-          object = {}
-          parsing = true
-        elsif parsing
-          tokens = line.split(':', 2)
-          object[tokens[0].strip]=tokens[1].strip unless tokens[1].nil?
-        end
-      end
-      _data[symbol_name] << object unless object.nil?
-      _data
-    end
   end
 end

data/lib/ruby-asterisk/response_parser.rb

@@ -0,0 +1,42 @@
+require 'ruby-asterisk/parsing_constants'
+
+module RubyAsterisk
+  ##
+  #
+  # Class for parsing response coming from Asterisk
+  #
+  class ResponseParser
+
+    def self.parse(raw_response, type)
+      if PARSE_DATA.include?(type)
+        self._parse_objects(raw_response, PARSE_DATA[type])
+      else
+        raw_response
+      end
+    end
+
+    protected
+
+    def self._add_status(exten_array)
+      exten_array.each do |hint|
+        hint["DescriptiveStatus"] = DESCRIPTIVE_STATUS[hint["Status"]]
+      end
+      exten_array
+    end
+
+    def self._parse_objects(response, parse_params)
+      object_array = []
+      object_regex = Regexp.new(/#{parse_params[:search_for]}\n(.*?)\n\n/m)
+      response.scan(object_regex) do |match|
+        object = {}
+        match[0].split(/\n/).each do |line|
+          tokens = line.split(':', 2)
+          object[tokens[0].strip]=tokens[1].strip unless tokens[1].nil?
+        end
+        object_array << object unless object.empty?
+      end
+      object_array = _add_status(object_array) if parse_params[:symbol].eql?(:hints)
+      { parse_params[:symbol] => object_array }
+    end
+  end
+end

data/lib/ruby-asterisk/version.rb

@@ -1,3 +1,3 @@
 module Rami
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ruby-asterisk.gemspec

@@ -7,10 +7,11 @@ Gem::Specification.new do |s|
   s.version     = Rami::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Emiliano Della Casa"]
-  s.email       = ["e.dellacasa@engim.eu"]
+  s.email       = ["emiliano.dellacasa@gmail.com"]
   s.homepage    = "http://github.com/emilianodellacasa/ruby-asterisk"
   s.summary     = %q{Asterisk Manager Interface in Ruby}
   s.description = %q{Add support to your ruby or rails projects to Asterisk Manager Interface (AMI)}
+  s.licenses    = ['MIT']
 
   s.rubyforge_project = "ruby-asterisk"
 
@@ -19,6 +20,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-	s.add_development_dependency "rake"
-	s.add_development_dependency 'rspec'
+  s.add_development_dependency "rake"
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'quality'
 end

data/spec/ruby-asterisk/request_spec.rb

@@ -8,7 +8,7 @@ describe RubyAsterisk::Request do
       request.commands.include?("Variable: var1=15\r\n").should_not be_nil
     end
 
-		it "should not set a Variable option if not set" do
+    it "should not set a Variable option if not set" do
       request = RubyAsterisk::Request.new("Originate",{"Channel" => "1234", "Context" => "test", "Exten" => "1", "Priority" => "1", "Callerid" => "1234", "Timeout" => "30000", "Variable" => nil  })
       request.commands.include?("Variable: var=15").should==false
     end

data/spec/ruby-asterisk/response_spec.rb

@@ -5,130 +5,130 @@ describe RubyAsterisk::Response do
   def sip_peers_response
     "Response: Success
      Message: Peer status list will follow
-     
+
      Event: PeerEntry
      Channeltype: SIP
      ObjectName: 9915057
-     IPport: 5060"
+     IPport: 5060\n\n"
+  end
+
+  def empty_core_show_channels_response
+    "Event: CoreShowChannelsComplete
+    EventList: Complete
+    ListItems: 1
+    ActionID: 839\n\n"
   end
 
-	def empty_core_show_channels_response
-		"Event: CoreShowChannelsComplete
-		EventList: Complete
+  def core_show_channels_response
+    "Event: CoreShowChannel
+    ActionID: 839
+    Channel: SIP/195.62.226.4-00000025
+    UniqueID: 1335448133.61
+    Context: incoming
+    Extension: s
+    Priority: 1
+    ChannelState: 6
+    ChannelStateDesc: Up
+    Application: Parked Call
+    ApplicationData:
+    CallerIDnum: 123456
+    CallerIDname:
+    ConnectedLineNum:
+    ConnectedLineName:
+    Duration: 00:00:05
+    AccountCode:
+    BridgedChannel:
+    BridgedUniqueID:
+
+    Event: CoreShowChannelsComplete
+    EventList: Complete
     ListItems: 1
-    ActionID: 839"
-	end
-
-	def core_show_channels_response
-		"Event: CoreShowChannel
-		ActionID: 839
-		Channel: SIP/195.62.226.4-00000025
-		UniqueID: 1335448133.61
-		Context: incoming
-		Extension: s
-		Priority: 1
-		ChannelState: 6
-		ChannelStateDesc: Up
-		Application: Parked Call
-		ApplicationData:
-		CallerIDnum: 123456
-		CallerIDname:
-		ConnectedLineNum:
-		ConnectedLineName:
-		Duration: 00:00:05
-		AccountCode:
-		BridgedChannel:
-		BridgedUniqueID:
-
-		Event: CoreShowChannelsComplete
-		EventList: Complete
-		ListItems: 1
-		ActionID: 839"
-	end
-
-	def parked_calls_response
-		"Event: ParkedCall
-		Parkinglot: default
-		Exten: 701
-		Channel: SIP/195.62.226.2-00000026
-		From: SIP/195.62.226.2-00000026
-		Timeout: 3
-		CallerIDNum: 123456
-		CallerIDName:
-		ConnectedLineNum:
-		ConnectedLineName:
-		ActionID: 899"
-	end
-
-	def originate_response
-		"Event: Dial
-		Privilege: call,all
-		SubEvent: End
-		Channel: SIP/9100-0000002b
-		UniqueID: 1335457364.68
-		DialStatus: CHANUNAVAIL"
-	end
-
-	def meet_me_list_response
-		"Event: MeetmeList
-		ActionID: 921
-		Conference: 1234
-		UserNumber: 1
-		CallerIDNum: 123456
-		CallerIDName: <no name>
-		ConnectedLineNum: <unknown>
-		ConnectedLineName: <no name>
-		Channel: SIP/195.62.226.18-0000000e
-		Admin: No
-		Role: Talk and listen
-		MarkedUser: No
-		Muted: No
-		Talking: Not monitored"
-	end
-
-	def extension_state_response
-		"Response: Success
-		ActionID: 180
-		Message: Extension Status
-		Exten: 9100
-		Context: HINT
-		Hint: SIP/9100
-		Status: 0"
-	end
-
-	describe ".new" do
-		
-		describe "receiving a Core Show Channels request" do
-			it "should parse correctly data coming from Asterisk about channels" do 
-				@response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
-				@response.data[:channels].should_not be_empty
-			end
-
-			it "should correctly fill the fields" do
+    ActionID: 839\n\n"
+  end
+
+  def parked_calls_response
+    "Event: ParkedCall
+    Parkinglot: default
+    Exten: 701
+    Channel: SIP/195.62.226.2-00000026
+    From: SIP/195.62.226.2-00000026
+    Timeout: 3
+    CallerIDNum: 123456
+    CallerIDName:
+    ConnectedLineNum:
+    ConnectedLineName:
+    ActionID: 899\n\n"
+  end
+
+  def originate_response
+    "Event: Dial
+    Privilege: call,all
+    SubEvent: End
+    Channel: SIP/9100-0000002b
+    UniqueID: 1335457364.68
+    DialStatus: CHANUNAVAIL\n\n"
+  end
+
+  def meet_me_list_response
+    "Event: MeetmeList
+    ActionID: 921
+    Conference: 1234
+    UserNumber: 1
+    CallerIDNum: 123456
+    CallerIDName: <no name>
+    ConnectedLineNum: <unknown>
+    ConnectedLineName: <no name>
+    Channel: SIP/195.62.226.18-0000000e
+    Admin: No
+    Role: Talk and listen
+    MarkedUser: No
+    Muted: No
+    Talking: Not monitored\n\n"
+  end
+
+  def extension_state_response
+    "Response: Success
+    ActionID: 180
+    Message: Extension Status
+    Exten: 9100
+    Context: HINT
+    Hint: SIP/9100
+    Status: 0\n\n"
+  end
+
+  describe ".new" do
+
+    describe "receiving a Core Show Channels request" do
+      it "should parse correctly data coming from Asterisk about channels" do
+        @response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
+        @response.data[:channels].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
         @response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
         @response.data[:channels][0]["CallerIDnum"].should eq("123456")
       end
 
-			it "should have no channels if answer is empty" do
-				@response = RubyAsterisk::Response.new("CoreShowChannels",empty_core_show_channels_response)
-				@response.data[:channels].count.should eq(0)
-			end
-		end
-	
-		describe "receiving a Parked Calls request" do
-			it "should parse correctly data coming from Asterisk about calls" do
-				@response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
-				@response.data[:calls].should_not be_empty
-			end
-
-			it "should correctly fill the fields" do
-				@response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
-				@response.data[:calls][0]["Exten"].should eq("701")
-			end
-		end
-
-		describe "receiving a Originate request" do 
-			it "should parse correctly data coming from Asterisk about the call" do
+      it "should have no channels if answer is empty" do
+        @response = RubyAsterisk::Response.new("CoreShowChannels",empty_core_show_channels_response)
+        @response.data[:channels].count.should eq(0)
+      end
+    end
+
+    describe "receiving a Parked Calls request" do
+      it "should parse correctly data coming from Asterisk about calls" do
+        @response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
+        @response.data[:calls].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
+        @response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
+        @response.data[:calls][0]["Exten"].should eq("701")
+      end
+    end
+
+    describe "receiving a Originate request" do
+      it "should parse correctly data coming from Asterisk about the call" do
         @response = RubyAsterisk::Response.new("Originate",originate_response)
         @response.data[:dial].should_not be_empty
       end
@@ -143,8 +143,8 @@ describe RubyAsterisk::Response do
         @response.raw_response.should eq(originate_response)
       end
     end
-		
-		describe "receiving a MeetMeList request" do
+
+    describe "receiving a MeetMeList request" do
       it "should parse correctly data coming from Asterisk about the conference room" do
         @response = RubyAsterisk::Response.new("MeetMeList",meet_me_list_response)
         @response.data[:rooms].should_not be_empty
@@ -156,7 +156,7 @@ describe RubyAsterisk::Response do
       end
     end
 
-		describe "receiving a ExtensionState request" do
+    describe "receiving a ExtensionState request" do
       it "should parse correctly data coming from Asterisk about the state of the extension" do
         @response = RubyAsterisk::Response.new("ExtensionState",extension_state_response)
         @response.data[:hints].should_not be_empty
@@ -165,17 +165,17 @@ describe RubyAsterisk::Response do
       it "should correctly fill the fields" do
         @response = RubyAsterisk::Response.new("ExtensionState",extension_state_response)
         @response.data[:hints][0]["Status"].should eq("0")
-				@response.data[:hints][0]["DescriptiveStatus"].should eq("Idle")
+        @response.data[:hints][0]["DescriptiveStatus"].should eq("Idle")
       end
     end
-	end
+  end
 
   describe "receiving a SIPPeers request" do
     it "should parse correctly data coming from Asterisk abous sip peers" do
       @response = RubyAsterisk::Response.new("SIPpeers",sip_peers_response)
       @response.data[:peers].should_not be_empty
     end
-    
+
     it "should correctly fill the fields" do
       @response = RubyAsterisk::Response.new("SIPpeers",sip_peers_response)
       @response.data[:peers][0]["ObjectName"].should eq("9915057")