ruby-smpp 0.1.0

data/lib/smpp/pdu/base.rb

@@ -0,0 +1,140 @@
+# PDUs are the protcol base units in SMPP
+module Smpp::Pdu
+  class Base
+    # Error constants
+    ESME_ROK              = 0x00000000 # OK!
+    ESME_RINVMSGLEN       = 0x00000001 # Message Length is invalid 
+    ESME_RINVCMDLEN       = 0x00000002 # Command Length is invalid 
+    ESME_RINVCMDID        = 0x00000003 # Invalid Command ID 
+    ESME_RINVBNDSTS       = 0x00000004 # Incorrect BIND Status for given com- 
+    ESME_RALYBND          = 0x00000005 # ESME Already in Bound State 
+    ESME_RINVPRTFLG       = 0x00000006 # Invalid Priority Flag 
+    ESME_RINVREGDLVFLG    = 0x00000007 # Invalid Registered Delivery Flag 
+    ESME_RSYSERR          = 0x00000008 # System Error 
+    ESME_RINVSRCADR       = 0x0000000A # Invalid Source Address 
+    ESME_RINVDSTADR       = 0x0000000B # Invalid Dest Addr 
+    ESME_RINVMSGID        = 0x0000000C # Message ID is invalid 
+    ESME_RBINDFAIL        = 0x0000000D # Bind Failed 
+    ESME_RINVPASWD        = 0x0000000E # Invalid Password 
+    ESME_RINVSYSID        = 0x0000000F # Invalid System ID 
+    ESME_RCANCELFAIL      = 0x00000011 # Cancel SM Failed 
+    ESME_RREPLACEFAIL     = 0x00000013 # Replace SM Failed 
+    ESME_RMSGQFUL         = 0x00000014 # Message Queue Full 
+    ESME_RINVSERTYP       = 0x00000015 # Invalid Service Type 
+    ESME_RINVNUMDESTS     = 0x00000033 # Invalid number of destinations 
+    ESME_RINVDLNAME       = 0x00000034 # Invalid Distribution List name 
+    ESME_RINVDESTFLAG     = 0x00000040 # Destination flag is invalid 
+    ESME_RINVSUBREP       = 0x00000042 # Invalid ‘submit with replace’ request 
+    ESME_RINVESMCLASS     = 0x00000043 # Invalid esm_class field data 
+    ESME_RCNTSUBDL        = 0x00000044 # Cannot Submit to Distribution List 
+    ESME_RSUBMITFAIL      = 0x00000045 # submit_sm or submit_multi failed 
+    ESME_RINVSRCTON       = 0x00000048 # Invalid Source address TON 
+    ESME_RINVSRCNPI       = 0x00000049 # Invalid Source address NPI       
+    ESME_RINVDSTTON       = 0x00000050 # Invalid Destination address TON 
+    ESME_RINVDSTNPI       = 0x00000051 # Invalid Destination address NPI 
+    ESME_RINVSYSTYP       = 0x00000053 # Invalid system_type field 
+    ESME_RINVREPFLAG      = 0x00000054 # Invalid replace_if_present flag 
+    ESME_RINVNUMMSGS      = 0x00000055 # Invalid number of messages 
+    ESME_RTHROTTLED       = 0x00000058 # Throttling error (ESME has exceeded allowed message limits)     
+
+    # PDU types
+    GENERIC_NACK          = 0X80000000 
+    BIND_RECEIVER         = 0X00000001 
+    BIND_RECEIVER_RESP    = 0X80000001 
+    BIND_TRANSMITTER      = 0X00000002 
+    BIND_TRANSMITTER_RESP = 0X80000002 
+    BIND_TRANSCEIVER      = 0X00000009
+    BIND_TRANSCEIVER_RESP = 0X80000009
+    QUERY_SM              = 0X00000003 
+    QUERY_SM_RESP         = 0X80000003 
+    SUBMIT_SM             = 0X00000004 
+    SUBMIT_SM_RESP        = 0X80000004 
+    DELIVER_SM            = 0X00000005 
+    DELIVER_SM_RESP       = 0X80000005 
+    UNBIND                = 0X00000006 
+    UNBIND_RESP           = 0X80000006 
+    REPLACE_SM            = 0X00000007 
+    REPLACE_SM_RESP       = 0X80000007 
+    CANCEL_SM             = 0X00000008 
+    CANCEL_SM_RESP        = 0X80000008 
+    ENQUIRE_LINK          = 0X00000015 
+    ENQUIRE_LINK_RESP     = 0X80000015
+
+    # PDU sequence number. 
+    @@seq = [Time.now.to_i]
+
+    # Add monitor to sequence counter for thread safety
+    @@seq.extend(MonitorMixin)
+
+    attr_reader :command_id, :command_status, :sequence_number, :body, :data
+
+    def initialize(command_id, command_status, seq, body='')    
+      length = 16 + body.length
+      @command_id = command_id
+      @command_status = command_status
+      @body = body
+      @sequence_number = seq
+      @data = fixed_int(length) + fixed_int(command_id) + fixed_int(command_status) + fixed_int(seq) + body   
+    end      
+
+    def logger
+      Smpp::Base.logger
+    end
+
+    def to_human
+      # convert header (4 bytes) to array of 4-byte ints
+      a = @data.to_s.unpack('N4')
+      sprintf("(%22s) len=%3d cmd=%8s status=%1d seq=%03d (%s)", self.class.to_s[11..-1], a[0], a[1].to_s(16), a[2], a[3], @body)
+    end
+
+    # return int as binary string of 4 octets
+    def fixed_int(value)
+      sprintf("%c%c%c%c", value >> 24, value >> 16, value >> 8, value & 0xff)
+    end
+
+    def next_sequence_number
+      Base.next_sequence_number
+    end
+
+    def Base.next_sequence_number
+      @@seq.synchronize do 
+        (@@seq[0] += 1) % 512
+      end
+    end
+
+    # PDU factory method for common client PDUs (used to create PDUs from wire data)
+    def Base.create(data)
+      header = data[0..15]
+      if !header
+        return nil
+      end
+      len, cmd, status, seq = header.unpack('N4')
+      body = data[16..-1]
+      case cmd
+      when ENQUIRE_LINK:
+        EnquireLink.new(seq)
+      when ENQUIRE_LINK_RESP:
+        EnquireLinkResponse.new(seq)
+      when GENERIC_NACK:
+        GenericNack.new(seq, status, body)        
+      when UNBIND:
+        Unbind.new(seq)        
+      when UNBIND_RESP:
+        UnbindResponse.new(seq, status)        
+      when BIND_TRANSMITTER_RESP:
+        BindTransmitterResponse.new(seq, status, body) # could be opt'l params too
+      when BIND_RECEIVER_RESP:
+        BindReceiverResponse.new(seq, status, body) 
+      when BIND_TRANSCEIVER_RESP:
+        BindTransceiverResponse.new(seq, status, body)
+      when SUBMIT_SM_RESP:
+        SubmitSmResponse.new(seq, status, body)
+      when DELIVER_SM:
+        DeliverSm.new(seq, status, body)
+      else
+        Smpp::Base.logger.error "Unknown PDU: 0x#{cmd.to_s(16)}"
+        return nil
+      end
+    end
+  end
+end

data/lib/smpp/pdu/bind_transceiver.rb

@@ -0,0 +1,6 @@
+class Smpp::Pdu::BindTransceiver < Smpp::Pdu::Base
+  def initialize(system_id, password, addr_ton, addr_npi, address_range)
+    body = sprintf("%s\0%s\0\0%c%c%c%s\0", system_id, password, 0x34, addr_ton, addr_npi, address_range)
+    super(BIND_TRANSCEIVER, 0, next_sequence_number, body)
+  end
+end

data/lib/smpp/pdu/bind_transceiver_response.rb

@@ -0,0 +1,7 @@
+class Smpp::Pdu::BindTransceiverResponse < Smpp::Pdu::Base
+  attr_accessor :system_id
+  def initialize(seq, status, system_id)
+    super(BIND_TRANSCEIVER_RESP, status, seq, system_id) # pass in system_id as body for simple debugging
+    @system_id = system_id
+  end
+end

data/lib/smpp/pdu/deliver_sm.rb

@@ -0,0 +1,40 @@
+# Received for MO message or delivery notification
+class Smpp::Pdu::DeliverSm < Smpp::Pdu::Base
+  attr_reader :source_addr, :destination_addr, :short_message, :source_addr, :esm_class, :msg_reference, :stat
+  def initialize(seq, status, body)
+    # brutally unpack it
+    service_type, 
+    source_addr_ton, 
+    source_addr_npi, 
+    @source_addr, 
+    dest_addr_ton, 
+    dest_addr_npi, 
+    @destination_addr, 
+    @esm_class, 
+    protocol_id,
+    priority_flag, 
+    schedule_delivery_time, 
+    validity_period, 
+    registered_delivery, 
+    replace_if_present_flag, 
+    data_coding, 
+    sm_default_msg_id,
+    sm_length, 
+    @short_message = body.unpack('Z*CCZ*CCZ*CCCZ*Z*CCCCCa*')
+    logger.debug "DeliverSM with source_addr=#{@source_addr}, destination_addr=#{@destination_addr}"
+    
+    # Note: if the SM is a delivery receipt (esm_class=4) then the short_message _may_ be in this format:  
+    # "id:Smsc2013 sub:1 dlvrd:1 submit date:0610171515 done date:0610171515 stat:0 err:0 text:blah"
+    # or this format:
+    # "4790000000SMSAlert^id:1054BC63 sub:0 dlvrd:1 submit date:0610231217 done date:0610231217 stat:DELIVRD err: text:"
+    # (according to the SMPP spec, the format is vendor specific)
+    # For example, Tele2 (Norway):
+    # "<msisdn><shortcode>?id:10ea34755d3d4f7a20900cdb3349e549 sub:001 dlvrd:001 submit date:0611011228 done date:0611011230 stat:DELIVRD err:000 Text:abc'!10ea34755d3d4f7a20900cdb3349e549"
+    if @esm_class == 4
+      @msg_reference = @short_message.scanf('id:%s').to_s
+      # @stat must be parsed according to the SMSC vendor's specifications (see comment above)
+      @stat = 0
+    end
+    super(DELIVER_SM, status, seq, body)
+  end
+end

data/lib/smpp/pdu/deliver_sm_response.rb

@@ -0,0 +1,5 @@
+class Smpp::Pdu::DeliverSmResponse < Smpp::Pdu::Base
+  def initialize(seq, status=ESME_ROK)
+    super(DELIVER_SM_RESP, status, seq, "\000") # body must be NULL..!
+  end
+end

data/lib/smpp/pdu/enquire_link.rb

@@ -0,0 +1,5 @@
+class Smpp::Pdu::EnquireLink < Smpp::Pdu::Base
+  def initialize(seq = next_sequence_number)
+    super(ENQUIRE_LINK, 0, seq)
+  end
+end

data/lib/smpp/pdu/enquire_link_response.rb

@@ -0,0 +1,5 @@
+class Smpp::Pdu::EnquireLinkResponse < Smpp::Pdu::Base
+  def initialize(seq)
+    super(ENQUIRE_LINK_RESP, ESME_ROK, seq)
+  end
+end

data/lib/smpp/pdu/generic_nack.rb

@@ -0,0 +1,8 @@
+# signals invalid message header
+class Smpp::Pdu::GenericNack < Smpp::Pdu::Base
+  attr_accessor :error_code
+  def initialize(seq, error_code, original_sequence_code)
+    super(GENERIC_NACK, error_code, seq, "Error: #{error_code} Problem sequence: #{original_sequence_code.blank? ? 'unknown' : original_sequence_code }")
+    @error_code = error_code
+  end
+end        

data/lib/smpp/pdu/submit_sm.rb

@@ -0,0 +1,44 @@
+# Sending an MT message
+class Smpp::Pdu::SubmitSm < Smpp::Pdu::Base
+  
+  # Note: short_message (the SMS body) must be in iso-8859-1 format
+  def initialize(source_addr, destination_addr, short_message, options={})
+    options.merge!(
+      :esm_class => 0,    # default smsc mode
+      :dcs => 3           # iso-8859-1
+    ) { |key, old_val, new_val| old_val } 
+  
+    @msg_body = short_message
+    
+    udh = options[:udh]          
+    service_type            = ''
+    source_addr_ton         = 0 # network specific
+    source_addr_npi         = 1 # unknown
+    dest_addr_ton           = 1 # international
+    dest_addr_npi           = 1 # unknown 
+    esm_class               = options[:esm_class]
+    protocol_id             = 0
+    priority_flag           = 1
+    schedule_delivery_time  = ''
+    validity_period         = ''
+    registered_delivery     = 1 # we want delivery notifications
+    replace_if_present_flag = 0
+    data_coding             = options[:dcs]
+    sm_default_msg_id       = 0
+    payload                 = udh ? udh + short_message : (short_message + "\0")
+    sm_length               = payload.length
+    
+    # craft the string/byte buffer
+    pdu_body = sprintf("%s\0%c%c%s\0%c%c%s\0%c%c%c%s\0%s\0%c%c%c%c%c%s", service_type, source_addr_ton, source_addr_npi, source_addr,
+    dest_addr_ton, dest_addr_npi, destination_addr, esm_class, protocol_id, priority_flag, schedule_delivery_time, validity_period,
+    registered_delivery, replace_if_present_flag, data_coding, sm_default_msg_id, sm_length, payload)
+    super(SUBMIT_SM, 0, next_sequence_number, pdu_body)        
+  end
+  
+  # some special formatting is needed for SubmitSm PDUs to show the actual message content
+  def to_human
+    # convert header (4 bytes) to array of 4-byte ints
+    a = @data.to_s.unpack('N4')       
+    sprintf("(%22s) len=%3d cmd=%8s status=%1d seq=%03d (%s)", self.class.to_s[11..-1], a[0], a[1].to_s(16), a[2], a[3], @msg_body[0..30])
+  end
+end

data/lib/smpp/pdu/submit_sm_response.rb

@@ -0,0 +1,8 @@
+class Smpp::Pdu::SubmitSmResponse < Smpp::Pdu::Base
+  attr_accessor :message_id
+  def initialize(seq, status, message_id)
+    message_id = message_id.chomp("\000")
+    super(SUBMIT_SM_RESP, status, seq, message_id)
+    @message_id = message_id
+  end
+end    

data/lib/smpp/pdu/unbind.rb

@@ -0,0 +1,5 @@
+class Smpp::Pdu::Unbind < Smpp::Pdu::Base
+  def initialize(seq=next_sequence_number)
+    super(UNBIND, 0, seq)
+  end
+end

data/lib/smpp/pdu/unbind_response.rb

@@ -0,0 +1,5 @@
+class Smpp::Pdu::UnbindResponse < Smpp::Pdu::Base
+  def initialize(seq, status)
+    super(UNBIND_RESP, status, seq)
+  end
+end

data/lib/smpp/transceiver.rb

@@ -0,0 +1,97 @@
+class Smpp::Transceiver < Smpp::Base
+
+  # Expects a config hash, 
+  # a proc to invoke for incoming (MO) messages,
+  # a proc to invoke for delivery reports,
+  # and optionally a hash-like storage for pending delivery reports.
+  def initialize(config, mo_proc, dr_proc, pdr_storage={})
+    super(config)
+    @state = :unbound
+    @mo_proc = mo_proc
+    @dr_proc = dr_proc      
+    @pdr_storage = pdr_storage   
+    
+    # Array of un-acked MT message IDs indexed by sequence number.
+    # As soon as we receive SubmitSmResponse we will use this to find the 
+    # associated message ID, and then create a pending delivery report.
+    @ack_ids = Array.new(512)         
+    
+    ed = @config[:enquire_link_delay_secs] || 5
+    comm_inactivity_timeout = [ed - 5, 3].max
+  rescue Exception => ex
+    logger.error "Exception setting up transceiver: #{ex}"
+    raise
+  end
+
+  # Send an MT SMS message
+  def send_mt(message_id, source_addr, destination_addr, short_message, options={})
+    logger.debug "Sending MT: #{short_message}"
+    if @state == :bound
+      pdu = Pdu::SubmitSm.new(source_addr, destination_addr, short_message, options)
+      write_pdu pdu
+
+      # keep the message ID so we can associate the SMSC message ID with our message
+      # when the response arrives.      
+      @ack_ids[pdu.sequence_number] = message_id
+    else
+      raise InvalidStateException, "Transceiver is unbound. Cannot send MT messages."
+    end
+  end
+
+  # a PDU is received
+  def process_pdu(pdu)
+    case pdu
+    when Pdu::DeliverSm
+      write_pdu(Pdu::DeliverSmResponse.new(pdu.sequence_number))
+      logger.debug "ESM CLASS #{pdu.esm_class}"
+      if pdu.esm_class != 4
+        # MO message; invoke MO proc
+        @mo_proc.call(pdu.source_addr, pdu.destination_addr, pdu.short_message)
+      else
+        # Invoke DR proc (let the owner of the block do the mapping from msg_reference to mt_id)
+        @dr_proc.call(pdu.msg_reference.to_s, pdu.stat)
+      end     
+    when Pdu::BindTransceiverResponse
+      case pdu.command_status
+      when Pdu::Base::ESME_ROK
+        logger.debug "Bound OK."
+        @state = :bound
+      when Pdu::Base::ESME_RINVPASWD
+        logger.warn "Invalid password."
+        EventMachine::stop_event_loop
+      when Pdu::Base::ESME_RINVSYSID
+        logger.warn "Invalid system id."
+        EventMachine::stop_event_loop
+      else
+        logger.warn "Unexpected BindTransceiverResponse. Command status: #{pdu.command_status}"
+        EventMachine::stop_event_loop
+      end
+    when Pdu::SubmitSmResponse
+      mt_message_id = @ack_ids[pdu.sequence_number]
+      if !mt_message_id
+        raise "Got SubmitSmResponse for unknown sequence_number: #{pdu.sequence_number}"
+      end
+      if pdu.command_status != Pdu::Base::ESME_ROK
+        logger.error "Error status in SubmitSmResponse: #{pdu.command_status}"
+      else
+        logger.info "Got OK SubmitSmResponse (#{pdu.message_id} -> #{mt_message_id})"
+      end
+      # Now we got the SMSC message id; create pending delivery report
+      @pdr_storage[pdu.message_id] = mt_message_id
+    else
+      super
+    end 
+  end
+
+  # Send BindTransceiverResponse PDU.
+  def send_bind
+    raise IOError, 'Receiver already bound.' unless @state == :unbound
+    pdu = Pdu::BindTransceiver.new(
+    @config[:system_id], 
+    @config[:password], 
+    @config[:source_ton], 
+    @config[:source_npi], 
+    @config[:source_address_range])
+    write_pdu(pdu)
+  end
+end

data/lib/smpp/version.rb

@@ -0,0 +1,9 @@
+module Smpp #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/sms.rb

@@ -0,0 +1,9 @@
+# Basic SMS class for sample gateway
+
+class Sms
+  attr_accessor :id, :from, :to, :body
+  
+  def initialize(body)
+    self.body = body
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ruby-smpp.rb'}"
+puts "Loading ruby-smpp gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)