textris 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0715eb5a0c4ce47948654b5353c7d67b4f6ea3da
-  data.tar.gz: 00e2a1a8c37cd5e3f6b478a41173d5293dfa3098
+  metadata.gz: 809b477aaf1b029a62e607a176a28fd472d39278
+  data.tar.gz: f016ff50375a87cb76639ada746e94a1fe5b147e
 SHA512:
-  metadata.gz: a91454d5a3975a73149d944549a965b1f492f23de8671259f162d823ddd953fc82839c650e220058a8d2d8fd36fa3a3440b6d2e5c509db1b325d57170b34f2b8
-  data.tar.gz: 58ccf8ef1e8ccb8d7b0f49f16e801285346dd65db865b9e890e710d80ac5d53179ab3ad124f98528c56136949f09d5168c2d2a6324d855752c890e93b5771014
+  metadata.gz: 35fdb014b8dd1c9fd44900d6faf8c0e02919975df0d597e1cfe5268f3cfad74d23c54e1c4a90f46c9261155dece5b9c80a7b49eb76378df264f786615f423428
+  data.tar.gz: a7e10be07676138514db7c118e68f12c55bab309ab7ce40f989f7a8640b8055d464de2d29507ff44606763c116b887392de06094b16921a669b8fcfe15848cf9

data/README.md

@@ -1,5 +1,6 @@
 # textris
 
+[![Build Status](https://travis-ci.org/visualitypl/textris.svg)](https://travis-ci.org/visualitypl/textris)
 [![Code Climate](https://codeclimate.com/github/visualitypl/textris/badges/gpa.svg)](https://codeclimate.com/github/visualitypl/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.
@@ -8,11 +9,11 @@ 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
-- multiple, per-environment configurable and chainable delivery methods
 - built-in support for the Twilio API thanks to the [twilio-ruby](https://github.com/twilio/twilio-ruby) gem
+- multiple, per-environment configurable and chainable delivery methods
 - extensible with any number of custom delivery methods (also chainable)
 - support for testing using self-explanatory `Textris::Base.deliveries`
-- simple, extensible code written from the ground up instead of copying *ActionMailer*
+- simple, extensible and fully tested code written from the ground up instead of copying guts of *ActionMailer*
 
 ## Installation
 
@@ -58,51 +59,6 @@ class User < ActiveRecord::Base
 end
 ```
 
-### Twilio
-
-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|
-  config.account_sid = 'some_sid'
-  config.auth_token  = 'some_auth_token'
-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.
-
-### 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 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
-  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
-  def self.send_message_to_all(message)
-    other_send_method(:phone_array => message.to, :text => message.content)
-  end
-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.
-
-> 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:
-
-```ruby
-# Use your new delivery
-config.textris_delivery_method = :my_provider
-
-# Chain your new delivery with others, including stock ones
-config.textris_delivery_method = [:my_provider, :twilio, :mail]
-```
-
 ## Testing
 
 Access all messages that were sent with the `:test` delivery:
@@ -133,8 +89,10 @@ You can change default settings by placing them in any of environment files, lik
 
 ### Choosing and chaining delivery methods
 
+Below you'll find sample settings for any of supported delivery methods along with short description of each:
+
 ```ruby
-# Send messages via the Twilio REST API using the twilio-ruby gem
+# Send messages via the Twilio REST API
 config.textris_delivery_method = :twilio
 
 # Don't send anything, access your messages via Textris::Base.deliveries
@@ -147,6 +105,51 @@ config.textris_delivery_method = :mail
 config.textris_delivery_method = [:mail, :test]
 ```
 
+> Unless otherwise configured, *Twilio* will be the default delivery method in `development` and `production` environments, while the *test* method will be used in `test` environment by default.
+
+#### Twilio
+
+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|
+  config.account_sid = 'some_sid'
+  config.auth_token  = 'some_auth_token'
+end
+```
+
+#### 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 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
+  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
+  def self.send_message_to_all(message)
+    other_send_method(:phone_array => message.to, :text => message.content)
+  end
+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.
+
+> 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:
+
+```ruby
+# Use your new delivery
+config.textris_delivery_method = :my_provider
+
+# Chain your new delivery with others, including stock ones
+config.textris_delivery_method = [:my_provider, :twilio, :mail]
+```
+
 ### Configuring the mail delivery
 
 **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.
@@ -167,18 +170,18 @@ config.textris_mail_subject_template = '%{texter:dh} texter: %{action:h}'
 config.textris_mail_body_template = '%{content}'
 ```
 
-### Template interpolation
+#### Template interpolation
 
 You can use the following interpolations in your mail templates:
 
-- `app`: application name (like `AppName`)
-- `env`: enviroment name (like `test` or `production`)
-- `texter`: texter name (like `User`)
-- `action`: action name (like `welcome`)
-- `from_name`: name of the sender (like `Our Team`)
-- `from_phone`: phone number of the sender (like `48666777888`)
-- `to_phone`: phone number of the recipient (like `48111222333`)
-- `content`: message content (like `Welcome to our system, Mr Jones!`)
+- `%{app}`: application name (like `AppName`)
+- `%{env}`: enviroment name (like `test` or `production`)
+- `%{texter}`: texter name (like `User`)
+- `%{action}`: action name (like `welcome`)
+- `%{from_name}`: name of the sender (like `Our Team`)
+- `%{from_phone}`: phone number of the sender (like `48666777888`)
+- `%{to_phone}`: phone number of the recipient (like `48111222333`)
+- `%{content}`: message content (like `Welcome to our system, Mr Jones!`)
 
 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:
 
@@ -188,7 +191,7 @@ You can add optional interpolation modifiers using the `%{variable:modifiers}` s
 
 ## Contributing
 
-1. Fork it (https://github.com/visualitypl/codegrade/fork)
+1. Fork it (https://github.com/visualitypl/textris/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/textris/base.rb

@@ -2,11 +2,17 @@ require 'render_anywhere'
 
 module Textris
   class Base
+    class RenderingController < RenderAnywhere::RenderingController
+      def default_url_options
+        ActionMailer::Base.default_url_options || {}
+      end
+    end
+
     include RenderAnywhere
 
     class << self
       def deliveries
-        ::Textris::Delivery::Test.messages
+        ::Textris::Delivery::Test.deliveries
       end
 
       def with_defaults(options)
@@ -27,12 +33,6 @@ module Textris
       end
     end
 
-    class RenderingController < RenderAnywhere::RenderingController
-      def default_url_options
-        ActionMailer::Base.default_url_options || {}
-      end
-    end
-
     def initialize(action, *args)
       @action = action
       @args   = args

data/lib/textris/delivery/mail.rb

@@ -49,27 +49,26 @@ module Textris
             modifiers = directive.split(':')[1] || ''
 
             content = get_template_interpolation(var, message, vars)
-            content = apply_template_modifiers(content, modifiers)
+            content = apply_template_modifiers(content, modifiers.chars)
 
             content
           end
         end
 
         def get_template_interpolation(var, message, vars)
-          content = if var == 'app'
+          content = case var
+          when 'app'
             Rails.application.class.parent_name
-          elsif var == 'env'
+          when 'env'
             Rails.env
-          elsif var == 'texter' && (texter = message.texter).present?
-            texter.to_s.split('::').last.sub(/Texter$/, '')
-          elsif var == 'action' && (action = message.action).present?
-            action.to_s
-          elsif var == 'from_name' && (from = message.from_name).present?
-            from.to_s
-          elsif (value = vars[var.to_sym]).present?
-            value
-          elsif ['content', 'from_phone'].include?(var)
+          when 'texter'
+            message.texter.to_s.split('::').last.to_s.sub(/Texter$/, '')
+          when 'action', 'from_name'
             message.send(var)
+          when 'content', 'from_phone'
+            message.send(var)
+          else
+            value = vars[var.to_sym]
           end.to_s.strip
 
           if content.present?
@@ -80,16 +79,15 @@ module Textris
         end
 
         def apply_template_modifiers(content, modifiers)
-          if modifiers.include?('d')
-            content = content.underscore.dasherize
-          end
-
-          if modifiers.include?('h')
-            content = content.humanize.gsub(/[-_]/, ' ')
-          end
-
-          if modifiers.include?('p')
-            content = Phony.format(content) rescue content
+          modifiers.each do |modifier|
+            case modifier
+            when 'd'
+              content = content.underscore.dasherize
+            when 'h'
+              content = content.humanize.gsub(/[-_]/, ' ')
+            when 'p'
+              content = Phony.format(content) rescue content
+            end
           end
 
           content

data/lib/textris/delivery/test.rb

@@ -2,14 +2,14 @@ module Textris
   module Delivery
     class Test < Textris::Delivery::Base
       class << self
-        def messages
-          @messages ||= []
+        def deliveries
+          @deliveries ||= []
         end
 
         private
 
         def send_message(to, message)
-          messages.push(::Textris::Message.new(
+          deliveries.push(::Textris::Message.new(
             :content    => message.content,
             :from_name  => message.from_name,
             :from_phone => message.from_phone,

data/lib/textris/message.rb

@@ -58,6 +58,7 @@ module Textris
     end
 
     def parse_content(content)
+      content = content.to_s
       content = content.gsub(/\s{1,}/, ' ')
       content = content.strip
 

data/lib/textris/version.rb

@@ -0,0 +1,3 @@
+module Textris
+  VERSION = "0.1.8"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +140,7 @@ files:
 - lib/textris/delivery/test.rb
 - lib/textris/delivery/twilio.rb
 - lib/textris/message.rb
+- lib/textris/version.rb
 homepage: http://github.com/visualitypl/textris
 licenses:
 - MIT