wire2air 0.3.0 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/wire2air.rb

@@ -1,12 +1,12 @@
 require 'net/http'
 require 'uri'
 
-# Class for interacting with the TxtImpact sms sending and receiving service.
+# Class for interacting with the Wire2Air sms sending and receiving service.
 # Example usage:
-#   connection = TxtImpact.new(:username => 'your_username',
+#   connection = Wire2Air.new(:username => 'your_username',
 #     :password => 'your password',
 #     :profile_id => 42,
-#     :short_code => 1111,
+#     :from => 1111,
 #     :vasid => 12345)
 #   connection.submit_sm()
 class Wire2Air
@@ -31,7 +31,7 @@ class Wire2Air
   end
 
 
-  # Initializes a TxtImpact object with the common profile info needed
+  # Initializes a Wire2Air object with the common profile info needed
   # for making connections.
   # @param [Hash] opts The profile connection options
   # @option opts [String] :username The user name to connect as
@@ -56,10 +56,10 @@ class Wire2Air
 
   public
   # sends an sms
-  # @param [String, Array<String>] to_number DESTINATION MOBILE NUMBER. [(country
+  # @param [String, Array<String>] mobile_number DESTINATION MOBILE NUMBER. [(country
   #   code) + mobile number] e.g 17321234567 (for
   #   US), 919810601000 (for India)
-  # @param [String] short_code The short code number
+  # @param [String] from The short code number
   # @param [String] text The message text
   # @param [Hash] opts Extra optional settings
   # @option  opts [String] :batch_reference A reference string used when sending many sms
@@ -69,24 +69,22 @@ class Wire2Air
   # an Integer for the BatchID is returned.
   # @raise NotEnoughError Not enough credits to send the sms
   # @raise FailedAuthenticationError some authentication details are wrong
-  def submit_sm(short_code, to_number, text, opts = {})
+  def submit_sm(from, mobile_number, text, opts = {})
     params = common_options
     params['VERSION'] = '2.0'
-    params['FROM'] = short_code
+    params['FROM'] = from
     params['TEXT'] = text
     params['NETWORKID'] = opts[:network_id] if opts.has_key? :network_id
-    batch_send = !(to_number.is_a? String)
+    batch_send = !(mobile_number.is_a? String)
 
     if !batch_send
-      params['TO'] = to_number
+      params['TO'] = mobile_number
     else
-      params['TO'] = to_number.join(',')
+      params['TO'] = mobile_number.join(',')
       params['BATCHNAME'] = opts[:batch_reference]
 
     end
 
-    p params
-
     url = URI.parse('http://smsapi.wire2air.com/smsadmin/submitsm.aspx')
     res = Net::HTTP.post_form(url, params).body
     case res
@@ -138,7 +136,7 @@ class Wire2Air
         'PASSWORD' => password,
         'VASID' => vasid
     }).body
-    raise FailedAuthenticationError if res =~ /ERR: 301/
+    raise FailedAuthenticationError if res =~ /ERR:301/
     res.to_i
   end
 
@@ -152,14 +150,20 @@ class Wire2Air
         'USERID' => userid,
         'PASSWORD' => password,
         'VASID' => vasid,
-        'SHORTCODEID' => short_code,
+        'SHORTCODE' => short_code,
         'KEYWORD' => keyword
     })
 
-    puts response.body
-
-    response.body.include? "Err:0:"
-
+    case response.body
+      when /Err:0/
+        return true
+      when /Err:705/
+        return false
+      when /Err:301/
+        raise FailedAuthenticationError
+      else
+        raise StandardError.new response.body
+    end
 
   end
 
@@ -168,7 +172,7 @@ class Wire2Air
   # for a given short code.
   # @param opts Options for creating the keyword
   # @option opts [String] :service_name Service name for the keyword
-  # @option opts [String] :short_code_id
+  # @option opts [String] :short_code
   # @option opts [String] :keyword
   # @option opts [String] :processor_url The url of the webservice
   # @option opts [String] :help_msg Response for help message
@@ -185,7 +189,7 @@ class Wire2Air
     params['USERID'] = username
     params['PASSWORD'] = password
     params['VASID'] = vasid
-    params['SHORTCODE'] = opts[:short_code_id]
+    params['SHORTCODE'] = opts[:short_code]
     params['SERVICENAME'] = opts[:service_name]
     params['KEYWORD'] = opts[:keyword]
     params['PROCESSORURL'] = opts[:processor_url]
@@ -199,6 +203,8 @@ class Wire2Air
     case res
       when /Err:70[012346789]/, /Err:71[0134]/
         raise ArgumentError.new res
+      when /Err:300/
+        raise FailedAuthenticationError
       when /Err:705/
         raise KeywordIsTakenError
       when /Err:712/

data/manual_tests.rb

@@ -71,12 +71,16 @@ describe "sms api" do
     end
   end
 
+  it 'can check the number of available credits' do
+    credits = connection.check_sms_credits
+    true_false_prompt("Are there #{credits} number of sms credits available?").should be_true
+  end
 
   it 'can add more credits to the account' do
-    current_credits = prompt "Enter the number of available credits currently: "
+    current_credits = prompt "Enter the number of available keyword credits currently: "
 
     puts connection.subscribe_keywords(4)
-    true_false_prompt("Are there now #{current_credits.to_i + 4} credits available?").should be_true
+    true_false_prompt("Are there now #{current_credits.to_i + 4} keyword credits available?").should be_true
   end
 
   it 'can find if a keyword is available' do
@@ -88,7 +92,7 @@ describe "sms api" do
     service_keyword = 'new_keyword'
     service_id = connection.register_keyword(
         :service_name => service_name,
-        :short_code_id => opts[:short_code],
+        :short_code => opts[:short_code],
         :keyword => service_keyword,
         :processor_url => 'http://example.com/processor',
         :help_msg => "help message",
@@ -96,8 +100,6 @@ describe "sms api" do
     )
 
     true_false_prompt("Did a new service get registered with name '#{service_name}'").should be_true
-    connection.delete_service(opts[:short_code], service_id, service_keyword)
-    true_false_prompt("Did the service '#{service_name}' get deleted?").should be_true
 
 
   end

data/wire2air.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wire2air}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{David Miani}]
-  s.date = %q{2011-09-06}
+  s.date = %q{2011-09-08}
   s.description = %q{Allows sending sms and voice messages, checking and adding more credits, subscribing to keywords}
   s.email = %q{davidmiani@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wire2air
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153620960 !ruby/object:Gem::Requirement
+  requirement: &2153338800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2153620960
+  version_requirements: *2153338800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153636860 !ruby/object:Gem::Requirement
+  requirement: &2153338320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2153636860
+  version_requirements: *2153338320
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153636380 !ruby/object:Gem::Requirement
+  requirement: &2153337840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153636380
+  version_requirements: *2153337840
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2153635900 !ruby/object:Gem::Requirement
+  requirement: &2153337360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2153635900
+  version_requirements: *2153337360
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2153635420 !ruby/object:Gem::Requirement
+  requirement: &2153336880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153635420
+  version_requirements: *2153336880
 description: Allows sending sms and voice messages, checking and adding more credits,
   subscribing to keywords
 email: davidmiani@gmail.com