textris 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41a7e696b4cae68e7793538ad07e490c415f048c
-  data.tar.gz: 1cd679882d001d36860d0e9e0129dd096d036422
+  metadata.gz: 22e7162b57526b114af677ddabf1d417f97c31b7
+  data.tar.gz: 15f9e84235920d7413b252ed751e80023a5b15b7
 SHA512:
-  metadata.gz: 67b9819759fb074b871ce4ef1f4aef2c6baeddd9472e111b75beb1ac8ce33530126481d04aac3f47ac3274229bf910341d8a7f9ba926e79b813e36f114a181ac
-  data.tar.gz: 08cffc6511507e0c2898d0f0ea07ea9667e9947054db10fc89031ce0b4d977f1ea1480a3ab9f4643856e867c3a9a31e29495a6b57ce51011f59173fb03eff165
+  metadata.gz: 93312a94c10bab68d1faff3fc82d8fb882a5ffc0bd462e93e075cf28e2087176e10c48f2ee6dabe27cd6bd6b78ec89505037fe2aa103597052543782ce0cfc16
+  data.tar.gz: 1ef7417175290cbec6812c6c9c718d15f88c0fd98c1bafe25d7f0607a591d582f5c5403539bcb8f4058f443326a533ae002b9b66f9c8a1ad5f9bd915aafd15e6

data/README.md

@@ -1,5 +1,6 @@
 # textris
 
+[![GitHub version](https://badge.fury.io/gh/visualitypl%2Ftextris.svg)](http://badge.fury.io/gh/visualitypl%2Ftextris)
 [![Build Status](https://scrutinizer-ci.com/g/visualitypl/textris/badges/build.png?b=master)](https://scrutinizer-ci.com/g/visualitypl/textris/build-status/master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/visualitypl/textris/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/visualitypl/textris/?branch=master)
 [![Code Climate](https://codeclimate.com/github/visualitypl/textris/badges/gpa.svg)](https://codeclimate.com/github/visualitypl/textris)
@@ -11,7 +12,7 @@ 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 the [twilio-ruby](https://github.com/twilio/twilio-ruby) gem
+- built-in support for the Twilio API thanks to integration with 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)
 - background and scheduled texting thanks to integration with the [sidekiq](https://github.com/mperham/sidekiq) gem
@@ -74,7 +75,7 @@ UserTexter.delay_until(1.day.from_now).welcome(user)
 
 > You should not call `deliver` after the action invocation when using delay. It will be called by the *Textris::Delay::Sidekiq::Worker* worker.
 
-> You can safely pass ActiveRecord records and arrays as delayed action arguments. **textris** will store their `id`'s and find them upon scheduled delivery.
+> You can safely pass ActiveRecord records and arrays as delayed action arguments. **textris** will store their `id`s and find them upon scheduled delivery.
 
 Keep in mind that **textris** does not install *sidekiq* for you. If you don't have it yet, [install Redis](http://redis.io/topics/quickstart) on your machine and add the *sidekiq* gem to `Gemfile`:
 
@@ -123,6 +124,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
 
+# Don't send anything, log messages into Rails logger
+config.textris_delivery_method = :log
+
 # Don't send anything, access your messages via Textris::Base.deliveries
 config.textris_delivery_method = :test
 
@@ -133,11 +137,17 @@ 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.
+> 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.
 
 #### Twilio
 
-In order to use Twilio with **textris**, you must pre-configure the *twilio-ruby* settings. Create the `config/initializers/twilio.rb`:
+**textris** connects with the Twilio API using *twilio-ruby* gem. It does not, however, install the gem for you. If you don't have it yet, add the *twilio-ruby* gem to `Gemfile`:
+
+```ruby
+gem 'twilio-ruby'
+```
+
+Then, pre-configure the *twilio-ruby* settings by creating the `config/initializers/twilio.rb` file:
 
 ```ruby
 Twilio.configure do |config|
@@ -146,6 +156,14 @@ Twilio.configure do |config|
 end
 ```
 
+#### 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:
+
+```ruby
+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`):
@@ -224,3 +242,14 @@ You can add optional interpolation modifiers using the `%{variable:modifiers}` s
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Adding delivery methods
+
+Implementing new delivery methods in Pull Requests is strongly encouraged. Start by [implementing custom delivery method](#custom-delivery-methods). Then, you can prepare it for a Pull Request by adhering to following guidelines:
+
+1. Delivery class should be placed in `lib/textris/delivery/service_name.rb` and named in a way that will best indicate the service with which it's supposed to work with.
+5. Add your method to code example in [Choosing and chaining delivery methods](#choosing-and-chaining-delivery-methods) in README. Also, add sub-chapter for it if it depends on other gems or requires explanation.
+6. Your delivery code is expected to throw exceptions with self-explanatory messages upon failure. Include specs that test this. Mock external API requests with [webmock](https://github.com/bblimke/webmock).
+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.

data/lib/textris.rb

@@ -26,4 +26,5 @@ require 'textris/delivery'
 require 'textris/delivery/base'
 require 'textris/delivery/test'
 require 'textris/delivery/mail'
+require 'textris/delivery/log'
 require 'textris/delivery/twilio'

data/lib/textris/delay/sidekiq/serializer.rb

@@ -10,6 +10,7 @@ module Textris
             objects.collect do |object|
               serialize_active_record_object(object) ||
                 serialize_active_record_array(object) ||
+                serialize_active_record_relation(object) ||
                 object
             end
           rescue NameError
@@ -19,7 +20,6 @@ module Textris
           def deserialize(objects)
             objects.collect do |object|
               deserialize_active_record_object(object) ||
-                deserialize_active_record_array(object) ||
                 object
             end
           end
@@ -32,27 +32,24 @@ module Textris
             end
           end
 
-          def deserialize_active_record_object(object)
-            if object.is_a?(Array) &&
-                object.try(:length) == 3 &&
-                object[0] == ACTIVERECORD_POINTER
-              object[1].constantize.find(object[2])
+          def serialize_active_record_relation(array)
+            if array.class < ActiveRecord::Relation
+              [ACTIVERECORD_ARRAY_POINTER, array.model.to_s, array.map(&:id)]
             end
           end
 
           def serialize_active_record_array(array)
-            if array.class < ActiveRecord::Relation
-              [ACTIVERECORD_ARRAY_POINTER, array.model.to_s, array.map(&:id)]
-            elsif array.is_a?(Array) &&
+            if array.is_a?(Array) &&
                 (model = get_active_record_common_model(array))
               [ACTIVERECORD_ARRAY_POINTER, model, array.map(&:id)]
             end
           end
 
-          def deserialize_active_record_array(object)
+          def deserialize_active_record_object(object)
             if object.is_a?(Array) &&
                 object.try(:length) == 3 &&
-                object[0] == ACTIVERECORD_ARRAY_POINTER
+                [ACTIVERECORD_POINTER,
+                 ACTIVERECORD_ARRAY_POINTER].include?(object[0])
               object[1].constantize.find(object[2])
             end
           end

data/lib/textris/delivery.rb

@@ -6,10 +6,12 @@ module Textris
       methods = Rails.application.config.try(:textris_delivery_method)
       methods = [*methods].compact
       if methods.blank?
-        if Rails.env.test?
+        if Rails.env.development?
+          methods = [:log]
+        elsif Rails.env.test?
           methods = [:test]
         else
-          methods = [:twilio]
+          methods = [:mail]
         end
       end
 

data/lib/textris/delivery/log.rb

@@ -0,0 +1,29 @@
+module Textris
+  module Delivery
+    class Log < Textris::Delivery::Base
+      AVAILABLE_LOG_LEVELS = %w{debug info warn error fatal unknown}
+
+      def deliver(to)
+        log :info,  "Sent text to #{Phony.format(to)}"
+        log :debug, "Texter: #{message.texter || 'UnknownTexter'}" + "#" +
+          "#{message.action || 'unknown_action'}"
+        log :debug, "Date: #{Time.now}"
+        log :debug, "From: #{message.from || 'unknown'}"
+        log :debug, "To: #{message.to.map { |i| Phony.format(to) }.join(', ')}"
+        log :debug, "Content: #{message.content}"
+      end
+
+      private
+
+      def log(level, message)
+        level = Rails.application.config.try(:textris_log_level) || level
+
+        unless AVAILABLE_LOG_LEVELS.include?(level.to_s)
+          raise(ArgumentError, "Wrong log level: #{level}")
+        end
+
+        Rails.logger.send(level, message)
+      end
+    end
+  end
+end

data/lib/textris/delivery/mail.rb

@@ -56,7 +56,7 @@ module Textris
       end
 
       def get_template_interpolation(key, variables)
-        content = case key
+        case key
         when 'app', 'env'
           get_rails_variable(key)
         when 'texter', 'action', 'from_name', 'from_phone', 'content'

data/lib/textris/message.rb

@@ -40,6 +40,16 @@ module Textris
       end
     end
 
+    def from
+      if @from_name.present? && @from_phone.present?
+        "#{@from_name} <#{Phony.format(@from_phone)}>"
+      elsif @from_name.present?
+        @from_name
+      elsif @from_phone.present?
+        Phony.format(@from_phone)
+      end
+    end
+
     private
 
     def parse_from(from)

data/lib/textris/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,6 +183,7 @@ files:
 - lib/textris/delay/sidekiq/worker.rb
 - lib/textris/delivery.rb
 - lib/textris/delivery/base.rb
+- lib/textris/delivery/log.rb
 - lib/textris/delivery/mail.rb
 - lib/textris/delivery/test.rb
 - lib/textris/delivery/twilio.rb