ruby-smpp 0.1.3 → 0.2.0

data/.gitignore

@@ -17,6 +17,7 @@ tmtags
 coverage
 rdoc
 pkg
+tags
 
 ## PROJECT::SPECIFIC
 *.log

data/Rakefile

@@ -33,7 +33,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
+    test.pattern = 'test/**/*_test.rb'
     test.verbose = true
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/lib/smpp.rb

@@ -10,6 +10,7 @@ require 'logger'
 $:.unshift(File.dirname(__FILE__))
 require 'smpp/base.rb'
 require 'smpp/transceiver.rb'
+require 'smpp/optional_parameter'
 require 'smpp/pdu/base.rb'
 require 'smpp/pdu/bind_base.rb'
 require 'smpp/pdu/bind_resp_base.rb'

data/lib/smpp/base.rb

@@ -165,7 +165,10 @@ module Smpp
     end
 
     def hex_debug(data, prefix = "")
-      return unless @config[:hex_debug]
+      Base.hex_debug(data, prefix)
+    end
+
+    def Base.hex_debug(data, prefix = "")
       logger.debug do
         message = "Hex dump follows:\n"
         hexdump(data).each_line do |line| 
@@ -175,7 +178,7 @@ module Smpp
       end
     end
 
-    def hexdump(target)
+    def Base.hexdump(target)
       width=16
       group=2
 

data/lib/smpp/optional_parameter.rb

@@ -0,0 +1,31 @@
+class Smpp::OptionalParameter
+
+  attr_reader :tag, :value
+  
+  def initialize(tag, value)
+    @tag = tag
+    @value = value
+  end
+
+  def [](symbol)
+    self.send symbol
+  end
+
+  #class methods
+  class << self
+    def from_wire_data(data)
+
+      return nil if data.nil?
+      tag, length, remaining_bytes = data.unpack('H4na*')
+      tag = tag.hex
+
+      raise "invalid data, cannot parse optional parameters" if tag == 0 or length.nil?
+
+      value = remaining_bytes.slice!(0...length)
+
+      return new(tag, value), remaining_bytes
+    end
+
+  end
+
+end

data/lib/smpp/pdu/base.rb

@@ -98,11 +98,32 @@ module Smpp::Pdu
     end
 
     # return int as binary string of 4 octets
-    def fixed_int(value)
+    def Base.fixed_int(value)
       arr = [value >> 24, value >> 16, value >> 8, value & 0xff]
       arr.pack("cccc")
     end
 
+    def fixed_int(value)
+      Base.fixed_int(value)
+    end
+
+    #expects a hash like {tag => Smpp::OptionalParameter}
+    def Base.optional_parameters_to_buffer(optionals)
+      output = ""
+      optionals.each do |tag, optional_param|
+        length = optional_param.value.length
+        buffer = []
+        buffer += [tag >> 8, tag & 0xff]
+        buffer += [length >> 8, length & 0xff]
+        output << buffer.pack('cccc') << optional_param.value
+      end
+      output
+    end
+
+    def optional_parameters_to_buffer(optionals)
+      Base.optional_parameters_to_buffer(optionals)
+    end
+
     def next_sequence_number
       Base.next_sequence_number
     end
@@ -147,10 +168,8 @@ module Smpp::Pdu
       optionals = {}
       while not remaining_bytes.empty?
         optional = {}
-        tag, optional[:length], remaining_bytes = remaining_bytes.unpack('H4na*')
-        optional[:tag] = tag.hex
-        optional[:value] = remaining_bytes.slice!(0...optional[:length])
-        optionals[tag.hex] = optional
+        optional_parameter, remaining_bytes = Smpp::OptionalParameter.from_wire_data(remaining_bytes)
+        optionals[optional_parameter.tag] = optional_parameter
       end
       
       return optionals

data/lib/smpp/pdu/submit_sm.rb

@@ -4,7 +4,7 @@ class Smpp::Pdu::SubmitSm < Smpp::Pdu::Base
   attr_reader :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, :udh, :short_message
+              :sm_default_msg_id, :sm_length, :udh, :short_message, :optional_parameters
 
   
   # Note: short_message (the SMS body) must be in iso-8859-1 format
@@ -33,11 +33,17 @@ class Smpp::Pdu::SubmitSm < Smpp::Pdu::Base
     payload                  = @udh ? @udh + @short_message : @short_message 
     @sm_length               = payload.length
     
+    @optional_parameters     = options[:optional_parameters]
+    
     # 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)
 
+    if @optional_parameters
+      pdu_body << optional_parameters_to_buffer(@optional_parameters)
+    end
+
     seq ||= next_sequence_number
 
     super(SUBMIT_SM, 0, seq, pdu_body)        
@@ -70,8 +76,14 @@ class Smpp::Pdu::SubmitSm < Smpp::Pdu::Base
     options[:data_coding], 
     options[:sm_default_msg_id],
     options[:sm_length], 
-    short_message = body.unpack('Z*CCZ*CCZ*CCCZ*Z*CCCCCa*')
-    Smpp::Base.logger.debug "DeliverSM with source_addr=#{source_addr}, destination_addr=#{destination_addr}"
+    remaining_bytes = body.unpack('Z*CCZ*CCZ*CCCZ*Z*CCCCCa*')
+
+    short_message = remaining_bytes.slice!(0...options[:sm_length])
+
+    #everything left in remaining_bytes is 3.4 optional parameters
+    options[:optional_parameters] = optional_parameters(remaining_bytes)
+
+    Smpp::Base.logger.debug "SubmitSM with source_addr=#{source_addr}, destination_addr=#{destination_addr}"
 
     new(source_addr, destination_addr, short_message, options, seq) 
   end

data/ruby-smpp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-smpp}
-  s.version = "0.1.3"
+  s.version = "0.2.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{2010-02-05}
+  s.date = %q{2010-02-11}
   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 = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "examples/sample_smsc.rb",
      "lib/smpp.rb",
      "lib/smpp/base.rb",
+     "lib/smpp/optional_parameter.rb",
      "lib/smpp/pdu/base.rb",
      "lib/smpp/pdu/bind_base.rb",
      "lib/smpp/pdu/bind_resp_base.rb",
@@ -51,7 +52,9 @@ Gem::Specification.new do |s|
      "lib/smpp/transceiver.rb",
      "lib/sms.rb",
      "ruby-smpp.gemspec",
-     "test/smpp_test.rb"
+     "test/optional_parameter_test.rb",
+     "test/smpp_test.rb",
+     "test/submit_sm_test.rb"
   ]
   s.homepage = %q{http://github.com/raykrueger/ruby-smpp}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -60,7 +63,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Ruby implementation of the SMPP protocol, based on EventMachine.}
   s.test_files = [
-    "test/smpp_test.rb",
+    "test/optional_parameter_test.rb",
+     "test/smpp_test.rb",
+     "test/submit_sm_test.rb",
      "examples/sample_gateway.rb",
      "examples/sample_smsc.rb"
   ]

data/test/optional_parameter_test.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'smpp'
+
+class OptionalParameterTest < Test::Unit::TestCase
+  include Smpp
+
+  def test_symbol_accessor
+    op = OptionalParameter.new(0x2150, "abcd")
+    assert_equal "abcd", op[:value]
+    assert_equal 0x2150, op[:tag]
+  end
+
+  def test_bad_data_does_not_puke
+    assert_raise RuntimeError do
+      OptionalParameter.from_wire_data("")
+    end
+  end
+
+  def test_from_wire_data
+    data = "\041\120\000\002\001\177"
+    op, remaining_data = OptionalParameter.from_wire_data(data)
+    assert_not_nil op, "op should not be nil"
+    assert_equal 0x2150, op.tag
+    assert_equal "\001\177", op.value
+    assert_equal "", remaining_data
+  end
+
+end
+

data/test/submit_sm_test.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'test/unit'
+require 'smpp'
+
+class SubmitSmTest < Test::Unit::TestCase
+
+  def test_this_is_not_a_real_test
+    value = [383 >> 8, 383 & 0xff]
+    optionals = {0x2150 => Smpp::OptionalParameter.new(0x2150, value.pack('cc'))}
+    pdu = Smpp::Pdu::SubmitSm.new('12345', '54321', "Ba Ba Boosh", {:optional_parameters => optionals})
+    Smpp::Base.hex_debug(pdu.data)
+    puts "PDU DATA", pdu.data.inspect
+    
+  end
+
+  def test_fixnum_optional_parameter
+    value = [383 >> 8, 383 & 0xff]
+    optionals = {0x2150 => Smpp::OptionalParameter.new(0x2150, value.pack('cc'))}
+
+    pdu = Smpp::Pdu::SubmitSm.new('12345', '54321', "Ba Ba Boosh", {:optional_parameters => optionals})
+    pdu_from_wire = Smpp::Pdu::Base.create(pdu.data)
+
+    assert optional = pdu_from_wire.optional_parameters[0x2150]
+    
+    optional_value = optional[:value].unpack('n')[0]
+    assert_equal 383, optional_value
+  end
+
+  def test_string_optional_parameter
+    optionals = {0x2150 => Smpp::OptionalParameter.new(0x2150, "boosh")}
+
+    pdu = Smpp::Pdu::SubmitSm.new('12345', '54321', "Ba Ba Boosh", {:optional_parameters => optionals})
+    pdu_from_wire = Smpp::Pdu::Base.create(pdu.data)
+
+    assert optional = pdu_from_wire.optional_parameters[0x2150]
+    
+    optional_value = optional[:value].unpack("A*")[0]
+    assert_equal 'boosh', optional_value
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-smpp
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ray Krueger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 -06:00
+date: 2010-02-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - examples/sample_smsc.rb
 - lib/smpp.rb
 - lib/smpp/base.rb
+- lib/smpp/optional_parameter.rb
 - lib/smpp/pdu/base.rb
 - lib/smpp/pdu/bind_base.rb
 - lib/smpp/pdu/bind_resp_base.rb
@@ -67,7 +68,9 @@ files:
 - lib/smpp/transceiver.rb
 - lib/sms.rb
 - ruby-smpp.gemspec
+- test/optional_parameter_test.rb
 - test/smpp_test.rb
+- test/submit_sm_test.rb
 has_rdoc: true
 homepage: http://github.com/raykrueger/ruby-smpp
 licenses: []
@@ -97,6 +100,8 @@ signing_key:
 specification_version: 3
 summary: Ruby implementation of the SMPP protocol, based on EventMachine.
 test_files: 
+- test/optional_parameter_test.rb
 - test/smpp_test.rb
+- test/submit_sm_test.rb
 - examples/sample_gateway.rb
 - examples/sample_smsc.rb