textris 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec9ef9f16f25185395f550204e2e5afbd067d8b
-  data.tar.gz: b5f8bf92434c2e95ff71a0bf6d9ee2a4692b0091
+  metadata.gz: 2f1998dcf38ee77fccc6357527ad6129fe3ce6e7
+  data.tar.gz: 84953db540e4d1ceff87f3d44157d98df7727f55
 SHA512:
-  metadata.gz: 5c721b8a4f1e67a3e62ee457869f8afb0f83c39f92e979dc7c63fa1300a03538b9a5ac1b9917b7e39ea44ad9ff89fca1734cedd37d34185c99655d5e6420e2f9
-  data.tar.gz: 4e723b946fbd68b08ef751d2785171a24a0a4c66fec6a1fd6de67cc4992c44952ebdc152321dffb4f6fc9034961eaf510a9579dbdead94534b372ec6055672f1
+  metadata.gz: 0a2d83ecaaf191b1e3a0e8cca147f76d2ee0bbd5e175ae9c249f6986f8934d4fd58bae41499a0771dfacf25a9b36558b2fa06f74f9197cde7446060fd13dfe51
+  data.tar.gz: d47fceee3c971d97f4025d97dc306c3bb3631f031349ff465360b579ca9beaa9f161a32592a58c5a49c4ab7b9870191d8adfa727aa8f394b3a4d10252eb0f0fb

data/README.md

@@ -5,14 +5,13 @@ Simple gem for implementing texter classes which allow sending SMS messages in s
 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
+- 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
 - 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*
 
-Currently, this gem comes with `test` and `mail` delivery methods, so there's no method for any real SMS gateway yet. Still, you can easily implement your own - see the [Custom delivery methods](#custom-delivery-methods) chapter below.
-
 ## Installation
 
 Add to `Gemfile`:
@@ -57,9 +56,22 @@ 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
 
-Place desired delivery method 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 method class in `app/deliveries/<name>_delivery.rb` (e.g. `app/deliveries/my_provider_delivery.rb`):
 
 ```ruby
 class MyProviderDelivery < Textris::Delivery::Base
@@ -75,10 +87,10 @@ class MyProviderDelivery < Textris::Delivery::Base
 end
 ```
 
-> **NOTE**: You can also place your custom deliveries in `app/texters` if you don't want to clutter the *app* directory too much.
-
 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.
+
 After implementing your own deliveries, you can activate them by setting app configuration:
 
 ```ruby
@@ -86,7 +98,7 @@ After implementing your own deliveries, you can activate them by setting app con
 config.textris_delivery_method = :my_provider
 
 # Chain your new delivery with others, including stock ones
-config.textris_delivery_method = [:my_provider, :mail]
+config.textris_delivery_method = [:my_provider, :twilio, :mail]
 ```
 
 ## Testing
@@ -120,6 +132,9 @@ You can change default settings by placing them in any of environment files, lik
 Choose the delivery method:
 
 ```ruby
+# Send messages via the Twilio REST API using the twilio-ruby gem
+config.textris_delivery_method = :twilio
+
 # Don't send anything, access your messages via Textris::Base.deliveries
 config.textris_delivery_method = :test
 

data/lib/textris.rb

@@ -7,3 +7,4 @@ require 'textris/delivery'
 require 'textris/delivery/base'
 require 'textris/delivery/test'
 require 'textris/delivery/mail'
+require 'textris/delivery/twilio'

data/lib/textris/delivery.rb

@@ -6,7 +6,11 @@ module Textris
       methods = Rails.application.config.try(:textris_delivery_method)
       methods = [*methods].compact
       if methods.blank?
-        methods = [:test]
+        if Rails.env.test?
+          methods = [:test]
+        else
+          methods = [:twilio]
+        end
       end
 
       methods.map do |method|

data/lib/textris/delivery/twilio.rb

@@ -0,0 +1,22 @@
+require 'twilio-ruby'
+
+module Textris
+  module Delivery
+    class Twilio < Textris::Delivery::Base
+      class << self
+        private
+
+        def send_message(to, message)
+          client.messages.create(
+            :from => message.from_phone,
+            :to   => to,
+            :body => message.content)
+        end
+
+        def client
+          @client ||= Twilio::REST::Client.new
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Karol Słuszniak
@@ -54,6 +54,7 @@ files:
 - lib/textris/delivery/base.rb
 - lib/textris/delivery/mail.rb
 - lib/textris/delivery/test.rb
+- lib/textris/delivery/twilio.rb
 - lib/textris/message.rb
 homepage: http://github.com/visualitypl/textris
 licenses: