wire2air 0.1.0 → 0.2.2

data/Gemfile

@@ -14,5 +14,6 @@ group :development do
 end
 
 group :test do
+
   gem "trollop"
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.2

data/lib/wire2air.rb

@@ -37,12 +37,10 @@ class Wire2Air
   # @option opts [String] :username The user name to connect as
   # @option opts [String] :password The password (in plain text) for connecting
   # @option opts [Integer] :profile_id The id of the profile
-  # @options opts [Integer] :short_code The short code for the account
   # @options opts [Integer] :vasid The vasid of the account
   def initialize(opts)
-    valid_keys =[:username, :password, :profile_id, :short_code, :vasid]
+    valid_keys =[:username, :password, :profile_id, :vasid]
     if opts.keys.sort != valid_keys.sort
-      puts opts.keys
       raise ArgumentError.new "The options must only have the keys #{valid_keys}"
     end
 
@@ -52,7 +50,7 @@ class Wire2Air
 
   end
 
-  attr_reader :username, :password, :vasid, :profile_id, :short_code
+  attr_reader :username, :password, :vasid, :profile_id
 
   alias :userid :username
 
@@ -61,26 +59,30 @@ class Wire2Air
   # @param [String, Array<String>] to_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] text The message text
-  # @param [String] batch_reference If sending to multiple numbers, is used to identify
-  #   the send request used in reports
+  # @param [Hash] opts Extra optional settings
+  # @option  opts [String] :batch_reference A reference string used when sending many sms
+  # @option opts [String] :network_id Th id of the destination network. This is the same as
+  # what is passed from incoming sms message for the HTTP API.
   # @return [JobId, Integer] If a single sms is being sent, a JobId is returned. Otherwise
   # an Integer for the BatchID is returned.
   # @raise NotEnoughError Not enough credits to send the sms
   # @raise FailedAuthenticationError some authentication details are wrong
-  def send_sms(to_number, text, batch_reference = "batched send")
+  def submit_sm(short_code, to_number, text, opts = {})
     params = common_options
     params['VERSION'] = '2.0'
     params['FROM'] = short_code
     params['TEXT'] = text
-
+    params['NETWORKID'] = opts[:network_id] if opts.has_key? :network_id
     batch_send = !(to_number.is_a? String)
 
     if !batch_send
       params['TO'] = to_number
     else
       params['TO'] = to_number.join(',')
-      params['BATCHNAME'] = batch_reference
+      params['BATCHNAME'] = opts[:batch_reference]
+
     end
 
     p params
@@ -104,7 +106,7 @@ class Wire2Air
   # Adds some credits to the account
   # @param [Integer] keyword_credits The number of credits to add
   # @return [void]
-  def subscribe_credits(keyword_credits = 1)
+  def subscribe_keywords(keyword_credits = 1)
     url = URI.parse('http://mzone.wire2air.com/mserver/api/subscribekeywords.aspx')
     res = Net::HTTP.post_form(url, {
         'USERID' => userid,
@@ -129,7 +131,7 @@ class Wire2Air
 
   # returns the number of credits available
   # @return Integer the number of credits available
-  def credit_count
+  def check_sms_credits
     url = URI.parse('http://smsapi.wire2air.com/smsadmin/checksmscredits.aspx')
     res = Net::HTTP.post_form(url, {
         'USERID' => userid,
@@ -141,8 +143,10 @@ class Wire2Air
   end
 
   # Checks whether the keyword can be registered.
+  # @param [String] short_code The short code id
+  # @param [String] keyword The keyword to search for
   # @return Boolean true if the keyword is available
-  def is_keyword_available?(keyword)
+  def check_keyword(short_code, keyword)
     url = URI.parse('http://mzone.wire2air.com/shortcodemanager/api/checkkeywordapi.aspx')
     response = Net::HTTP.post_form(url, {
         'USERID' => userid,
@@ -152,6 +156,8 @@ class Wire2Air
         'KEYWORD' => keyword
     })
 
+    puts response.body
+
     response.body.include? "Err:0:"
 
 
@@ -161,6 +167,7 @@ class Wire2Air
   # registers a keyword
   # @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] :keyword
   # @option opts [String] :processor_url The url of the webserice
   # @option opts [String] :help_msg Response for help message
@@ -170,8 +177,11 @@ class Wire2Air
   # @raise KeywordIsTakenError
   def register_keyword(opts)
     url = URI.parse('http://mzone.wire2air.com/shortcodemanager/api/RegisterKeywordAPI.aspx')
-    params = common_options
-    params['SHORTCODEID'] = short_code
+    params = {}
+    params['USERID'] = username
+    params['PASSWORD'] = password
+    params['VASID'] = vasid
+    params['SHORTCODE'] = opts[:short_code_id]
     params['SERVICENAME'] = opts[:service_name]
     params['KEYWORD'] = opts[:keyword]
     params['PROCESSORURL'] = opts[:processor_url]
@@ -180,6 +190,7 @@ class Wire2Air
     params['ACTION'] = 'ADD'
 
     res = Net::HTTP.post_form(url, params).body
+    puts res
 
     case res
       when /Err:70[012346789]/, /Err:71[0134]/
@@ -197,11 +208,13 @@ class Wire2Air
   # deletes a service created with register_keyword.
   # @param [Integer] service_id The id of the service to delete
   # @param [String] keyword the keyword for the service
-  def delete_service(service_id, keyword)
+  def delete_service(short_code_id, service_id, keyword)
     url = URI.parse('http://mzone.wire2air.com/shortcodemanager/api/RegisterKeywordAPI.aspx')
-    params = common_options
-    params.delete 'PROFILEID'
-    params['SHORTCODEID'] = short_code
+    params = {}
+    params['USERID'] = username
+    params['PASSWORD'] = password
+    params['VASID'] = vasid
+    params['SHORTCODE'] = short_code_id
     params['SERVICEID'] = service_id.to_s
     params['KEYWORD'] = keyword
     params['ACTION'] = 'DELETE'

data/manual_tests.rb

@@ -1,10 +1,15 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
+# Usage: Run this script passing in parameters for --username, --password,
+# --profile-id, --short-code, --vasid, --test-number
+# It will then prompt for information and test using that
+# eg ruby manual_tests.rb --username some_username --password some_password --profile-id 42 --short-code 3 --vasid 34 --test-number 12345677
 
-require 'bundler/setup'
+require 'rubygems'
 require 'trollop'
-require './lib/wire2air'
+require 'wire2air'
 require 'rspec'
+require 'rspec/autorun'
 
 
 def prompt(string)
@@ -40,7 +45,7 @@ opts = Trollop::options do
   opt :username, "The username to log in as", :type => :string, :required => true
   opt :password, "The password to log in as", :type => :string, :required => true
   opt :profile_id, "The profile_id to log in as", :type => :string, :required => true
-  opt :short_code, "The short_code to log in as", :type => :string, :required => true
+  opt :short_code, "The short_code to use in tests", :type => :string, :required => true
   opt :vasid, "The vasid to log in as", :type => :string, :required => true
   opt :test_number, "The mobile number to test with", :type => :string, :required => true
 
@@ -52,8 +57,7 @@ end
 connection_opts = opts.dup
 
 connection_opts = { :username => opts[:username], :password => opts[:password],
-                    :profile_id => opts[:profile_id], :short_code => opts[:short_code],
-                    :vasid => opts[:vasid]
+                    :profile_id => opts[:profile_id], :vasid => opts[:vasid]
 }
 connection  = Wire2Air.new connection_opts
 
@@ -61,7 +65,7 @@ describe "sms api" do
   unless opts[:dont_test_sending_sms]
     it "should send a single sms message" do
       msg = "test message #{Time.now}"
-      puts connection.send_sms(opts[:test_number], msg)
+      puts connection.submit_sm(opts[:short_code], opts[:test_number], msg)
 
      true_false_prompt("Did a message with the text '#{msg}' get sent?").should be_true
     end
@@ -71,19 +75,20 @@ describe "sms api" do
   it 'can add more credits to the account' do
     current_credits = prompt "Enter the number of available credits currently: "
 
-    puts connection.subscribe_credits(4)
+    puts connection.subscribe_keywords(4)
     true_false_prompt("Are there now #{current_credits.to_i + 4} credits available?").should be_true
   end
 
   it 'can find if a keyword is available' do
-    connection.is_keyword_available?("testing_keyword_34551").should be_true
+    connection.check_keyword(opts[:short_code], "testing_keyword_34551").should be_true
   end
 
   it "can register a keyword and unregister a keyword" do
-    service_name = "A service name"
-    service_keyword = 'testing_keyword'
+    service_name = "New service"
+    service_keyword = 'new_keyword'
     service_id = connection.register_keyword(
         :service_name => service_name,
+        :short_code_id => opts[:short_code],
         :keyword => service_keyword,
         :processor_url => 'http://example.com/processor',
         :help_msg => "help message",
@@ -91,7 +96,7 @@ describe "sms api" do
     )
 
     true_false_prompt("Did a new service get registered with name '#{service_name}'").should be_true
-    connection.delete_service(service_id, service_keyword)
+    connection.delete_service(opts[:short_code], service_id, service_keyword)
     true_false_prompt("Did the service '#{service_name}' get deleted?").should be_true
 
 
@@ -104,4 +109,3 @@ end
 
 
 
-

data/wire2air.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wire2air}
-  s.version = "0.1.0"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{David Miani}]
-  s.date = %q{2011-08-20}
+  s.date = %q{2011-09-06}
   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 = [
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wire2air
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2011-09-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165590560 !ruby/object:Gem::Requirement
+  requirement: &2153296680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2165590560
+  version_requirements: *2153296680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2165590080 !ruby/object:Gem::Requirement
+  requirement: &2153296200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2165590080
+  version_requirements: *2153296200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2165589600 !ruby/object:Gem::Requirement
+  requirement: &2153295720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2165589600
+  version_requirements: *2153295720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2165589120 !ruby/object:Gem::Requirement
+  requirement: &2153295240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2165589120
+  version_requirements: *2153295240
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2165588640 !ruby/object:Gem::Requirement
+  requirement: &2153294760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165588640
+  version_requirements: *2153294760
 description: Allows sending sms and voice messages, checking and adding more credits,
   subscribing to keywords
 email: davidmiani@gmail.com
@@ -78,7 +78,6 @@ files:
 - .document
 - .rspec
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile

data/Gemfile.lock

@@ -1,32 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.9.2)
-    rcov (0.9.10)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    trollop (1.16.2)
-    yard (0.6.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.4)
-  rcov
-  rspec (~> 2.3.0)
-  trollop
-  yard (~> 0.6.0)