ruby-smpp 0.1.2 → 0.1.3.pre1

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.log
+nbproject

data/{NEWS.txt → CHANGELOG}

@@ -1,4 +1,9 @@
-= 2009.01.22
+= 0.1.3
+* Transition maintenance from August to Ray Krueger
+* Changed the expected signature of transceiver delegates to use the full PDU instead of picking off attributes one by one
+* Added support for parsing optional parameters from delivery receipts in deliver_sm PDUs (this is also the fix for trailing bytes from MOs)
+
+= 0.1.2 2009.01.22
 
 == Delegate methods
 
@@ -41,4 +46,4 @@ I have implemented 4.5.1 section of SMPPv3.4: support for sending an MT message
  
 == Initial release (August Z. Flatby)
 
-My first open source project after all these years! Ah.. it feels good.
+My first open source project after all these years! Ah.. it feels good.

data/CONTRIBUTORS.txt

@@ -1,4 +1,5 @@
 Maintainer:
+  Ray Krueger <raykrueger@gmail.com>
   August Z. Flatby <august@apparat.no>
 
 Contributors:
@@ -6,4 +7,5 @@ Contributors:
   Taryn East <taryn@taryneast.org>
   Josh Bryan <jbryan@cashnetusa.com>
   Jon Wood <jonathan.wood@uk.clara.net>
-  Jacob Eiler <jacob.eiler@apide.com>
+  Jacob Eiler <jacob.eiler@apide.com>
+  Valdis Pornieks <valdis@ithouse.lv>

data/{README.txt → README.rdoc}

@@ -6,30 +6,33 @@ Ruby-SMPP is a Ruby implementation of the SMPP v3.4 protocol. It is suitable for
 
 The implementation is based on the Ruby/EventMachine library.
 
-Glossary
------------------
-SMSC: SMS Center. Mobile operators normally operate an SMSC in their network. The SMSC stores and forwards SMS messages.
-MO:   Mobile Originated SMS: originated in a mobile phone, ie. sent by an end user.
-MT:   Mobile Terminated SMS: terminated in a mobile phone, ie. received by an end user.
-DR:   Delivery Report, or delivery notification. When you send an MT message, you should receive a DR after a while.
-PDU:  Protcol Base Unit, the data units that SMPP is comprised of. This implementation does _not_ implement all SMPP PDUs.
-
-Protocol
------------------
+<b>NOTE: Breaking change from 0.1.2 to 0.1.3</b>. See below.
+
+=== Glossary
+
+
+* SMSC: SMS Center. Mobile operators normally operate an SMSC in their network. The SMSC stores and forwards SMS messages.
+* MO: Mobile Originated SMS: originated in a mobile phone, ie. sent by an end user.
+* MT: Mobile Terminated SMS: terminated in a mobile phone, ie. received by an end user.
+* DR: Delivery Report, or delivery notification. When you send an MT message, you should receive a DR after a while.
+* PDU: Protcol Base Unit, the data units that SMPP is comprised of. This implementation does _not_ implement all SMPP PDUs.
+
+=== Protocol
+
 The SMPP 3.4 protocol spec can be downloaded here: http://smsforum.net/SMPP_v3_4_Issue1_2.zip
 
-Testing/Sample Code
--------------------
-Logica provides an SMPP simulator that you can download from http://opensmpp.logica.com/. You can 
+=== 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
+  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
+  ruby 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. 
 
@@ -37,15 +40,14 @@ You can also send MO messages from the simulator to the sample gateway by typing
 
 == FEATURES/PROBLEMS:
 
+
 * Implements only typical client subset of SMPP 3.4 with single-connection Transceiver.
 * Contributors are encouraged to add missing PDUs.
-* Need more test cases!
 
 == BASIC USAGE:
 
 Start the transceiver. Receive delegate callbacks whenever incoming messages or delivery reports arrive. Send messages with Transceiver#send_mt. 
 
-<pre>
   # connect to SMSC
   tx = EventMachine::run do             
     $tx = EventMachine::connect(
@@ -53,44 +55,34 @@ Start the transceiver. Receive delegate callbacks whenever incoming messages or
     port, 
     Smpp::Transceiver, 
     config,             # a property hash 
-    mo_proc,            # the proc invoked on incoming (MO) messages
-    dr_proc,            # the proc invoked on delivery reports
-    pdr_storage)        # hash-like storage for pending delivery reports
+    delegate            # delegate class that will receive callbacks on MOs and DRs and other events
   end
   
   # send a message
   tx.send_mt(id, from, to, body)
-</pre>
+
+As of 0.1.3 the delegate method signatures are as follows:
+*   mo_received(transceiver, deliver_sm_pdu)
+*   delivery_report_received(transceiver, deliver_sm_pdu)
+*   message_accepted(transceiver, mt_message_id, submit_sm_response_pdu)
+*   message_rejected(transceiver, mt_message_id, submit_sm_response_pdu)
+*   bound(transceiver)
+*   unbound(transceiver)
+
+Where 'pdu' above is the actual actual instance of the Smpp:Pdu:: class created.
 
 For a more complete example, see examples/sample_gateway.rb
 
 == REQUIREMENTS:
 
+
 * Eventmachine >= 0.10.0
 
 == INSTALL:
 
-* sudo gem install ruby-smpp
+  sudo gem install ruby-smpp
 
 == LICENSE:
 
 Copyright (c) 2008 Apparat AS
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Released under the MIT license.

data/Rakefile

@@ -1,9 +1,58 @@
-task :test do
-  ruby "test/smpp_test.rb"
-end
-
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
-
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-smpp"
+    gem.summary = %Q{Ruby implementation of the SMPP protocol, based on EventMachine.}
+    gem.description = gem.summary + " SMPP is a protocol that allows ordinary people outside the mobile network to exchange SMS messages directly with mobile operators."
+    gem.email = "raykrueger@gmail.com"
+    gem.homepage = "http://github.com/raykrueger/ruby-smpp"
+    gem.authors = ["Ray Krueger", "August Z. Flatby"]
+    gem.rubyforge_project = gem.name
+
+    gem.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "CONTRIBUTORS.txt"]
+
+    gem.add_dependency "eventmachine", ">= 0.10.0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-smpp #{version}"
+  rdoc.rdoc_files.include('README*', "CHANGELOG", "CONTRIBUTORS.txt", "LICENSE")
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3.pre1

data/examples/sample_gateway.rb

@@ -1,56 +1,51 @@
-#!/usr/bin/env ruby0
+#!/usr/bin/env ruby
+
+# Sample SMS gateway that can receive MOs (mobile originated messages) and
+# DRs (delivery reports), and send MTs (mobile terminated messages).
+# MTs are, in the name of simplicity, entered on the command line in the format
+# <sender> <receiver> <message body>
+# MOs and DRs will be dumped to standard out.
+
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/smpp'
+
 LOGFILE = File.dirname(__FILE__) + "/sms_gateway.log"
 Smpp::Base.logger = Logger.new(LOGFILE)
 
-# the transceiver
-$tx = nil
-
 # We use EventMachine to receive keyboard input (which we send as MT messages).
 # A "real" gateway would probably get its MTs from a message queue instead.
 module KeyboardHandler
   include EventMachine::Protocols::LineText2
 
   def receive_line(data)
-    puts "Sending MT: #{data}"
-    from = '2210'
-    to = '4790000000'     
-    msg_id = 123  
-    $tx.send_mt(msg_id, 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")  
+    sender, receiver, *body_parts = data.split
+    unless sender && receiver && body_parts.size > 0
+      puts "Syntax: <sender> <receiver> <message body>"      
+    else
+      body = body_parts.join(' ')
+      puts "Sending MT from #{sender} to #{receiver}: #{body}"  
+      SampleGateway.send_mt(sender, receiver, body)
+    end
     prompt
   end
   
   def prompt
-    print "Enter MT body: "
+    print "MT: "
     $stdout.flush
   end
 end
 
 class SampleGateway
-  include KeyboardHandler
   
+  # MT id counter. 
+  @@mt_id = 0
+  
+  # expose SMPP transceiver's send_mt method
+  def self.send_mt(*args)
+    @@mt_id += 1
+    @@tx.send_mt(@@mt_id, *args)
+  end
+    
   def logger
     Smpp::Base.logger
   end
@@ -60,65 +55,46 @@ class SampleGateway
     # semantics to map SMSC message IDs to your own message IDs.
     pdr_storage = {} 
 
-    # The block invoked when we receive an MO message from the SMSC
-    mo_proc = Proc.new do |sender, receiver, msg|
-      begin
-        # This is where you'd enqueue or store the MO message for further processing.
-        logger.info "Received MO from <#{sender}> to <#{receiver}>: <#{msg}>"
-      rescue Exception => ex
-        logger.error "Exception processing MO: #{ex}"
-      end
-    end
-
-    # Invoked on delivery reports
-    dr_proc = Proc.new do |msg_reference, stat, dr_pdu|
-      begin
-        # The SMSC returns its own message reference. Look up (and delete) our stored objects
-        # based on this reference.
-        # 
-        # The short_message attribute contains details on the current delivery status of the
-        # message.
-        pending_message = pdr_storage.delete(msg_reference)
-        logger.info "Received DR for #{pending_message}. Stat: #{stat} SM: #{dr_pdu.short_message}"
-      rescue Exception => ex
-        logger.error "Error processing DR: #{ex}"
-      end
-    end
-
     # Run EventMachine in loop so we can reconnect when the SMSC drops our connection.
-    prompt
+    puts "Connecting to SMSC..."
     loop do
       EventMachine::run do             
-        $tx = EventMachine::connect(
-        config[:host], 
-        config[:port], 
-        Smpp::Transceiver, 
-        config, 
-        self  # self is delegate
+        @@tx = EventMachine::connect(
+          config[:host], 
+          config[:port], 
+          Smpp::Transceiver, 
+          config, 
+          self    # delegate that will receive callbacks on MOs and DRs and other events
         )     
-
+        print "MT: "
+        $stdout.flush
+        
         # Start consuming MT messages (in this case, from the console)
         # Normally, you'd hook this up to a message queue such as Starling
         # or ActiveMQ via STOMP.
         EventMachine::open_keyboard(KeyboardHandler)
       end
-      logger.warn "Event loop stopped. Restarting in 5 seconds.."
+      puts "Disconnected. Reconnecting in 5 seconds.."
       sleep 5
     end
+  end
+  
+  # ruby-smpp delegate methods 
 
+  def mo_received(transceiver, pdu)
+    logger.info "Delegate: mo_received: from #{pdu.source_addr} to #{pdu.destination_addr}: #{pdu.short_message}"
   end
-  # Delegate methods that will receive callbacks on various events
 
-  def mo_received(transceiver, source_addr, destination_addr, short_message)
-    logger.info "Delegate: mo_received: from #{source_addr} to #{destination_addr}: #{short_message}"
+  def delivery_report_received(transceiver, pdu)
+    logger.info "Delegate: delivery_report_received: ref #{pdu.msg_reference} stat #{pdu.stat}"
   end
 
-  def delivery_report_received(transceiver, msg_reference, stat, pdu)
-    logger.info "Delegate: delivery_report_received: ref #{msg_reference} stat #{stat} pdu #{pdu}"
+  def message_accepted(transceiver, mt_message_id, pdu)
+    logger.info "Delegate: message_accepted: id #{mt_message_id} smsc ref id: #{pdu.message_id}"
   end
 
-  def message_accepted(transceiver, mt_message_id, smsc_message_id)
-    logger.info "Delegate: message_sent: id #{mt_message_id} smsc ref id: #{smsc_message_id}"
+  def message_rejected(transceiver, mt_message_id, pdu)
+    logger.info "Delegate: message_rejected: id #{mt_message_id} smsc ref id: #{pdu.message_id}"
   end
 
   def bound(transceiver)
@@ -129,21 +105,22 @@ class SampleGateway
     logger.info "Delegate: transceiver unbound"
     EventMachine::stop_event_loop
   end
+  
 end
 
 # Start the Gateway
 begin   
-  puts "Starting SMS Gateway. Check the log at #{LOGFILE}"  
+  puts "Starting SMS Gateway. Please check the log at #{LOGFILE}"  
 
   # SMPP properties. These parameters work well with the Logica SMPP simulator.
   # Consult the SMPP spec or your mobile operator for the correct settings of 
   # the other properties.
   config = {
-    :host => 'localhost',
+    :host => '127.0.0.1',
     :port => 6000,
     :system_id => 'hugo',
     :password => 'ggoohu',
-    :system_type => 'vma', # default given according to SMPP 3.4 Spec
+    :system_type => '', # default given according to SMPP 3.4 Spec
     :interface_version => 52,
     :source_ton  => 0,
     :source_npi => 1,