sms-easy 1.3.0 → 1.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/MIT-LICENSE +1 -1
- data/{README.rdoc → README.md} +24 -25
- data/lib/sms/easy/version.rb +1 -1
- data/sms-easy.gemspec +3 -3
- metadata +10 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: af525d30f4ff306e646910933a7bde05f1fa6537
|
4
|
+
data.tar.gz: 35b81632a61b68dfc02afed35433c9fb7c559eae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6cf9d08233a7a5febec2ba491fb1ea8046dd08e5723e5356980fc5dbb0eb5e53d0faf040e630b430d804335ec36ec8ad1276322510912fe6d3490ef1023e2845
|
7
|
+
data.tar.gz: 703546aa4125455c07c09e039e6d49a5b1c8381d1146df2e60effd688704dc8e0b5f1336ce020c64e08a8e9e3be725f28dc868455338d36a7f29366bbf1e0d42
|
data/MIT-LICENSE
CHANGED
data/{README.rdoc → README.md}
RENAMED
@@ -1,11 +1,13 @@
|
|
1
|
-
|
1
|
+
# SMSEasy (sms-easy)
|
2
2
|
|
3
3
|
SMSEasy allows you to send SMS messages from your Ruby application for free using email-to-text services provided by many carriers.
|
4
4
|
|
5
5
|
This is largely based on Brendan Lim's sms-fu for older apps. (https://github.com/brendanlim/sms-fu) If you're replacing sms-fu, SMSEasy is very similar, but not identical, and does not support legacy versions of activerecord.
|
6
6
|
|
7
|
+
Rails 4 integration is supported, though not required. Additionally, SMSEasy works perfectly well with background job processing gems such as Sidekiq and delayed_job.
|
7
8
|
|
8
|
-
|
9
|
+
|
10
|
+
## Supported Carriers (US & International):
|
9
11
|
|
10
12
|
Alltel, Ameritech, AT&T, Bell Atlantic, BellSouth Mobility, Beeline(UA), BlueSkyFrog,
|
11
13
|
Boost Mobile, BPL Mobile, Cellular South, Claro (Brazil, Nicaragua), Comcast, Du,
|
@@ -19,25 +21,24 @@ feature before they are able to receive SMS messages this way. If one your user
|
|
19
21
|
mentions that they are not receiving their messages, chances are it is due to this
|
20
22
|
limitation. Some of these carriers are include, Mobitel, Etisalat, T-Mobile (Netherlands).
|
21
23
|
|
22
|
-
|
24
|
+
## Requirements
|
23
25
|
|
24
|
-
* SMSEasy requires the use of a recent version of '
|
26
|
+
* SMSEasy requires the use of a recent version of 'action\_mailer'. Unlike the older sms-fu gem, ***only* action\_mailer 4 is supported**. If you have an older app, please try one of the older variants that supports action\_mailer 3 and/or pony email agents.
|
25
27
|
|
26
28
|
|
27
|
-
|
29
|
+
## Setup Instructions
|
28
30
|
|
29
|
-
|
31
|
+
Install the sms-easy gem:
|
30
32
|
|
31
33
|
gem install sms-easy
|
32
34
|
|
33
35
|
|
34
36
|
|
35
37
|
|
36
|
-
|
38
|
+
## Numbers and Carriers
|
37
39
|
|
38
|
-
* You
|
39
|
-
|
40
|
-
* The two required parameters are the phone number and the phone carrier.
|
40
|
+
* You'll need 10-digit phone numbers, stripped of any non-numeric characters.
|
41
|
+
* As SMSEasy relies on free carrier-specific email-to-SMS gateways, you'll also need to know the carrier of the receiving phone number.
|
41
42
|
* Here are some of the default carrier values:
|
42
43
|
|
43
44
|
Alltel Wireless => "alltel"
|
@@ -50,12 +51,11 @@ limitation. Some of these carriers are include, Mobitel, Etisalat, T-Mobile (Ne
|
|
50
51
|
Verizon Wireless => "verizon"
|
51
52
|
Vodafone Tokyo => "vodafone-jp-tokyo"
|
52
53
|
|
53
|
-
* Check sms-easy.yml for a complete list of supported carriers, including international
|
54
|
-
carriers as well.
|
54
|
+
* Check sms-easy.yml for a complete list of supported carriers, including international carriers.
|
55
55
|
|
56
|
-
|
56
|
+
## Usage
|
57
57
|
|
58
|
-
|
58
|
+
###Basic Rails Configuration
|
59
59
|
|
60
60
|
# Override the default "from" address with config/initializers/sms-easy.rb
|
61
61
|
SMSEasy::Client.config['from_address'] = "noreply@example.com"
|
@@ -72,9 +72,9 @@ limitation. Some of these carriers are include, Mobitel, Etisalat, T-Mobile (Ne
|
|
72
72
|
# Deliver a simple message.
|
73
73
|
easy.deliver("5551234567", "verizon", "Hey!")
|
74
74
|
|
75
|
-
|
75
|
+
### Basic Ruby (non-Rails) Use Case (non-Rails)
|
76
76
|
|
77
|
-
#SMSEasy will use actionmailer's default configuration, which can be overriden if needed:
|
77
|
+
# SMSEasy will use actionmailer's default configuration, which can be overriden if needed:
|
78
78
|
ActionMailer::Base.smtp_settings = {
|
79
79
|
:address => 'smtp.example.com',
|
80
80
|
# :port => '587',
|
@@ -101,31 +101,30 @@ limitation. Some of these carriers are include, Mobitel, Etisalat, T-Mobile (Ne
|
|
101
101
|
|
102
102
|
easy.deliver("5551234567", "verizon", "Boo-yaa!", :limit => 128)
|
103
103
|
|
104
|
-
|
105
|
-
|
104
|
+
# You can retrieve just the formatted address to use in your own mailer.
|
106
105
|
SMSEasy::Client.sms_address("5558675309","at&t") # => "5558675309@txt.att.net"
|
107
106
|
|
108
|
-
|
107
|
+
## View Helpers (Rails)
|
109
108
|
|
110
|
-
|
109
|
+
Include view helpers in application_helper.rb:
|
111
110
|
|
112
|
-
|
111
|
+
module ApplicationHelper
|
113
112
|
include SMSEasyHelper
|
114
113
|
end
|
115
114
|
|
116
|
-
|
115
|
+
Retrieve a collection of all carriers
|
117
116
|
|
118
117
|
<%= carrier_collection %>
|
119
118
|
|
120
|
-
|
119
|
+
Display a select box with mobile carriers
|
121
120
|
|
122
121
|
<%= carrier_select %>
|
123
122
|
|
124
|
-
|
123
|
+
Display a custom select box with mobile carriers
|
125
124
|
|
126
125
|
<%= carrier_select('user[carrier_name]', "Please choose a carrier") %>
|
127
126
|
|
128
|
-
|
127
|
+
## Special Thanks
|
129
128
|
|
130
129
|
I want to thank the following individuals with their help with adding some patches to SMS Fu:
|
131
130
|
|
data/lib/sms/easy/version.rb
CHANGED
data/sms-easy.gemspec
CHANGED
@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
|
|
18
18
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
19
|
spec.require_paths = ["lib"]
|
20
20
|
|
21
|
-
spec.add_dependency "actionmailer", '>= 4.
|
21
|
+
spec.add_dependency "actionmailer", '>= 4.2.3' # Already depends on minitest, so we don't need to add it. :)
|
22
22
|
|
23
|
-
spec.add_development_dependency 'bundler', '>= 1.
|
24
|
-
spec.add_development_dependency 'rake', '10.
|
23
|
+
spec.add_development_dependency 'bundler', '>= 1.10.5'
|
24
|
+
spec.add_development_dependency 'rake', '10.4.2'
|
25
25
|
|
26
26
|
end
|
27
27
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sms-easy
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.3.
|
4
|
+
version: 1.3.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brendan G. Lim
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2015-
|
13
|
+
date: 2015-07-20 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: actionmailer
|
@@ -18,42 +18,42 @@ dependencies:
|
|
18
18
|
requirements:
|
19
19
|
- - ">="
|
20
20
|
- !ruby/object:Gem::Version
|
21
|
-
version: 4.
|
21
|
+
version: 4.2.3
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
25
25
|
requirements:
|
26
26
|
- - ">="
|
27
27
|
- !ruby/object:Gem::Version
|
28
|
-
version: 4.
|
28
|
+
version: 4.2.3
|
29
29
|
- !ruby/object:Gem::Dependency
|
30
30
|
name: bundler
|
31
31
|
requirement: !ruby/object:Gem::Requirement
|
32
32
|
requirements:
|
33
33
|
- - ">="
|
34
34
|
- !ruby/object:Gem::Version
|
35
|
-
version: 1.
|
35
|
+
version: 1.10.5
|
36
36
|
type: :development
|
37
37
|
prerelease: false
|
38
38
|
version_requirements: !ruby/object:Gem::Requirement
|
39
39
|
requirements:
|
40
40
|
- - ">="
|
41
41
|
- !ruby/object:Gem::Version
|
42
|
-
version: 1.
|
42
|
+
version: 1.10.5
|
43
43
|
- !ruby/object:Gem::Dependency
|
44
44
|
name: rake
|
45
45
|
requirement: !ruby/object:Gem::Requirement
|
46
46
|
requirements:
|
47
47
|
- - '='
|
48
48
|
- !ruby/object:Gem::Version
|
49
|
-
version: 10.
|
49
|
+
version: 10.4.2
|
50
50
|
type: :development
|
51
51
|
prerelease: false
|
52
52
|
version_requirements: !ruby/object:Gem::Requirement
|
53
53
|
requirements:
|
54
54
|
- - '='
|
55
55
|
- !ruby/object:Gem::Version
|
56
|
-
version: 10.
|
56
|
+
version: 10.4.2
|
57
57
|
description: SMSEasy allows you to send text messages to a mobile recipient for free. It
|
58
58
|
leverages ActionMailer for delivery of text messages through e-mail. Based on the
|
59
59
|
Brendan Lim's sms-easy.
|
@@ -65,7 +65,7 @@ extra_rdoc_files: []
|
|
65
65
|
files:
|
66
66
|
- ".gitignore"
|
67
67
|
- MIT-LICENSE
|
68
|
-
- README.
|
68
|
+
- README.md
|
69
69
|
- Rakefile
|
70
70
|
- lib/sms-easy.rb
|
71
71
|
- lib/sms/easy/easy.rb
|
@@ -105,3 +105,4 @@ summary: SMSEasy allows you to send text messages to a mobile recipient for free
|
|
105
105
|
test_files:
|
106
106
|
- test/lib/sms-easy/sms-easy_test.rb
|
107
107
|
- test/test_helper.rb
|
108
|
+
has_rdoc:
|