pdu_sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f34b8435129509cbab1543cb0101fa93e625d775
+  data.tar.gz: 43bb228bf0e9b952ce8f429cb80121e34276fac4
+SHA512:
+  metadata.gz: 17cb43eacb25768c6a4588528bf873673189625bddcbb962ce0e49e8fef7c78fd280c36b82d1668b40b40d7081f12d11799e85406ce53728c0378741d6ebf22b
+  data.tar.gz: d0f1408ac21dad2960554d46c6b3a621f098ce33e2703328ffc85fad1e9c3623b1e6fd6531fa7b435b5a9b8eabb23272fd577546d0762c55b27bc39f5f3601e6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdu_sms.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mikhail Stolyarov <schnack.desu@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# PduSms
+
+## Description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    ruby gem 'pdu_sms'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdu_sms
+
+## Usage
+
+    include PduSms
+    # MS(Mobile Station) => SC(SMS Center)
+    encode_pdu_ms = PacketDataUnit.encode_ms('+71234567890', 'Hello!!!')
+    encode_pdu_ms[0].get_hex            #=> "0001000b911732547698F0000008C8329BFD0E8542"
+    encode_pdu_ms[0].get_message        #=> "Hello!!!"
+    encode_pdu_ms[0].get_phone_number   #=> "+71234567890"
+    
+    decode_pdu_ms = PacketDataUnit.decode('0001000b911732547698F0000008C8329BFD0E8542')
+    decode_pdu_ms.get_hex               #=> "0001000b911732547698F0000008C8329BFD0E8542"
+    decode_pdu_ms.get_message           #=> "Hello!!!"
+    decode_pdu_ms.get_phone_number      #=> "+71234567890"
+    
+    # SC => MS
+    encode_pdu_sc = PacketDataUnit.encode_sc('+71234567890', 'Tele2', 'hello!!!')
+    encode_pdu_sc[0].get_hex            #=> "07911732547698F00009d0D432BB2C0300005111713115142108E8329BFD0E8542"
+    encode_pdu_sc[0].get_message        #=> "hello!!!"
+    encode_pdu_sc[0].get_phone_number   #=> "Tele2"
+    
+    decode_pdu_sc = PacketDataUnit.decode('07911732547698F00009d0D432BB2C0300005111713115142108E8329BFD0E8542')
+    decode_pdu_sc.get_hex               #=> "07911732547698F00009d0D432BB2C0300005111713115142108E8329BFD0E8542"
+    decode_pdu_sc.get_message           #=> "hello!!!"
+    decode_pdu_sc.get_phone_number      #=> "Tele2"
+    
+    
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schnack/pdu_sms.
+
+## License
+
+MTI
+
+## Authors
+
+* Mikhail Stolyarov <schnack.desu@gmail.com>

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'Spec all functionality of gem'
+task :spec_all do
+  system("rspec spec/*/")
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdu_sms"
+require "irb"
+
+include PduSms
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pdu_sms.rb

@@ -0,0 +1,99 @@
+require 'pdu_sms/helpers'
+require 'pdu_sms/phone'
+require 'pdu_sms/data_coding_scheme'
+require 'pdu_sms/destination_address'
+require 'pdu_sms/message_reference'
+require 'pdu_sms/packet_data_unit'
+require 'pdu_sms/pdu_type'
+require 'pdu_sms/protocol_identifier'
+require 'pdu_sms/service_center_address'
+require 'pdu_sms/user_data'
+require 'pdu_sms/user_data_length'
+require 'pdu_sms/validity_period'
+require 'pdu_sms/originating_address'
+require 'pdu_sms/service_center_time_stamp'
+require 'pdu_sms/packet_data_unit_error'
+require 'pdu_sms/version'
+
+module PduSms
+
+  include Helpers
+  ##
+  # Type of number (TON):
+  ID_UNKNOWN = 0b000                    # Unknown
+  ID_INTERNATIONAL = 0b001              # International number
+  ID_NATIONAL = 0b010                   # National number
+  ID_NETWORK = 0b011                    # Network specific number
+  ID_SUBSCRIBER = 0b100                 # Subscriber number
+  ID_ALPHANUMERIC = 0b101               # Alphanumeric, (coded according to 3GPP TS 23.038 [9] GSM 7 bit default alphabet)
+  ID_ABBREVIATED = 0b110                # Abbreviated number
+  ID_RESERVED = 0b111                   # Reserved for extension
+
+  ##
+  # Numbering plan identification (NPI):
+  TP_UNKNOWN = 0b0000                   # Unknown
+  TP_ISDN = 0b0001                      # ISDN/telephone numbering plan (E.164/E.163)
+  TP_DATA = 0b0011                      # Data numbering plan (X.121)
+  TP_TELEX = 0b100                      # Telex numbering plan
+  TP_SERVICE_CENTER_SPECIFIC1 = 0b0101  # Service Centre Specific plan 1)
+  TP_SERVICE_CENTER_SPECIFIC2 = 0b0110  # Service Centre Specific plan 1)
+  TP_NATIONAL = 0b1000                  # National numbering plan
+  TP_PRIVATE = 0b1001                   # Private numbering plan
+  TP_ERMES = 0b1010                     # ERMES numbering plan (ETSI DE/PS 3 01 3)
+  TP_RESERVED = 0b1111                  # Reserved for extension
+
+  ##
+  # Protocol Identifier
+  PROTOCOL_IDENTIFIER = 0x00            # Default store and forward short message
+
+  ##
+  # Data Coding Scheme
+  #6,7 bit
+  BIT0 = 0b00                           # Default
+  COMPRESSED = 0b1                      # Indicates the text is compressed using the GSM standard compression algorithm
+  UNCOMPRESSED = 0b0                    # Indicates the text is uncompressed
+  MESSAGE_CLASS_OFF = 0b0               #
+  MESSAGE_CLASS_ON= 0b1                 #
+  ALPHABET_7BIT = 0b00                  # GSM 7 bit
+  ALPHABET_8BIT = 0b01                  # 8 bit data
+  ALPHABET_16BIT = 0b10                 # UCS2(16bit)
+  RESERVED = 0b11                       # Reserved
+  CLASS_0_IMMEDIATE_DISPLAY = 0b00      # Flash messages are received by a mobile phone even though it has full memory. They are not stored in the phone, they just displayed on the phone display.
+  CLASS_1_ME_SPECIFIC = 0b01            # ME-specific
+  CLASS_2_SIM_SPECIFIC = 0b10           # SIM / USIM specific
+  CLASS_3_TE_SPECIFIC = 0b11            # TE-specific
+
+  ##
+  # PDU TYPE
+  # @rp
+  REPLY_PATH_0 = 0b0                    # Reply Path parameter is not set in this SMS-SUBMIT
+  REPLY_PATH_1 = 0b1                    # Reply Path parameter is set in this SMS-SUBMIT
+  # @udhi
+  USER_DATA_HEADER_INCLUDED_0 = 0b0     # User Data field contains only the short message
+  USER_DATA_HEADER_INCLUDED_1 = 0b1     # The beginning of the UD field contains a Header in addition to the short message
+  # @srr
+  STATUS_REPORT_REQUEST_0 = 0b0         # A status report is not requested
+  STATUS_REPORT_REQUEST_1 = 0b1         # A status report is requested
+  # @vpf
+  VALIDITY_PERIOD_FORMAT_00 = 0b00      # Validity Period not present
+  VALIDITY_PERIOD_FORMAT_01 = 0b01      # Validity Period present- relative format
+  VALIDITY_PERIOD_FORMAT_10 = 0b10      # Validity Period present - enhanced format (reserved)
+  VALIDITY_PERIOD_FORMAT_11 = 0b11      # Validity Period present - absolute format
+  # @rd
+  REJECT_DUPLICATES_0 = 0b0             # Instruct the SC to accept SMS-SUBMIT for a SM still held in the SC which has the same MR and the same DA as a previously submitted SM from the same OA
+  REJECT_DUPLICATES_1 = 0b1             # Instruct the SC to reject an SMS-SUBMIT for an SM still held in the SC which has the same MR and the same DA as the previously submitted SM from the same OA. In this case an appropriate FCS value will be returned in the SMS-SUBMIT-REPORT
+  # @mti
+  MESSAGE_TYPE_INDICATOR_00 = 0b00      # SMS-DELIVER (in the direction SC to MS) SMS-DELIVER REPORT (in the direction MS to SC)
+  MESSAGE_TYPE_INDICATOR_01 = 0b01      # SMS-STATUS-REPORT (in the direction SC to MS) SMS-COMMAND (in the direction MS to SC)
+  MESSAGE_TYPE_INDICATOR_10 = 0b10      # SMS-SUBMIT (in the direction MS to SC) SMS-SUBMIT-REPORT (in the direction SC to MS)
+  MESSAGE_TYPE_INDICATOR_11 = 0b11      # Reserved
+
+  MORE_MESSAGES_TO_SEND_0 = 0b0         # More Message are waiting for the MS in the SMSC
+  MORE_MESSAGES_TO_SEND_1 = 0b1         # No more Message are waiting for the MS in the SMSC
+
+  STATUS_REPORT_INDICATION_0 = 0b0      # A status report will not be returned to the SME
+  STATUS_REPORT_INDICATION_1 = 0b1      # A status report will be returned to the SME
+
+end
+
+

data/lib/pdu_sms/data_coding_scheme.rb

@@ -0,0 +1,120 @@
+module PduSms
+
+  class DataCodingScheme
+
+    def initialize(type, compressed: UNCOMPRESSED, message_class: false, alphabet: ALPHABET_16BIT)
+      raise ArgumentError, 'The "compresses" is incorrect' unless compressed and (UNCOMPRESSED..COMPRESSED).include?(compressed)
+      raise ArgumentError, 'The "alphabet" is incorrect' unless alphabet and (ALPHABET_7BIT..RESERVED).include?(alphabet)
+      @compressed = compressed
+      @alphabet = alphabet
+      if message_class
+        if (CLASS_0_IMMEDIATE_DISPLAY..CLASS_3_TE_SPECIFIC).include?(message_class)
+          @message_class_trigger = MESSAGE_CLASS_ON
+          @message_class = message_class
+        else
+          raise ArgumentError, 'The "message_class" is incorrect'
+        end
+      else
+        @message_class_trigger = MESSAGE_CLASS_OFF
+        @message_class = 0b00
+      end
+    end
+
+    def DataCodingScheme.encode_ms(compressed: UNCOMPRESSED, message_class: false, alphabet: ALPHABET_16BIT)
+      new(:encode_ms, compressed:compressed, message_class:message_class, alphabet:alphabet).freeze
+    end
+
+    def DataCodingScheme.decode_ms(pdu_str)
+      pdu = '%08b' % DataCodingScheme.cut_off_pdu(pdu_str, :current, :ms).to_i(16)
+      message_class = (pdu[1].to_i == MESSAGE_CLASS_ON) ? pdu[6..7].to_i(2) : false
+      new(:decode_ms, compressed:pdu[2].to_i(2), message_class:message_class, alphabet:pdu[4..5].to_i(2)).freeze
+    end
+
+    def DataCodingScheme.encode_sc(compressed: UNCOMPRESSED, message_class: false, alphabet: ALPHABET_16BIT)
+      new(:encode_sc, compressed:compressed, message_class:message_class, alphabet:alphabet).freeze
+    end
+
+    def DataCodingScheme.decode_sc(pdu_str)
+      pdu = '%08b' % DataCodingScheme.cut_off_pdu(pdu_str, :current, :sc).to_i(16)
+      message_class = (pdu[1].to_i == MESSAGE_CLASS_ON) ? pdu[6..7].to_i(2) : false
+      new(:decode_sc, compressed:pdu[2].to_i(2), message_class:message_class, alphabet:pdu[4..5].to_i(2)).freeze
+    end
+
+    def DataCodingScheme.cut_off_pdu(pdu, part=:all, type=:ms) # tail current
+      part_pdu = ProtocolIdentifier.cut_off_pdu(pdu, :tail, type)
+      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 compressed?
+      @compressed == COMPRESSED
+    end
+
+    def alphabet_7bit?
+      @alphabet == ALPHABET_7BIT
+    end
+
+    def alphabet_8bit?
+      @alphabet == ALPHABET_8BIT
+    end
+
+    def alphabet_16bit?
+      @alphabet == ALPHABET_16BIT
+    end
+
+    def alphabet_reserved?
+      @alphabet == RESERVED
+    end
+
+    def message_class?
+      @message_class_trigger == MESSAGE_CLASS_ON
+    end
+
+    def message_class_immediate_display?
+      @message_class == CLASS_0_IMMEDIATE_DISPLAY
+    end
+
+    def message_class_me?
+      @message_class == CLASS_1_ME_SPECIFIC
+    end
+
+    def message_class_sim?
+      @message_class == CLASS_2_SIM_SPECIFIC
+    end
+
+    def message_class_te?
+      @message_class == CLASS_3_TE_SPECIFIC
+    end
+
+    def get_compressed
+      '%b' % @compressed
+    end
+
+    def get_alphabet
+      '%02b' % @alphabet
+    end
+
+    def get_message_class_trigger
+      '%b' % @message_class_trigger
+    end
+
+    def get_message_class
+      '%02b' % @message_class
+    end
+
+    def get_bit0
+      '%02b' % BIT0
+    end
+
+    def get_hex
+      '%02x' % (get_bit0 << get_compressed << get_message_class_trigger << get_alphabet << get_message_class).to_i(2)
+    end
+
+  end
+end

data/lib/pdu_sms/destination_address.rb

@@ -0,0 +1,57 @@
+module PduSms
+  class DestinationAddress < Phone
+
+    def initialize(type=false, data=false, number_play_identifier=false, type_number=false)
+      if type == :decode_ms
+        _set_pdu_hex data
+      elsif type == :encode_ms
+        _set_phone_number data, number_play_identifier, type_number
+      end
+    end
+
+    def DestinationAddress.encode_ms(phone_number, number_play_identifier=false, type_number=false)
+      new(:encode_ms, phone_number, number_play_identifier, type_number).freeze
+    end
+
+    def DestinationAddress.decode_ms(pdu)
+      new(:decode_ms, DestinationAddress.cut_off_pdu(pdu, :current, :ms)).freeze
+    end
+
+    def DestinationAddress.cut_off_pdu(pdu, part=:all, type=:ms) # tail current
+      part_pdu = MessageReference.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 @phone_number[0] == ?+
+        '%02x' % (@phone_number.length - 1)
+      else
+        '%02x' % @phone_number.length
+      end
+    end
+
+  end
+end

data/lib/pdu_sms/helpers.rb

@@ -0,0 +1,67 @@
+module PduSms
+  module Helpers
+
+    def encode_bcd(str)
+      if String == str.class and str.length % 2 == 0
+        str.split('').enum_for(:each_slice, 2).to_a.collect{|array| array[0], array[1] = array[1], array[0]}.join
+      else
+        raise ArgumentError, 'The number of characters must be even'
+      end
+    end
+
+    def decode_bcd(str)
+      encode_bcd(str)
+    end
+
+    def decode_ucs2(message)
+      message.split('').enum_for(:each_slice,4).to_a.collect(&:join).collect {|o| o.to_i(16).chr(Encoding::UTF_8)}.join
+    end
+
+    def encode_ucs2(message)
+      message.chars.to_a.collect {|char| "%04X" % char.ord}.join
+    end
+
+    def is_7bit?(message)
+      /^[A-Za-z0-9\@£\$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ\!\"#¤\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?¡¿ÄÖÑܧäöñüà\^\{\}\\\[~\]\|€]*$/ === message
+    end
+
+    def encode_7bit(string)
+      string_encode = []
+      string.chars.each_slice(8).each do |chars|
+        chars.each_with_index do |char, i|
+          bit_char = '%07b' % char.ord
+          if i == 0
+            string_encode << bit_char
+          else
+            string_encode[-1] = '%s%s' % [bit_char[-i..-1], string_encode[-1]]
+            string_encode << bit_char[0..(-1-i)] if bit_char[0..(-1-i)] != ''
+          end
+        end
+      end
+      string_encode.collect {|x| '%02x' % x.to_i(2)}.join.upcase
+    end
+
+    def decode_7bit(string)
+      text = ''
+      string.split('').each_slice(2).collect {|s| '%08b' % s.join.to_i(16)}.each_slice(7) do |bytes|
+        ending = ''
+        bytes.each_with_index do |byte, i|
+          text << ('0%s%s' % [byte[i+1..-1], ending]).to_i(2).chr
+          ending = byte[0..i]
+          text << ('0%s' % ending).to_i(2).chr if i == 6 and ending.to_i(2) != 0
+        end
+      end
+      text
+    end
+
+    def encode_8bit(string)
+      string.chars.to_a.collect {|char| '%02x' % char.ord }.join
+    end
+
+    def decode_8bit(string)
+      string.split('').enum_for(:each_slice, 2).to_a.collect(&:join).collect {|char| char.to_i(16).chr}.join
+    end
+
+  end
+end
+