textris 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f1998dcf38ee77fccc6357527ad6129fe3ce6e7
-  data.tar.gz: 84953db540e4d1ceff87f3d44157d98df7727f55
+  metadata.gz: 4ba73d33c35ee5b623025045060cf7a030f899ed
+  data.tar.gz: 1a593b72d843f7a91c68dea1146ed4935c55d544
 SHA512:
-  metadata.gz: 0a2d83ecaaf191b1e3a0e8cca147f76d2ee0bbd5e175ae9c249f6986f8934d4fd58bae41499a0771dfacf25a9b36558b2fa06f74f9197cde7446060fd13dfe51
-  data.tar.gz: d47fceee3c971d97f4025d97dc306c3bb3631f031349ff465360b579ca9beaa9f161a32592a58c5a49c4ab7b9870191d8adfa727aa8f394b3a4d10252eb0f0fb
+  metadata.gz: 1c15ad890fecb9796c37fd69fa89beb260d258cb8c46531bcdc7618c0c15cbee6094a3632e7a40de32d2e2e9d13390d142c4590f639fdb667b60767f28cdb795
+  data.tar.gz: dfad82c93b9e866a280d4bd98dfeca44b4c340e66ee5402645155fb852a74f12146402fe15962baf0230ee31c012e9a75846700bb926f80c7167639f729a44cc

data/README.md

@@ -1,8 +1,8 @@
-# Textris
+# textris
 
 Simple gem for implementing texter classes which allow sending SMS messages in similar way to how e-mails are implemented and sent with ActionMailer-based mailers.
 
-Unlike similar gems, **Textris** has some unique features:
+Unlike similar gems, **textris** has some unique features:
 
 - e-mail proxy allowing to inspect messages using [Mailinator](https://mailinator.com/) or similar service
 - phone number E164 validation and normalization with the [phony](https://github.com/floere/phony) gem
@@ -58,7 +58,7 @@ end
 
 ### Twilio
 
-In order to use Twilio with textris, you must pre-configure the *twilio-ruby* settings. Create the `config/initializers/twilio.rb`:
+In order to use Twilio with **textris**, you must pre-configure the *twilio-ruby* settings. Create the `config/initializers/twilio.rb`:
 
 ```ruby
 Twilio.configure do |config|
@@ -67,21 +67,21 @@ Twilio.configure do |config|
 end
 ```
 
-> Unless otherwise [configured](#configuration), Twilio will be the default delivery method in `development` and `production` environment, while the `test` method will be used in (surprise, surprise) `test` environment by default.
+> Unless otherwise [configured](#configuration), *Twilio* will be the default delivery method in `development` and `production` environment, while the *test* method will be used in (surprise, surprise) `test` environment by default.
 
 ### Custom delivery methods
 
-Currently, textris comes with `twilio`, `test` and `mail` delivery methods built-in, but you can easily implement your own. Place desired delivery method class in `app/deliveries/<name>_delivery.rb` (e.g. `app/deliveries/my_provider_delivery.rb`):
+Currently, **textris** comes with `twilio`, `test` and `mail` delivery methods built-in, but you can easily implement your own. Place desired delivery class in `app/deliveries/<name>_delivery.rb` (e.g. `app/deliveries/my_provider_delivery.rb`):
 
 ```ruby
 class MyProviderDelivery < Textris::Delivery::Base
   # Implement sending message to single phone number
-  self.send_message(phone, message)
+  def self.send_message(phone, message)
     some_send_method(:phone => phone, :text => message.content)
   end
 
   # ...or implement sending message to multiple phone numbers at once
-  self.send_message_to_all(message)
+  def self.send_message_to_all(message)
     other_send_method(:phone_array => message.to, :text => message.content)
   end
 end
@@ -89,7 +89,7 @@ end
 
 Only one of methods above must be implemented for the delivery class to work. In case of multiple phone numbers and no implementation of *send_message_to_all*, the *send_message* method will be invoked multiple times.
 
-> **NOTE**: You can also place your custom deliveries in `app/texters` if you don't want to clutter the *app* directory too much.
+> You can place your custom deliveries in `app/texters` instead of `app/deliveries` if you don't want to clutter the *app* directory too much.
 
 After implementing your own deliveries, you can activate them by setting app configuration:
 
@@ -129,7 +129,7 @@ will yield multiple message deliveries, each for specific phone number.
 
 You can change default settings by placing them in any of environment files, like `development.rb` or `test.rb`, or setting them globally in `application.rb`.
 
-Choose the delivery method:
+### Choosing and chaining delivery methods
 
 ```ruby
 # Send messages via the Twilio REST API using the twilio-ruby gem
@@ -145,15 +145,19 @@ config.textris_delivery_method = :mail
 config.textris_delivery_method = [:mail, :test]
 ```
 
-Configure the mail delivery with custom templates:
+### Configuring the mail delivery
 
-```ruby
-# E-mail sender, here: "our-team-48666777888@test.app-name.com"
-config.textris_mail_from_template = '%{from_name:d}-%{from_phone}@%{env:d}.%{app:d}.com'
+**textris** comes with reasonable defaults for the `mail` delivery method. It will send messages to a Mailinator address specific to the application name, environment and target phone number. You can customize the mail delivery by setting appropriate templates presented below.
+
+> Arguably, the *textris_mail_to_template* setting is the most important here as it specifies the target e-mail address scheme.
 
+```ruby
 # E-mail target, here: "app-name-test-48111222333-texts@mailinator.com"
 config.textris_mail_to_template = '%{app:d}-%{env:d}-%{to_phone}-texts@mailinator.com'
 
+# E-mail sender, here: "our-team-48666777888@test.app-name.com"
+config.textris_mail_from_template = '%{from_name:d}-%{from_phone}@%{env:d}.%{app:d}.com'
+
 # E-mail subject, here: "User texter: Welcome"
 config.textris_mail_subject_template = '%{texter:dh} texter: %{action:h}'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Karol Słuszniak
@@ -14,30 +14,44 @@ dependencies:
   name: render_anywhere
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
 description: Implement texter classes for sending SMS messages in similar way to how
   e-mails are sent with ActionMailer-based mailers. Take advantage of e-mail proxying
   and enhanced phone number parsing, among others.