textris 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e7162b57526b114af677ddabf1d417f97c31b7
-  data.tar.gz: 15f9e84235920d7413b252ed751e80023a5b15b7
+  metadata.gz: c892d39927e7381aa8d34757802e9102d3341681
+  data.tar.gz: 63b2c323d52306386dd787c4304c98f458023715
 SHA512:
-  metadata.gz: 93312a94c10bab68d1faff3fc82d8fb882a5ffc0bd462e93e075cf28e2087176e10c48f2ee6dabe27cd6bd6b78ec89505037fe2aa103597052543782ce0cfc16
-  data.tar.gz: 1ef7417175290cbec6812c6c9c718d15f88c0fd98c1bafe25d7f0607a591d582f5c5403539bcb8f4058f443326a533ae002b9b66f9c8a1ad5f9bd915aafd15e6
+  metadata.gz: 2a8b73f20130a57a8b226eff56d89cc39b1b875265edc2bcc1fea1b5cc519bfb72f009bb709436e6490de1e29715955f2faae1f33a3e341b81e4ba99b4d4db55
+  data.tar.gz: 1ade51f79ebf729434c12c9a470500da2c99e0c4b87af1c01f102c2f41a05bde92f5cc2fc6e36866c9201e57fae632e308edbfcda86190467d2f3c076e3f77df

data/README.md

@@ -12,13 +12,15 @@ 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
-- built-in support for the Twilio API thanks to integration with the [twilio-ruby](https://github.com/twilio/twilio-ruby) gem
+- built-in support for the Twilio and Nexmo APIs with [twilio-ruby](https://github.com/twilio/twilio-ruby) and [nexmo](https://github.com/timcraft/nexmo) gems
 - multiple, per-environment configurable and chainable delivery methods
 - extensible with any number of custom delivery methods (also chainable)
 - background and scheduled texting thanks to integration with the [sidekiq](https://github.com/mperham/sidekiq) gem
 - support for testing using self-explanatory `Textris::Base.deliveries`
 - simple, extensible, fully tested code written from the ground up instead of copying *ActionMailer*
 
+See the [blog entry](http://www.visuality.pl/posts/txt-messaging-with-textris-gem) for the whole story and a practical usage example.
+
 ## Installation
 
 Add to `Gemfile`:
@@ -124,6 +126,9 @@ Below you'll find sample settings for any of supported delivery methods along wi
 # Send messages via the Twilio REST API
 config.textris_delivery_method = :twilio
 
+# Send messages via the Nexmo API
+config.textris_delivery_method = :nexmo
+
 # Don't send anything, log messages into Rails logger
 config.textris_delivery_method = :log
 
@@ -133,8 +138,8 @@ config.textris_delivery_method = :test
 # Send e-mails instead of SMSes in order to inspect their content
 config.textris_delivery_method = :mail
 
-# Chain multiple delivery methods (e.g. to have e-mail backups of your messages)
-config.textris_delivery_method = [:mail, :test]
+# Chain multiple delivery methods (e.g. to have e-mail and log backups of messages)
+config.textris_delivery_method = [:twilio, :mail, :log]
 ```
 
 > Unless otherwise configured, default delivery methods will be: *log* in `development` environment, *test* in `test` environment and *mail* in `production` environment. All these come with reasonable defaults and will work with no further configuration.
@@ -156,6 +161,17 @@ Twilio.configure do |config|
 end
 ```
 
+#### Nexmo
+
+In order to use Nexmo with **textris**, you need to include the `nexmo` gem in your `Gemfile`:
+
+```ruby
+gem 'nexmo'
+```
+
+The Nexmo gem uses the environment variables `NEXMO_API_KEY` and `NEXMO_API_SECRET` to authenticate with the API.
+Therefore the safest way to provide authentication credentials is to set these variables in your application environment.
+
 #### Log
 
 **textris** logger has similar logging behavior to ActionMailer. It will log single line to *info* log with production in mind and then a couple details to *debug* log. You can change the log level for the whole output:
@@ -166,7 +182,7 @@ config.textris_log_level = :info
 
 #### Custom delivery methods
 
-Currently, **textris** comes with `twilio`, `mail` and `test` 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`):
+Currently, **textris** comes with several 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
@@ -253,3 +269,5 @@ Implementing new delivery methods in Pull Requests is strongly encouraged. Start
 2. If delivery depends on any gems, don't add them as runtime dependencies. You can (and should in order to write complete specs) add them as development dependencies.
 3. Delivery code must load without exceptions even when dependent libraries are missing. Specs should test such case (you can use `remove_const` to undefine loaded consts).
 4. New deliveries are expected to have 100% test coverage. Run `COVERAGE=1 bundle exec rake spec` to generate *simplecov* coverage into the **coverage/index.html** file.
+
+The commit in which [the log delivery was added](https://github.com/visualitypl/textris/commit/7c3231ca5eeb94cca01a3beced19a1a909299faf) is an example of delivery method addition that meets all guidelines listed above.

data/lib/textris.rb

@@ -28,3 +28,4 @@ require 'textris/delivery/test'
 require 'textris/delivery/mail'
 require 'textris/delivery/log'
 require 'textris/delivery/twilio'
+require 'textris/delivery/nexmo'

data/lib/textris/delivery/nexmo.rb

@@ -0,0 +1,18 @@
+module Textris
+  module Delivery
+    class Nexmo < Textris::Delivery::Base
+      def deliver(phone)
+        client.send_message(
+          from: message.from_phone,
+          to:   phone,
+          text: message.content
+        )
+      end
+
+      private
+        def client
+          @client ||= ::Nexmo::Client.new
+        end
+    end
+  end
+end

data/lib/textris/message.rb

@@ -41,12 +41,14 @@ module Textris
     end
 
     def from
-      if @from_name.present? && @from_phone.present?
-        "#{@from_name} <#{Phony.format(@from_phone)}>"
+      if @from_phone.present?
+        if @from_name.present?
+          "#{@from_name} <#{Phony.format(@from_phone)}>"
+        else
+          Phony.format(@from_phone)
+        end
       elsif @from_name.present?
         @from_name
-      elsif @from_phone.present?
-        Phony.format(@from_phone)
       end
     end
 

data/lib/textris/version.rb

@@ -1,3 +1,3 @@
 module Textris
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: nexmo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +199,7 @@ files:
 - lib/textris/delivery/base.rb
 - lib/textris/delivery/log.rb
 - lib/textris/delivery/mail.rb
+- lib/textris/delivery/nexmo.rb
 - lib/textris/delivery/test.rb
 - lib/textris/delivery/twilio.rb
 - lib/textris/message.rb