textris 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b6a77853a55daea7e35e6c9531d82040a9d3338
-  data.tar.gz: 2c5d6cf2a18d1d16b609c3b53d7042b6b411c1b1
+  metadata.gz: b5b1b356ff6632acadf4831ec739a67b94b41091
+  data.tar.gz: e3a85db82e310bc468db91927e9436f419973839
 SHA512:
-  metadata.gz: 8b32e7a5aae9d7583db862173ed376236f771173ef1f8e9f3ab6e60f5a87e832a451a7856d801dd68daf2f123d8a5670088e58be2a9adf7d769cc3cf68398e6f
-  data.tar.gz: 1c145dd35898dc2a0556b28efc6fc64a3297fc4df88f3c8ac514815c614ceb526bbf0581da4f86235999b41047f961482e066608bfe9f128dc9c3adb36935851
+  metadata.gz: 1a1189862b71010b4c3ea10c128fc5683d25030ad800b442324855185ff8127c1ae4fbd28a42607888bb3c16d11894db833549144555be6ba7ed4162893a63bd
+  data.tar.gz: 62828972a887951e081a5a9e310b765efe2546d75dd04fe9265ff1aae5ab81f50134d1c6e8c136f767ec269a406515b9f4b13414195e43d3e5544cd8a57ba780

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://img.shields.io/gem/v/textris.svg?style=flat-square&label=version)](https://rubygems.org/gems/textris)
 [![Downloads](https://img.shields.io/gem/dt/textris.svg?style=flat-square)](https://rubygems.org/gems/textris)
-[![Build Status](https://img.shields.io/circleci/project/visualitypl/textris/master.svg?style=flat-square&label=build)](https://circleci.com/gh/visualitypl/textris/tree/master)
+[![Build Status](https://img.shields.io/travis/visualitypl/textris/master.svg?style=flat-square&label=build)](https://travis-ci.org/visualitypl/textris)
 [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/visualitypl/textris.svg?style=flat-square)](https://scrutinizer-ci.com/g/visualitypl/textris/?branch=master)
 [![Code Climate](https://img.shields.io/codeclimate/github/visualitypl/textris.svg?style=flat-square)](https://codeclimate.com/github/visualitypl/textris)
 [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/visualitypl/textris.svg?style=flat-square)](https://codeclimate.com/github/visualitypl/textris)
@@ -67,6 +67,27 @@ class User < ActiveRecord::Base
 end
 ```
 
+### MMS
+
+Media messages are supported if you are using the [Twilio](#twilio), [Log](#log) or [Mail](#configuring-the-mail-delivery) adapter. [Twilio currently supports sending MMS in the US and Canada](https://support.twilio.com/hc/en-us/articles/223181608-Can-I-send-or-receive-MMS-messages-).
+
+Media messages aren't part of a template, but must be specified as an array of URLs when sending the message, like:
+
+```ruby
+class UserMediaTexter < Textris::Base
+  default :from => "Our Team <+48 666-777-888>"
+
+  def welcome(user)
+    @user = user
+
+    text(
+      :to         => @user.phone,
+      :media_urls => ["http://example.com/hilarious.gif"]
+    )
+  end
+end
+```
+
 ### Background and scheduled
 
 #### ActiveJob integration
@@ -266,6 +287,7 @@ You can use the following interpolations in your mail templates:
 - `%{from_phone}`: phone number of the sender (e.g. `48666777888`)
 - `%{to_phone}`: phone number of the recipient (e.g. `48111222333`)
 - `%{content}`: message content (e.g. `Welcome to our system, Mr Jones!`)
+- `%{media_urls}`: comma separated string of media URLs (e.g. `http://example.com/hilarious.gif`)
 
 You can add optional interpolation modifiers using the `%{variable:modifiers}` syntax. These are most useful for making names e-mail friendly. The following modifiers are available:
 

data/lib/textris.rb

@@ -22,6 +22,7 @@ else
 end
 
 require 'textris/base'
+require 'textris/phone_formatter'
 require 'textris/message'
 
 begin

data/lib/textris/base.rb

@@ -19,14 +19,17 @@ module Textris
       end
 
       def with_defaults(options)
-        (@defaults || {}).merge(options)
+        defaults.merge(options)
+      end
+
+      def defaults
+        @defaults ||= superclass.respond_to?(:defaults) ? superclass.defaults.dup : {}
       end
 
       protected
 
       def default(options)
-        @defaults ||= {}
-        @defaults.merge!(options)
+        defaults.merge!(options)
       end
 
       private
@@ -58,11 +61,11 @@ module Textris
 
       options = self.class.with_defaults(options)
       options.merge!(
-        :texter   => self.class,
-        :action   => @action,
-        :args     => @args,
-        :content  => options[:body].is_a?(String) ? options[:body] : nil,
-        :renderer => self)
+        :texter     => self.class,
+        :action     => @action,
+        :args       => @args,
+        :content    => options[:body].is_a?(String) ? options[:body] : nil,
+        :renderer   => self)
 
       ::Textris::Message.new(options)
     end

data/lib/textris/delay/sidekiq.rb

@@ -6,7 +6,7 @@ module Textris
       end
 
       def delay_for(interval)
-        unless interval.is_a?(Fixnum)
+        unless interval.is_a?(Integer)
           raise(ArgumentError, "Proper interval must be provided")
         end
 
@@ -23,5 +23,3 @@ module Textris
     end
   end
 end
-
-

data/lib/textris/delivery/log.rb

@@ -11,6 +11,11 @@ module Textris
         log :debug, "From: #{message.from || 'unknown'}"
         log :debug, "To: #{message.to.map { |i| Phony.format(to) }.join(', ')}"
         log :debug, "Content: #{message.content}"
+        (message.media_urls || []).each_with_index do |media_url, index|
+          logged_message = index == 0 ? "Media URLs: " : "            "
+          logged_message << media_url
+          log :debug, logged_message
+        end
       end
 
       private

data/lib/textris/delivery/mail.rb

@@ -61,6 +61,8 @@ module Textris
           get_rails_variable(key)
         when 'texter', 'action', 'from_name', 'from_phone', 'content'
           message.send(key)
+        when 'media_urls'
+          message.media_urls.join(', ')
         else
           variables[key.to_sym]
         end.to_s.strip

data/lib/textris/delivery/test.rb

@@ -14,7 +14,8 @@ module Textris
           :from_phone => message.from_phone,
           :texter     => message.texter,
           :action     => message.action,
-          :to         => to))
+          :to         => to,
+          :media_urls => message.media_urls))
       end
     end
   end

data/lib/textris/delivery/twilio.rb

@@ -2,19 +2,19 @@ module Textris
   module Delivery
     class Twilio < Textris::Delivery::Base
       def deliver(to)
-        client.messages.create(
-          :from => phone_with_plus(message.from_phone),
-          :to   => phone_with_plus(to),
-          :body => message.content)
+        options = {
+          :from => PhoneFormatter.format(message.from_phone),
+          :to   => PhoneFormatter.format(to),
+          :body => message.content
+        }
+        if message.media_urls.is_a?(Array)
+          options[:media_url] = message.media_urls
+        end
+        client.messages.create(options)
       end
 
       private
 
-      # Twillo requires phone numbers starting with a '+' sign
-      def phone_with_plus(phone)
-        phone.to_s.start_with?('+') ? phone : "+#{phone}"
-      end
-
       def client
         @client ||= ::Twilio::REST::Client.new
       end

data/lib/textris/message.rb

@@ -1,15 +1,17 @@
 module Textris
   class Message
-    attr_reader :content, :from_name, :from_phone, :to, :texter, :action, :args
+    attr_reader :content, :from_name, :from_phone, :to, :texter, :action, :args,
+      :media_urls
 
     def initialize(options = {})
       initialize_content(options)
       initialize_author(options)
       initialize_recipients(options)
 
-      @texter = options[:texter]
-      @action = options[:action]
-      @args   = options[:args]
+      @texter     = options[:texter]
+      @action     = options[:action]
+      @args       = options[:args]
+      @media_urls = options[:media_urls]
     end
 
     def deliver
@@ -32,7 +34,15 @@ module Textris
     def from
       if @from_phone.present?
         if @from_name.present?
-          "#{@from_name} <#{Phony.format(@from_phone)}>"
+          if PhoneFormatter.is_alphameric?(@from_phone)
+            @from_phone
+          else
+            if PhoneFormatter.is_a_short_code?(@from_phone)
+              "#{@from_name} <#{@from_phone}>"
+            else
+              "#{@from_name} <#{Phony.format(@from_phone)}>"
+            end
+          end
         else
           Phony.format(@from_phone)
         end
@@ -79,15 +89,23 @@ module Textris
     end
 
     def parse_from_dual(from)
-      if (matches = from.to_s.match(/(.*)\<(.*)\>\s*$/).to_a).size == 3 &&
-          Phony.plausible?(matches[2])
-        [matches[1].strip, Phony.normalize(matches[2])]
+      matches = from.match(/(.*)\<(.*)\>\s*$/)
+      return unless matches
+      name, sender_id = matches.captures
+      return unless name && sender_id
+
+      if Phony.plausible?(sender_id) || PhoneFormatter.is_a_short_code?(sender_id)
+        [name.strip, Phony.normalize(sender_id)]
+      elsif PhoneFormatter.is_alphameric?(sender_id)
+        [name.strip, sender_id]
       end
     end
 
     def parse_from_singular(from)
       if Phony.plausible?(from)
         [nil, Phony.normalize(from)]
+      elsif PhoneFormatter.is_a_short_code?(from)
+        [nil, from.to_s]
       elsif from.present?
         [from.strip, nil]
       end
@@ -103,8 +121,7 @@ module Textris
 
     def parse_content(content)
       content = content.to_s
-      content = content.gsub(/\s{1,}/, ' ')
-      content = content.strip
+      content = content.rstrip
 
       content
     end

data/lib/textris/phone_formatter.rb

@@ -0,0 +1,28 @@
+module Textris
+  class PhoneFormatter
+    class << self
+      def format(phone = '')
+        return phone if is_a_short_code?(phone) || is_alphameric?(phone) || phone.nil?
+        "#{'+' unless phone.start_with?('+')}#{phone}"
+      end
+
+      # Short codes have more dependencies and limitations;
+      # but this is a good general start
+      def is_a_short_code?(phone)
+        !!phone.to_s.match(/\A\d{4,6}\z/)
+      end
+
+      def is_a_phone_number?(phone)
+        Phony.plausible?(phone)
+      end
+
+      def is_alphameric?(phone)
+        # \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
+        !!phone.to_s.match(/\A(?=.*[a-zA-Z])[a-zA-z\d]{1,11}\z/)
+      end
+    end
+  end
+end

data/lib/textris/version.rb

@@ -1,3 +1,3 @@
 module Textris
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,7 @@ files:
 - lib/textris/delivery/test.rb
 - lib/textris/delivery/twilio.rb
 - lib/textris/message.rb
+- lib/textris/phone_formatter.rb
 - lib/textris/version.rb
 homepage: http://github.com/visualitypl/textris
 licenses:
@@ -255,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple SMS messaging gem for Rails based on concepts and conventions similar