smstools 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 09a075d7c0f5acd2105e5a361cda66d81926f2bf
-  data.tar.gz: 24febc16536d2174a802876034baee4533cb1512
+SHA256:
+  metadata.gz: 7df349a1fd0872910cc9f6d2c23992d33807419968cbc9d68547549ef16a18bd
+  data.tar.gz: a30dd9cbb8550e475a322317b0cecdcb67c13a09f95449bf392c67d8200eb11c
 SHA512:
-  metadata.gz: 934a838ced26fa606f876deb6720e15082de09c5c845a5672a28bae2fc390e4c471b9ce18b5cf1cc43db833f5941169db182b329f3cf94e1a4b7bafff163b44d
-  data.tar.gz: f2f826aff33b5806db30a4d1882c694bb71deba907b4e75d27a6fb146937ea8603f3f38e48ab980cc44c26fbe3756ed6ebdd391e4e6ba581cb34199dde72b072
+  metadata.gz: edd17e186943ec7b89941e2eaba41279fadc39a27ee987cdb0efc3d4f8f4cbac85bb31a50afbe6d9df94fe7fd9f4498fe561861d9f60b97dd0bd39c49ed19ec8
+  data.tar.gz: b197d9070437eef8bf732134be1a9b3fcedcf71f71f95e0057d1ae214bde4c1b8d2f00769e58104df02acf776df71cf123bb34ead1d4a828c867a2ff1aae639c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1 (18 Aug 2020)
+
+* #7 Introduce `SmsTools.use_ascii_encoding` option (defaults to `true` for backwards-compatibility) that allows disabling the `:ascii` workaround encoding. See #6 and #7 for details. Thanks @kingsley-wang.
+
 ## 0.2.0 (2 March 2017)
 
 * The non-breaking space character (0x00A0 in Unicode and "\xC2\xA0" in UTF-8) is no longer regarded as a valid GSM 7-bit symbol. [#4](https://github.com/livebg/smstools/issues/4)

data/README.md

@@ -4,7 +4,7 @@ A small collection of Ruby and JavaScript classes implementing often needed func
 dealing with SMS messages.
 
 The gem can also be used in a Rails application as an engine. It integrates with the asset pipeline
-and gives you access to some clinet-side SMS manipulation functionality.
+and gives you access to some client-side SMS manipulation functionality.
 
 ## Features
 
@@ -66,6 +66,16 @@ JavaScript part of the library, like so:
     //= require sms_tools
     SmsTools.use_gsm_encoding = false;
 
+There is another alternative as well. As explained in this commit – f1ffd948d4b8c – SmsTools will by
+default detect the encoding as `:ascii` if the SMS message contains ASCII-only symbols. The safest
+way to send messages would be to use an ASCII subset of the GSM encodnig.
+
+The `:ascii` encoding is informative only, however. Your SMS sending implementation will have to
+decide how to handle it. You may also find it confusing that the dummy `:ascii` encoding does not
+consider double-byte chars at all when counting the length of the message.
+
+To disable this dummy `:ascii` encoding, set `SmsTools.use_ascii_encoding` to `false`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -183,3 +193,4 @@ assumed. It might be possible to use it in other setups as well, but you're on y
 5. Commit your changes (`git commit -am 'Add some feature'`)
 6. Push to the branch (`git push origin my-new-feature`)
 7. Send a pull request.
+

data/lib/assets/javascripts/sms_tools/message.js.coffee

@@ -43,8 +43,14 @@ class SmsTools.Message
     else
       SmsTools['use_gsm_encoding']
 
+   use_ascii_encoding: ->
+    if SmsTools['use_ascii_encoding'] == undefined
+      true
+    else
+      SmsTools['use_ascii_encoding']
+
   _encoding: ->
-    if @asciiPattern.test(@text)
+    if @asciiPattern.test(@text) and @use_ascii_encoding()
       'ascii'
     else if @use_gsm_encoding() and @gsmEncodingPattern.test(@text)
       'gsm'

data/lib/sms_tools.rb

@@ -15,5 +15,13 @@ module SmsTools
     def use_gsm_encoding=(value)
       @use_gsm_encoding = value
     end
+
+    def use_ascii_encoding?
+      @use_ascii_encoding.nil? ? true : @use_ascii_encoding
+    end
+
+    def use_ascii_encoding=(value)
+      @use_ascii_encoding = value
+    end
   end
 end

data/lib/sms_tools/encoding_detection.rb

@@ -25,7 +25,7 @@ module SmsTools
 
     def encoding
       @encoding ||=
-        if text.ascii_only?
+        if text.ascii_only? and SmsTools.use_ascii_encoding?
           :ascii
         elsif SmsTools.use_gsm_encoding? and GsmEncoding.valid?(text)
           :gsm

data/lib/sms_tools/version.rb

@@ -1,3 +1,3 @@
 module SmsTools
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/sms_tools/encoding_detection_spec.rb

@@ -56,6 +56,28 @@ describe SmsTools::EncodingDetection do
         detection_for('').encoding.must_equal :ascii
       end
     end
+
+    describe 'with SmsTools.use_ascii_encoding = false' do
+      before do
+        SmsTools.use_ascii_encoding = false
+      end
+
+      after do
+        SmsTools.use_ascii_encoding = true
+      end
+
+      it "returns GSM 03.38 as encoding for special symbols defined in GSM 03.38" do
+        detection_for('09azAZ@Δ¡¿£_!Φ"¥Γ#èΛ¤éΩ%ùΠ&ìΨòΣCΘΞ:Ø;ÄäøÆ,<Ööæ=ÑñÅß>Üüåɧà€~').encoding.must_equal :gsm
+      end
+
+      it 'returns GSM 03.38 for simple ASCII text' do
+        detection_for('Hello world.').encoding.must_equal :gsm
+      end
+
+      it "defaults to GSM 03.38 encoding for empty messages" do
+        detection_for('').encoding.must_equal :gsm
+      end
+    end
   end
 
   describe "message length" do
@@ -95,6 +117,26 @@ describe SmsTools::EncodingDetection do
       detection_for('Уникод: ^{}[~]|€\\').length.must_equal 17
       detection_for('Уникод: Σ: €').length.must_equal 12
     end
+
+    describe 'with SmsTools.use_gsm_encoding = false' do
+      before do
+        SmsTools.use_gsm_encoding = false
+      end
+
+      it "returns ASCII encoded length for some specific symbols which are also in GSM 03.38" do
+        detection_for('[]').length.must_equal 2
+      end
+    end
+
+    describe 'with SmsTools.use_ascii_encoding = false' do
+      before do
+        SmsTools.use_ascii_encoding = false
+      end
+
+      it "returns GSM 03.38 encoded length for some specific symbols which are also in ASCII" do
+        detection_for('[]').length.must_equal 4
+      end
+    end
   end
 
   describe "concatenated message parts counting" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smstools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dimitar Dimitrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ homepage: https://github.com/mitio/smstools
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Small library of classes for common SMS-related functionality.
 test_files: