aql_sms_api 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Russell
+
+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.md

@@ -0,0 +1,39 @@
+# AQL SMS API
+
+A ruby wrapper for the AQL SMS API. I am building this for use in a specific project, nothing more. If you feel it can be enhanced and devloped then please feel free to fork away.
+
+## Usage
+
+#### Authentication
+
+    # @params username, password [, originator]
+    #
+    AQL::SMS.authenticate "username", "password"
+
+#### Check credit
+
+    # @return integer number of credits
+    #
+    AQL::SMS.check_credit
+
+#### Send message
+
+    # @params desitnation, message [, options]
+    #   destination can be single number string or array of multiple numbers
+    #   options can be hash of :originator, :max_concat, :sendtime, :unix_sendtime, :replace_sms, :flash, :dlr_url
+    #
+    AQL::SMS.send_message "07777 777 777", "R U coming rnd 2 mine 2nite?"
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Aaron Russell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "aql_sms_api"
+    gem.summary = %Q{A ruby wrapper for the AQL SMS API.}
+    gem.description = %Q{A ruby wrapper for the AQL SMS API.}
+    gem.email = "aaron@gc4.co.uk"
+    gem.homepage = "http://github.com/aaronrussell/aql_sms_api"
+    gem.authors = ["Aaron Russell"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "httparty", ">= 0.5.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "aql_sms_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/aql_sms_api.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aql_sms_api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Russell"]
+  s.date = %q{2010-05-28}
+  s.description = %q{A ruby wrapper for the AQL SMS API.}
+  s.email = %q{aaron@gc4.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "aql_sms_api.gemspec",
+     "lib/aql_sms_api.rb",
+     "test/helper.rb",
+     "test/test_aql_sms_api.rb"
+  ]
+  s.homepage = %q{http://github.com/aaronrussell/aql_sms_api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A ruby wrapper for the AQL SMS API.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_aql_sms_api.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+  end
+end
+

data/lib/aql_sms_api.rb

@@ -0,0 +1,63 @@
+require 'httparty'
+
+module AQL
+  
+  class SMS
+    
+    include HTTParty
+    base_uri "https://gw.aql.com/sms/"
+    
+    def self.authenticate(user = nil, pass = nil, orig = nil)
+      @auth = {:username => user, :password => pass, :originator => orig}
+    end
+    
+    authenticate
+        
+    def self.check_credit
+      res = get "/postmsg.php", :query => @auth.merge(:cmd => "credit")
+      valid?(res) ? (res == "AQSMS-AUTHERROR" ? false : res.match(/\=(\d+)/)[1]).to_i : res
+    end
+    
+    def self.send_message(dests = [], msg = "", opts = {})
+      numbers = dests.collect{|n| format_number(n)}.join(",")
+      res = get "/sms_gw.php", :query => @auth.merge(:destination => numbers, :message => msg).merge(opts)
+      valid?(res) ? SMSResponse.new(res) : res
+    end
+    
+    def self.format_number(number, format = :uk)
+      NumberFormat.send(format, number)
+    end
+    
+    private
+    
+    def self.valid?(res)
+      res.code == 200
+    end
+    
+  end
+  
+  class SMSResponse
+    
+    attr_reader :code, :credits, :message
+    
+    def initialize(res)
+      parts = res.match(/^([0-9]):(\d+)\s(.+)$/)
+      @code = parts[1]
+      @credits = parts[2]
+      @message = parts[3].strip
+    end
+    
+  end
+  
+  module NumberFormat
+    
+    def self.uk(number)
+      number.
+        gsub(/\D/, "").               # removes all non digit characters
+        gsub(/^00([1-9]{2})/, "\\1"). # asumes numbers beginning 00 are int and strips leading 00
+        gsub(/^0([1-9])/, "44\\1")    # removes leading 0 and add international code
+    end
+    
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'aql_sms_api'
+
+class Test::Unit::TestCase
+end

data/test/test_aql_sms_api.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAqlSmsApi < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: aql_sms_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id002
+description: A ruby wrapper for the AQL SMS API.
+email: aaron@gc4.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- aql_sms_api.gemspec
+- lib/aql_sms_api.rb
+- test/helper.rb
+- test/test_aql_sms_api.rb
+has_rdoc: true
+homepage: http://github.com/aaronrussell/aql_sms_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the AQL SMS API.
+test_files: 
+- test/helper.rb
+- test/test_aql_sms_api.rb