Support for Short Codes and Alphameric sender ID #39

Marahin · 2017-11-24T14:09:06Z

Tested on example app:

Sent text to +48 12 545 67 89
Texter: User#welcome
Date: 2017-11-24 15:39:54 +0100
From: Team Sp.z.o.o
To: +48 12 545 67 89
Rendered user_texter/welcome.text.erb (0.2ms)

Keep in mind that in order to use Alphanumeric sender ID you have to declare it this way: from: 'My Team <Team Inc.>', where 'My Team' will be equal to name, and Team Inc. to Sender ID (.from_phone).

Lackoftactics · 2017-11-24T14:12:15Z

Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'

 gemspec
+
+gem 'pry'


I am not sure if pry should be here, or add it as development dependency.

Lackoftactics · 2017-11-24T14:16:56Z

lib/textris/message.rb

-      if (matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a).size == 3 &&
-          Phony.plausible?(matches[2])
+      matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a
+      return if matches.size != 3


magic number, what 3 represents here?

@Lackoftactics https://github.com/visualitypl/textris/blame/ab770cb966218d6a4c2225a7a7ab360d590698ae/lib/textris/message.rb#L88

But:

irb(main):001:0> "Jan Matusz <+48123456789>".match(/(.*)\<(.*)\>\s*$/).to_a => ["Jan Matusz <+48123456789>", "Jan Matusz ", "+48123456789"]

So basicly it "splits" the sender string (which allows us to normalize/set the sender ID and sender name explicitly).

Lackoftactics · 2017-11-24T14:19:22Z

lib/textris/message.rb

@@ -81,15 +81,20 @@ def parse_from(from)
    end

    def parse_from_dual(from)
-      if (matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a).size == 3 &&
-          Phony.plausible?(matches[2])
+      matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a


use captures instead of converting to array
from.to_s.match(/(.*)\<(.*)\>\s*$/).captures

@Lackoftactics done, but this required me to use the short try notation (&.).

Lackoftactics · 2017-11-24T15:13:20Z

lib/textris/message.rb

-          Phony.plausible?(matches[2])
+      matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a
+      return if matches.size != 3
+      if Phony.plausible?(matches[2]) || PhoneFormatter.is_a_short_code?(matches[2])


maybe some simple helper method, that will be readable for getting name and number from the dual field

.idea folder contains JetBrains' IDE data and configurations, it should not be added to the project.

@philnash

Continue support introduction (based on @philnash's code: #26) for Short Codes and fulfill request to bring Alphameric Sender ID support. Handle formatting/discovery logic in newly created class, Textris::PhoneFormatter.

Lackoftactics · 2017-11-24T16:51:03Z

lib/textris/message.rb

-          Phony.plausible?(matches[2])
-        [matches[1].strip, Phony.normalize(matches[2])]
+      matches = from.match(/(.*)\<(.*)\>\s*$/)
+      return if matches.nil?


checking nil? maybe better to

return if !matches

What do you think?

@Lackoftactics maybe return unless matches?

`&.` breaks backward compatibility - instead add explicit calls that check if there are any matches; and if there are - select the captures.

philnash · 2017-11-27T01:11:40Z

lib/textris/phone_formatter.rb

+      # that cannot be resolved as a short code or a phone
+      # number, then it is Alphameric Sender ID
+      def is_alphameric?(phone)
+        !is_a_phone_number?(phone) && !is_a_short_code?(phone)


The rules for an alphanumeric ID are:

You may use any combination of 1 to 11 letters, A-Z and numbers, 0-9. Both lowercase and uppercase characters are supported as well as spaces. 1 letter and no more than 11 alphanumeric characters may be used.

I messed around with a regex to match this constraint and came up with:

\A(?=.*[a-zA-Z])[a-zA-z\d]{1,11}\z

Broken down, this is:

\A # Start of the string (?=.*[a-zA-Z]) # Lookahead to ensure there is at least one letter in the entire string [a-zA-z\d]{1,11} # Between 1 and 11 characters in the string \z # End of the string

So we could rewrite this as:

def is_alphanumeric?(phone) !!phone.to_s.match(/\A(?=.*[a-zA-Z])[a-zA-z\d]{1,11}\z/) end

philnash · 2017-11-27T01:12:36Z

spec/textris/phone_formatter_spec.rb

+  end
+
+  it 'treat non-short code non-phone number numbers as alphamerics' do
+    ['8945', '894', '89', '8', '8945467', '89454678', '894546789'].each do |number|


These tests are incorrect, alphanumeric sender IDs are required to have at least one letter.

I'd recommend tests that ensured these numbers were not considered as alphanumeric sender IDs, but that the strings: a, 1a, 1aaaaaaaaaa and ZZZZZZZZZZ9 are all considered valid alphanumeric IDs.

We should also ensure that alphanumeric sender IDs are not more than 11 characters long.

This test case was not supposed to check whether it's classified as alphameric, but rather 'treated' as it was like it (so no additional formatting), if I remember correctly :) but yes, this should be replaced with a proper alphamerics tests, I agree.

Lackoftactics reviewed Nov 24, 2017

View reviewed changes

Marahin force-pushed the short-codes-alphamerics branch from cabfe92 to dddc47b Compare November 24, 2017 14:17

Lackoftactics reviewed Nov 24, 2017

View reviewed changes

Marahin force-pushed the short-codes-alphamerics branch 2 times, most recently from 99a3bda to 33537d6 Compare November 24, 2017 14:43

Lackoftactics reviewed Nov 24, 2017

View reviewed changes

philnash and others added 3 commits November 24, 2017 17:00

Initial support for sending SMS from short codes

48d5505

Add .idea to .gitignore

a41d0e6

.idea folder contains JetBrains' IDE data and configurations, it should not be added to the project.

Add support for alphameric sender ID and short codes

a1a6d19

Continue support introduction (based on @philnash's code: #26) for Short Codes and fulfill request to bring Alphameric Sender ID support. Handle formatting/discovery logic in newly created class, Textris::PhoneFormatter.

Marahin force-pushed the short-codes-alphamerics branch 2 times, most recently from 261ff84 to ab5ffd9 Compare November 24, 2017 16:16

Lackoftactics reviewed Nov 24, 2017

View reviewed changes

Do not use &. notation, and instead make explicit capture calls

3b66337

`&.` breaks backward compatibility - instead add explicit calls that check if there are any matches; and if there are - select the captures.

Marahin force-pushed the short-codes-alphamerics branch from ab5ffd9 to 3b66337 Compare November 24, 2017 16:54

philnash suggested changes Nov 27, 2017

View reviewed changes

Refactor is_alphameric? method and it's tests

068805d

philnash approved these changes Nov 27, 2017

View reviewed changes

philnash mentioned this pull request Dec 1, 2017

Initial support for sending SMS from short codes #26

Closed

This was referenced Dec 6, 2017

Shortcodes don't work #25

Closed

Alphanumeric support for Twilio #34

Closed

Add summary of #39 changes to CHANGELOG.md

6dcdabc

Marahin merged commit 66ed742 into master Dec 6, 2017

Marahin deleted the short-codes-alphamerics branch December 6, 2017 11:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Short Codes and Alphameric sender ID #39

Support for Short Codes and Alphameric sender ID #39

Marahin commented Nov 24, 2017 •

edited

Loading

Lackoftactics Nov 24, 2017 •

edited

Loading

Lackoftactics Nov 24, 2017

Marahin Nov 24, 2017

Lackoftactics Nov 24, 2017 •

edited

Loading

Marahin Nov 24, 2017

Lackoftactics Nov 24, 2017

Lackoftactics Nov 24, 2017

Marahin Nov 24, 2017

philnash Nov 27, 2017

Marahin Nov 27, 2017

philnash Nov 27, 2017 •

edited

Loading

Marahin Nov 27, 2017

Support for Short Codes and Alphameric sender ID #39

Support for Short Codes and Alphameric sender ID #39

Conversation

Marahin commented Nov 24, 2017 • edited Loading

Lackoftactics Nov 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lackoftactics Nov 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philnash Nov 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Marahin commented Nov 24, 2017 •

edited

Loading

Lackoftactics Nov 24, 2017 •

edited

Loading

Lackoftactics Nov 24, 2017 •

edited

Loading

philnash Nov 27, 2017 •

edited

Loading