anthill_smpp_ruby 0.5.1

data/lib/pdu/smpp_query_broadcast_sm.rb

@@ -0,0 +1,120 @@
+#
+#   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.
+#
+
+
+module Majoron
+  module AntHill
+  	module SMPP
+  		class SMPPQueryBroadcastSM < SMPPPDU
+  			def initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil)
+  				super(CommandId::CM_QUERY_BROADCAST_SM, command_status, sequence_number)
+  
+  				# Mandatory fields
+  				@message_id = ""
+  				@source_addr_ton = TON::UNKNOWN
+  				@source_addr_npi = TON::UNKNOWN
+  				@source_addr = ""
+  
+  				# Optional fields
+  				@user_message_reference = nil
+  			
+  				# Optional fields length
+  				@user_message_reference_len = SMPPTLVLen::WORD_LEN
+  
+  			end
+  
+  			# Interface to encode SMPP packet 
+  			def encode_packet(encoder)
+  				# Encode header and mandatory fields
+  				encoder.encode_header(@header)
+  				encoder.encode_message_id(@message_id)
+  				encoder.encode_source_addr_ton(@source_addr_ton)
+  				encoder.encode_source_addr_npi(@source_addr_npi)
+  				encoder.encode_source_addr21(@source_addr)
+  
+  				# Encode optional fields
+  				encoder.encode_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  			end
+  
+  			# Interface to decode SMPP packet 
+  			def decode_packet(decoder)
+  				# Decode header and mandatory fields
+  				@header = decoder.decode_header()
+  				@message_id = decoder.decode_message_id(command_length())
+  				@source_addr_ton = decoder.decode_source_addr_ton(command_length())
+  				@source_addr_npi = decoder.decode_source_addr_npi(command_length())
+  				@source_addr = decoder.decode_source_addr21(command_length())
+  
+  				# Decode optional fields
+  				while decoder.has_tlvs() 
+  					case decoder.get_tlv_code()
+  						when OptTags::TAG_USER_MESSAGE_REFERENCE
+  							@user_message_reference, @user_message_reference_len = 
+  								decoder.decode_user_message_reference(command_length())
+  						else
+  							# Report about error
+  							raise Errors::UNKNOWN_TAG_MSG + decoder.get_tlv_error()
+  					end
+  				end
+  			end
+  
+  			# Interface to validate SMPP packet 
+  			def validate_packet(validator)
+  				# Validate header and mandatory fields
+  				validator.validate_header(@header)
+  				validator.validate_message_id(@message_id)
+  				validator.validate_source_addr_ton(@source_addr_ton)
+  				validator.validate_source_addr_npi(@source_addr_npi)
+  				validator.validate_source_addr21(@source_addr)
+  
+  				# Encode optional fields
+  				validator.validate_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  			end
+  
+  			# Interface to output SMPP packet 
+  			def output_packet(outputter)
+  				# Output header and mandatory fields
+  				outputter.output_header(@header)
+  				outputter.output_message_id(@message_id)
+  				outputter.output_source_addr_ton(@source_addr_ton)
+  				outputter.output_source_addr_npi(@source_addr_npi)
+  				outputter.output_source_addr21(@source_addr)
+  
+  				# Encode optional fields
+  				outputter.output_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  			end
+  
+  		public
+  			# Mandatory fields
+  			attr_accessor :message_id
+  			attr_accessor :source_addr_ton
+  			attr_accessor :source_addr_npi
+  			attr_accessor :source_addr
+  
+  			# Optional fields
+  			attr_accessor :user_message_reference
+  
+  			# Optional fields length
+  			attr_accessor :user_message_reference_len
+  
+  		end
+  	end
+  end
+end

data/lib/pdu/smpp_query_broadcast_sm_resp.rb

@@ -0,0 +1,192 @@
+#
+#   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.
+#
+
+
+module Majoron
+  module AntHill
+  	module SMPP
+  		class SMPPQueryBroadcastSMResp < SMPPResp
+  			# Constructor. 
+  			def initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil)
+  				super(CommandId::CM_QUERY_BROADCAST_SM_RESP, command_status, sequence_number)
+  
+  				# Mandatory fields
+  				@message_id = ""
+  				@message_state = nil
+  				@broadcast_area_identifier = nil
+  				@broadcast_area_success = nil
+  
+  
+  				# Mandatory fields len
+  				@message_state_len = SMPPTLVLen::BYTE_LEN
+  				@broadcast_area_identifier_len = SMPPTLVLen::ZERO_LEN
+  				@broadcast_area_success_len = SMPPTLVLen::BYTE_LEN
+  
+  				# Optional fields
+  				@user_message_reference = nil
+  				@broadcast_end_time = nil
+  
+  				# Optional fields length
+  				@user_message_reference_len = SMPPTLVLen::WORD_LEN
+  				@brodcast_end_time_len = SMPPTLVLen::ZERO_LEN
+  
+  			end
+  
+  			# Interface to encode SMPP packet 
+  			def encode_packet(encoder)
+  				# Encode header and mandatory fields
+  				encoder.encode_header(@header)
+  				encoder.encode_message_id(@message_id)
+  
+  				# Encode mandatory fields as TLV structures
+  				encoder.encode_message_state_tlv(@message_state,
+  					@message_state_len)
+  				encoder.encode_broadcast_area_identifier(@broadcast_area_identifier,
+  					@broadcast_area_identifier_len)
+  				encoder.encode_broadcast_area_success(@broadcast_area_success,
+  					@broadcast_area_success_len)
+  
+  				# Encode optional fields
+  				encoder.encode_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  				encoder.encode_broadcast_end_time(@broadcast_end_time, 
+  					@broadcast_end_time_len) if !@broadcast_end_time.nil?
+  
+  			end
+  
+  			# Interface to decode SMPP packet 
+  			def decode_packet(decoder)
+  				# Decode header and mandatory fields
+  				@header = decoder.decode_header()
+  				@message_id = decoder.decode_message_id(command_length())
+  
+  				# Decode mandatory fields as TLV structures
+  				if decoder.has_tlvs() && decoder.get_tlv_code() == OptTags::TAG_MESSAGE_STATE
+  					@message_state, @message_state_len = 
+  						decoder.decode_message_state_tlv(command_length())
+  				end
+  
+  				while decoder.has_tlvs() && decoder.get_tlv_code() == OptTags::TAG_BROADCAST_AREA_IDENTIFIER
+  					id, len = decoder.decode_broadcast_area_identifier(command_length())
+  					if @broadcast_area_identifier.nil? || @broadcast_area_identifier_len.nil?
+  						@broadcast_area_identifier = []
+  						@broadcast_area_identifier_len = []
+  					end
+  					@broadcast_area_identifier << id
+  					@broadcast_area_identifier_len << len
+  				end
+  
+  				if decoder.has_tlvs() && decoder.get_tlv_code() == OptTags::TAG_BROADCAST_AREA_SUCCESS
+  					@broadcast_area_success, @broadcast_area_success_len = 
+  						decoder.decode_broadcast_area_success(command_length())
+  				end
+  
+  				# Decode optional fields
+  				while decoder.has_tlvs() 
+  					case decoder.get_tlv_code()
+  						when OptTags::TAG_USER_MESSAGE_REFERENCE
+  							@user_message_reference, @user_message_reference_len = 
+  								decoder.decode_user_message_reference(command_length())
+  						when OptTags::TAG_BROADCAST_END_TIME
+  							@broadcast_end_time, @broadcast_end_time_len = 
+  								decoder.decode_broadcast_end_time(command_length())
+  						else
+  							# Report about error
+  							raise Errors::UNKNOWN_TAG_MSG + decoder.get_tlv_error()
+  					end
+  				end
+  			end
+  
+  			# Interface to validate SMPP packet 
+  			def validate_packet(validator)
+  				# Validate header and mandatory fields
+  				validator.validate_header(@header)
+  				validator.validate_message_id(@message_id)
+  
+  				# Validate mandatory fields as TLV structures
+  				validator.validate_message_state_tlv(@message_state,
+  					@message_state_len)
+  				validator.validate_broadcast_area_identifier(@broadcast_area_identifier,
+  					@broadcast_area_identifier_len)
+  				validator.validate_broadcast_area_success(@broadcast_area_success,
+  					@broadcast_area_success_len)
+  
+  				# Validate optional fields
+  				validator.validate_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  				validator.validate_broadcast_end_time(@broadcast_end_time, 
+  					@broadcast_end_time_len) if !@broadcast_end_time.nil?
+  			end
+  
+  			# Interface to output SMPP packet 
+  			def output_packet(outputter)
+  				# Output header and mandatory fields
+  				outputter.output_header(@header)
+  				outputter.output_message_id(@message_id)
+  
+  				# Output mandatory fields as TLV structures
+  				outputter.output_message_state_tlv(@message_state,
+  					@message_state_len)
+  				outputter.output_broadcast_area_identifier(@broadcast_area_identifier,
+  					@broadcast_area_identifier_len)
+  				outputter.output_broadcast_area_success(@broadcast_area_success,
+  					@broadcast_area_success_len)
+  
+  				# Output optional fields
+  				outputter.output_user_message_reference(@user_message_reference, 
+  					@user_message_reference_len) if !@user_message_reference.nil?
+  				outputter.output_broadcast_end_time(@broadcast_end_time, 
+  					@broadcast_end_time_len) if !@broadcast_end_time.nil?
+  			end
+  		public
+  			def broadcast_area_identifier=(broadcast_area_identifier)
+  				@broadcast_area_identifier = broadcast_area_identifier
+  				@broadcast_area_identifier_len = []
+  				0.upto(broadcast_area_identifier.size() -1) do | i |
+  					@broadcast_area_identifier_len << broadcast_area_identifier[i].value.size()
+  				end
+  			end
+  
+  			def broadcast_end_time=(broadcast_end_time)
+  				@broadcast_end_time = broadcast_end_time
+  				@broadcast_end_time_len = broadcast_end_time.size() + 1 	# 1 = NULL terminator
+  			end
+  
+  		public
+  			# Mandatory fields
+  			attr_accessor :message_id
+  			attr_accessor :message_state
+  			attr_reader :broadcast_area_identifier
+  			attr_accessor :broadcast_area_success
+  
+  			# Mandatory fields len
+  			attr_accessor :message_state_len
+  			attr_accessor :broadcast_area_identifier_len
+  			attr_accessor :broadcast_area_success_len
+  
+  			# Optional fields
+  			attr_accessor :user_message_reference
+  			attr_reader :broadcast_end_time
+  
+  			# Optional fields length
+  			attr_accessor :user_message_reference_len
+  			attr_accessor :broadcast_end_time_len
+  
+  		end
+  	end
+  end
+end

data/lib/pdu/smpp_query_sm.rb

@@ -0,0 +1,92 @@
+#
+#   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.
+#
+
+
+module Majoron
+  module AntHill
+  	module SMPP
+  		class SMPPQuerySM < SMPPPDU
+  			def initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil)
+  				super(CommandId::CM_QUERY_SM, command_status, sequence_number)
+  
+  				# Mandatory fields
+  				@message_id = ""
+  				@source_addr_ton = TON::UNKNOWN
+  				@source_addr_npi = NPI::UNKNOWN
+  				@source_addr = ""
+  
+  			end
+  
+  			# Interface to encode SMPP packet 
+  			def encode_packet(encoder)
+  				# Encode header and mandatory fields
+  				encoder.encode_header(@header)
+  				encoder.encode_message_id(message_id)
+  				encoder.encode_source_addr_ton(source_addr_ton)
+  				encoder.encode_source_addr_npi(source_addr_npi)
+  				encoder.encode_source_addr21(source_addr)
+  
+  			end
+  
+  			# Interface to decode SMPP packet 
+  			def decode_packet(decoder)
+  				# Decode header and mandatory fields
+  				@header = decoder.decode_header()
+  				@message_id = decoder.decode_message_id(command_length())
+  				@source_addr_ton = decoder.decode_source_addr_ton(command_length())
+  				@source_addr_npi = decoder.decode_source_addr_npi(command_length())
+  				@source_addr = decoder.decode_source_addr21(command_length())
+  				
+  			end
+  
+  			# Interface to validate SMPP packet 
+  			def validate_packet(validator)
+  				# Validate header and mandatory fields
+  				validator.validate_header(@header)
+  				validator.validate_message_id(message_id)
+  				validator.validate_source_addr_ton(source_addr_ton)
+  				validator.validate_source_addr_npi(source_addr_npi)
+  				validator.validate_source_addr21(source_addr)
+  			end
+  
+  			# Interface to output SMPP packet 
+  			def output_packet(outputter)
+  				# Output header and mandatory fields
+  				outputter.output_header(@header)
+  				outputter.output_message_id(message_id)
+  				outputter.output_source_addr_ton(source_addr_ton)
+  				outputter.output_source_addr_npi(source_addr_npi)
+  				outputter.output_source_addr21(source_addr)
+  			end
+  
+  		public
+  			# Mandatory fields
+  			attr_accessor :message_id
+  			attr_accessor :source_addr_ton
+  			attr_accessor :source_addr_npi
+  			attr_accessor :source_addr
+  
+  			# Optional fields
+  			# attr_accessor :sc_interface_version
+  
+  			# Optional fields length
+  			# attr_accessor :sc_interface_version_len
+  
+  		end
+  	end
+  end
+end

data/lib/pdu/smpp_query_sm_resp.rb

@@ -0,0 +1,92 @@
+#
+#   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.
+#
+
+
+module Majoron
+  module AntHill
+  	module SMPP
+  		class SMPPQuerySMResp < SMPPResp
+  			# Constructor. 
+  			def initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil)
+  				super(CommandId::CM_QUERY_SM_RESP, command_status, sequence_number)
+  
+  				# Mandatory fields
+  				@message_id = ""
+  				@final_date = ""
+  				@message_state = MessageState::UNKNOWN
+  				@error_code = 0
+  
+  				# Optional fields
+  			
+  				# Optional fields length
+  
+  			end
+  
+  			# Interface to encode SMPP packet 
+  			def encode_packet(encoder)
+  				# Encode header and mandatory fields
+  				encoder.encode_header(@header)
+  				encoder.encode_message_id(@message_id)
+  				encoder.encode_final_date(@final_date)
+  				encoder.encode_message_state(@message_state)
+  				encoder.encode_error_code(@error_code)
+  			end
+  
+  			# Interface to decode SMPP packet 
+  			def decode_packet(decoder)
+  				# Decode header and mandatory fields
+  				@header = decoder.decode_header()
+  				@message_id = decoder.decode_message_id(command_length())
+  				@final_date = decoder.decode_final_date(command_length())
+  				@message_state = decoder.decode_message_state(command_length())
+  				@error_code = decoder.decode_error_code(command_length())
+  			end
+  
+  			# Interface to validate SMPP packet 
+  			def validate_packet(validator)
+  				# Validate header and mandatory fields
+  				validator.validate_header(@header)
+  				validator.validate_message_id(@message_id)
+  				validator.validate_final_date(@final_date)
+  				validator.validate_message_state(@message_state)
+  				validator.validate_error_code(@error_code)
+  			end
+  
+  			# Interface to output SMPP packet 
+  			def output_packet(outputter)
+  				# Output header and mandatory fields
+  				outputter.output_header(@header)
+  				outputter.output_message_id(@message_id)
+  				outputter.output_final_date(@final_date)
+  				outputter.output_message_state(@message_state)
+  				outputter.output_error_code(@error_code)
+  			end
+  
+  		public
+  			# Mandatory fields
+  			attr_accessor :message_id
+  			attr_accessor :final_date
+  			attr_accessor :message_state
+  			attr_accessor :error_code
+  
+  			# Optional fields
+  
+  			# Optional fields length
+  		end
+  	end
+  end
+end