pdu_sms 0.1.0

data/lib/pdu_sms/message_reference.rb

@@ -0,0 +1,41 @@
+module PduSms
+  class MessageReference
+
+    def initialize(num)
+      if (0..255).include?(num)
+        @mr = num
+      else
+        raise ArgumentError, 'The "num" is incorrect'
+      end
+    end
+
+    def MessageReference.encode_ms(num)
+      new(num).freeze
+    end
+
+    def MessageReference.decode_ms(pdu)
+      new(MessageReference.cut_off_pdu(pdu, :current, :ms).to_i(2)).freeze
+    end
+
+    def MessageReference.cut_off_pdu(pdu, part=:all, type=:ms) # tail current
+      part_pdu = PDUType.cut_off_pdu(pdu, :tail)
+      raise ArgumentError, 'The "pdu" is incorrect' if part_pdu.length < 2
+      current = part_pdu[0..1]
+      tail = part_pdu[2..-1]
+      case part
+        when :current then current
+        when :tail then tail
+        else [current,tail]
+      end
+    end
+
+    def get_hex
+      '%02x' % @mr
+    end
+
+    def get_mr
+      @mr
+    end
+
+  end
+end

data/lib/pdu_sms/originating_address.rb

@@ -0,0 +1,57 @@
+module PduSms
+  class OriginatingAddress < Phone
+
+    def initialize(type=false, data=false, number_play_identifier=false, type_number=false)
+      if type == :decode_sc
+        _set_pdu_hex OriginatingAddress.cut_off_pdu(data, :current, :sc)
+      elsif type == :encode_sc
+        _set_phone_number data, number_play_identifier, type_number
+      end
+    end
+
+    def OriginatingAddress.encode_sc(phone, number_play_identifier=false, type_number=false)
+      new(:encode_sc, phone, number_play_identifier, type_number)
+    end
+
+    def OriginatingAddress.decode_sc(pdu)
+      new(:decode_sc, pdu).freeze
+    end
+
+    def OriginatingAddress.cut_off_pdu(pdu, part=:all, type=:sc) # tail current
+      part_pdu = PDUType.cut_off_pdu(pdu, :tail)
+      raise ArgumentError, 'The "pdu" is incorrect' if part_pdu.length < 4
+      length = part_pdu[0..1].to_i(16)
+      if length % 2 == 0
+        current = part_pdu[0..length+3]
+        tail = part_pdu[length+4..-1]
+      else
+        current = part_pdu[0..length+4]
+        tail = part_pdu[length+5..-1]
+      end
+      case part
+        when :current then current
+        when :tail then tail
+        else [current,tail]
+      end
+    end
+
+    def get_hex
+      '%s%s' % [_address_length, _get_hex_type_and_phone]
+    end
+
+    private
+
+    def _set_pdu_hex(str_pdu)
+      _set_hex_type_and_phone(str_pdu[2..-1])
+      self
+    end
+
+    def _address_length
+      if @number_plan_identifier == ID_ALPHANUMERIC
+        '%02x' % (@phone_number.length * 0.875 * 2).round
+      else
+        '%02x' %  @phone_number.length
+      end
+    end
+  end
+end

data/lib/pdu_sms/packet_data_unit.rb

@@ -0,0 +1,126 @@
+
+module PduSms
+
+  class PacketDataUnit
+
+    attr_reader(:sca,:service_center_address,:pdu_type,:mr,:message_reference,:da,:destination_address,
+                :pid,:protocol_identifier,:dcs,:data_coding_scheme,:vp,:validity_period,:udl,:user_data_length,:ud,:user_data,
+                :oa,:originating_address,:scts,:service_center_time_stamp)
+
+    def initialize(sca: false, pdu_type: false, mr: false, da: false, pid: false, dcs: false, vp: false, udl: false, ud: false, oa: false, scts: false)
+      raise ArgumentError, 'sca parameter should contain an object of class ServiceCenterAddress' unless ServiceCenterAddress == sca.class
+      raise ArgumentError, 'pdu_type parameter should contain an object of class PDUType' unless PDUType == pdu_type.class
+      raise ArgumentError, 'mr parameter should contain an object of class MessageReference' unless mr == false or MessageReference == mr.class
+      raise ArgumentError, 'da parameter should contain an object of class DestinationAddress' unless da == false or DestinationAddress == da.class
+      raise ArgumentError, 'pid parameter should contain an object of class ProtocolIdentifier' unless ProtocolIdentifier == pid.class
+      raise ArgumentError, 'dcs parameter should contain an object of class DataCodingScheme' unless DataCodingScheme == dcs.class
+      raise ArgumentError, 'vp parameter should contain an object of class ValidityPeriod' unless vp == false or ValidityPeriod == vp.class
+      raise ArgumentError, 'udl parameter should contain an object of class UserDataLength' unless UserDataLength == udl.class
+      raise ArgumentError, 'ud parameter should contain an object of class UserData' unless UserData == ud.class
+      raise ArgumentError, 'oa parameter should contain an object of class OriginatingAddress' unless oa == false or OriginatingAddress == oa.class
+      raise ArgumentError, 'scts parameter should contain an object of class ServiceCenterTimeStamp' unless scts == false or ServiceCenterTimeStamp == scts.class
+      @sca = @service_center_address = sca
+      @pdu_type = pdu_type
+      @mr = @message_reference = mr
+      @da = @destination_address = da
+      @pid = @protocol_identifier = pid
+      @dcs = @data_coding_scheme = dcs
+      @vp = @validity_period = vp
+      @udl = @user_data_length = udl
+      @ud = @user_data = ud
+      @oa = @originating_address = oa
+      @scts = @service_center_time_stamp = scts
+    end
+
+    def PacketDataUnit.encode_ms(phone, message, coding: :auto, phone_npi: false, phone_ton: false, sca: false, sca_npi: false, sca_ton: false, rp: REPLY_PATH_0, srr: STATUS_REPORT_REQUEST_0, vp: false, rd: REJECT_DUPLICATES_0, message_class: false, compressed: UNCOMPRESSED)
+      user_data_array = UserData.encode_ms(message, coding)
+      user_data_array.collect.each_with_index do |user_data, current_num_pdu|
+        service_center_address = ServiceCenterAddress.encode_ms(sca, sca_npi, sca_ton)
+        destination_address = DestinationAddress.encode_ms(phone, phone_npi, phone_ton)
+        protocol_identifier = ProtocolIdentifier.encode_ms
+        message_reference = MessageReference.encode_ms(current_num_pdu)
+        validity_period = ValidityPeriod.encode_ms(vp)
+        pdu_type = PDUType.encode_ms(rp:rp, srr:srr, rd:rd, udhi: user_data.get_udh, vpf: validity_period.is_setup)
+        data_coding_scheme = DataCodingScheme.encode_ms(compressed: compressed, message_class: message_class, alphabet: user_data.get_coding)
+        user_data_length = UserDataLength.encode_ms(user_data)
+        new(sca: service_center_address, pdu_type: pdu_type, mr: message_reference, da: destination_address, pid: protocol_identifier, dcs: data_coding_scheme, vp: validity_period, udl: user_data_length, ud: user_data).freeze
+      end
+    end
+
+    def PacketDataUnit.decode_ms(pdu)
+      service_center_address = ServiceCenterAddress.decode_ms(pdu)
+      pdu_type = PDUType.decode_ms(pdu)
+      message_reference = MessageReference.decode_ms(pdu)
+      destination_address = DestinationAddress.decode_ms(pdu)
+      protocol_identifier = ProtocolIdentifier.decode_ms(pdu)
+      data_coding_scheme = DataCodingScheme.decode_ms(pdu)
+      validity_period = ValidityPeriod.decode_ms(pdu)
+      user_data_length = UserDataLength.decode_ms(pdu)
+      user_data = UserData.decode_ms(pdu)
+      new(sca: service_center_address, pdu_type: pdu_type, mr: message_reference, da: destination_address, pid: protocol_identifier, dcs: data_coding_scheme, vp: validity_period, udl: user_data_length, ud: user_data).freeze
+    end
+
+    def PacketDataUnit.encode_sc(sca, phone, message, coding: :auto, sca_npi: false, sca_ton: false, phone_npi: false, phone_ton: false, rp: REPLY_PATH_0, sri: STATUS_REPORT_INDICATION_0, mms: MORE_MESSAGES_TO_SEND_0, message_class: false, compressed: UNCOMPRESSED, scts: Time.now.getutc.to_i)
+      user_data_array = UserData.encode_sc(message, coding)
+      user_data_array.collect do |user_data|
+        service_center_address = ServiceCenterAddress.encode_sc(sca, sca_npi, sca_ton)
+        pdu_type = PDUType.encode_sc(rp: rp, udhi: user_data.get_udh, sri: sri, mms: mms)
+        originating_address = OriginatingAddress.encode_sc(phone, phone_npi, phone_ton)
+        protocol_identifier = ProtocolIdentifier.encode_sc
+        data_coding_scheme = DataCodingScheme.encode_sc(compressed: compressed, message_class: message_class, alphabet: user_data.get_coding)
+        service_center_time_stamp = ServiceCenterTimeStamp.encode_sc(scts)
+        user_data_length = UserDataLength.encode_sc(user_data)
+        new(sca: service_center_address, pdu_type: pdu_type, pid: protocol_identifier, dcs: data_coding_scheme, udl: user_data_length, ud: user_data, oa: originating_address, scts: service_center_time_stamp).freeze
+      end
+    end
+
+    def PacketDataUnit.decode_sc(pdu)
+      service_center_address = ServiceCenterAddress.decode_sc(pdu)
+      pdu_type = PDUType.decode_sc(pdu)
+      originating_address = OriginatingAddress.decode_sc(pdu)
+      protocol_identifier = ProtocolIdentifier.decode_sc(pdu)
+      data_coding_scheme = DataCodingScheme.decode_sc(pdu)
+      service_center_time_stamp = ServiceCenterTimeStamp.decode_sc(pdu)
+      user_data_length = UserDataLength.decode_sc(pdu)
+      user_data = UserData.decode_sc(pdu)
+      new(sca: service_center_address, pdu_type: pdu_type, pid: protocol_identifier, dcs: data_coding_scheme, udl: user_data_length, ud: user_data, oa: originating_address, scts: service_center_time_stamp).freeze
+    end
+
+    def PacketDataUnit.decode(pdu)
+      pdu_type = PDUType.decode(pdu)
+      if pdu_type.message_type_indicator_in?
+        decode_sc(pdu)
+      elsif pdu_type.message_type_indicator_out?
+        decode_ms(pdu)
+      else
+        raise ArgumentError, 'failed to recognize the type of package'
+      end
+    end
+
+    def get_hex
+      if @pdu_type.message_type_indicator_out?
+        '' << @sca.get_hex << @pdu_type.get_hex << @mr.get_hex << @da.get_hex << @pid.get_hex << @dcs.get_hex << @vp.get_hex << @udl.get_hex << @ud.get_hex
+      elsif @pdu_type.message_type_indicator_in?
+        '' << @sca.get_hex << @pdu_type.get_hex << @oa.get_hex << @pid.get_hex << @dcs.get_hex << @scts.get_hex << @udl.get_hex << @ud.get_hex
+      else
+        raise PacketDataUnitError, 'oops SMS-SUBMIT not supported by this version of the library'
+      end
+    end
+
+    def get_message
+      @ud.get_message
+    end
+
+    def get_phone_number
+      if @pdu_type.message_type_indicator_out?
+        @da.get_phone_number
+      elsif @pdu_type.message_type_indicator_in?
+        @oa.get_phone_number
+      else
+        raise PacketDataUnitError, 'oops SMS-SUBMIT not supported by this version of the library'
+      end
+    end
+
+  end
+end
+

data/lib/pdu_sms/packet_data_unit_error.rb

@@ -0,0 +1,2 @@
+class PacketDataUnitError < StandardError
+end

data/lib/pdu_sms/pdu_type.rb

@@ -0,0 +1,179 @@
+module PduSms
+  class PDUType
+
+    def initialize(type, rp: REPLY_PATH_0, udhi: USER_DATA_HEADER_INCLUDED_0, mti: MESSAGE_TYPE_INDICATOR_01, vpf: false, srr: false, sri: false, rd: false, mms: false)
+      raise ArgumentError, 'The "rp" is incorrect' unless (REPLY_PATH_0..REPLY_PATH_1).include?(rp)
+      raise ArgumentError, 'The "udhi" is incorrect' unless (USER_DATA_HEADER_INCLUDED_0..USER_DATA_HEADER_INCLUDED_1).include?(udhi)
+      raise ArgumentError, 'The "mti" is incorrect' unless (MESSAGE_TYPE_INDICATOR_00..MESSAGE_TYPE_INDICATOR_11).include?(mti)
+      if mti == MESSAGE_TYPE_INDICATOR_01
+        raise ArgumentError, 'The "srr" is incorrect' unless (STATUS_REPORT_REQUEST_0..STATUS_REPORT_REQUEST_1).include?(srr)
+        raise ArgumentError, 'The "vpf" is incorrect' unless (VALIDITY_PERIOD_FORMAT_00..VALIDITY_PERIOD_FORMAT_11).include?(vpf)
+        raise ArgumentError, 'The "rd" is incorrect' unless (REJECT_DUPLICATES_0..REJECT_DUPLICATES_1).include?(rd)
+      elsif mti == MESSAGE_TYPE_INDICATOR_00
+        raise ArgumentError, 'The "sri" is incorrect' unless (STATUS_REPORT_INDICATION_0..STATUS_REPORT_INDICATION_1).include?(sri)
+        raise ArgumentError, 'The "mms" is incorrect' unless (MORE_MESSAGES_TO_SEND_0..MORE_MESSAGES_TO_SEND_1).include?(mms)
+      end
+      @rp = rp
+      @udhi = udhi
+      @srr = srr
+      @vpf = vpf
+      @rd = rd
+      @mti = mti
+      @mms = mms
+      @sri = sri
+    end
+
+    def PDUType.encode(rp: REPLY_PATH_0, udhi: USER_DATA_HEADER_INCLUDED_0, srr: STATUS_REPORT_REQUEST_0, vpf: VALIDITY_PERIOD_FORMAT_00, rd: REJECT_DUPLICATES_0, mti: MESSAGE_TYPE_INDICATOR_01, sri: STATUS_REPORT_INDICATION_0, mms:MORE_MESSAGES_TO_SEND_0)
+      if mti == MESSAGE_TYPE_INDICATOR_01
+        PDUType.encode_ms(rp:rp,udhi:udhi, srr:srr, vpf:vpf, rd:rd)
+      elsif mti == MESSAGE_TYPE_INDICATOR_00
+        PDUType.encode_sc(rp:rp, udhi:udhi, sri:sri, mms:mms)
+      elsif mti == MESSAGE_TYPE_INDICATOR_10
+        raise PacketDataUnitError, 'oops SMS-SUBMIT not supported by this version of the library'
+      end
+    end
+
+    def PDUType.decode(pdu_str)
+      pdu = '%08b' % PDUType.cut_off_pdu(pdu_str, :current, :ms)
+      mti = pdu[6..7].to_i(2)
+      if mti == MESSAGE_TYPE_INDICATOR_00
+        PDUType.decode_sc(pdu_str)
+      elsif mti == MESSAGE_TYPE_INDICATOR_01
+        PDUType.decode_ms(pdu_str)
+      elsif mti == MESSAGE_TYPE_INDICATOR_10
+        raise PacketDataUnitError, 'oops SMS-SUBMIT not supported by this version of the library'
+      else
+        raise PacketDataUnitError, 'format error'
+      end
+    end
+
+    def PDUType.encode_ms(rp: REPLY_PATH_0, udhi: USER_DATA_HEADER_INCLUDED_0, srr: STATUS_REPORT_REQUEST_0, vpf: VALIDITY_PERIOD_FORMAT_00, rd: REJECT_DUPLICATES_0)
+      new(:encode_ms, rp:rp, udhi:udhi, srr:srr, vpf:vpf, rd:rd, mti:MESSAGE_TYPE_INDICATOR_01).freeze
+    end
+
+    def PDUType.decode_ms(pdu_str)
+      pdu = '%08b' % PDUType.cut_off_pdu(pdu_str, :current, :ms).to_i(16)
+      raise ArgumentError, 'wrong format "PDU" package' if pdu[6..7].to_i(2) != MESSAGE_TYPE_INDICATOR_01
+      new(:decode_ms, rp:pdu[0].to_i(2), udhi:pdu[1].to_i(2), srr:pdu[2].to_i(2), vpf:pdu[3..4].to_i(2), rd:pdu[5].to_i(2), mti:MESSAGE_TYPE_INDICATOR_01).freeze
+    end
+
+    def PDUType.encode_sc(rp: REPLY_PATH_0, udhi: USER_DATA_HEADER_INCLUDED_0, sri: STATUS_REPORT_INDICATION_0, mms:MORE_MESSAGES_TO_SEND_0)
+      new(:encode_ms, rp:rp, udhi:udhi, sri:sri, mms:mms, mti:MESSAGE_TYPE_INDICATOR_00).freeze
+    end
+
+    def PDUType.decode_sc(pdu_str)
+      pdu = '%08b' % PDUType.cut_off_pdu(pdu_str, :current, :sc).to_i(16)
+      raise ArgumentError, 'wrong format "PDU" package' if pdu[6..7].to_i(2) != MESSAGE_TYPE_INDICATOR_00
+      new(:decode_ms, rp:pdu[0].to_i(2), udhi:pdu[1].to_i(2), sri:pdu[2].to_i(2), mms:pdu[5].to_i(2), mti:MESSAGE_TYPE_INDICATOR_00).freeze
+    end
+
+    def PDUType.cut_off_pdu(pdu, part=:all, type=:ms) # tail current
+      part_pdu = ServiceCenterAddress.cut_off_pdu(pdu, :tail)
+      raise TypeError.new('Слишком короткая строка') if part_pdu.length < 2
+      current = part_pdu[0..1]
+      tail = part_pdu[2..-1]
+      case part
+        when :current then current
+        when :tail then tail
+        else [current,tail]
+      end
+    end
+
+    def reply_path?
+      @rp == REPLY_PATH_1
+    end
+
+    def user_data_header_included?
+      @udhi == USER_DATA_HEADER_INCLUDED_1
+    end
+
+    def status_report_request?
+      @srr == STATUS_REPORT_REQUEST_1
+    end
+
+    def validity_period_format_off?
+      @vpf == VALIDITY_PERIOD_FORMAT_00
+    end
+
+    def validity_period_format_reserve?
+      @vpf == VALIDITY_PERIOD_FORMAT_01
+    end
+
+    def validity_period_format_relative?
+      @vpf == VALIDITY_PERIOD_FORMAT_10
+    end
+
+    def validity_period_format_absolute?
+      @vpf == VALIDITY_PERIOD_FORMAT_11
+    end
+
+    def reject_duplicates?
+      @rd == REJECT_DUPLICATES_1
+    end
+
+    def message_type_indicator_in?
+      @mti == MESSAGE_TYPE_INDICATOR_00
+    end
+
+    def message_type_indicator_out?
+      @mti == MESSAGE_TYPE_INDICATOR_01
+    end
+
+    def message_type_indicator_report?
+      @mti == MESSAGE_TYPE_INDICATOR_10
+    end
+
+    def message_type_indicator_reserve?
+      @mti == MESSAGE_TYPE_INDICATOR_11
+    end
+
+    def more_messages_to_send?
+      @mms == MORE_MESSAGES_TO_SEND_1
+    end
+
+    def status_report_indication?
+      @sri == STATUS_REPORT_INDICATION_1
+    end
+
+    def get_reply_path
+      '%b' % @rp
+    end
+
+    def get_user_data_header_included
+      '%b' % @udhi
+    end
+
+    def get_status_report_request
+      '%b' % @srr
+    end
+
+    def get_validity_period_format
+      '%02b' % @vpf
+    end
+
+    def get_reject_duplicates
+      '%b' % @rd
+    end
+
+    def get_message_type_indicator
+      '%02b' % @mti
+    end
+
+    def get_status_report_indication
+      '%b' % @sri
+    end
+
+    def get_more_messages_to_send
+      '%b' % @mms
+    end
+
+    def get_hex
+      if message_type_indicator_out?
+        '%02x' % [('' << get_reply_path << get_user_data_header_included << get_status_report_request << get_validity_period_format << get_reject_duplicates << get_message_type_indicator).to_i(2)]
+      elsif message_type_indicator_in?
+        '%02x' % [('' << get_reply_path << get_user_data_header_included << get_status_report_indication << '00' << get_more_messages_to_send << get_message_type_indicator).to_i(2)]
+      end
+    end
+
+  end
+end

data/lib/pdu_sms/phone.rb

@@ -0,0 +1,121 @@
+module PduSms
+
+  class Phone
+
+    attr_reader(:number_plan_identifier, :type_number)
+
+    @phone_number = ''
+    @number_plan_identifier = false
+    @type_number = false
+
+    def get_phone_number
+      if @number_plan_identifier == ID_INTERNATIONAL
+        '+%s' % @phone_number
+      else
+        '%s' % @phone_number
+      end
+    end
+
+    protected
+
+    def _auto_detect(phone_number)
+      if /^\+\d+$/ === phone_number
+        @number_plan_identifier = ID_INTERNATIONAL
+        @type_number = TP_ISDN
+      elsif /^\d+$/ === phone_number
+        @number_plan_identifier = ID_UNKNOWN
+        @type_number = TP_ISDN
+      elsif is_7bit?(phone_number)
+        @number_plan_identifier = ID_ALPHANUMERIC
+        @type_number = TP_UNKNOWN
+      else
+        raise PacketDataUnitError, 'Could not automatically determine the type of phone number'
+      end
+      self
+    end
+
+    def _check_phone?
+      if @number_plan_identifier == ID_ALPHANUMERIC
+        is_7bit?(@phone_number)
+      else
+        /^\d+$/ === @phone_number
+      end
+    end
+
+    def _get_hex_type_and_phone
+      if @number_plan_identifier == ID_ALPHANUMERIC
+        '%s%s' % [_type_of_address_hex, encode_7bit(@phone_number)]
+      else
+        '%s%s' % [_type_of_address_hex, _convert_to_bcd_format]
+      end
+    end
+
+    def _set_phone_number(phone_number, number_play_identifier=false, type_number=false)
+      if number_play_identifier == false or type_number == false
+        _auto_detect(phone_number)
+      else
+        raise ArgumentError, 'Incorrect type of phone number' unless (TP_UNKNOWN..TP_RESERVED).include?(type_number)
+        raise ArgumentError, 'Invalid type id telephone' unless (ID_UNKNOWN..ID_RESERVED).include?(number_play_identifier)
+        @type_number = type_number
+        @number_plan_identifier = number_play_identifier
+      end
+
+      if @number_plan_identifier == ID_INTERNATIONAL and phone_number[0] == '+'
+        @phone_number = phone_number[1..-1]
+      else
+        @phone_number = phone_number
+      end
+
+      unless _check_phone?
+        @phone_number = ''
+        raise ArgumentError, 'Phone number is invalid'
+      end
+      self
+    end
+
+    private
+
+    def _set_hex_type_and_phone(bcd)
+      _convert_to_normal_format bcd
+      unless _check_phone?
+        @phone_number = ''
+        raise ArgumentError, 'Phone number is invalid'
+      end
+      self
+    end
+
+    def _convert_to_bcd_format
+      if @phone_number[0] == ?+
+        clear_phone = @phone_number[1..-1]
+      else
+        clear_phone = @phone_number
+      end
+      if clear_phone.length % 2 != 0
+        clear_phone += 'F'
+      end
+      encode_bcd(clear_phone)
+    end
+
+    def _convert_to_normal_format(bcd)
+      @phone_number = ''
+      if bcd.length < 4
+        raise ArgumentError, 'Wrong format'
+      end
+      raise ArgumentError, 'Incorrect number plan identifier' unless (128..255).include?(bcd[0..1].to_i(16))
+      number_type = '%08b' % bcd[0..1].to_i(16)
+      @number_plan_identifier = number_type[1..3].to_i(2)
+      @type_number = number_type[4..7].to_i(2)
+      if @number_plan_identifier == ID_ALPHANUMERIC
+        @phone_number = decode_7bit(bcd[2..-1])
+      else
+        @phone_number = decode_bcd(bcd[2..-1])[/[fF]$/] ? decode_bcd(bcd[2..-1])[0..-2] : decode_bcd(bcd[2..-1])
+      end
+      self
+    end
+
+    def _type_of_address_hex
+      '%02x' % ('1%03b%04b' % [@number_plan_identifier, @type_number]).to_i(2)
+    end
+
+  end
+end