sms_carrier 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bea90caa9579c390186c64fd2dbd159b8c4bfd70
-  data.tar.gz: 2ee0fe5ef2db5c818c86d257c42ad9807d10609c
+  metadata.gz: ee73ecb55b99a951d996f41eaf2929f11c19e3b9
+  data.tar.gz: 18404897e902d9789ce14382e79ee477f79da951
 SHA512:
-  metadata.gz: 4946aa528cd57098b66e4752f816f4ed9301a3a5036869fbd03e00b63e6207abeabfa53cfdd78997812226f701899bd3af7febfea97fe792fdcff170db190ecb
-  data.tar.gz: 31813632c3f42980ca391daaee909ba77c1a3ce5427d4e79cf2b8924a15e42a4528cced415935661d98cb5a4758fe17cc68d6fe1cacd87419c5669b357ff323f
+  metadata.gz: b858afda7b224bd955e1408ccd9817063f4d5363cd1fea5111ced4b2aed217dffece2345aa1ec29f717a45effa738695d52bb640601e9bd3e30bf29518de550e
+  data.tar.gz: 7e02ab750c68e1d13211a37efe51cc9fbf1738230617d549e056389188cf861503fe5debc20e912a013f20977cbbcff42ef371fe7d62addb7d89668b8e3f1713

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.1.2 / 2015-10-29
+
+* Add generators.
+
 # v0.1.1 / 2015-10-26
 
 * Fixed warning and add require file.

data/README.md

@@ -61,6 +61,15 @@ Or you can send SMS without carrier and template:
 SmsCarrier::Base.sms(from: "+886987654321", to: "+886912345678", body: "Your token is #{token}, please confirm your phone number").deliver_now
 ```
 
+### Deliver Later
+SMS Carrier use Active Job like Action Mailer. So you can deliver SMS later, too:
+```Ruby
+sms.deliver_later
+sms.deliver_later(wait_until: Date.tomorrow.noon)
+sms.deliver_later(wait: 1.week)
+```
+Options are defined by Active Job, please refer to [Active Job](https://github.com/rails/rails/blob/7f18ea14c893cb5c9f04d4fda9661126758332b5/activejob/lib/active_job/enqueuing.rb#L32).
+
 ### Setting defaults
 You can set up default settings in carrier by `default` method.
 ```Ruby
@@ -73,6 +82,62 @@ You can also set up in rails config, eg. `config/environments/production.rb`
 config.sms_carrier.default_options = { from: "+886987654321" }
 ```
 
+### Generators
+You can run following commands to generate carriers:
+
+    rails g carrier [name] [action] [action]...
+
+Eg
+
+    rails g carrier registration welcome
+
+It creates a Registration carrier class and test:
+```
+Carrier:     app/carriers/registration_carrier.rb
+Test:        test/carriers/registration_carrier_test.rb
+or
+RSpec:       spec/carriers/registration_carrier_spec.rb
+```
+And class looks like this:
+```Ruby
+class RegistrationCarrier < ApplicationCarrier
+  def welcome
+    # ...
+  end
+end
+```
+
+### Delivery Methods
+You can also refer to the projects:
+* [twilio-carrier](https://github.com/emn178/twilio-carrier): Twilio SMS service.
+* [yunpian-carrier](https://github.com/emn178/yunpian-carrier): Yunpian(云片) SMS service.
+* [dynamic-carrier](https://github.com/emn178/dynamic-carrier): A delivery method layer that decides the delivery method dynamically by your rules.
+* [virtual_sms](https://github.com/emn178/virtual_sms): You can send SMS to a virtual SMS box instead of real SMS service in development environment.
+
+You can implement your delivery method. 
+```Ruby
+class MyCarrier
+  attr_accessor :settings
+
+  def initialize(settings)
+    self.settings = settings
+  end
+
+  def deliver!(sms)
+    # sms.to is Array
+    # my_deliver(sms.from, sms.to, sms.body)
+  end
+end
+SmsCarrier::Base.add_delivery_method :my, MyCarrier
+```
+In your Rails project, you can set up in configuration:
+```Ruby
+config.sms_carrier.delivery_method = :my
+config.sms_carrier.my_settings = {
+  :settings => :pass_to_initialize
+}
+```
+
 ### Difference with Action Mailer
 * SMS Carrier removed preview.
 * SMS Carrier removed attachments feature.

data/lib/generators/rspec/carrier_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+		class CarrierGenerator < ::Rails::Generators::NamedBase
+		  source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+		  def create_carrier_test
+		    template 'carrier_spec.rb', File.join('spec/carriers', class_path, "#{file_name}_carrier_spec.rb")
+		  end
+		end
+	end
+end

data/lib/generators/rspec/templates/carrier_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>Carrier do
+	pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/test_unit/carrier_generator.rb

@@ -0,0 +1,11 @@
+module TestUnit
+  module Generators
+		class CarrierGenerator < ::Rails::Generators::NamedBase
+		  source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+		  def create_carrier_test
+		    template 'carrier_test.rb', File.join('test/carriers', class_path, "#{file_name}_carrier_test.rb")
+		  end
+		end
+	end
+end

data/lib/generators/test_unit/templates/carrier_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name %>CarrierTest < ActiveSupport::TestCase
+end

data/lib/rails/generators/carrier/USAGE

@@ -0,0 +1,16 @@
+Description:
+============
+    Stubs out a new carrier and its views. Passes the carrier name, either
+    CamelCased or under_scored, and an optional list of emails as arguments.
+
+    This generates a carrier class in app/carriers and invokes your template
+    engine and test framework generators.
+
+Example:
+========
+    rails generate carrier Notifications signup forgot_password invoice
+
+    creates a Notifications carrier class and test:
+        Carrier:     app/carriers/notifications_carrier.rb
+        Test:        test/carriers/notifications_carrier_test.rb
+        Rspec:       spec/carriers/notifications_carrier_spec.rb

data/lib/rails/generators/carrier/carrier_generator.rb

@@ -0,0 +1,25 @@
+module Rails
+  module Generators
+    class CarrierGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      check_class_collision suffix: "Carrier"
+
+      def create_carrier_file
+        template "carrier.rb", File.join('app/carriers', class_path, "#{file_name}_carrier.rb")
+        if self.behavior == :invoke
+          template "application_carrier.rb", 'app/carriers/application_carrier.rb'
+        end
+      end
+
+      hook_for :test_framework
+
+      protected
+        def file_name
+          @_file_name ||= super.gsub(/\_carrier/i, '')
+        end
+    end
+  end
+end

data/lib/rails/generators/carrier/templates/application_carrier.rb

@@ -0,0 +1,3 @@
+class ApplicationCarrier < SmsCarrier::Base
+  default from: "+886987654321"
+end

data/lib/rails/generators/carrier/templates/carrier.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Carrier < ApplicationCarrier
+<% actions.each do |action| -%>
+  def <%= action %>
+    @greeting = "Hi"
+
+    sms to: "+88612345678"
+  end
+<% end -%>
+end
+<% end -%>

data/lib/sms_carrier/base.rb

@@ -275,11 +275,7 @@ module SmsCarrier
         templates_name = options.delete(:template_name) || action_name
 
         template = lookup_context.find(templates_name, templates_path)
-        if template.nil?
-          raise ActionView::MissingTemplate.new(templates_path, templates_name, templates_path, false, 'carrier')
-        else
-          return render(template: template)
-        end
+        return render(template: template)
       end
     end
 

data/lib/sms_carrier/version.rb

@@ -1,3 +1,3 @@
 module SmsCarrier
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_carrier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Chen Yi-Cyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -110,6 +110,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rspec/carrier_generator.rb
+- lib/generators/rspec/templates/carrier_spec.rb
+- lib/generators/test_unit/carrier_generator.rb
+- lib/generators/test_unit/templates/carrier_test.rb
+- lib/rails/generators/carrier/USAGE
+- lib/rails/generators/carrier/carrier_generator.rb
+- lib/rails/generators/carrier/templates/application_carrier.rb
+- lib/rails/generators/carrier/templates/carrier.rb
 - lib/sms_carrier.rb
 - lib/sms_carrier/base.rb
 - lib/sms_carrier/delivery_job.rb