ruby-asterisk 0.1.0 → 1.0.0

data/spec/ruby-asterisk/response_spec.rb

@@ -1,185 +1,184 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 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
-        @response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
-        @response.data[:channels][0]["CallerIDnum"].should eq("123456")
+    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
-        @response = RubyAsterisk::Response.new("Originate",originate_response)
+      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
 
-      it "should correctly fill the fields" do
-        @response = RubyAsterisk::Response.new("Originate",originate_response)
-        @response.data[:dial][0]["UniqueID"].should eq("1335457364.68")
+      it 'should correctly fill the fields' do
+        @response = RubyAsterisk::Response.new('Originate', [originate_response])
+        @response.data[:dial][0]['UniqueID'].should eq('1335457364.68')
       end
 
-      it "should have a field with original raw response" do
-        @response = RubyAsterisk::Response.new("Originate",originate_response)
-        @response.raw_response.should eq(originate_response)
+      it 'should have a field with original raw response' do
+        @response = RubyAsterisk::Response.new('Originate', [originate_response])
+        @response.raw_response.join.should eq(originate_response)
       end
     end
-		
-		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)
+
+    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
       end
 
-      it "should correctly fill the fields" do
-        @response = RubyAsterisk::Response.new("MeetMeList",meet_me_list_response)
-        @response.data[:rooms][0]["Conference"].should eq("1234")
+      it 'should correctly fill the fields' do
+        @response = RubyAsterisk::Response.new('MeetMeList', [meet_me_list_response])
+        @response.data[:rooms][0]['Conference'].should eq('1234')
       end
     end
 
-		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)
+    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
       end
 
-      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")
+      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')
       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)
+  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")
-      @response.data[:peers][0]["IPport"].should eq("5060")
+
+    it 'should correctly fill the fields' do
+      @response = RubyAsterisk::Response.new('SIPpeers', [sip_peers_response])
+      @response.data[:peers][0]['ObjectName'].should eq('9915057')
+      @response.data[:peers][0]['IPport'].should eq('5060')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
 require 'rubygems'
 require 'bundler'
 
 require 'ruby-asterisk'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = %i[should expect]
+  end
+
+  config.after(:suite) do
+    puts '[CI] Done.'
+  end
+end

data/spec/support/mock_ami_server.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module MockAMIServer
+  def self.handle_client(client, &block)
+    client.puts 'Asterisk Call Manager/1.1'
+
+    if block
+      yield(client)
+    else
+      while (line = client.gets)
+        client.puts "Echo: #{line}"
+      end
+    end
+  rescue StandardError => e
+    puts "Client error: #{e.message}"
+  ensure
+    begin
+      client.close
+    rescue StandardError
+      nil
+    end
+    puts 'Client disconnected'
+  end
+
+  def self.start(port = 0, &block)
+    server = TCPServer.new('localhost', port)
+    assigned_port = server.addr[1]
+
+    client_threads = []
+    server_thread = Thread.new do
+      loop do
+        client = server.accept
+        puts "Client connected: #{client.peeraddr.inspect}"
+        client_threads << Thread.new(client) { |c| handle_client(c, &block) }
+      end
+    rescue IOError, Errno::EBADF # Server closed
+    ensure
+      begin
+        server.close
+      rescue StandardError
+        nil
+      end
+      client_threads.each(&:kill)
+    end
+
+    [server_thread, assigned_port]
+  end
+end

data/spec/support/mock_ari_websocket_server.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'json'
+require 'websocket/driver'
+
+# Minimal in-process WebSocket server used by ARI::WebSocket integration specs.
+# Accepts connections on an ephemeral port, completes the WebSocket handshake
+# with websocket-driver in server mode, and records what clients send.
+class MockAriWebSocketServer
+  # websocket-driver server adapter: it only needs #write
+  class ServerAdapter
+    def initialize(io)
+      @io = io
+    end
+
+    def write(data)
+      @io.write(data)
+    end
+  end
+
+  ClientConnection = Struct.new(:socket, :driver)
+
+  attr_reader :port, :messages, :pings, :connections
+
+  def initialize
+    @server = TCPServer.new('127.0.0.1', 0)
+    @port = @server.addr[1]
+    @messages = Queue.new    # text frames received from clients
+    @pings = Queue.new       # ping frames received from clients
+    @connections = Queue.new # one entry per completed handshake
+    @clients = []
+    @clients_mutex = Mutex.new
+    @accept_thread = Thread.new { accept_loop }
+  end
+
+  # Send an event (Hash) to every connected client
+  def broadcast(event)
+    data = JSON.generate(event)
+    each_client { |client| client.driver.text(data) }
+  end
+
+  # Close every client socket abruptly (no close frame), simulating a drop
+  def drop_clients
+    each_client { |client| client.socket.close }
+    @clients_mutex.synchronize { @clients.clear }
+  end
+
+  def stop
+    @server.close
+    @accept_thread.join(1)
+    drop_clients
+  rescue IOError
+    nil
+  end
+
+  # Pop from one of the queues, failing the spec on timeout
+  def self.pop(queue, timeout = 5)
+    deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout
+    loop do
+      return queue.pop(true)
+    rescue ThreadError
+      if Process.clock_gettime(Process::CLOCK_MONOTONIC) > deadline
+        raise "timed out waiting for queue after #{timeout}s"
+      end
+
+      sleep 0.01
+    end
+  end
+
+  private
+
+  def accept_loop
+    loop do
+      socket = @server.accept
+      Thread.new { handle_client(socket) }
+    end
+  rescue IOError, SystemCallError
+    nil
+  end
+
+  def handle_client(socket)
+    driver = ::WebSocket::Driver.server(ServerAdapter.new(socket))
+    client = ClientConnection.new(socket, driver)
+    @clients_mutex.synchronize { @clients << client }
+
+    setup_driver(driver, client)
+    driver.parse(socket.readpartial(4096)) until socket.closed?
+  rescue IOError, SystemCallError
+    nil
+  ensure
+    begin
+      socket.close
+    rescue StandardError
+      nil
+    end
+  end
+
+  def setup_driver(driver, client)
+    driver.on(:connect) { driver.start if ::WebSocket::Driver.websocket?(driver.env) }
+    driver.on(:open) { @connections << client }
+    driver.on(:message) { |event| @messages << event.data }
+    driver.on(:ping) { |event| @pings << event }
+  end
+
+  def each_client
+    clients = @clients_mutex.synchronize { @clients.dup }
+    clients.each do |client|
+      yield client
+    rescue IOError, SystemCallError
+      nil
+    end
+  end
+end