sms_carrier 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8856860fad36aa1fa2eef28c277106e3c3e8a361
-  data.tar.gz: 261bcc32724a7d9c75eae9217208800a1117881f
+  metadata.gz: bea90caa9579c390186c64fd2dbd159b8c4bfd70
+  data.tar.gz: 2ee0fe5ef2db5c818c86d257c42ad9807d10609c
 SHA512:
-  metadata.gz: 0f5dccb9d50b80a849099fb1df1dc732ae78a6ca50c4d7e750e725472ef1debe2b149845b8cd46e78d881b017473df20445e8d9979d35fe4910e017d81ec39d5
-  data.tar.gz: 0a144ff33491e6ae9bd781010eacb4cbf76e347b670a886b5c9102e5dd755b8c31a3365ccef590b1f925378bae702129e3970ae112fb669350afdfcb8da85363
+  metadata.gz: 4946aa528cd57098b66e4752f816f4ed9301a3a5036869fbd03e00b63e6207abeabfa53cfdd78997812226f701899bd3af7febfea97fe792fdcff170db190ecb
+  data.tar.gz: 31813632c3f42980ca391daaee909ba77c1a3ce5427d4e79cf2b8924a15e42a4528cced415935661d98cb5a4758fe17cc68d6fe1cacd87419c5669b357ff323f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.1.1 / 2015-10-26
+
+* Fixed warning and add require file.
+
 # v0.1.0 / 2015-10-23
 
 Create project

data/README.md

@@ -3,9 +3,7 @@
 [![Build Status](https://api.travis-ci.org/emn178/sms_carrier.png)](https://travis-ci.org/emn178/sms_carrier)
 [![Coverage Status](https://coveralls.io/repos/emn178/sms_carrier/badge.svg?branch=master)](https://coveralls.io/r/emn178/sms_carrier?branch=master)
 
-SMS Carrier is a framework for designing SMS service layers. These layers are used to consolidate code for sending out confirmation token, and any other use case that requires a written notification to either a person or another system.
-
-SMS Carrier is in essence a wrapper around Action Controller. It provides a way to make SMSes using templates in the same way that Action Controller renders views using templates.
+SMS Carrier is a framework for designing SMS service layers. This is modified from Action Mailer of Rails framework, so the most of usage is just like Action Mailer.
 
 ## Installation
 
@@ -25,11 +23,9 @@ Or install it yourself as:
 
 ## Usage
 ### Sending SMSes
-The framework works by initializing any instance variables you want to be available in the SMS template, followed by a call to sms to deliver the SMS.
-
-This can be as simple as:
+You can use carrier and template to send SMSes.
 ```Ruby
-class Notifier < SmsCarrier::Base
+class RegistrationCarrier < SmsCarrier::Base
   default from: '+886987654321'
 
   def welcome(recipient, token)
@@ -38,44 +34,50 @@ class Notifier < SmsCarrier::Base
   end
 end
 ```
-The body of the SMS is created by using an Action View template (regular ERB) that has the instance variables that are declared in the carrier action.
-
-So the corresponding body template for the method above could look like this:
+In your view, eg. `app/views/registration_carrier/welcome.erb.html`
 ```
 Your token is <%= @token %>, please confirm your phone number
 ```
-If the token was given as “1234”, the SMS generated would look like this:
+
+If the token was given as `1234`, the SMS generated would look like this:
 ```
 Your token is 1234, please confirm your phone number
 ```
+
 In order to send SMSes, you simply call the method and then call deliver_now on the return value.
 
 Calling the method returns a Sms object:
 ```Ruby
-message = Notifier.welcome("1234")   # => Returns a SmsCarrier::Sms object
-message.deliver_now                  # => delivers the SMS
+sms = RegistrationCarrier.welcome("+886912345678", "1234")
+sms.deliver_now
 ```
 Or you can just chain the methods together like:
 ```Ruby
-Notifier.welcome("1234").deliver_now # Creates the SMS and sends it immediately
+RegistrationCarrier.welcome("+886912345678", "1234").deliver_now
 ```
+
 Or you can send SMS without carrier and template:
 ```Ruby
-SmsCarrier::Base.sms(from: "+886987654321", to: "+886912345678", body: "Your token is #{@token}").deliver_now
+SmsCarrier::Base.sms(from: "+886987654321", to: "+886912345678", body: "Your token is #{token}, please confirm your phone number").deliver_now
 ```
 
 ### Setting defaults
-It is possible to set default values that will be used in every method in your SMS Carrier class. To implement this functionality, you just call the public class method default which you get for free from SmsCarrier::Base. This method accepts a Hash as the parameter. You can use any of the options, SMS messages have, like :from as the key. You can also pass in a string as the key, like “Content-Type”, but SMS Carrier does this out of the box for you, so you won't need to worry about that. Finally, it is also possible to pass in a Proc that will get evaluated when it is needed.
-
-Note that every value you set with this method will get overwritten if you use the same key in your carrier method.
-
-Example:
+You can set up default settings in carrier by `default` method.
 ```Ruby
 class AuthenticationCarrier < SmsCarrier::Base
   default from: "+886987654321", body: Proc.new { "SMS was generated at #{Time.now}" }
-  .....
 end
 ```
+You can also set up in rails config, eg. `config/environments/production.rb`
+```Ruby
+config.sms_carrier.default_options = { from: "+886987654321" }
+```
+
+### Difference with Action Mailer
+* SMS Carrier removed preview.
+* SMS Carrier removed attachments feature.
+* SMS Carrier removed multiple part rendering.
+* SMS Carrier use `Hash` as options to replace the `Mail::Header` as headers in Action Mailer.
 
 ## License
 

data/lib/sms_carrier/base.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/module/anonymous'
+require 'active_support/core_ext/hash/reverse_merge'
 
 require 'sms_carrier/sms'
 require 'sms_carrier/log_subscriber'

data/lib/sms_carrier/sms.rb

@@ -1,6 +1,6 @@
 module SmsCarrier
   class Sms
-    attr_accessor :body, :from, :to, :options, :perform_deliveries, :raise_delivery_errors, :delivery_handler
+    attr_accessor :body, :from, :options, :perform_deliveries, :raise_delivery_errors, :delivery_handler
 
     def initialize
       @options = {}

data/lib/sms_carrier/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_carrier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chen Yi-Cyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack