textris 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5932f935ac05fd8ca113cb3e218b171153b106c6
-  data.tar.gz: 10c63364aeef04d95d9b6382c9949d1ff867bb47
+  metadata.gz: a8e727a1d0513890fb986e6ee295e831273c50e6
+  data.tar.gz: 99747c26382ad719e0741449f8afed9bb23048d0
 SHA512:
-  metadata.gz: 8f371b94fd9a376866847ef1b0faef2896431fa90e526327a66081600b9988f4446b6a3466390512f971ddeeb6fb7d548b545315d7e9ba2393efe2c0fe4a0fcd
-  data.tar.gz: d46bb126af552ef5008fd1aa6a5d3b2e68d16a5f22cd0952b1fb6f3255f7eb55bb571957d7b2c0fe1d68e0e0761cba6de95ad34495af9095f9cc6dff7a892896
+  metadata.gz: 82a8e78f5edb3dd26940dd23bed9c8d22b4006cc7e2692d4baf52a055a54632b99b29ca7828284dba2480260ef164f4a99ff3b340b73c044e4410f15d00063af
+  data.tar.gz: 694ba014f20b5e6a1d9476da92665741aecfe79ec2f67b5a533aa3fbe98bfd6cf05c8a88d513e87ba8d40e93edc11590f0ed6c309f9f55eb9be9aed630e5780b

data/README.md

@@ -16,7 +16,8 @@ Unlike similar gems, **textris** has some unique features:
 - 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
+- background and scheduled texting for Rails 4.2+ thanks to integration with [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html)
+- scheduled texting for Rails 4.1 and older 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*
 
@@ -68,6 +69,26 @@ end
 
 ### Background and scheduled
 
+#### ActiveJob integration
+
+As of version 0.4, **textris** supports native Rails 4.2+ way of background job handling, the [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html). You can delay delivery of your texters the same way as with ActionMailer mailers, like:
+
+```ruby
+UserTexter.welcome(user).deliver_later
+UserTexter.welcome(user).deliver_later(:wait => 1.hour)
+UserTexter.welcome(user).deliver_later(:wait_until => 1.day.from_now)
+UserTexter.welcome(user).deliver_later(:queue => :custom_queue)
+UserTexter.welcome(user).deliver_now
+```
+
+> You can safely pass ActiveRecord records as delayed action arguments. ActiveJob uses [GlobalID](https://github.com/rails/activemodel-globalid/) to serialize them for scheduled delivery.
+
+By default, `textris` queue will be used by the *Textris::Delay::ActiveJob::Job* job.
+
+#### Direct Sidekiq integration
+
+> As of Rails 4.2, ActiveJob is the recommended way for background job handling and it does support Sidekiq as its backend, so please see [chapter above](#activejob-integration) if you're using Rails 4.2 or above. Otherwise, keep on reading to use textris with Sidekiq regardless of your Rails version.
+
 Thanks to Sidekiq integration, you can send text messages in the background to speed things up, retry in case of failures or just to do it at specific time. To do so, use one of three delay methods:
 
 ```ruby
@@ -76,7 +97,7 @@ UserTexter.delay_for(1.hour).welcome(user)
 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.
+Remember not to 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.
 
@@ -252,6 +273,34 @@ You can add optional interpolation modifiers using the `%{variable:modifiers}` s
 - `h`: humanize (for instance, `user_name` becomes `User name`)
 - `p`: format phone (for instance, `48111222333` becomes `+48 111 222 333`)
 
+## Example project
+
+[Here](https://github.com/visualitypl/textris/tree/master/example/rails-4.2) you can find a simple example project that demonstrates **textris** usage with Rails 4.2. In order to see how it works or experiment with it, just go to project's directory and invoke:
+
+```
+bundle install
+rake db:migrate
+rails server
+```
+
+Open [application page](http://localhost:3000/) and fill in some user information. Sample texter will be invoked and you'll see an output similar to following in your server log:
+
+```
+[ActiveJob] Enqueued Textris::Delay::ActiveJob::Job (Job ID: 71ed54f7-02e8-4205-9093-6f2a0ff7f483) to Inline(textris) with arguments: "UserTexter", "welcome", [#<User id: 1, name: "Mr Jones", phone: "48666777888", created_at: "2015-02-20 17:17:16", updated_at: "2015-02-20 17:17:16">]
+[ActiveJob]   User Load (0.3ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = ? LIMIT 1  [["id", 1]]
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Performing Textris::Delay::ActiveJob::Job from Inline(textris) with arguments: "UserTexter", "welcome", [#<User id: 1, name: "Mr Jones", phone: "48666777888", created_at: "2015-02-20 17:17:16", updated_at: "2015-02-20 17:17:16">]
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Sent text to +48 666 777 888
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Texter: User#welcome
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Date: 2015-02-20 18:17:16 +0100
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] From: Our Team <+48 666 777 888>
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] To: +48 666 777 888
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483]   Rendered user_texter/welcome.text.erb (0.4ms)
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Content: Welcome to our system, Mr Jones!
+[ActiveJob] [Textris::Delay::ActiveJob::Job] [71ed54f7-02e8-4205-9093-6f2a0ff7f483] Performed Textris::Delay::ActiveJob::Job from Inline(textris) in 9.98ms
+```
+
+Example project may serve as a convenient sandbox for [developing custom delivery methods](#custom-delivery-methods).
+
 ## Contributing
 
 1. Fork it (https://github.com/visualitypl/textris/fork)

data/lib/textris.rb

@@ -1,5 +1,6 @@
 require 'action_controller'
 require 'action_mailer'
+require 'active_support'
 require 'phony'
 
 begin

data/lib/textris/base.rb

@@ -46,12 +46,14 @@ module Textris
     def render_content
       set_instance_variables_for_rendering
 
-      render(:template => template_name, :formats => ['text'])
+      render(:template => template_name, :formats => ['text'], :locale => @locale)
     end
 
     protected
 
     def text(options = {})
+      @locale = options[:locale] || I18n.locale
+
       options = self.class.with_defaults(options)
       options.merge!(
         :texter   => self.class,

data/lib/textris/delay/active_job.rb

@@ -8,13 +8,7 @@ module Textris
       def deliver_later(options = {})
         job = Textris::Delay::ActiveJob::Job
 
-        [:wait, :wait_until, :queue].each do |option|
-          if options.has_key?(option)
-            job.set(option => options[option])
-          end
-        end
-
-        job.perform_later(texter(:raw => true).to_s, action.to_s, args)
+        job.new(texter(:raw => true).to_s, action.to_s, args).enqueue(options)
       end
     end
   end

data/lib/textris/delivery/twilio.rb

@@ -3,13 +3,18 @@ module Textris
     class Twilio < Textris::Delivery::Base
       def deliver(to)
         client.messages.create(
-          :from => message.from_phone,
-          :to   => to,
+          :from => phone_with_plus(message.from_phone),
+          :to   => phone_with_plus(to),
           :body => message.content)
       end
 
       private
 
+      # Twillo requires phone numbers starting with a '+' sign
+      def phone_with_plus(phone)
+        phone.to_s.start_with?('+') ? phone : "+#{phone}"
+      end
+
       def client
         @client ||= ::Twilio::REST::Client.new
       end

data/lib/textris/message.rb

@@ -3,24 +3,9 @@ module Textris
     attr_reader :content, :from_name, :from_phone, :to, :texter, :action, :args
 
     def initialize(options = {})
-      @to       = parse_to      options[:to]
-      @content  = parse_content options[:content] if options[:content].present?
-      @renderer = options[:renderer]
-
-      if options.has_key?(:from)
-        @from_name, @from_phone = parse_from options[:from]
-      else
-        @from_name  = options[:from_name]
-        @from_phone = options[:from_phone]
-      end
-
-      unless @content.present? || @renderer.respond_to?(:render)
-        raise(ArgumentError, "Content must be provided")
-      end
-
-      unless @to.present?
-        raise(ArgumentError, "Recipients must be provided and E.164 compilant")
-      end
+      initialize_content(options)
+      initialize_author(options)
+      initialize_recipients(options)
 
       @texter = options[:texter]
       @action = options[:action]
@@ -57,11 +42,38 @@ module Textris
     end
 
     def content
-      @content ||= @renderer.render_content
+      @content ||= parse_content(@renderer.render_content)
     end
 
     private
 
+    def initialize_content(options)
+      if options[:content].present?
+        @content  = parse_content options[:content]
+      elsif options[:renderer].present?
+        @renderer = options[:renderer]
+      else
+        raise(ArgumentError, "Content must be provided")
+      end
+    end
+
+    def initialize_author(options)
+      if options.has_key?(:from)
+        @from_name, @from_phone = parse_from options[:from]
+      else
+        @from_name  = options[:from_name]
+        @from_phone = options[:from_phone]
+      end
+    end
+
+    def initialize_recipients(options)
+      @to = parse_to options[:to]
+
+      unless @to.present?
+        raise(ArgumentError, "Recipients must be provided and E.164 compilant")
+      end
+    end
+
     def parse_from(from)
       parse_from_dual(from) || parse_from_singular(from)
     end

data/lib/textris/version.rb

@@ -1,3 +1,3 @@
 module Textris
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: phony
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Simple SMS messaging gem for Rails based on concepts and conventions similar