signupto 0.1.0 → 1.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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

@@ -1,13 +1,4 @@
-== USEAGE
+signupto
+=================
 
-account = Net::SMS::SignupTo::Account.new('YOUR ACCOUNT HASH', 'CUSTOMER NUMBER')
-message = Net::SMS::SignupTo::Message.new(RECIPIENT_NUMBER,'NAME OF SENDER (max 12 chars)', 'BODY OF MESSAGE, NON-URI encoded')
-send = Net::SMS::SignupTo::Send.new(account, message)
-
-Thats it.
-
-== TESTS
-
-Yes I know there are no tests yet and that its really bad.
-
-This lib is in early early alpha stages so I am getting there - please bear with me :)
+Signupto SMS gateway client

data/Rakefile

@@ -1,104 +1,35 @@
 require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
 require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require File.join(File.dirname(__FILE__), 'lib', 'net', 'sms','signupto')
+require 'lib/signupto/version'
 
-PKG_NAME      = 'signupto'
-PKG_VERSION   = Net::SMS::SignupTo::Version.to_s
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-RELEASE_NAME  = PKG_VERSION
+PLUGIN = "signupto"
+NAME = "signupto"
+VERSION = Signupto::Version::STRING
+AUTHOR = "Tim Perrett"
+EMAIL = "code@timperrett.com"
+HOMEPAGE = "http://blog.timperrett.com"
+SUMMARY = "Core connectivity to the signupto SMS gateway service"
 
-RDOC_TITLE    = "SignUpTo SMS API Bindings"
-RDOC_EXTRAS   = ["README", "CHANGELOG", 'TODO']
-
-
-namespace 'signupto' do
-
-# Generate the RDoc documentation
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = RDOC_TITLE
-  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
-  rdoc.rdoc_files.include('README', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-# gem spec
 spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = 'An API client for sending SMS messages via the Signup.to service'
-  #s.description          = ""
-  s.author = 'Tim Perrett'
-  s.email = 'code@timperrett.com'
-  s.homepage = 'http://www.timperrett.com'
+  s.name = NAME
+  s.version = VERSION
   s.platform = Gem::Platform::RUBY
-  s.require_path = 'lib'
-  s.autorequire = 'net/sms/signupto'
   s.has_rdoc = true
-  s.rdoc_options << '--title' << RDOC_TITLE << '--line-numbers' << '--main' << 'README'
-  s.extra_rdoc_files = RDOC_EXTRAS
-  files = FileList['**/*']
-  files.exclude '**/._*'
-  files.exclude 'doc'
-  files.exclude 'examples'
-  files.exclude 'pkg'
-  files.exclude '.svn/*'
-  s.files = files.to_a
-end
-
-# specify the compression required
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
-end
-
-desc "Uninstall Gem"
-task :uninstall_gem do
-  sh "gem uninstall #{PKG_NAME}" rescue nil
-end
-
-desc "Build and install Gem from source"
-task :install_gem => [:package, :uninstall_gem] do
-  dir = File.join(File.dirname(__FILE__), 'pkg')
-  chdir(dir) do
-    latest = Dir["#{PKG_NAME}-*.gem"].last
-    sh "gem install #{latest}"
-  end
-end
-
-desc "Display the current version"
-task :version do
-  puts 'Current version of ' + PKG_NAME + ' is ' + PKG_VERSION
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
 
-desc "display total number of lines in the codebase"
-task :lines do
-  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
-  for file_name in FileList["lib/net/sms/**/*.rb"]
-    # next if file_name =~ /vendor/
-    f = File.open(file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-    
-    total_lines     += lines
-    total_codelines += codelines
-    
-    lines, codelines = 0, 0
-  end
-  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
 end
 
-end
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end

data/lib/signupto.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'signupto/account'
+require 'signupto/message'
+require 'signupto/action/base'
+require 'signupto/action/balance'
+require 'signupto/action/sender'
+require 'signupto/base'

data/lib/signupto/account.rb

@@ -0,0 +1,19 @@
+module Signupto
+  class Account
+    
+    attr_reader :apihash
+    attr_reader :customer_number
+    
+    # Pass in your account details to create an account object.
+    # Your +apihash+ and +cid+ which will both be found on the signup.to
+    # dashboard interface.
+    def initialize(apihash, customer_number)
+      @apihash, @customer_number = apihash, customer_number
+    end
+    
+    def to_http
+      URI.encode("cid=#{@customer_number}&hash=#{@apihash}")
+    end
+    
+  end
+end

data/lib/signupto/action/balance.rb

@@ -0,0 +1,24 @@
+module Signupto
+  module Action
+    class Balance < Base
+      
+      def initialize(account)
+        if account.is_a?(Account)
+          if super(account.apihash, account.customer_number)
+            payload = set_payload()
+            run_action(payload)
+          end
+        else
+          raise "ERROR"
+        end
+      end
+
+      protected
+      
+        def set_payload
+          @payload = [@account.to_http, 'mode=balance'].join('&')
+        end
+      
+    end
+  end
+end

data/lib/signupto/action/base.rb

@@ -0,0 +1,31 @@
+require 'net/http'
+require 'uri'
+
+module Signupto
+  module Action
+    class Base
+      
+      # Parent class that all specific actions are derived.
+      def initialize(account_hash, customer_number)
+        @account = Signupto::Account.new(account_hash, customer_number)
+      end
+      
+      def to_s
+        return @result.body
+      end
+
+      protected
+      
+        # Actually make the call to the api URL. SignUp.to use a 
+        # PHP response method, so I make a URI encoded GET to there servers
+        # and await the response; handling it appropriatly.
+        def run_action(payload, page = 'smpp_account')
+          Net::HTTP.start('sms.sign-up.to', 80) do |http|
+            @result = http.get('/'<< page << '.php?' << payload)
+            return @result
+          end
+        end
+      
+    end
+  end
+end

data/lib/signupto/action/sender.rb

@@ -0,0 +1,32 @@
+module Signupto
+  module Action
+    class Sender < Base
+      
+      def initialize(account, message)
+        if message.is_a?(Message) and account.is_a?(Account)
+          if super(account.apihash, account.customer_number)
+            @message = message
+            payload = set_payload()
+            run_action(payload, 'smpp_send')
+          end
+        else
+          raise "You can only supply a Message object"
+        end
+      end
+      
+      protected
+      
+        # Configure the payload to send on this text message.
+        # to   - Recipient mobile number in full international format (no ‘+’ or ‘00’) 
+        # message  - Message body text 
+        # from   - SMS sender 
+        # cost   - Cost (in pence) to the recipient 
+        # network  - Recipient’s network  
+        # smsc   - ID of client selected SMS route 
+        def set_payload
+          @payload = [@account.to_http, "to=#{@message.to.to_s}", "message=#{@message.body.to_s}", "from=#{@message.from.to_s}"].join('&')
+        end
+      
+    end
+  end
+end

data/lib/signupto/base.rb

@@ -0,0 +1,30 @@
+module Signupto
+  class Base
+  
+    class << self
+      # retrives your account balance and returns it as a string
+      def balance(options = {})
+        if options.has_key?(:account_hash) and options.has_key?(:customer_number)
+          account = Account.new(options[:account_hash], options[:customer_number])
+          return Action::Balance.new(account).to_s
+        end
+      end
+      
+      # Upon a sucsesfull send this will return the message number for tracking purposese
+      # on the signupto systems.
+      def send!(options = {})
+        if options.has_key?(:account_hash) and options.has_key?(:customer_number)
+          account = Account.new(options[:account_hash], options[:customer_number])
+          if options.has_key?(:message) and options.has_key?(:to)
+            message = Message.new(options[:to], options[:message], options[:from])
+            puts message.to
+            return Action::Sender.new(account, message)
+          else
+            raise ArgumentError, "You must supply a message to send and a place to send it"
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/signupto/message.rb

@@ -0,0 +1,19 @@
+module Signupto
+  class Message
+    
+    # Make the elements of the message accesible.
+    # This way you can do @message.from etc to makes debuging the code
+    # a lot simpler (I find at least)
+    attr_reader :to, :from, :body
+    
+    # Set the recipient (which must be in international format, with no leading +)
+    # and the from paramater, and the body. The From paramater will take a string up to
+    # 12 characters long, then on the recipients phone it will appear as if it is from 
+    # someone in there contacts rather than and unknown number.
+    def initialize(to, body, from = nil)
+      # validate_number(to)
+      @to, @body, @from = to, URI.encode(body), from
+    end
+    
+  end
+end

data/lib/signupto/version.rb

@@ -0,0 +1,9 @@
+module Signupto
+  module Version #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -1,67 +1,66 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: signupto
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-10-03 00:00:00 +01:00
-summary: An API client for sending SMS messages via the Signup.to service
-require_paths: 
-- lib
-email: code@timperrett.com
-homepage: http://www.timperrett.com
-rubyforge_project: 
-description: 
-autorequire: net/sms/signupto
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Tim Perrett
-files: 
-- CHANGELOG
-- init.rb
-- lib
-- lib/net
-- lib/net/sms
-- lib/net/sms/signupto
-- lib/net/sms/signupto/account.rb
-- lib/net/sms/signupto/action.rb
-- lib/net/sms/signupto/balance.rb
-- lib/net/sms/signupto/message.rb
-- lib/net/sms/signupto/send.rb
-- lib/net/sms/signupto.rb
-- Rakefile
-- README
-- test
-- TODO
-test_files: []
+autorequire: signupto
+bindir: bin
+cert_chain: []
 
-rdoc_options: 
-- --title
-- SignUpTo SMS API Bindings
-- --line-numbers
-- --main
-- README
-extra_rdoc_files: 
-- README
-- CHANGELOG
-- TODO
+date: 2008-01-10 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Core connectivity to the signupto SMS gateway service
+email: code@timperrett.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/signupto
+- lib/signupto/account.rb
+- lib/signupto/action
+- lib/signupto/action/balance.rb
+- lib/signupto/action/base.rb
+- lib/signupto/action/sender.rb
+- lib/signupto/base.rb
+- lib/signupto/message.rb
+- lib/signupto/version.rb
+- lib/signupto.rb
+has_rdoc: true
+homepage: http://blog.timperrett.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Core connectivity to the signupto SMS gateway service
+test_files: []
 

data/CHANGELOG

@@ -1 +0,0 @@
-== CHANGE LOG

data/TODO

@@ -1,5 +0,0 @@
-== TODO
-
-* Tests of all kinds!
-* Add support for delivery checking
-* International number validation and checking

data/init.rb

@@ -1,2 +0,0 @@
-# hook code here
-# require File.dirname(__FILE__) + '/action'

data/lib/net/sms/signupto.rb

@@ -1,40 +0,0 @@
-require File.dirname(__FILE__) + '/signupto/account'
-
-module Net
-  module SMS
-    module SignupTo
-      
-      # Get the current gem version.
-      class Version  
-        Major = '0'
-        Minor = '1'
-        Tiny  = '0'
-        
-        def self.to_s
-          [Major, Minor, Tiny].join('.')
-        end
-      end
-      
-    end
-  end
-end
-      
-      
-#       class Service
-#         
-#         attr_reader :account
-#         
-#         def initialize(apihash, customer_number)
-#           @account = Account.new(apihash, customer_number)
-#         end
-#         
-#         def send_message()
-#         end
-#         
-#         def send()
-#         end
-#         
-#       end
-#     end
-#   end 
-# end

data/lib/net/sms/signupto/account.rb

@@ -1,26 +0,0 @@
-require 'net/http'
-require 'uri'
-
-module Net
-	module SMS
-    module SignupTo
-      class Account
-        
-        # Pass in your account details to create an account object.
-        # Your +apihash+ and +cid+ which will both be found on the signup.to
-        # dashboard interface.
-        def initialize(apihash, customer_number)
-          @apihash, @customer_number = apihash, customer_number
-        end
-        
-        def to_http
-          URI.encode("cid=#{@customer_number}&hash=#{@apihash}")
-        end
-        
-      end
-      
-      class AccountError < Exception; 	end
-      
-    end 
-	end
-end

data/lib/net/sms/signupto/action.rb

@@ -1,36 +0,0 @@
-require 'net/http'
-require 'uri'
-
-module Net
-	module SMS
-    module SignupTo
-      class Action
-        
-        attr_writer :page
-        
-        # Parent class that all specific actions are derived.
-        def initialize(account)
-          if account.kind_of? Account
-            @account = account
-          else
-            raise ActionError, 'You can only pass an account object to create an action'
-          end
-        end
-        
-        # Actually make the call to the api URL. SignUp.to use a 
-        # PHP response method, so I make a URI encoded GET to there servers
-        # and await the response; handling it appropriatly.
-        def run_action(payload)
-          Net::HTTP.start('sms.sign-up.to', 80) do |http|
-            resp = http.get('/'<< @page << '?' << payload)
-            return resp
-          end
-        end
-        
-      end
-      
-      class ActionError < Exception; end
-          
-    end
-  end
-end

data/lib/net/sms/signupto/balance.rb

@@ -1,32 +0,0 @@
-require File.dirname(__FILE__) + '/action'
-
-module Net
-	module SMS
-    module SignupTo
-      class Balance < Action
-        
-        # Get remaining balence of credits left on
-        # any given account. Returns a number.
-        def initialize(account)
-          super(account)
-          @page = 'smpp_account.php'
-          set_payload()
-          @result = run_action(@payload)
-        end
-        
-        def to_s
-          return @result.body
-        end
-        
-        protected
-        
-        def set_payload
-          @payload = [@account.to_http, 'mode=balance'].join('&')
-        end
-        
-        private
-        
-      end
-    end
-  end
-end

data/lib/net/sms/signupto/message.rb

@@ -1,43 +0,0 @@
-require 'uri'
-
-module Net
-	module SMS
-    module SignupTo
-      class Message
-        
-        # Make the elements of the message accesible.
-        # This way you can do @message.from etc to makes debuging the code
-        # a lot simpler (I find at least)
-        attr_reader :to, :from, :body
-        
-        # Set the recipient (which must be in international format, with no leading +)
-        # and the from paramater, and the body. The From paramater will take a string up to
-        # 12 characters long, then on the recipients phone it will appear as if it is from 
-        # someone in there contacts rather than and unknown number.
-        def initialize(to, from, body)
-          # validate_number(to)
-          @to, @from, @body = to, from, URI.encode(body)
-        end
-        
-        private
-        
-        # Obsolete method. Doesnt work as yet.
-        # TODO!!!
-        def validate_number(number)
-          if number =~ /^(\+44\s?7\d{3}|\(?07\d{3}\)?)\s?\d{3}\s?\d{3}$/ then
-            return number
-          else
-            raise InvalidNumberError, 'The number ' << number << ' is not a valid UK phone number'
-          end
-          # do somethig with number to clean it
-        end
-        
-      end
-      
-      # Reserved for the future when the number entered does 
-      # not meet international format.
-      class InvalidNumberError < Exception; end
-      
-    end
-  end
-end

data/lib/net/sms/signupto/send.rb

@@ -1,41 +0,0 @@
-require File.dirname(__FILE__) + '/action'
-
-module Net
-	module SMS
-    module SignupTo
-      class Send < Action
-        
-        # You need to pass in an account object, and the message you
-        # wish to send out. The message will be automatically URI encoded
-        # and replace any unsafe characters.
-        def initialize(account, message)
-          super(account)
-          @page, @message = 'smpp_send.php', message
-          set_payload()
-          @result = run_action(@payload)
-        end
-        
-        def to_s #:nodoc:
-          return @result.body
-        end
-        
-        protected
-        
-        # Configure the payload to send on this text message.
-        def set_payload
-          # to   - Recipient mobile number in full international format (no ‘+’ or ‘00’) 
-          # message  - Message body text 
-          # from   - SMS sender 
-          # cost   - Cost (in pence) to the recipient 
-          # network  - Recipient’s network  
-          # smsc   - ID of client selected SMS route 
-          #"from=#{@message.from.to_s}"
-          @payload = [@account.to_http, "to=#{@message.to.to_s}", "message=#{@message.body.to_s}"].join('&')
-        end
-        
-        private
-        
-      end
-    end
-  end
-end