wire2air 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "trollop"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+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)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Miani
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,20 @@
+= Wire2Air
+
+Description goes here.
+
+== Contributing to wire2air:w
+
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 wire2air. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "wire2air"
+  gem.homepage = "http://github.com/nanothief/wire2air"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby interface to the wire2air sms and voice mail service}
+  gem.description = %Q{Allows sending sms and voice messages, checking and adding more credits, subscribing to keywords}
+  gem.email = "davidmiani@gmail.com"
+  gem.authors = ["David Miani"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/wire2air.rb

@@ -0,0 +1,226 @@
+require 'net/http'
+require 'uri'
+
+# Class for interacting with the TxtImpact sms sending and receiving service.
+# Example usage:
+#   connection = TxtImpact.new(:username => 'your_username',
+#     :password => 'your password',
+#     :profile_id => 42,
+#     :short_code => 1111,
+#     :vasid => 12345)
+#   connection.send_sms()
+class Wire2Air
+
+
+  class FailedAuthenticationError < StandardError; end
+  class NotEnoughCreditsError < StandardError; end
+  class KeywordIsTakenError < StandardError; end
+  class AccountUpdateError  < StandardError; end
+  class CreditCardDeclinedError < StandardError; end
+
+
+  class JobId
+    def initialize(mobile_number, sms_id)
+      @mobile_number, @sms_id = mobile_number, sms_id
+    end
+    attr_reader :mobile_number, :sms_id
+    def self.from_s(str)
+      matches = str.match /^JOBID: (\d+):(\d+)/
+      JobId.new(matches[1], matches[2])
+    end
+  end
+
+
+  # Initializes a TxtImpact 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
+  # @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]
+    if opts.keys.sort != valid_keys.sort
+      puts opts.keys
+      raise ArgumentError.new "The options must only have the keys #{valid_keys}"
+    end
+
+    opts.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+
+  end
+
+  attr_reader :username, :password, :vasid, :profile_id, :short_code
+
+  alias :userid :username
+
+  public
+  # sends an sms
+  # @param [String, Array<String>] to_number DESTINATION MOBILE NUMBER. [(country
+  #   code) + mobile number] e.g 17321234567 (for
+  #   US), 919810601000 (for India)
+  # @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
+  # @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")
+    params = common_options
+    params['VERSION'] = '2.0'
+    params['FROM'] = short_code
+    params['TEXT'] = text
+
+    batch_send = !(to_number.is_a? String)
+
+    if !batch_send
+      params['TO'] = to_number
+    else
+      params['TO'] = to_number.join(',')
+      params['BATCHNAME'] = 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
+      when /^ERR: 301/
+        raise FailedAuthenticationError
+      when /^ERR: 305/
+        raise NotEnoughCreditsError
+    end
+    if (batch_send)
+      res.match(/BATCHID: \d+/)[1]
+    else
+      puts res
+      JobId.from_s(res)
+    end
+  end
+
+  # Adds some credits to the account
+  # @param [Integer] keyword_credits The number of credits to add
+  # @return [void]
+  def subscribe_credits(keyword_credits = 1)
+    url = URI.parse('http://mzone.wire2air.com/mserver/api/subscribekeywords.aspx')
+    res = Net::HTTP.post_form(url, {
+        'USERID' => userid,
+        'PASSWORD' => password,
+        'KEYWORDREDITS' => keyword_credits
+
+    })
+    case res.body
+      when /^Err:70[34]/
+        raise ArgumentError.new "Missing username or password"
+      when /^Err:705/
+        raise KeywordIsTakenError
+      when /^Err:300/
+        raise FailedAuthenticationError
+      when /^Err:715/
+        raise AccountUpdateError
+      when /^Err:716/
+        raise CreditCardDeclinedError
+    end
+
+  end
+
+  # returns the number of credits available
+  # @return Integer the number of credits available
+  def credit_count
+    url = URI.parse('http://smsapi.wire2air.com/smsadmin/checksmscredits.aspx')
+    res = Net::HTTP.post_form(url, {
+        'USERID' => userid,
+        'PASSWORD' => password,
+        'VASID' => vasid
+    }).body
+    raise FailedAuthenticationError if res =~ /ERR: 301/
+    res.to_i
+  end
+
+  # Checks whether the keyword can be registered.
+  # @return Boolean true if the keyword is available
+  def is_keyword_available?(keyword)
+    url = URI.parse('http://mzone.wire2air.com/shortcodemanager/api/checkkeywordapi.aspx')
+    response = Net::HTTP.post_form(url, {
+        'USERID' => userid,
+        'PASSWORD' => password,
+        'VASID' => vasid,
+        'SHORTCODEID' => short_code,
+        'KEYWORD' => keyword
+    })
+
+    response.body.include? "Err:0:"
+
+
+  end
+
+
+  # registers a keyword
+  # @param opts Options for creating the keyword
+  # @option opts [String] :service_name Service name for the keyword
+  # @option opts [String] :keyword
+  # @option opts [String] :processor_url The url of the webserice
+  # @option opts [String] :help_msg Response for help message
+  # @option opts [String] :stop_msg Responce for opt-out message
+  # @return [Integer] The service id
+  # @raise ArgumentError If arguments are missing/invalid
+  # @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['SERVICENAME'] = opts[:service_name]
+    params['KEYWORD'] = opts[:keyword]
+    params['PROCESSORURL'] = opts[:processor_url]
+    params['HELPMSG'] = opts[:help_msg]
+    params['STOPMSG'] = opts[:stop_msg]
+    params['ACTION'] = 'ADD'
+
+    res = Net::HTTP.post_form(url, params).body
+
+    case res
+      when /Err:70[012346789]/, /Err:71[0134]/
+        raise ArgumentError.new res
+      when /Err:705/
+        raise KeywordIsTakenError
+      when /Err:712/
+        raise "Sticky session is not allowed"
+    end
+
+    res.match(/SERVICEID:(\d+)/)[1].to_i
+
+  end
+
+  # 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)
+    url = URI.parse('http://mzone.wire2air.com/shortcodemanager/api/RegisterKeywordAPI.aspx')
+    params = common_options
+    params.delete 'PROFILEID'
+    params['SHORTCODEID'] = short_code
+    params['SERVICEID'] = service_id.to_s
+    params['KEYWORD'] = keyword
+    params['ACTION'] = 'DELETE'
+    p params
+    res = Net::HTTP.post_form(url, params)
+    raise StandardError.new res.body unless res.body.start_with? "SERVICEID"
+  end
+
+  private
+  def common_options
+    { 'USERID' => username,
+      'PASSWORD' => password,
+      'VASID' => vasid,
+      'PROFILEID' => profile_id,
+    }
+
+  end
+
+
+end
+
+

data/manual_tests.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'bundler/setup'
+require 'trollop'
+require './lib/wire2air'
+require 'rspec'
+
+
+def prompt(string)
+  STDOUT.sync = true
+  print string
+  res = gets
+  STDOUT.sync = false
+  res
+end
+
+def true_false_prompt(string)
+  res = prompt(string + "(y/n)")
+  res[0].downcase != "n"
+end
+
+def fail_with_message(msg)
+  puts msg
+  exit 1
+end
+
+def test_section(section_name)
+  puts "testing #{section_name}"
+  res = yield
+  if res
+    puts "#{section_name} working correctly"
+  else
+    puts "FAILED: #{section_name}"
+    exit 1
+  end
+end
+
+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 :vasid, "The vasid to log in as", :type => :string, :required => true
+  opt :test_number, "The mobile number to test with", :type => :string, :required => true
+
+  opt :dont_test_sending_sms, "Prevent the sending of sms from being tested"
+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]
+}
+connection  = Wire2Air.new connection_opts
+
+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)
+
+     true_false_prompt("Did a message with the text '#{msg}' get sent?").should be_true
+    end
+  end
+
+
+  it 'can add more credits to the account' do
+    current_credits = prompt "Enter the number of available credits currently: "
+
+    puts connection.subscribe_credits(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
+  end
+
+  it "can register a keyword and unregister a keyword" do
+    service_name = "A service name"
+    service_keyword = 'testing_keyword'
+    service_id = connection.register_keyword(
+        :service_name => service_name,
+        :keyword => service_keyword,
+        :processor_url => 'http://example.com/processor',
+        :help_msg => "help message",
+        :stop_msg => "stop message"
+    )
+
+    true_false_prompt("Did a new service get registered with name '#{service_name}'").should be_true
+    connection.delete_service(service_id, service_keyword)
+    true_false_prompt("Did the service '#{service_name}' get deleted?").should be_true
+
+
+  end
+end
+
+
+
+
+
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'txtimpact_sms'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/txtimpact_sms_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TxtimpactSms" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/wire2air.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wire2air}
+  s.version = "0.1.0"
+
+  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.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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/wire2air.rb",
+    "manual_tests.rb",
+    "spec/spec_helper.rb",
+    "spec/txtimpact_sms_spec.rb",
+    "wire2air.gemspec"
+  ]
+  s.homepage = %q{http://github.com/nanothief/wire2air}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{Ruby interface to the wire2air sms and voice mail service}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: wire2air
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Miani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165590560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165590560
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2165590080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165590080
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165589600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165589600
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2165589120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2165589120
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2165588640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165588640
+description: Allows sending sms and voice messages, checking and adding more credits,
+  subscribing to keywords
+email: davidmiani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/wire2air.rb
+- manual_tests.rb
+- spec/spec_helper.rb
+- spec/txtimpact_sms_spec.rb
+- wire2air.gemspec
+homepage: http://github.com/nanothief/wire2air
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the wire2air sms and voice mail service
+test_files: []