ruby-smpp 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.1 2008-10-20
+
+* Contributions:
+  * See NEWS.txt
+
 == 0.1.0 2008-04-07
 
 * 1 major enhancement:

data/Manifest.txt

@@ -17,13 +17,14 @@ lib/smpp/pdu/deliver_sm_response.rb
 lib/smpp/pdu/enquire_link.rb
 lib/smpp/pdu/enquire_link_response.rb
 lib/smpp/pdu/generic_nack.rb
+lib/smpp/pdu/submit_multi.rb
+lib/smpp/pdu/submit_multi_response.rb
 lib/smpp/pdu/submit_sm.rb
 lib/smpp/pdu/submit_sm_response.rb
 lib/smpp/pdu/unbind.rb
 lib/smpp/pdu/unbind_response.rb
 lib/smpp/transceiver.rb
 lib/sms.rb
-log/
 script/console
 script/destroy
 script/generate

data/README.txt

@@ -1,7 +1,5 @@
 = Ruby-SMPP
 
-* http://ruby-smpp.rubyforge.org
-
 == DESCRIPTION:
 
 Ruby-SMPP is a Ruby implementation of the SMPP v3.4 protocol. It is suitable for writing gateway daemons that communicate with SMSCs for sending and receiving SMS messages.
@@ -20,14 +18,26 @@ Protocol
 -----------------
 The SMPP 3.4 protocol spec can be downloaded here: http://smsforum.net/SMPP_v3_4_Issue1_2.zip
 
-Testing
------------------
+Testing/Sample Code
+-------------------
 Logica provides an SMPP simulator that you can download from http://opensmpp.logica.com/. You can 
 also sign up for a demo SMPP account at one of the many bulk-SMS providers out there.
 
+For a quick test, download smscsim.jar and smpp.jar from the Logica site, and start the simulator by typing:
+
+java -cp smscsim.jar:smpp.jar com.logica.smscsim.Simulator
+
+Then type 1 (start simulation), and enter 6000 for port number. The simulator then starts a server socket on a background thread. In another terminal window, start the sample sms gateway from the ruby-smpp/examples directory by typing:
+
+./sample_gateway.rb
+
+You will be able to send MT messages from the sample gateway terminal window by typing the message body. In the simulator terminal window you should see SMPP PDUs being sent from the sample gateway. 
+
+You can also send MO messages from the simulator to the sample gateway by typing 7 (log to screen off) and then 4 (send message). MO messages received by the sample gateway will be logged to ./sms_gateway.log.
+
 == FEATURES/PROBLEMS:
 
-* Implements only typical client subset of SMPP 3.4 with single-connection Transceiver as opposed to dual-connection Transmitter + Receiver. 
+* Implements only typical client subset of SMPP 3.4 with single-connection Transceiver as opposed to dual-connection Transmitter + Receiver (UPDATE: see NEWS re. patch from Taryn East)
 * Contributors are encouraged to add missing PDUs.
 * Need more test cases!
 
@@ -56,7 +66,7 @@ For a more complete example, see examples/sample_gateway.rb
 
 == REQUIREMENTS:
 
-* Eventmachine 0.10.0
+* Eventmachine >= 0.10.0
 
 == INSTALL:
 

data/examples/sample_gateway.rb

@@ -13,11 +13,12 @@
 # and accepts outgoing (MT) messages from the console. This may be useful for
 # testing your SMPP setup.
 
+require 'rubygems'
 gem 'ruby-smpp'
 require 'smpp'
 
 # set up logger
-Smpp::Base.logger = Logger.new(File.join(File.dirname(__FILE__), '..', 'log/sms_gateway.log'))
+Smpp::Base.logger = Logger.new('sms_gateway.log')
 
 # the transceiver
 $tx = nil
@@ -32,6 +33,29 @@ module KeyboardHandler
     from = '2210'
     to = '4790000000'       
     $tx.send_mt(123, from, to, data)
+
+
+# if you want to send messages with custom options, uncomment below code, this configuration allows the sender ID to be alpha numeric
+#    $tx.send_mt(123, "RubySmpp", to, "Testing RubySmpp as sender id",{
+#    :source_addr_ton=> 5,
+#	:service_type => 1,
+#	:source_addr_ton => 5,
+#	:source_addr_npi => 0 ,
+#	:dest_addr_ton => 2, 
+#	:dest_addr_npi => 1, 
+#	:esm_class => 3 ,
+#	:protocol_id => 0, 
+#	:priority_flag => 0,
+#	:schedule_delivery_time => nil,
+#	:validity_period => nil,
+#	:registered_delivery=> 1,
+#	:replace_if_present_flag => 0,
+#	:data_coding => 0,
+#	:sm_default_msg_id => 0 
+#     })   
+
+# if you want to send message to multiple destinations , uncomment below code
+#    $tx.send_multi_mt(123, from, ["919900000001","919900000002","919900000003"], "I am echoing that ruby-smpp is great")  
     prompt
   end
 end
@@ -103,8 +127,10 @@ begin
   config = {
     :host => 'localhost',
     :port => 6000,
-    :system_id => 'jorge',
-    :password => 'jorge',
+    :system_id => 'hugo',
+    :password => 'ggoohu',
+	  :system_type => 'vma', # default given according to SMPP 3.4 Spec
+    :interface_version => 52,
     :source_ton  => 0,
     :source_npi => 1,
     :destination_ton => 1,
@@ -117,4 +143,4 @@ begin
   start(config)  
 rescue Exception => ex
   puts "Exception in SMS Gateway: #{ex} at #{ex.backtrace[0]}"
-end
+end

data/lib/smpp/base.rb

@@ -1,3 +1,6 @@
+require 'rubygems'
+gem 'eventmachine'
+
 require 'timeout'
 require 'iconv'
 require 'scanf'
@@ -27,6 +30,7 @@ module Smpp
     
     def initialize(config)
       @config = config
+      @data = ""
     end
     
     # invoked by EventMachine when connected
@@ -54,11 +58,25 @@ module Smpp
 
     # EventMachine::Connection#receive_data
     def receive_data(data)
-      # parse incoming PDU
-      pdu = read_pdu(data)
-      
-      # let subclass process it
-      process_pdu(pdu) if pdu
+      #append data to buffer
+      @data << data
+
+      while (@data.length >=4)
+        cmd_length = @data[0..3].unpack('N').first
+        if(@data.length < cmd_length)
+          #not complete packet ... break
+          break
+        end
+        
+        pkt = @data.slice!(0,cmd_length)
+
+        # parse incoming PDU
+        pdu = read_pdu(pkt)
+
+        # let subclass process it
+        process_pdu(pdu) if pdu
+
+      end
     end
     
     # EventMachine::Connection#unbind
@@ -121,4 +139,4 @@ module Smpp
       pdu
     end    
   end
-end
+end

data/lib/smpp/pdu/base.rb

@@ -59,7 +59,8 @@ module Smpp::Pdu
     CANCEL_SM_RESP        = 0X80000008 
     ENQUIRE_LINK          = 0X00000015 
     ENQUIRE_LINK_RESP     = 0X80000015
-
+    SUBMIT_MULTI	  = 0X00000021
+    SUBMIT_MULTI_RESP     = 0X80000021
     # PDU sequence number. 
     @@seq = [Time.now.to_i]
 
@@ -129,6 +130,8 @@ module Smpp::Pdu
         BindTransceiverResponse.new(seq, status, body)
       when SUBMIT_SM_RESP:
         SubmitSmResponse.new(seq, status, body)
+      when SUBMIT_MULTI_RESP:
+        SubmitMultiResponse.new(seq, status, body)
       when DELIVER_SM:
         DeliverSm.new(seq, status, body)
       else
@@ -137,4 +140,4 @@ module Smpp::Pdu
       end
     end
   end
-end
+end

data/lib/smpp/pdu/bind_transceiver.rb

@@ -1,6 +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)
+  def initialize(system_id, password, system_type, addr_ton, addr_npi, address_range)
+    body = sprintf("%s\0%s\0%s\0%c%c%c%s\0", system_id, password,system_type, 0x34, addr_ton, addr_npi, address_range)
     super(BIND_TRANSCEIVER, 0, next_sequence_number, body)
   end
 end

data/lib/smpp/pdu/submit_multi.rb

@@ -0,0 +1,67 @@
+# Sending an MT message to multiple addresses
+# Author: Abhishek Parolkar, (abhishek[at]parolkar.com)
+class Smpp::Pdu::SubmitMulti < Smpp::Pdu::Base
+  IS_SMEADDR = 1 # type of dest_flag
+  IS_DISTLISTNAME = 2 #type of dest_flag  
+
+  # Note: short_message (the SMS body) must be in iso-8859-1 format
+  def initialize(source_addr, destination_addr_array, 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
+    number_of_dests         = destination_addr_array.length # Max value can be 254
+    dest_addr_ton           = 1 # international
+    dest_addr_npi           = 1 # unknown
+    dest_addresses          = build_destination_addresses(destination_addr_array,dest_addr_ton,dest_addr_npi,IS_SMEADDR) 
+    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 # this used to be (short_message + "\0")
+    sm_length               = payload.length
+    
+    # craft the string/byte buffer
+    pdu_body = sprintf("%s\0%c%c%s\0%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, number_of_dests,dest_addresses, 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_MULTI, 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
+  def build_destination_addresses(dest_array,dest_addr_ton,dest_addr_npi, dest_flag = IS_SMEADDR)
+  
+	formatted_array = Array.new
+	dest_array.each { |dest_elem|
+		if dest_flag == IS_SMEADDR
+			packet_str = sprintf("%c%c%c%s",IS_SMEADDR,dest_addr_ton,dest_addr_npi,dest_elem)
+			formatted_array.push(packet_str)
+
+		elsif dest_flag == IS_DISTLISTNAME
+			packet_str = sprintf("%c%s",IS_SMEADDR,dest_elem)
+                        formatted_array.push(packet_str)
+
+		end
+
+	}
+
+	formatted_array.join('\0');
+  end
+  
+end

data/lib/smpp/pdu/submit_multi_response.rb

@@ -0,0 +1,10 @@
+# Recieving response for an MT message sent to multiple addresses
+# Author: Abhishek Parolkar, (abhishek[at]parolkar.com)
+class Smpp::Pdu::SubmitMultiResponse < Smpp::Pdu::Base
+  attr_accessor :message_id
+  def initialize(seq, status, message_id)
+    message_id = message_id.chomp("\000")
+    super(SUBMIT_MULTI_RESP, status, seq, message_id)
+    @message_id = message_id
+  end
+end    

data/lib/smpp/pdu/submit_sm.rb

@@ -3,29 +3,25 @@ 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")
+    service_type            = options[:service_type]? options[:service_type] :''
+    source_addr_ton         = options[:source_addr_ton]?options[:source_addr_ton]:0 # network specific
+    source_addr_npi         = options[:source_addr_npi]?options[:source_addr_npi]:1 # unknown
+    dest_addr_ton           = options[:dest_addr_ton]?options[:dest_addr_ton]:1 # international
+    dest_addr_npi           = options[:dest_addr_npi]?options[:dest_addr_npi]:1 # unknown 
+    esm_class               = options[:esm_class]?options[:esm_class]:0 # default smsc mode
+    protocol_id             = options[:protocol_id]?options[:protocol_id]:0
+    priority_flag           = options[:priority_flag]?options[:priority_flag]:1
+    schedule_delivery_time  = options[:schedule_delivery_time]?options[:schedule_delivery_time]:''
+    validity_period         = options[:validity_period]?options[:validity_period]:''
+    registered_delivery     = options[:registered_delivery]?options[:registered_delivery]:1 # we want delivery notifications
+    replace_if_present_flag = options[:replace_if_present_flag]?options[:replace_if_present_flag]:0
+    data_coding             = options[:data_coding]?options[:data_coding]:3 # iso-8859-1
+    sm_default_msg_id       = options[:sm_default_msg_id]?options[:sm_default_msg_id]:0
+    payload                 = udh ? udh + short_message : short_message # this used to be (short_message + "\0")
     sm_length               = payload.length
     
     # craft the string/byte buffer

data/lib/smpp/transceiver.rb

@@ -37,6 +37,23 @@ class Smpp::Transceiver < Smpp::Base
       raise InvalidStateException, "Transceiver is unbound. Cannot send MT messages."
     end
   end
+  # Send  MT SMS message for multiple dest_address
+  # Author: Abhishek Parolkar (abhishek[at]parolkar.com)
+  # USAGE: $tx.send_multi_mt(123, "9100000000", ["9199000000000","91990000000001","9199000000002"], "Message here")
+  def send_multi_mt(message_id, source_addr, destination_addr_arr, short_message, options={})
+    logger.debug "Sending Multiple MT: #{short_message}"
+    if @state == :bound
+      pdu = Pdu::SubmitMulti.new(source_addr, destination_addr_arr, 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)
@@ -78,6 +95,16 @@ class Smpp::Transceiver < Smpp::Base
       end
       # Now we got the SMSC message id; create pending delivery report
       @pdr_storage[pdu.message_id] = mt_message_id
+    when Pdu::SubmitMultiResponse
+      mt_message_id = @ack_ids[pdu.sequence_number]
+      if !mt_message_id
+        raise "Got SubmitMultiResponse for unknown sequence_number: #{pdu.sequence_number}"
+      end
+      if pdu.command_status != Pdu::Base::ESME_ROK
+        logger.error "Error status in SubmitMultiResponse: #{pdu.command_status}"
+      else
+        logger.info "Got OK SubmitMultiResponse (#{pdu.message_id} -> #{mt_message_id})"
+      end
     else
       super
     end 
@@ -88,10 +115,11 @@ class Smpp::Transceiver < Smpp::Base
     raise IOError, 'Receiver already bound.' unless @state == :unbound
     pdu = Pdu::BindTransceiver.new(
     @config[:system_id], 
-    @config[:password], 
+    @config[:password],
+    @config[:system_type], 
     @config[:source_ton], 
     @config[:source_npi], 
     @config[:source_address_range])
     write_pdu(pdu)
   end
-end
+end

data/lib/smpp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-smpp
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - August Z. Flatby
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-09 00:00:00 +02:00
+date: 2008-10-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.10.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
 description: Ruby-implementation of the SMPP protocol, based on EventMachine. SMPP is a protocol that allows ordinary people outside the mobile network to exchange SMS messages directly with mobile operators.
 email: 
 - august@apparat.no
@@ -53,13 +64,14 @@ files:
 - lib/smpp/pdu/enquire_link.rb
 - lib/smpp/pdu/enquire_link_response.rb
 - lib/smpp/pdu/generic_nack.rb
+- lib/smpp/pdu/submit_multi.rb
+- lib/smpp/pdu/submit_multi_response.rb
 - lib/smpp/pdu/submit_sm.rb
 - lib/smpp/pdu/submit_sm_response.rb
 - lib/smpp/pdu/unbind.rb
 - lib/smpp/pdu/unbind_response.rb
 - lib/smpp/transceiver.rb
 - lib/sms.rb
-- log/
 - script/console
 - script/destroy
 - script/generate
@@ -92,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby-smpp
-rubygems_version: 1.0.1
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Ruby-implementation of the SMPP protocol, based on EventMachine. SMPP is a protocol that allows ordinary people outside the mobile network to exchange SMS messages directly with mobile operators.