voip 3.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a28bde69941674d06ec91208197b123e0566099
+  data.tar.gz: 80f25ebbbe88da364936ce8b5b7e26534805e4c5
+SHA512:
+  metadata.gz: 285ea9974aabc178247e316205618b41a5cb39e2b369e8371453f3cb90f13f8bf2d00752ce4cdd886c3b16a50723d1ed697d5f222b9fed57d12495f3686bdfdc
+  data.tar.gz: 89b162107f0300ba1a0dd8d37d588261866b18d44f96a1890596a2ca39a31211cb1c5c9a3033a9fc434226b42ecc89deb4e8417724e26d13c234a5417a7c5d86

data/lib/voip.rb

@@ -0,0 +1,343 @@
+# Simple way to make and receive telephone calls through a VoIP PBX, such as Ozeki Phone System XE.
+
+class NG
+
+  require 'uri'
+  require 'net/http'
+
+  # Creates a new NG object.
+  def initialize ng_ip_address, username, password, port=9501
+    @ng_ip_address = ng_ip_address
+    @username = username
+    @password = password
+    @port = port
+  end
+
+  # Instance method to send an SMS message.
+  def send_sms to, message, from=nil
+    NG.send_sms @ng_ip_address, @username, @password, to, message, @port, from
+  end
+
+  # Class method to send an SMS message.
+  def self.send_sms ng_ip_address, username, password, to, message, port=9501, from=nil
+    to = URI::encode(to)
+    message = URI::encode(message)
+    from ||= ""
+    uri = URI "http://#{ng_ip_address}:#{port}/api?action=sendmessage&username=#{username}&password=#{password}&originator=#{from}&recipient=#{to}&messagetype=SMS:TEXT&messagedata=#{message}"
+    Response.create Net::HTTP.get uri
+  end
+end
+
+class OPS
+
+  require 'uri'
+  require 'net/http'
+  
+  # Creates a new OPS object.
+  def initialize ops_ip_address, http_api_service_port=7780, api_extension=nil, username=nil, password=nil
+    @ops_ip_address = ops_ip_address
+    @username = username
+    @password = password
+    @api_extension = api_extension
+    @http_api_service_port = http_api_service_port || 7780
+  
+    @api_extension = api_extension
+  end
+  
+  # Instance method to make a call.
+  def make_call dialed, url=nil, error_url=nil, caller_id=nil, caller_displayed_name=nil
+    OPS.make_call @ops_ip_address, @api_extension, dialed, @http_api_service_port, url, error_url, caller_id, caller_displayed_name, @username, @password
+  end
+
+  # Instance method to send an SMS message.
+  def send_sms to, message, from=nil, delivery_report_url=nil
+    OPS.send_sms @ops_ip_address, @api_extension, to, message, @http_api_service_port, from, delivery_report_url, @username, @password
+  end
+  
+  # Instance method to send an e-mail message.
+  def send_email to, message=nil, subject=nil, from=nil
+    OPS.send_email @ops_ip_address, @api_extension, to, @http_api_service_port, message, subject, from, @username, @password
+  end
+  
+  # Instance method to retrieve the list of active calls.
+  def list_active_calls
+    OPS.list_active_calls @ops_ip_address, @http_api_service_port, @username, @password
+  end
+
+  # Class method to retrieve the list of active calls.
+  def self.list_active_calls ops_ip_address, http_api_service_port=7780, username=nil, password=nil
+    http_api_service_port ||= 7780
+    
+    query = "http://#{ops_ip_address}:#{http_api_service_port}/?Command=ListActiveCalls"
+    
+    if (username != nil) && (password != nil)
+      query += "&username=#{username}&password=#{password}"
+    end
+  
+    uri = URI query
+    response = Net::HTTP.get uri
+  
+    resp = Response.create response
+    if (resp.code != "200")
+      return resp
+    end
+    
+    lines = response.split(/[\r\n]+/)
+    
+    call_infos = []
+  
+    lines.each do |line|
+    
+      if (line.index('<CallInfo>') != nil)
+        call_infos << Call.new(ops_ip_address, http_api_service_port, username, password)
+    
+      elsif (((start_index = line.index('<CallId>')) != nil) && (end_index = line.index('</CallId>')) != nil)
+        call_infos.last.call_id = line[start_index + 8, end_index - start_index - 8]
+
+      elsif (((start_index = line.index('<CallState>')) != nil) && (end_index = line.index('</CallState>')) != nil)
+        call_infos.last.call_state = line[start_index + 11, end_index - start_index - 11]
+
+      elsif (((start_index = line.index('<Source>')) != nil) && (end_index = line.index('</Source>')) != nil)
+        call_infos.last.source = line[start_index + 8, end_index - start_index - 8]
+
+      elsif (((start_index = line.index('<CallerId>')) != nil) && (end_index = line.index('</CallerId>')) != nil)
+        call_infos.last.caller_id = line[start_index + 10, end_index - start_index - 10]
+
+      elsif (((start_index = line.index('<Destination>')) != nil) && (end_index = line.index('</Destination>')) != nil)
+        call_infos.last.destination = line[start_index + 13, end_index - start_index - 13]
+
+      elsif (((start_index = line.index('<StartTime>')) != nil) && (end_index = line.index('</StartTime>')) != nil)
+        call_infos.last.start_time = line[start_index + 11, end_index - start_index - 11]
+
+      elsif (((start_index = line.index('<RingDuration>')) != nil) && (end_index = line.index('</RingDuration>')) != nil)
+        call_infos.last.ring_duration = line[start_index + 14, end_index - start_index - 14]
+
+      elsif (((start_index = line.index('<TalkDuration>')) != nil) && (end_index = line.index('</TalkDuration>')) != nil)
+        call_infos.last.talk_duration = line[start_index + 14, end_index - start_index - 14]
+      end
+    end
+
+    return call_infos
+  end
+
+  # Class method to make a call.
+  def self.make_call ops_ip_address, api_extension, dialed, http_api_service_port=7780, url=nil, error_url=nil, caller_id=nil, caller_displayed_name=nil, username=nil, password=nil
+    url ||= ""
+    error_url ||= ""
+    caller_id ||= ""
+    caller_displayed_name ||= caller_id
+    http_api_service_port ||= 7780
+  
+    OPS.execute_query "http://#{ops_ip_address}:#{http_api_service_port}/?Command=Call&Dialed=#{dialed}&ApiExtension=#{api_extension}&CallerId=#{caller_id}&CallerDisplayName=#{caller_displayed_name}&Url=#{url}&ErrorUrl=#{error_url}", username, password
+  end
+  
+  # Class method to send an SMS message.
+  def self.send_sms ops_ip_address, api_extension, to, message, http_api_service_port=7780, from=nil, delivery_report_url=nil, username=nil, password=nil
+    to = URI::encode(to)
+    message = URI::encode(message)
+    
+    from ||= ""
+    from = URI::encode(from)
+    delivery_report_url ||= "" 
+    delivery_report_url = URI::encode(delivery_report_url)
+    http_api_service_port ||= 7780
+
+    OPS.execute_query "http://#{ops_ip_address}:#{http_api_service_port}/?Command=SendSms&ApiExtension=#{api_extension}&Sender=#{from}&Recipient=#{to}&Message=#{message}&DeliveryReportURL=#{delivery_report_url}", username, password
+  end
+  
+  # Class method to send an e-mail message.
+  def self.send_email ops_ip_address, api_extension, to, http_api_service_port=7780, message=nil, subject=nil, from=nil, username=nil, password=nil
+    
+    subject = URI::encode(subject || '')
+    from = URI::encode(from || '')
+    message = URI::encode(message || '')
+    to = URI::encode(to)
+    http_api_service_port ||= 7780
+    
+    OPS.execute_query "http://#{ops_ip_address}:#{http_api_service_port}/?Command=SendEmail&ApiExtension=#{api_extension}&Sender=#{from}&Recipient=#{to}&Message=#{message}&Subject=#{subject}", username, password
+  end
+  
+  private
+  # Executes a HTTP get request
+  def self.execute_query query, username, password
+    if (username != nil) && (password != nil)
+      query += "&username=#{username}&password=#{password}"
+    end
+
+    uri = URI query 
+    Response.create Net::HTTP.get uri   
+  end
+end
+
+class Response
+  
+  # code: Get the status code of the returned response
+  # message: Get the status message of the returned response
+  attr_accessor :code, :message
+
+  # User friendly string format
+  def to_s
+     message + " (" + code + ")"
+  end
+  
+  private
+  def initialize code=nil, message=nil
+    @code = code || ""
+    @message = message || ""
+  end
+  
+  private
+  def self.create response
+    lines = response.split(/[\r\n]+/)
+    
+    resp = Response.new
+  
+    lines.each do |line|
+      if (((start_index = line.index('<Code>')) != nil) && (end_index = line.index('</Code>')) != nil)
+        resp.code = line[start_index + 6, end_index - start_index - 6]
+      elsif (((start_index = line.index('<statuscode>')) != nil) && (end_index = line.index('</statuscode>')) != nil)
+        resp.code = line[start_index + 12, end_index - start_index - 12]
+      elsif (((start_index = line.index('<Message>')) != nil) && (end_index = line.index('</Message>')) != nil)
+        resp.message = line[start_index + 9, end_index - start_index - 9]
+      elsif (((start_index = line.index('<statusmessage>')) != nil) && (end_index = line.index('</statusmessage>')) != nil)
+        resp.message = line[start_index + 15, end_index - start_index - 15]
+      end
+    end
+
+    if (resp.code != "") && (resp.message != "")
+      return resp
+    else
+      return response
+    end
+  end
+end
+
+class Call
+
+  def initialize ops_ip_address=nil, http_api_service_port=nil, username=nil, password=nil, call_id=nil, call_state=nil, source=nil, caller_id=nil, destination=nil, start_time=nil, ring_duration=nil, talk_duration=nil
+    @http_api_service_port = http_api_service_port || 7780
+    @ops_ip_address = ops_ip_address || "localhost"
+    @username = username
+    @password = password
+    @call_id = call_id || ""
+    @call_state = call_state || ""
+    @source = source || ""
+    @caller_id = caller_id || ""
+    @destination = destination || ""
+    @start_time = start_time || ""
+    @ring_duration = ring_duration || ""
+    @talk_duration = talk_duration || ""
+  end
+
+  attr_accessor :call_id, :call_state, :source, :caller_id, :destination, :start_time, :ring_duration, :talk_duration
+
+  public
+  def to_s
+    caller_id + " => " + destination + " - " + call_id + "(" + call_state + ")"
+  end
+  
+  # If getting a call, you can put it on hold and call a 2nd number, then connect the call with the 2nd number using AttendedTransfer.
+  def attended_transfer target_call_id
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=AttendedTransfer&TransferredCallId=#{@call_id}&TargetCallId=#{target_call_id}"
+  end
+
+  # Transfer the call during the conversation, and the callee will leave the conversation.
+  def blind_transfer_callee target
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=BlindTransfer&CallId=#{@call_id}&TransferorParty=callee&Target=#{target}"
+  end
+  
+  # Transfer the call during the conversation, and the caller will leave the conversation.
+  def blind_transfer_caller target
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=BlindTransfer&CallId=#{@call_id}&TransferorParty=caller&Target=#{target}"
+  end
+
+  # Forward a call by ID to another number if it can't be answered.
+  def forward destination
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Forward&CallId=#{@call_id}&Destination=#{destination}"
+  end
+
+  # Terminates a call in progress by ID.
+  def hangup
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Hangup&CallId=#{@call_id}"
+  end
+  
+  # Puts both legs of the call from InCall state to Hold state by ID.
+  def hold
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Hold&CallId=#{@call_id}"
+  end
+
+  # Plays an audio file (local or downloaded from URL) in an existing call for both party.
+  def play_file filename, repeat=false
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Play&CallId=#{@call_id}&Party=all&AudioFile=#{filename}&Repeat=#{repeat}"
+  end
+
+  # Plays an audio file (local or downloaded from URL) in an existing call for the callee.
+  def play_file_to_callee filename, repeat=false
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Play&CallId=#{@call_id}&Party=callee&AudioFile=#{filename}&Repeat=#{repeat}"
+  end
+
+  # Plays an audio file (local or downloaded from URL) in an existing call for the caller.
+  def play_file_to_caller filename, repeat=false
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Play&CallId=#{@call_id}&Party=caller&AudioFile=#{filename}&Repeat=#{repeat}"
+  end
+  
+  # Records a call in mp3 format.
+  def record_mp3 finished_url=""
+    finished_url ||= ""
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Record&CallId=#{@call_id}&Format=mp3&FinishedUrl=#{finished_url}"
+  end
+
+  # Records a call in wav format.
+  def record_wav finished_url=""
+    finished_url ||= ""
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Record&CallId=#{@call_id}&Format=wav&FinishedUrl=#{finished_url}"
+  end
+
+  # Sends a DTMF message for both party.
+  def dtmf keys
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=SendDTMF&CallId=#{@call_id}&Party=all&Keys=#{keys}"
+  end
+
+  # Sends a DTMF message for the callee.
+  def dtmf_to_callee keys
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=SendDTMF&CallId=#{@call_id}&Party=callee&Keys=#{keys}"
+  end
+
+  # Sends a DTMF message for the caller.
+  def dtmf_to_caller keys
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=SendDTMF&CallId=#{@call_id}&Party=caller&Keys=#{keys}"
+  end
+
+  # Reads a text for both party using the text to speech engine into a call in progress.
+  def speak message
+    message = URI::encode message
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Speak&CallId=#{@call_id}&Text=#{message}&Party=all"
+  end
+
+  # Reads a text for callee using the text to speech engine into a call in progress.
+  def speak_to_callee message
+    message = URI::encode message
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Speak&CallId=#{@call_id}&Text=#{message}&Party=callee"
+  end
+  
+  # Reads a text for caller using the text to speech engine into a call in progress.
+  def speak_to_caller message
+    message = URI::encode message
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Speak&CallId=#{@call_id}&Text=#{message}&Party=caller"
+  end
+
+  # Puts both legs of the call to InCall state by ID.
+  def unhold
+    execute_query "http://#{@ops_ip_address}:#{@http_api_service_port}/?Command=Unhold&CallId=#{@call_id}"
+  end
+
+  private
+  def execute_query query
+    if (@username != nil) && (@password != nil)
+      query += "&username=#{@username}&password=#{@password}"
+    end
+  
+    uri = URI query 
+    Response.create Net::HTTP.get uri   
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: voip
+version: !ruby/object:Gem::Version
+  version: 3.7.2
+platform: ruby
+authors:
+- Robert Simon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-28 00:00:00.000000000 Z
+dependencies: []
+description: Simple way to make and receive telephone calls through a VoIP PBX, such
+  as Ozeki Phone System XE.
+email: simon.robert@ozekiphone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/voip.rb
+homepage: http://www.ozekiphone.com/index.php?owpn=825
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Ozeki Phone System SDK
+test_files: []