ruby-asterisk 0.2.0 → 1.0.0

data/spec/ruby-asterisk/request_spec.rb

@@ -1,17 +1,37 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 describe RubyAsterisk::Request do
-
-  describe "of type Originate" do
-    it "should set a Variable option if set" do
-      request = RubyAsterisk::Request.new("Originate",{"Channel" => "1234", "Context" => "test", "Exten" => "1", "Priority" => "1", "Callerid" => "1234", "Timeout" => "30000", "Variable" => "var1=15"  })
+  describe 'of type Originate' do
+    it 'should set a Variable option if set' do
+      request = RubyAsterisk::Request.new('Originate', { 'Channel' => '1234', 'Context' => 'test', 'Exten' => '1', 'Priority' => '1', 'Callerid' => '1234', 'Timeout' => '30000', 'Variable' => 'var1=15' })
       request.commands.include?("Variable: var1=15\r\n").should_not be_nil
     end
 
-    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
+    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
   end
-end
 
+  describe 'action_id' do
+    it 'generates one when none is supplied' do
+      request = RubyAsterisk::Request.new('Ping')
+
+      expect(request.action_id).not_to be_empty
+      expect(request.commands.join).to include("ActionID: #{request.action_id}\r\n")
+    end
+
+    it 'uses the supplied action_id' do
+      request = RubyAsterisk::Request.new('Status', {}, action_id: 'my-own-id')
+
+      expect(request.action_id).to eq('my-own-id')
+    end
+
+    it 'emits exactly one ActionID header' do
+      request = RubyAsterisk::Request.new('Status', { 'Channel' => 'SIP/alice' }, action_id: 'my-own-id')
+
+      expect(request.commands.join.scan(/^ActionID:/).size).to eq(1)
+    end
+  end
+end

data/spec/ruby-asterisk/response_spec.rb

@@ -1,7 +1,7 @@
-# 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
@@ -96,90 +96,89 @@ describe RubyAsterisk::Response do
     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)
+  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")
+      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)
+      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)
+    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")
+      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)
+    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
 
-  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,6 +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

metadata

@@ -1,15 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: ruby-asterisk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Emiliano Della Casa
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +94,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: quality
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,29 +143,86 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/skills/ruby-asterisk-agi/SKILL.md"
+- ".claude/skills/ruby-asterisk-ami/SKILL.md"
+- ".claude/skills/ruby-asterisk-ari-websocket/SKILL.md"
+- ".claude/skills/ruby-asterisk-ari/SKILL.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- CHANGELOG
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENCE
 - README.md
 - Rakefile
 - lib/ruby-asterisk.rb
+- lib/ruby-asterisk/agi/protocol.rb
+- lib/ruby-asterisk/agi/server.rb
+- lib/ruby-asterisk/agi/session.rb
+- lib/ruby-asterisk/ami/client.rb
+- lib/ruby-asterisk/ami/commands/channel.rb
+- lib/ruby-asterisk/ami/commands/conference.rb
+- lib/ruby-asterisk/ami/commands/extension.rb
+- lib/ruby-asterisk/ami/commands/mailbox.rb
+- lib/ruby-asterisk/ami/commands/monitor.rb
+- lib/ruby-asterisk/ami/commands/queue.rb
+- lib/ruby-asterisk/ami/commands/sip.rb
+- lib/ruby-asterisk/ami/commands/system.rb
+- lib/ruby-asterisk/ami/event.rb
+- lib/ruby-asterisk/ami/event_list_aggregation.rb
+- lib/ruby-asterisk/ami/parser.rb
+- lib/ruby-asterisk/ami/promise.rb
+- lib/ruby-asterisk/ami/reactor.rb
+- lib/ruby-asterisk/ari/client.rb
+- lib/ruby-asterisk/ari/resources/base.rb
+- lib/ruby-asterisk/ari/resources/bridge.rb
+- lib/ruby-asterisk/ari/resources/channel.rb
+- lib/ruby-asterisk/ari/resources/collection.rb
+- lib/ruby-asterisk/ari/resources/endpoint.rb
+- lib/ruby-asterisk/ari/resources/playback.rb
+- lib/ruby-asterisk/ari/websocket.rb
+- lib/ruby-asterisk/ari/websocket/connection.rb
+- lib/ruby-asterisk/ari/websocket/event_handlers.rb
+- lib/ruby-asterisk/ari/websocket/heartbeat.rb
+- lib/ruby-asterisk/ari/websocket/reconnect.rb
+- lib/ruby-asterisk/ari/websocket/socket_adapter.rb
+- lib/ruby-asterisk/compat.rb
+- lib/ruby-asterisk/error.rb
 - lib/ruby-asterisk/parsing_constants.rb
 - lib/ruby-asterisk/request.rb
 - lib/ruby-asterisk/response.rb
+- lib/ruby-asterisk/response_builder.rb
 - lib/ruby-asterisk/response_parser.rb
 - lib/ruby-asterisk/version.rb
 - ruby-asterisk.gemspec
+- spec/ruby-asterisk/agi/protocol_spec.rb
+- spec/ruby-asterisk/agi/server_spec.rb
+- spec/ruby-asterisk/agi/session_spec.rb
+- spec/ruby-asterisk/ami/async_client_spec.rb
+- spec/ruby-asterisk/ami/multi_event_spec.rb
+- spec/ruby-asterisk/ami/parser_spec.rb
+- spec/ruby-asterisk/ami/reactor_spec.rb
+- spec/ruby-asterisk/ami_client_spec.rb
+- spec/ruby-asterisk/ari/client_spec.rb
+- spec/ruby-asterisk/ari/resources/bridge_spec.rb
+- spec/ruby-asterisk/ari/resources/channel_spec.rb
+- spec/ruby-asterisk/ari/resources/collection_spec.rb
+- spec/ruby-asterisk/ari/resources/endpoint_spec.rb
+- spec/ruby-asterisk/ari/resources/playback_spec.rb
+- spec/ruby-asterisk/ari/websocket_integration_spec.rb
+- spec/ruby-asterisk/ari/websocket_spec.rb
+- spec/ruby-asterisk/immutability_spec.rb
 - spec/ruby-asterisk/request_spec.rb
 - spec/ruby-asterisk/response_spec.rb
-- spec/ruby-asterisk/ruby_asterisk_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_ami_server.rb
+- spec/support/mock_ari_websocket_server.rb
 homepage: http://github.com/emilianodellacasa/ruby-asterisk
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -104,20 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ruby-asterisk
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Asterisk Manager Interface in Ruby
-test_files:
-- spec/ruby-asterisk/request_spec.rb
-- spec/ruby-asterisk/response_spec.rb
-- spec/ruby-asterisk/ruby_asterisk_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/CHANGELOG

@@ -1,3 +0,0 @@
-## v0.0.1
-
-* Initial release