anthill_smpp_ruby 0.5.1

data/data/pdus/smpp_submit_multi_no_optional.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_submit_multi>
+		<command_status>0</command_status>
+		<sequence_number>12</sequence_number>
+		<service_type>srvtp</service_type>
+		<source_addr_ton>1</source_addr_ton>
+		<source_addr_npi>2</source_addr_npi>
+		<source_addr>123</source_addr>
+		<number_of_dest>6</number_of_dest>
+		<dest_addresses>
+			<dest_address>
+				<distr_list_name>distr_list1</distr_list_name>
+			</dest_address>
+			<dest_address>
+				<distr_list_name>distr_list2</distr_list_name>
+			</dest_address>
+			<dest_address>
+				<sme_address>
+					<ton>1</ton>
+					<npi>1</npi>
+					<address>123</address>
+				</sme_address>
+			</dest_address>
+			<dest_address>
+				<sme_address>
+					<ton>2</ton>
+					<npi>2</npi>
+					<address>223</address>
+				</sme_address>
+			</dest_address>
+			<dest_address>
+				<distr_list_name>distr_list1</distr_list_name>
+			</dest_address>
+			<dest_address>
+				<distr_list_name>distr_list2</distr_list_name>
+			</dest_address>
+		</dest_addresses>
+		<esm_class>1</esm_class>
+		<protocol_id>2</protocol_id>
+		<priority_flag>3</priority_flag>
+		<schedule_delivery_time/>
+		<validity_period/>
+		<registered_delivery>4</registered_delivery>
+		<replace_if_present_flag>5</replace_if_present_flag>
+		<data_coding>6</data_coding>
+		<sm_default_msg_id>7</sm_default_msg_id>
+		<sm_length>0</sm_length>
+		<short_message></short_message>
+	</smpp_submit_multi>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_submit_multi_resp.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_submit_multi_resp>
+		<command_status>0</command_status>
+		<sequence_number>12</sequence_number>
+		<message_id>123</message_id>
+		<no_unsuccess>3</no_unsuccess>
+		<unsuccess_smes>
+			<unsuccess_sme>
+				<sme_address>
+					<ton>1</ton>
+					<npi>2</npi>
+					<address>123</address>
+				</sme_address>
+				<error_status_code>1</error_status_code>
+			</unsuccess_sme>
+			<unsuccess_sme>
+				<sme_address>
+					<ton>3</ton>
+					<npi>4</npi>
+					<address>321</address>
+				</sme_address>
+				<error_status_code>3</error_status_code>
+			</unsuccess_sme>
+			<unsuccess_sme>
+				<sme_address>
+					<ton>5</ton>
+					<npi>6</npi>
+					<address>213</address>
+				</sme_address>
+				<error_status_code>3</error_status_code>
+			</unsuccess_sme>
+		</unsuccess_smes>
+	</smpp_submit_multi_resp>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_submit_sm.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands 
+xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" 
+xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_submit_sm>
+			<command_status>0</command_status>
+			<sequence_number>12</sequence_number>
+			<service_type>SMS</service_type>
+			<source_addr_ton>1</source_addr_ton>
+			<source_addr_npi>2</source_addr_npi>
+			<source_addr>123</source_addr>
+			<dest_addr_ton>4</dest_addr_ton>
+			<dest_addr_npi>5</dest_addr_npi>
+			<dest_addr>321</dest_addr>
+			<esm_class>6</esm_class>
+			<protocol_id>7</protocol_id>
+			<priority_flag>8</priority_flag>
+			<schedule_delivery_time></schedule_delivery_time>
+			<validity_period></validity_period>
+			<registered_delivery>9</registered_delivery>
+			<replace_if_present_flag>10</replace_if_present_flag>
+			<data_coding>11</data_coding>
+			<sm_default_msg_id>12</sm_default_msg_id>
+			<sm_length>0</sm_length>
+			<short_message></short_message>
+			
+			<user_message_reference>1</user_message_reference>
+			<source_port>2</source_port>
+			<source_addr_subunit>3</source_addr_subunit>
+			<destination_port>4</destination_port>
+			<dest_addr_subunit>5</dest_addr_subunit>
+			<sar_msg_ref_num>6</sar_msg_ref_num>
+			<sar_total_segments>7</sar_total_segments>
+			<sar_segment_seqnum>8</sar_segment_seqnum>
+			<more_messages_to_send>9</more_messages_to_send>
+			<payload_type>10</payload_type>
+			<message_payload>01 02 AA FF</message_payload>
+			<privacy_indicator>11</privacy_indicator>
+			<callback_num>01 02 AA FF</callback_num>
+			<callback_num_pres_ind>12</callback_num_pres_ind>
+			<callback_num_atag>01 02 AA FF</callback_num_atag>
+			<source_subaddress>01 02 AA FF</source_subaddress>
+			<dest_subaddress>01 02 AA FF</dest_subaddress>
+			<user_response_code>13</user_response_code>
+			<display_time>14</display_time>
+			<sms_signal>15</sms_signal>
+			<ms_validity>16</ms_validity>
+			<ms_msg_wait_facilities>17</ms_msg_wait_facilities>
+			<number_of_messages>18</number_of_messages>
+			<alert_on_msg_delivery>19</alert_on_msg_delivery>
+			<language_indicator>20</language_indicator>
+			<its_reply_type>21</its_reply_type>
+			<its_session_info>22</its_session_info>
+			<ussd_service_op>23</ussd_service_op>
+	</smpp_submit_sm>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_submit_sm_no_optional.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands 
+xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" 
+xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_submit_sm>
+			<command_status>0</command_status>
+			<sequence_number>12</sequence_number>
+			<service_type>SMS</service_type>
+			<source_addr_ton>1</source_addr_ton>
+			<source_addr_npi>2</source_addr_npi>
+			<source_addr>123</source_addr>
+			<dest_addr_ton>4</dest_addr_ton>
+			<dest_addr_npi>5</dest_addr_npi>
+			<dest_addr>321</dest_addr>
+			<esm_class>6</esm_class>
+			<protocol_id>7</protocol_id>
+			<priority_flag>8</priority_flag>
+			<schedule_delivery_time></schedule_delivery_time>
+			<validity_period></validity_period>
+			<registered_delivery>9</registered_delivery>
+			<replace_if_present_flag>10</replace_if_present_flag>
+			<data_coding>11</data_coding>
+			<sm_default_msg_id>12</sm_default_msg_id>
+			<sm_length>0</sm_length>
+			<short_message></short_message>
+	</smpp_submit_sm>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_submit_sm_resp.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_submit_sm_resp>
+		<command_status>0</command_status>
+		<sequence_number>12</sequence_number>
+		<message_id>123</message_id>
+	</smpp_submit_sm_resp>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_unbind.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands 
+xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" 
+xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_unbind>
+			<command_status>0</command_status>
+			<sequence_number>12</sequence_number>
+	</smpp_unbind>
+</smpp_commands:smpp_commands>

data/data/pdus/smpp_unbind_resp.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<smpp_commands:smpp_commands 
+xsi:schemaLocation="http://www.example.net/smpp_commands.xsd smpp_commands.xsd" 
+xmlns:smpp_commands="http://www.example.net/smpp_commands.xsd" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<smpp_unbind_resp>
+			<command_status>0</command_status>
+			<sequence_number>12</sequence_number>
+	</smpp_unbind_resp>
+</smpp_commands:smpp_commands>

data/examples/dump_viewer.rb

@@ -0,0 +1,298 @@
+#!/usr/bin/ruby
+# == Synopsis 
+#   SMPP decoder.
+#
+# == Examples
+#   This command decode SMPP package and output it.
+#     dump_viewer --dumpfile dump.smpp
+#
+#   Other examples:
+#     dump_viewer -q --dumpfile _dump.smpp --showdump 1 --outputter txt
+#     dump_viewer --verbose --dumpfile _dump.smpp --showdump 0 --outputter csv
+#
+# == Usage 
+#   dump_viewer [options]
+#
+#   For help use: dump_viewer -h
+#
+# == Options
+#   -h, --help          	Displays help message
+#   -v, --version       	Display the version, then exit
+#   -q, --quiet         	Output as little as possible, overrides verbose
+#   -V, --verbose       	Verbose output
+#   -f, --dumpfile      	Path to file with SMPP dump
+#   -x, --[no-]showhex       	Show hex fields representation
+#   -d, --[no-]showdump      	Show buffer dump after reading it from file
+#   -e, --[no-]showesm       	Show detailed information from esm class
+#   -f, --[no-]showfmt       	Show detailed information about area format
+#   -o, --outputter		Outputter for printing(txt, csv, hex or xml)
+#
+# == Author
+#   Majoron
+#
+# == Copyright
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+$:.unshift File.dirname(__FILE__) + '/../lib/'
+$:.unshift File.dirname(__FILE__) + '/../lib/' + '/../../../AntHill/0.5/lib/'
+
+
+# Include necessary libraries
+require "optparse"
+require "rdoc/usage"
+require "ostruct"
+require "date"
+
+# Include anthill library
+require "anthill"
+require "anthill_smpp"
+
+
+#
+class DumpViewer
+	# Module contains supportable outputters
+	module Outputter
+		TXT	= "TXT"
+		CSV	= "CSV"
+		HEX	= "HEX"
+		XML	= "XML"
+	end
+
+	# Module contains error messages
+	module Errors
+		UNABLE_TO_OPEN_FILE			= "Unable to open file."
+		INVALID_COMMAND_ID 			= "Unknown PDU command id."
+		MORE_THAN_ONE_PACKAGE 			= "Dump contains a valid SMPP package and extra dump information."
+		UNSUPPORTABLE_OUTPUTTER 		= "Unsupportable outputter. Supportable are: txt, csv, hex and xml."
+	end
+
+	# Constructor
+	def initialize(arguments, stdin)
+		@arguments = arguments
+		@stdin = stdin
+    
+		# Set defaults
+		@options = OpenStruct.new
+		@options.verbose = false
+		@options.quiet = false
+		@options.showhex = true
+		@options.showdump = true
+		@options.showesm = true
+		@options.showfmt = true
+		@options.dumpfile = "dump.smpp"
+		@options.outputter = "txt"
+
+		# Set accessors
+		@outputter = ""
+		@package = nil
+		@buffer = ""
+	end
+
+	# Entry point to run application
+	def run_application
+		if parsed_options? && arguments_valid? 
+			output_options if @options.verbose # [Optional]
+			process_arguments
+			process_application
+		else
+			output_usage
+		end
+	end
+
+	# Public accessors
+	attr_reader :options
+
+protected
+	def parsed_options?
+		# Specify options
+		opts = OptionParser.new 
+		opts.on('-v', '--version')    { output_version ; exit 0 }
+		opts.on('-h', '--help')       { output_help }
+		opts.on('-V', '--verbose')    { @options.verbose = true }
+		opts.on('-q', '--quiet')      { @options.quiet = true }
+
+		# Get a show dump option
+		opts.on("-x", "--[no-]showhex", "Show hex fields representation") do |val|
+			options.showhex = val
+		end
+
+		# Get a show dump option
+		opts.on("-d", "--[no-]showdump", "Show buffer dump after reading it from file") do |val|
+			options.showdump = val
+		end
+
+		# Get a show esm class options option
+		opts.on("-e", "--[no-]showesm", "Show detailed information from esm class") do |val|
+			options.showesm = val
+		end
+
+		# Get a show format option
+		opts.on("-e", "--[no-]showfmt", "Show detailed information about area format") do |val|
+			options.showfmt = val
+		end
+
+		# Get a dumpfile
+		opts.on("-f", "--dumpfile DUMPFILE", "Path to file with SMPP dump") do |dump|
+			@options.dumpfile = dump
+		end
+
+		# Get a outputter
+		opts.on("-o", "--outputter OUTPUTTER",
+			"Outputter for printing(txt, csv, hex or xml)") do |out|
+			@options.outputter = out
+		end
+
+		opts.parse!(@arguments) rescue return false
+		process_options
+		true      
+		
+	end
+
+	# Performs post-parse processing on options
+	def process_options
+		@options.verbose = false if @options.quiet
+	end
+    
+	def output_options
+		puts "Options:\n"
+		@options.marshal_dump.each do |name, val|        
+			puts "  #{name} = #{val}"
+		end
+	end
+
+	# True if required arguments were provided
+	def arguments_valid?
+		return false if @options.dumpfile.nil?
+		true
+	end
+    
+	# Setup the arguments
+	def process_arguments
+		# Place in local vars, etc
+	end
+    
+	def output_help
+		output_version
+		RDoc::usage() #exits app
+	end
+    
+	def output_usage
+		RDoc::usage('usage') # gets usage from comments above
+	end
+    
+	def output_version
+		puts "#{File.basename(__FILE__)} version #{VERSION}"
+	end
+
+	# At the begining read data from file, then decode a byte buffer
+	# that was read and then output information about SMPP package
+	def process_application
+		begin
+			create_smpp_outputter()
+
+			create_byte_buffer()
+
+			decode_byte_buffer()
+
+			output_byte_buffer()
+
+			output_smpp_package()
+		rescue Exception => e
+			puts e
+		end
+	end
+
+	# Create appropriate outputter based on command line
+	def create_smpp_outputter
+		case @options.outputter.upcase
+			when Outputter::TXT 
+				@outputter = AntHill::SMPP::SMPPTxtOutputter.new(STDOUT, 
+					options.showhex, options.showesm, options.showfmt)
+			when Outputter::CSV
+				@outputter = AntHill::SMPP::SMPPCSVOutputter.new(STDOUT,
+					options.showesm, options.showfmt)
+			when Outputter::HEX
+				@outputter = AntHill::SMPP::SMPPHexOutputter.new(STDOUT)
+			when Outputter::XML
+				@outputter = AntHill::SMPP::SMPPXMLOutputter.new(STDOUT)
+			else
+				raise Errors::UNSUPPORTABLE_OUTPUTTER
+		end
+	end
+
+	# Open file with smpp dump and create a byte buffer based on a file
+	def create_byte_buffer
+		file = File.new(@options.dumpfile,  "r")
+		raise Errors::UNABLE_TO_OPEN_FILE if file.nil?
+		begin
+			buf = AntHill::ByteBuffer.new(@buffer)
+			buf.read_dump(file)
+			file.close()
+		rescue RuntimeError => e
+			file.close()
+			raise
+		end
+	end
+
+	def decode_byte_buffer
+		begin
+			decoder = AntHill::SMPP::SMPPDecoder.new()
+			validator = AntHill::SMPP::SMPPValidator.new()
+
+			decoder.append_buffer(@buffer)
+			@package = decoder.get_packet()
+			if !@package.nil?
+				@package.decode_packet(decoder)
+				decoder.validate_offset(@package.command_length)
+				@package.validate_packet(validator)
+				if @package.command_length != @buffer.size()
+					puts Errors::MORE_THAN_ONE_PACKAGE
+				end
+			else
+				raise Errors::INVALID_COMMAND_ID
+			end
+		rescue RuntimeError => e
+			puts e
+		end
+
+	end
+
+	# Output byte buffer if showdump option is true
+	def output_byte_buffer
+		return if !@options.showdump
+		puts AntHill::ByteBuffer.encode_hex(@buffer)
+	end
+
+	def output_smpp_package
+		return if package.nil?
+		package.output_packet(@outputter)
+	end
+
+	#
+	VERSION = '0.5.1'
+
+	# Private accessors
+	attr_accessor :outputter
+	attr_accessor :package
+	attr_accessor :buffer
+
+
+end
+
+# Create a application and process
+dump_viewer = DumpViewer.new(ARGV, STDIN)
+dump_viewer.run_application()