gsm_texting 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6371fec8250ebd69c530c37b12c254e61595bc6bb6dcb2a465e9e59042c1a77f
-  data.tar.gz: 0762b3325b76b835d0b602f3940686c664f9b0e54d5b5b90c5d1968fa1e122ed
+  metadata.gz: 933264662ecb13ee743db2c7b9910c8c037b7205c3f6f42f0c73ea845d0e3122
+  data.tar.gz: 493de2a7c06e968508c242170d24244d66da7605f4af885e96510bf28459d04f
 SHA512:
-  metadata.gz: 934653921b5a3066f027d09b510ecaf040d54ce41c51f61fc77192a37a99819e3777d2e6fdfd5cdb0c01ca6662482d8ecee2cc81849f74107caff0a5c68e5241
-  data.tar.gz: 79a077cd060273434d1e2b4f10b61f185f426bc5e3be1d90bffe7043be4282d167b3fc1b4fa4a9214ab81f7d1dd9a45399e81b3175e9c61928bc888b79439c3f
+  metadata.gz: 913eddd3409475dffe4e4950119900c94a58640cd1944fc0095a2838282e7fa5f512ff7a38c8a0d68bb8b95e9a1b75f2241f4015c124097c443cd25a02b4e806
+  data.tar.gz: 1e2205456987355c317e17ecb599fe48d56d3525718a99ae7edbd6f1abc1c184fb308f11655491bba1747bde492a600dd0651c94f2508f973bbae576085205fb

data/lib/gsm_texting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'character_constants'
 require 'compatibility_table'
 require 'conversion_table'
@@ -8,23 +10,25 @@ module GSMTexting
   include ConversionTable
   extend self
 
-  DEFAULT_REPLACE_CHAR = "?".freeze
+  class InvalidGSMString < StandardError; end
+
+  DEFAULT_REPLACE_CHAR = '?'
 
   BASIC_CHARACTER_SET = [
-    '@', 'Δ',  SP, '0', '¡', 'P', '¿', 'p',
+    '@', 'Δ', SP, '0', '¡', 'P', '¿', 'p',
     '£', '_', '!', '1', 'A', 'Q', 'a', 'q',
-    '$', 'Φ',  DQ, '2', 'B', 'R', 'b', 'r',
+    '$', 'Φ', DQ, '2', 'B', 'R', 'b', 'r',
     '¥', 'Γ', '#', '3', 'C', 'S', 'c', 's',
     'è', 'Λ', '¤', '4', 'D', 'T', 'd', 't',
     'é', 'Ω', '%', '5', 'E', 'U', 'e', 'u',
     'ù', 'Π', '&', '6', 'F', 'V', 'f', 'v',
-    'ì', 'Ψ',  SQ, '7', 'G', 'W', 'g', 'w',
+    'ì', 'Ψ', SQ, '7', 'G', 'W', 'g', 'w',
     'ò', 'Σ', '(', '8', 'H', 'X', 'h', 'x',
     'Ç', 'Θ', ')', '9', 'I', 'Y', 'i', 'y',
-     LF, 'Ξ', '*', ':', 'J', 'Z', 'j', 'z',
+    LF, 'Ξ', '*', ':', 'J', 'Z', 'j', 'z',
     'Ø', ESC, '+', ';', 'K', 'Ä', 'k', 'ä',
     'ø', 'Æ', ',', '<', 'L', 'Ö', 'l', 'ö',
-     CR, 'æ', '-', '=', 'M', 'Ñ', 'm', 'ñ',
+    CR, 'æ', '-', '=', 'M', 'Ñ', 'm', 'ñ',
     'Å', 'ß', '.', '>', 'N', 'Ü', 'n', 'ü',
     'å', 'É', '/', '?', 'O', '§', 'o', 'à'
   ].freeze
@@ -34,9 +38,19 @@ module GSMTexting
   ].freeze
 
   CHARACTER_SET_REGEX = Regexp.escape(BASIC_CHARACTER_SET.join)
-  CHARACTER_EXTENSION_REGEX = Regexp.escape(BASIC_CHARACTER_SET_EXTENSION.compact.join)
-
+  CHARACTER_EXTENSION_REGEX = Regexp.escape(BASIC_CHARACTER_SET_EXTENSION.join)
   GSM_REGEX = /\A[#{CHARACTER_SET_REGEX}#{CHARACTER_EXTENSION_REGEX}]*\z/.freeze
+  GSM_NOT_EXTENDED_REGEX = /[^#{CHARACTER_EXTENSION_REGEX}]/.freeze
+
+  GSM_SEGMENT_LENGTH = 160
+
+  # Check if string fits into a single gsm sms segment (1120 bits)
+  def single_segment?(str)
+    raise InvalidGSMString unless can_encode?(str)
+
+    extended_chars = str.gsub(GSM_NOT_EXTENDED_REGEX, '').length
+    (str.length + extended_chars) <= GSM_SEGMENT_LENGTH
+  end
 
   # Verifies if string can be encoded in GSM-7 without loosing information
   def can_encode?(str)
@@ -44,17 +58,20 @@ module GSMTexting
   end
 
   # Convert unicode chars to GSM-7 compatible equivalents if possible
-  def encode(str, transliterate: false, replace_char: nil)
+  def encode(str, transliterate: false, replace_char: nil, truncate: false)
     return if str.nil?
+
     replace_char = canonicalize_replace_char(replace_char)
 
-    str.unpack("U*").map { |char|
+    processed_str = str.unpack('U*').map do |char|
       utf8_char = char.chr(Encoding::UTF_8)
 
       compatible_char = compatible_char_for(char)
       transformed_char = transformed_char_for(char) if transliterate
       gsm_char_for(compatible_char || transformed_char || utf8_char, replace_char)
-    }.join
+    end.join
+
+    truncate ? truncate_into_single_segment(processed_str) : processed_str
   end
 
   private
@@ -74,4 +91,14 @@ module GSMTexting
   def gsm_char_for(char, replace_char)
     can_encode?(char) ? char : replace_char
   end
+
+  # Truncates string to fit into a single SMS Segment of 1120 bits
+  # Each basic character takes a septet and extended characters take two.
+  def truncate_into_single_segment(str)
+    return str if single_segment?(str)
+
+    extended_chars = str.gsub(GSM_NOT_EXTENDED_REGEX, '').length
+    final_length = GSM_SEGMENT_LENGTH - extended_chars - 3
+    str[0..final_length].concat('...')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gsm_texting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jorge Kalmbach