textris 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e6cb842843c6a7f189e4f59b35d8f8501453757
-  data.tar.gz: 8f40de6578336302ed61860b06601578a2291b97
+  metadata.gz: e13df5317b09424b8db2890130f2e29d468bbaca
+  data.tar.gz: 77ea8801bc86ed0ee3378084445e73eeaa2e3e50
 SHA512:
-  metadata.gz: a8be0a77ed1bdba813eda54f4bae86a7b28a5451a6e7f167ad1705caaac8a2caef0ae92e2042043219f1f735bca37ae0909134b0cd2eed378345252bb4f8d2c8
-  data.tar.gz: 4fe1195f482cced30d505148fecdf44329226a70851cebe87d905c3ed9cbc5abf3a02faedcafcd6a3343fe54c205890bdcf8186f0ed2dfe37fd5c6bb6205659a
+  metadata.gz: 914d3089beba2457bf2df38e1cf310cf1de2b986b7874704b8cc9658baa0cdfea5584e368e58b4d85711a074312bde4a9a978b8b25bdbd520fadd01787ec7a3c
+  data.tar.gz: d8e5554a3ed82a078c4d77fd949700b34c4278327397d67c63300655e6bef8992fd054808414cf5698709f9ffe4c786963438163d1cf29a2b20491376fa39fd3

data/README.md

@@ -14,7 +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
+- 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*
 
@@ -62,21 +62,9 @@ class User < ActiveRecord::Base
 end
 ```
 
-### Background and scheduled processing
+### Background and scheduled
 
-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.
+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
 UserTexter.delay.welcome(user)
@@ -86,6 +74,17 @@ 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.
 
+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`:
+
+```ruby
+gem 'sidekiq'
+```
+
+Then run:
+
+    bundle install
+    bundle exec sidekiq
+
 ## Testing
 
 Access all messages that were sent with the `:test` delivery:
@@ -147,7 +146,7 @@ end
 
 #### Custom delivery methods
 
-Currently, **textris** comes with `twilio`, `test` and `mail` 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 `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`):
 
 ```ruby
 class MyProviderDelivery < Textris::Delivery::Base
@@ -165,7 +164,7 @@ end
 
 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.
 
-> You can place your custom deliveries in `app/texters` instead of `app/deliveries` if you don't want to clutter the *app* directory too much.
+> You can place your custom deliveries in `app/texters` or `app/models` instead of `app/deliveries` 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:
 

data/lib/textris.rb

@@ -2,6 +2,18 @@ require 'action_controller'
 require 'action_mailer'
 require 'phony'
 
+begin
+  require 'sidekiq'
+rescue LoadError
+  require 'textris/delay/sidekiq/missing'
+
+  Textris::Delay::Sidekiq.include(Textris::Delay::Sidekiq::Missing)
+else
+  require 'textris/delay/sidekiq'
+  require 'textris/delay/sidekiq/proxy'
+  require 'textris/delay/sidekiq/worker'
+end
+
 require 'textris/base'
 require 'textris/message'
 require 'textris/delivery'
@@ -9,4 +21,3 @@ require 'textris/delivery/base'
 require 'textris/delivery/test'
 require 'textris/delivery/mail'
 require 'textris/delivery/twilio'
-require 'textris/delay/sidekiq'

data/lib/textris/base.rb

@@ -9,6 +9,7 @@ module Textris
     end
 
     include RenderAnywhere
+    extend Textris::Delay::Sidekiq
 
     class << self
       def deliveries

data/lib/textris/delay/sidekiq.rb

@@ -1,48 +1,6 @@
-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
@@ -64,4 +22,6 @@ module Textris
       end
     end
   end
-end
+end
+
+

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

@@ -0,0 +1,15 @@
+module Textris
+  module Delay
+    module Sidekiq
+      module Missing
+        def sidekiq_missing(*args)
+          raise(LoadError, "Sidekiq is required to delay sending messages")
+        end
+
+        alias_method :delay,       :sidekiq_missing
+        alias_method :delay_for,   :sidekiq_missing
+        alias_method :delay_until, :sidekiq_missing
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Textris
+  module Delay
+    module Sidekiq
+      class Proxy
+        def initialize(texter, options = {})
+          @texter     = texter
+          @perform_in = options[:perform_in]
+          @perform_at = options[:perform_at]
+        end
+
+        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
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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
+    end
+  end
+end

data/lib/textris/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textris
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,20 +164,6 @@ 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.
@@ -191,6 +177,9 @@ files:
 - lib/textris.rb
 - lib/textris/base.rb
 - lib/textris/delay/sidekiq.rb
+- lib/textris/delay/sidekiq/missing.rb
+- lib/textris/delay/sidekiq/proxy.rb
+- lib/textris/delay/sidekiq/worker.rb
 - lib/textris/delivery.rb
 - lib/textris/delivery/base.rb
 - lib/textris/delivery/mail.rb