eztexting 0.3.2 → 0.3.3
Sign up to get free protection for your applications and to get access to all the features.
- data/README.textile +13 -13
- data/RELEASE_NOTES +41 -41
- data/Rakefile +1 -1
- data/eztexting.gemspec +2 -2
- metadata +4 -4
data/README.textile
CHANGED
@@ -1,17 +1,17 @@
|
|
1
|
-
h1.
|
1
|
+
h1. Ez Texting Gem
|
2
2
|
|
3
|
-
0.3.
|
3
|
+
0.3.3
|
4
4
|
|
5
|
-
This is
|
5
|
+
This gem is designed to make the Ez Texting SMS text messaging API's as easy to use as possible. They allow for use of all of what the API offers in a
|
6
6
|
very easy and clear fashion.
|
7
7
|
|
8
8
|
h2. Dependencies
|
9
9
|
|
10
|
-
This gem relies on HTTParty for making its requests. That is the only runtime dependency. The testing uses rspec
|
10
|
+
This gem relies on HTTParty for making its requests. That is the only runtime dependency. The testing uses rspec. The documentation
|
11
11
|
is written to be viewed with YARD.
|
12
12
|
|
13
13
|
h2. API Calls Available
|
14
|
-
|
14
|
+
The following calls are available, along with the corresponding classes to use them
|
15
15
|
|
16
16
|
* SMS (Eztexting::Sms)
|
17
17
|
* Credit Purchase and Balance Check (Eztexting::Credits)
|
@@ -21,12 +21,12 @@ These are the following calls available and their corresponding classes to use t
|
|
21
21
|
|
22
22
|
h2. How To Use / How The Gem Is Setup
|
23
23
|
|
24
|
-
|
25
|
-
can use any of the classes to interact with
|
24
|
+
Call the connect method on the Eztexting module. Once that's done then your credentials are cached and you
|
25
|
+
can use any of the classes to interact with Ez Texting's API's.
|
26
26
|
|
27
|
-
**All API calls require your
|
28
|
-
the connect method and cache them. By doing this you enter your credentials once and then they merged with the options for the
|
29
|
-
want to make. This
|
27
|
+
**All API calls require your username and password** which is why you call
|
28
|
+
the connect method and cache them. By doing this you enter your credentials once and then they are merged with the options for the API call you
|
29
|
+
want to make. This reduces friction when interacting with the Ez Texting API - as there is no state or authentication and the credentials
|
30
30
|
must be passed along through every request.
|
31
31
|
|
32
32
|
|
@@ -39,9 +39,9 @@ Eztexting.connect!('username','password')
|
|
39
39
|
# => "credentials cached"
|
40
40
|
|
41
41
|
# Make a hash with the required keys of subject, message and phonenumber
|
42
|
-
# and then send out the SMS.
|
43
|
-
# The response will be an array
|
44
|
-
# documentation lists
|
42
|
+
# and then send out the SMS. It's that simple. 3 lines, 2 if you condense the creation of the Hash into the Method call.
|
43
|
+
# The response will be an array: the first element will be the response mapped from the code to the literal that the Ez Texting
|
44
|
+
# documentation lists; rhe second element will be the raw value. In some cases this bit is important - in the credit balance
|
45
45
|
# check this would be the number of credits.
|
46
46
|
options = {:subject => "testing out how awesome eztexting is", :phonenumber => "5555555555", :message => "Wow this is so simple and easy to use"}
|
47
47
|
Eztexting::Sms.single(options)
|
data/RELEASE_NOTES
CHANGED
@@ -1,41 +1,41 @@
|
|
1
|
-
Carrier Lookup Account Issues
|
2
|
-
The
|
3
|
-
you must have one account for the Carrier lookup API command and another for all other commands. To use this gem with respect to this
|
4
|
-
issue you need to swap the accounts (calling the Eztexting.connect! method) when using the carrier lookup command and then swap
|
5
|
-
if back to your account for the rest of the API when you use those commands
|
6
|
-
|
7
|
-
Example
|
8
|
-
---------------------------------------------------------
|
9
|
-
1) Cache your credentials for your account for the API
|
10
|
-
|
11
|
-
# Account for API usage (except carrier lookup)
|
12
|
-
Eztexting.connect!(username_for_api_without_carrier,password)
|
13
|
-
# => "credentials cached"
|
14
|
-
|
15
|
-
2) Use as you wish for all commands except the carrier lookup
|
16
|
-
options = {
|
17
|
-
:subject => "testing out how awesome eztexting is",
|
18
|
-
:phonenumber => "5555555555",
|
19
|
-
:message => "Wow this is so simple and easy to use"
|
20
|
-
}
|
21
|
-
Eztexting::Sms.single(options)
|
22
|
-
# => ["Message Sent",1]
|
23
|
-
|
24
|
-
Eztexting::Credits.balance
|
25
|
-
# => ["The amount of plan and additional credits available", 54353]
|
26
|
-
|
27
|
-
|
28
|
-
3) Swap your credentials by calling the connect! method again with the different account information
|
29
|
-
|
30
|
-
Eztexting.connect!(carrier_lookup_enabled_account,password)
|
31
|
-
# => "credentials cached
|
32
|
-
|
33
|
-
|
34
|
-
4) Call the lookup command as much as you need
|
35
|
-
Eztexting::Lookup.carrier(5555555555)
|
36
|
-
|
37
|
-
|
38
|
-
5) When you need to use any of the other API commands change your cached credentials back to the account for the rest of the API
|
39
|
-
Eztexting.connect!(username_for_api_without_carrier,password)
|
40
|
-
# => "credentials cached"
|
41
|
-
|
1
|
+
Carrier Lookup Account Issues
|
2
|
+
The Ez Texting service has a slight caveat for usage of the carrier lookup command. Unfortunately the account system is setup so that
|
3
|
+
you must have one account for the Carrier lookup API command and another for all other commands. To use this gem with respect to this
|
4
|
+
issue you need to swap the accounts (calling the Eztexting.connect! method) when using the carrier lookup command and then swap
|
5
|
+
if back to your account for the rest of the API when you use those commands
|
6
|
+
|
7
|
+
Example
|
8
|
+
---------------------------------------------------------
|
9
|
+
1) Cache your credentials for your account for the API
|
10
|
+
|
11
|
+
# Account for API usage (except carrier lookup)
|
12
|
+
Eztexting.connect!(username_for_api_without_carrier,password)
|
13
|
+
# => "credentials cached"
|
14
|
+
|
15
|
+
2) Use as you wish for all commands except the carrier lookup
|
16
|
+
options = {
|
17
|
+
:subject => "testing out how awesome eztexting is",
|
18
|
+
:phonenumber => "5555555555",
|
19
|
+
:message => "Wow this is so simple and easy to use"
|
20
|
+
}
|
21
|
+
Eztexting::Sms.single(options)
|
22
|
+
# => ["Message Sent",1]
|
23
|
+
|
24
|
+
Eztexting::Credits.balance
|
25
|
+
# => ["The amount of plan and additional credits available", 54353]
|
26
|
+
|
27
|
+
|
28
|
+
3) Swap your credentials by calling the connect! method again with the different account information
|
29
|
+
|
30
|
+
Eztexting.connect!(carrier_lookup_enabled_account,password)
|
31
|
+
# => "credentials cached
|
32
|
+
|
33
|
+
|
34
|
+
4) Call the lookup command as much as you need
|
35
|
+
Eztexting::Lookup.carrier(5555555555)
|
36
|
+
|
37
|
+
|
38
|
+
5) When you need to use any of the other API commands change your cached credentials back to the account for the rest of the API
|
39
|
+
Eztexting.connect!(username_for_api_without_carrier,password)
|
40
|
+
# => "credentials cached"
|
41
|
+
|
data/Rakefile
CHANGED
@@ -3,7 +3,7 @@ require 'rake'
|
|
3
3
|
require 'echoe'
|
4
4
|
require 'yard'
|
5
5
|
|
6
|
-
Echoe.new('eztexting', '0.3.
|
6
|
+
Echoe.new('eztexting', '0.3.3') do |p|
|
7
7
|
p.description = "A Gem to make using eztexting simple and fun"
|
8
8
|
p.url = "http://github.com/EzTexting/eztexting"
|
9
9
|
p.author = "David Malin"
|
data/eztexting.gemspec
CHANGED
@@ -2,11 +2,11 @@
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |s|
|
4
4
|
s.name = %q{eztexting}
|
5
|
-
s.version = "0.3.
|
5
|
+
s.version = "0.3.3"
|
6
6
|
|
7
7
|
s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
|
8
8
|
s.authors = ["David Malin"]
|
9
|
-
s.date = %q{
|
9
|
+
s.date = %q{2011-01-04}
|
10
10
|
s.description = %q{A Gem to make using eztexting simple and fun}
|
11
11
|
s.email = %q{dmalin@eztexting.com}
|
12
12
|
s.extra_rdoc_files = ["LICENSE", "README.textile", "lib/eztexting.rb", "lib/eztexting/availablity.rb", "lib/eztexting/base.rb", "lib/eztexting/credits.rb", "lib/eztexting/keywords.rb", "lib/eztexting/lookup.rb", "lib/eztexting/sms.rb", "lib/eztexting/voice.rb"]
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: eztexting
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 21
|
5
5
|
prerelease: false
|
6
6
|
segments:
|
7
7
|
- 0
|
8
8
|
- 3
|
9
|
-
-
|
10
|
-
version: 0.3.
|
9
|
+
- 3
|
10
|
+
version: 0.3.3
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- David Malin
|
@@ -15,7 +15,7 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date:
|
18
|
+
date: 2011-01-04 00:00:00 -05:00
|
19
19
|
default_executable:
|
20
20
|
dependencies:
|
21
21
|
- !ruby/object:Gem::Dependency
|