textris 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb703c3bd61fb19f5b040f6225d6c390fc1c2473
-  data.tar.gz: a42312ca7c46a2f18dc15b739c58ae87157b85c4
+  metadata.gz: 1e6cb842843c6a7f189e4f59b35d8f8501453757
+  data.tar.gz: 8f40de6578336302ed61860b06601578a2291b97
 SHA512:
-  metadata.gz: e30b26878f3cc4894b9b3189a29579c1b4fdc06a7f84a5a3bbf598c9be940725fd14304d34fb1a3d2e8a6598aa044810b0311335ca4807b889abb32fa1f98650
-  data.tar.gz: 43f57914ef22307eb2095b787f68763c1a5ce0ac0069b1225d2f349d5f89687c977052cb4617df16daaa3773be3cb71753cc6dbac5d077b2058db8a47b05e58b
+  metadata.gz: a8be0a77ed1bdba813eda54f4bae86a7b28a5451a6e7f167ad1705caaac8a2caef0ae92e2042043219f1f735bca37ae0909134b0cd2eed378345252bb4f8d2c8
+  data.tar.gz: 4fe1195f482cced30d505148fecdf44329226a70851cebe87d905c3ed9cbc5abf3a02faedcafcd6a3343fe54c205890bdcf8186f0ed2dfe37fd5c6bb6205659a

data/README.md

@@ -1,8 +1,9 @@
 # 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)
+[![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)
+[![Test Coverage](https://codeclimate.com/github/visualitypl/textris/badges/coverage.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.
 
@@ -13,6 +14,7 @@ Unlike similar gems, **textris** has some unique features:
 - 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)
+- background and scheduled processing 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*
 
@@ -60,6 +62,30 @@ class User < ActiveRecord::Base
 end
 ```
 
+### Background and scheduled processing
+
+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 specified time. To do so, first include the `Textris::Delay::Sidekiq` module in your texter:
+
+```ruby
+class UserTexter < Textris::Base
+  include Textris::Delay::Sidekiq
+
+  def welcome(user)
+    # ...
+  end
+end
+```
+
+Then use one of three delay methods.
+
+```ruby
+UserTexter.delay.welcome(user)
+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.
+
 ## Testing
 
 Access all messages that were sent with the `:test` delivery:

data/lib/textris.rb

@@ -9,3 +9,4 @@ require 'textris/delivery/base'
 require 'textris/delivery/test'
 require 'textris/delivery/mail'
 require 'textris/delivery/twilio'
+require 'textris/delay/sidekiq'

data/lib/textris/delay/sidekiq.rb

@@ -0,0 +1,67 @@
+require 'sidekiq'
+
+module Textris
+  module Delay
+    module Sidekiq
+      class Worker
+        include ::Sidekiq::Worker
+
+        def perform(texter, action, params)
+          texter = texter.safe_constantize
+
+          if texter.present?
+            texter.new(action, *params).call_action.deliver
+          end
+        end
+      end
+
+      class Proxy
+        def initialize(texter, options = {})
+          @texter     = texter
+          @perform_in = options[:perform_in]
+          @perform_at = options[:perform_at]
+        end
+
+        private
+
+        def method_missing(method_name, *args)
+          args = [@texter, method_name, args]
+
+          if @perform_in
+            ::Textris::Delay::Sidekiq::Worker.perform_in(@perform_in, *args)
+          elsif @perform_at
+            ::Textris::Delay::Sidekiq::Worker.perform_at(@perform_at, *args)
+          else
+            ::Textris::Delay::Sidekiq::Worker.perform_async(*args)
+          end
+        end
+      end
+
+      class << self
+        def included(base)
+          base.extend(self)
+        end
+      end
+
+      def delay
+        ::Textris::Delay::Sidekiq::Proxy.new(self)
+      end
+
+      def delay_for(interval)
+        unless interval.is_a?(Fixnum)
+          raise(ArgumentError, "Proper interval must be provided")
+        end
+
+        ::Textris::Delay::Sidekiq::Proxy.new(self, :perform_in => interval)
+      end
+
+      def delay_until(timestamp)
+        unless timestamp.respond_to?(:to_time)
+          raise(ArgumentError, "Proper timestamp must be provided")
+        end
+
+        ::Textris::Delay::Sidekiq::Proxy.new(self, :perform_at => timestamp)
+      end
+    end
+  end
+end

data/lib/textris/version.rb

@@ -1,3 +1,3 @@
 module Textris
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Karol Słuszniak
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  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
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Implement texter classes for sending SMS messages in similar way to how
   e-mails are sent with ActionMailer-based mailers. Take advantage of e-mail proxying
   and enhanced phone number parsing, among others.
@@ -148,6 +190,7 @@ files:
 - README.md
 - lib/textris.rb
 - lib/textris/base.rb
+- lib/textris/delay/sidekiq.rb
 - lib/textris/delivery.rb
 - lib/textris/delivery/base.rb
 - lib/textris/delivery/mail.rb