anjlab-ruby-smpp 0.6.0

data/lib/smpp/transceiver.rb

@@ -0,0 +1,109 @@
+# The SMPP Transceiver maintains a bidirectional connection to an SMSC.
+# Provide a config hash with connection options to get started. 
+# See the sample_gateway.rb for examples of config values.
+# The transceiver accepts a delegate object that may implement 
+# the following (all optional) methods:
+#
+#   mo_received(transceiver, pdu)
+#   delivery_report_received(transceiver, pdu)
+#   message_accepted(transceiver, mt_message_id, pdu)
+#   message_rejected(transceiver, mt_message_id, pdu)
+#   bound(transceiver)
+#   unbound(transceiver)
+
+class Smpp::Transceiver < Smpp::Base
+
+  # Send an MT SMS message. Delegate will receive message_accepted callback when SMSC 
+  # acknowledges, or the message_rejected callback upon error
+  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
+
+  # Send a concatenated message with a body of > 160 characters as multiple messages.
+  def send_concat_mt(message_id, source_addr, destination_addr, message, options = {})
+    logger.debug "Sending concatenated MT: #{message}"
+    if @state == :bound
+      # Split the message into parts of 153 characters. (160 - 7 characters for UDH)
+      parts = []
+      while message.size > 0 do
+        parts << message.slice!(0..Smpp::Transceiver.get_message_part_size(options))
+      end
+      
+      0.upto(parts.size-1) do |i|
+        udh = sprintf("%c", 5)            # UDH is 5 bytes.
+        udh << sprintf("%c%c", 0, 3)      # This is a concatenated message 
+
+        #TODO Figure out why this needs to be an int here, it's a string elsewhere
+        udh << sprintf("%c", message_id)  # The ID for the entire concatenated message
+
+        udh << sprintf("%c", parts.size)  # How many parts this message consists of
+        udh << sprintf("%c", i+1)         # This is part i+1
+        
+        options[:esm_class] = 64 # This message contains a UDH header.
+        options[:udh] = udh
+
+        pdu = Pdu::SubmitSm.new(source_addr, destination_addr, parts[i], options)
+        write_pdu pdu
+        
+        # This is definately a bit hacky - multiple PDUs are being associated with a single
+        # message_id.
+        @ack_ids[pdu.sequence_number] = message_id
+      end
+    else
+      raise InvalidStateException, "Transceiver is unbound. Connot 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
+
+  # Send BindTransceiverResponse PDU.
+  def send_bind
+    raise IOError, 'Receiver already bound.' unless unbound?
+    pdu = Pdu::BindTransceiver.new(
+        @config[:system_id], 
+        @config[:password],
+        @config[:system_type], 
+        @config[:source_ton], 
+        @config[:source_npi], 
+        @config[:source_address_range])
+    write_pdu(pdu)
+  end
+
+  # Use data_coding to find out what message part size we can use
+  # http://en.wikipedia.org/wiki/SMS#Message_size
+  def self.get_message_part_size options
+    return 153 if options[:data_coding].nil?
+    return 153 if options[:data_coding] == 0
+    return 134 if options[:data_coding] == 3
+    return 134 if options[:data_coding] == 5
+    return 134 if options[:data_coding] == 6
+    return 134 if options[:data_coding] == 7
+    return 67  if options[:data_coding] == 8
+    return 153
+  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/ruby-smpp.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{anjlab-ruby-smpp}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ray Krueger", "August Z. Flatby"]
+  s.date = %q{2011-10-14}
+  s.description = %q{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.}
+  s.email = %q{raykrueger@gmail.com}
+  s.extra_rdoc_files = [
+    "CHANGELOG",
+    "CONTRIBUTORS.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "CONTRIBUTORS.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "config/environment.rb",
+    "examples/PDU1.example",
+    "examples/PDU2.example",
+    "examples/sample_gateway.rb",
+    "examples/sample_smsc.rb",
+    "lib/smpp.rb",
+    "lib/smpp/base.rb",
+    "lib/smpp/encoding/utf8_encoder.rb",
+    "lib/smpp/optional_parameter.rb",
+    "lib/smpp/pdu/base.rb",
+    "lib/smpp/pdu/bind_base.rb",
+    "lib/smpp/pdu/bind_receiver.rb",
+    "lib/smpp/pdu/bind_receiver_response.rb",
+    "lib/smpp/pdu/bind_resp_base.rb",
+    "lib/smpp/pdu/bind_transceiver.rb",
+    "lib/smpp/pdu/bind_transceiver_response.rb",
+    "lib/smpp/pdu/deliver_sm.rb",
+    "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/receiver.rb",
+    "lib/smpp/server.rb",
+    "lib/smpp/transceiver.rb",
+    "lib/sms.rb",
+    "ruby-smpp.gemspec",
+    "test/delegate.rb",
+    "test/encoding_test.rb",
+    "test/optional_parameter_test.rb",
+    "test/pdu_parsing_test.rb",
+    "test/receiver_test.rb",
+    "test/responsive_delegate.rb",
+    "test/server.rb",
+    "test/smpp_test.rb",
+    "test/submit_sm_test.rb",
+    "test/transceiver_test.rb"
+  ]
+  s.homepage = %q{http://github.com/raykrueger/ruby-smpp}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruby-smpp}
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Ruby implementation of the SMPP protocol, based on EventMachine.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.10.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0.10.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0.10.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end
+

data/test/delegate.rb

@@ -0,0 +1,28 @@
+# the delagate receives callbacks when interesting things happen on the connection
+class Delegate
+
+  def mo_received(transceiver, pdu)
+    puts "** mo_received"
+  end
+
+  def delivery_report_received(transceiver, pdu)
+    puts "** delivery_report_received"
+  end
+
+  def message_accepted(transceiver, mt_message_id, pdu)
+    puts "** message_sent"
+  end
+
+  def message_rejected(transceiver, mt_message_id, pdu)
+    puts "** message_rejected"
+  end
+
+  def bound(transceiver)
+    puts "** bound"
+  end
+
+  def unbound(transceiver)
+    puts "** unbound"
+    EventMachine::stop_event_loop
+  end
+end

data/test/encoding_test.rb

@@ -0,0 +1,231 @@
+require 'rubygems'
+require 'test/unit'
+require 'smpp/encoding/utf8_encoder'
+
+require File.expand_path(File.dirname(__FILE__) + "../../lib/smpp")
+
+class EncodingTest < Test::Unit::TestCase
+
+
+  def setup
+    ::Smpp::Pdu::DeliverSm.data_encoder = ::Smpp::Encoding::Utf8Encoder.new
+  end
+
+  def teardown
+    ::Smpp::Pdu::DeliverSm.data_encoder = nil
+  end
+
+  def test_should_decode_pound_sign_from_hp_roman_8_to_utf_8
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 2950 6C65 6173 6520
+    6465 706F 7369 7420 BB35 2069 6E74 6F20
+    6D79 2061 6363 6F75 6E74 2C20 4A6F 73C5
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    expected = "Please deposit \302\2435 into my account, Jos\303\251"
+    assert_equal expected, pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_euro_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 1950 6c65 6173 6520
+    6465 706f 7369 7420 8d65 3520 7468 616e
+    6b73
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    expected = "Please deposit \342\202\2545 thanks"
+    assert_equal expected, pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_left_curly_bracket_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 28
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "{", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_right_curly_bracket_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 29
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "}", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_tilde_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 3d
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "~", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_left_square_bracket_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 3c
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "[", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_right_square_bracket_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 3e
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "]", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_backslash_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 2f
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "\\", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_vertical_bar_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d b8
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    assert_equal "|", pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_caret_or_circumflex_symbol
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 028d 86
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    expected = "\313\206"
+    assert_equal expected, pdu.short_message
+  end
+
+  def test_should_unescape_gsm_escaped_characters_together
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0000 4054 6573 748d b869
+    6e67 208d 8620 7374 6167 2f69 6e67 208d
+    3d20 6575 726f 208d 6520 616e 6420 8d28
+    6f74 688d 2f65 7220 8d3c 2063 6861 7261
+    8d3e 6374 6572 738d 29
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 0, pdu.data_coding
+
+    expected = "Test|ing ˆ stag/ing ~ euro € and {oth\\er [ chara]cters}"
+    assert_equal expected, pdu.short_message
+  end
+
+  def test_should_convert_ucs_2_into_utf_8_where_data_coding_indicates_its_presence
+    raw_data = <<-EOF
+    0000 003d 0000 0005 0000 0000 0000 0002
+    0001 0134 3437 3830 3330 3239 3833 3700
+    0101 3434 3738 3033 3032 3938 3337 0000
+    0000 0000 0000 0800 0E00 db00 f100 ef00
+    e700 f800 6401 13
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal 8, pdu.data_coding
+
+    expected = "\303\233\303\261\303\257\303\247\303\270d\304\223" # Ûñïçødē
+    assert_equal expected, pdu.short_message
+  end
+
+  def test_should_decode_pound_sign_from_hp_roman_8_to_utf_8_when_data_coding_set_to_1
+    raw_data = <<-EOF
+    0000 0096 0000 0005 0000 0000 0000 1b10
+    0005 004d 6f6e 6579 416c 6572 7400 0101
+    3434 3737 3738 3030 3036 3133 0000 0000
+    0000 0000 0100 5fbb 506f 756e 6473 bb20
+    EOF
+
+    pdu = create_pdu(raw_data)
+    assert_equal Smpp::Pdu::DeliverSm, pdu.class
+    assert_equal "£Pounds£ ", pdu.short_message
+  end
+
+  protected
+  def create_pdu(raw_data)
+    hex_data = [raw_data.chomp.gsub(" ","").gsub(/\n/,"")].pack("H*")
+    Smpp::Pdu::Base.create(hex_data)
+  end
+
+end