adammck-rubygsm 0.3.1 → 0.4

data/bin/gsm-modem-band

@@ -8,9 +8,9 @@ require "#{dir}/../lib/rubygsm.rb"
 
 
 begin
-	modem = GsmModem.new
+	modem = Gsm::Modem.new
 	
-rescue GsmModem::Error => err
+rescue Gsm::Modem::Error => err
 	puts "Initialization Error:"
 	puts "  " + err.desc
 	exit

data/bin/sms

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# vim: noet
+
+dir = File.dirname(__FILE__)
+require "#{dir}/../lib/rubygsm.rb"
+
+
+# expand args (TODO: optparser,
+# which we need so very badly)
+# or fail with USAGE message
+if (ARGV.length == 2)
+	recipient, msg = *ARGV
+	port = :auto
+
+elsif (ARGV.length == 3)
+	port, recipient, msg = *ARGV
+
+else
+	puts "Usage: sms [PORT] RECIPIENT MESSAGE"
+	puts "(don't forget to quote the message)"
+	puts
+	puts "Examples:"
+	puts '  sms +13474201234 Hello'
+	puts '  sms /dev/ttyS0 +13474201234 "Hello from RubyGSM"'
+	exit
+end
+
+# initialize the modem, send the sms, and
+# terminate. currently, rubygsm does a lot
+# of things that aren't strictly required
+# to get this done; maybe refactor
+begin
+	modem = Gsm::Modem.new(port)
+	modem.send_sms!(recipient, msg)
+	
+rescue Gsm::Error => err
+	puts "Error: #{err.desc}"
+end

data/lib/rubygsm.rb

@@ -5,3 +5,14 @@ dir = File.dirname(__FILE__)
 require "#{dir}/rubygsm/core.rb"
 require "#{dir}/rubygsm/errors.rb"
 require "#{dir}/rubygsm/log.rb"
+
+# messages are now passed around
+# using objects, rather than flat
+# arguments (from, time, msg, etc)
+require "#{dir}/rubygsm/msg/incoming.rb"
+require "#{dir}/rubygsm/msg/outgoing.rb"
+
+# during development, it's important to EXPLODE
+# as early as possible when something goes wrong
+Thread.abort_on_exception = true
+Thread.current["name"] = "main"

data/lib/rubygsm/core.rb

@@ -14,8 +14,8 @@ require "date.rb"
 require "rubygems"
 require "serialport"
 
-
-class GsmModem
+module Gsm
+class Modem
 	include Timeout
 	
 	
@@ -23,7 +23,7 @@ class GsmModem
 	attr_reader :device, :port
 	
 	# call-seq:
-	#   GsmModem.new(port, verbosity=:warn)
+	#   Gsm::Modem.new(port, verbosity=:warn)
 	#
 	# Create a new instance, to initialize and communicate exclusively with a
 	# single modem device via the _port_ (which is usually either /dev/ttyS0
@@ -76,12 +76,8 @@ class GsmModem
 		# the last part is delivered
 		@multipart = {}
 		
-		# (re-) open the full log file
-		@log = File.new "rubygsm.log", "w"
-		
-		# initialization message (yes, it's underlined)
-		msg = "RubyGSM Initialized at: #{Time.now}"
-		log msg + "\n" + ("=" * msg.length), :file
+		# start logging to file
+		log_init
 		
 		# to store incoming messages
 		# until they're dealt with by
@@ -144,8 +140,18 @@ class GsmModem
 			# notify the network that we accepted
 			# the incoming message (for read receipt)
 			# BEFORE pushing it to the incoming queue
-			# (to avoid really ugly race condition)
-			command "AT+CNMA"
+			# (to avoid really ugly race condition if
+			# the message is grabbed from the queue
+			# and responded to quickly, before we get
+			# a chance to issue at+cnma)
+			begin
+				command "AT+CNMA"
+				
+			# not terribly important if it
+			# fails, even though it shouldn't
+			rescue Gsm::Error
+				log "Receipt acknowledgement (CNMA) was rejected"
+			end
 			
 			# we might abort if this is
 			catch :skip_processing do
@@ -184,8 +190,8 @@ class GsmModem
 				# store the incoming data to be picked up
 				# from the attr_accessor as a tuple (this
 				# is kind of ghetto, and WILL change later)
-				dt = parse_incoming_timestamp(timestamp)
-				@incoming.push [from, dt, msg]
+				sent = parse_incoming_timestamp(timestamp)
+				@incoming.push Gsm::Incoming.new(self, from, sent, msg)
 			end
 			
 			# drop the two CMT lines (meta-info and message),
@@ -211,7 +217,7 @@ class GsmModem
 		# which probably means that it has
 		# crashed or been unplugged
 		rescue Errno::EIO
-			raise GsmModem::WriteError
+			raise Gsm::WriteError
 		end
 	end
 	
@@ -235,7 +241,7 @@ class GsmModem
 					
 					# die if we couldn't read
 					# (nil signifies an error)
-					raise GsmModem::ReadError\
+					raise Gsm::ReadError\
 						if char.nil?
 					
 					# convert the character to ascii,
@@ -346,13 +352,13 @@ class GsmModem
 			# some errors contain useful error codes,
 			# so raise a proper error with a description
 			if m = buf.match(/^\+(CM[ES]) ERROR: (\d+)$/)
-				log_then_decr "!! Raising GsmModem::Error #{$1} #{$2}"
+				log_then_decr "!! Raising Gsm::Error #{$1} #{$2}"
 				raise Error.new(*m.captures)
 			end
 		
 			# some errors are not so useful :|
 			if buf == "ERROR"
-				log_then_decr "!! Raising GsmModem::Error"
+				log_then_decr "!! Raising Gsm::Error"
 				raise Error
 			end
 		
@@ -380,7 +386,9 @@ class GsmModem
 		begin
 			
 			# prevent other threads from issuing
-			# commands while this block is working
+			# commands TO THIS MODDEM while this
+			# block is working. this does not lock
+			# threads, just the gsm device
 			if @locked_to and (@locked_to != Thread.current)
 				log "Locked by #{@locked_to["name"]}, waiting..."
 			
@@ -404,7 +412,7 @@ class GsmModem
 		
 		# something went bang, which happens, but
 		# just pass it on (after unlocking...)
-		rescue GsmModem::Error
+		rescue Gsm::Error
 			raise
 		
 		
@@ -514,10 +522,10 @@ class GsmModem
 	# Sets the band currently selected for use
 	# by the modem, using either a literal band
 	# number (passed directly to the modem, see
-	# GsmModem.Bands) or a named area from
-	# GsmModem.BandAreas:
+	# Gsm::Modem.Bands) or a named area from
+	# Gsm::Modem.BandAreas:
 	#
-	#   m = GsmModem.new
+	#   m = Gsm::Modem.new
 	#   m.band = :usa    => "850/1900"
 	#   m.band = :africa => "900E/1800"
 	#   m.band = :monkey => ArgumentError
@@ -526,7 +534,7 @@ class GsmModem
 	# America is wearing its ass backwards.)
 	#
 	# Raises ArgumentError if an unrecognized band was
-	# given, or raises GsmModem::Error if the modem does
+	# given, or raises Gsm::Error if the modem does
 	# not support the given band.
 	def band=(new_band)
 		
@@ -548,7 +556,7 @@ class GsmModem
 		
 		# set the band right now (second wmbs
 		# argument is: 0=NEXT-BOOT, 1=NOW). if it
-		# fails, allowGsmModem::Error to propagate
+		# fails, allow Gsm::Error to propagate
 		command("AT+WMBS=#{new_band},1")
 	end
 	
@@ -576,7 +584,7 @@ class GsmModem
 		
 			# if the command failed, then
 			# the pin was not accepted
-			rescue GsmModem::Error
+			rescue Gsm::Error
 				return false
 			end
 		end
@@ -631,24 +639,70 @@ class GsmModem
 	
 	
 	# call-seq:
-	#   send(recipient, message) => true or false
+	#   send_sms(message) => true or false
+	#   send_sms(recipient, text) => true or false
+	#
+	# Sends an SMS message via _send_sms!_, but traps
+	# any exceptions raised, and returns false instead.
+	# Use this when you don't really care if the message
+	# was sent, which is... never.
+	def send_sms(*args)
+		begin
+			send_sms!(*args)
+			return true
+		
+		# something went wrong
+		rescue Gsm::Error
+			return false
+		end
+	end
+	
+	
+	# call-seq:
+	#   send_sms!(message) => true or raises Gsm::Error
+	#   send_sms!(receipt, text) => true or raises Gsm::Error
 	#
 	# Sends an SMS message, and returns true if the network
 	# accepted it for delivery. We currently can't handle read
-	# receipts, so have no way of confirming delivery.
+	# receipts, so have no way of confirming delivery. If the
+	# device or network rejects the message, a Gsm::Error is
+	# raised containing (hopefully) information about what went
+	# wrong.
 	#
 	# Note: the recipient is passed directly to the modem, which
 	# in turn passes it straight to the SMSC (sms message center).
-	# for maximum compatibility, use phone numbers in international
+	# For maximum compatibility, use phone numbers in international
 	# format, including the *plus* and *country code*.
-	def send(to, msg)
+	def send_sms!(*args)
+		
+		# extract values from Outgoing object.
+		# for now, this does not offer anything
+		# in addition to the recipient/text pair,
+		# but provides an upgrade path for future
+		# features (like FLASH and VALIDITY TIME)
+		if args.length == 1\
+		and args[0].is_a? Gsm::Outgoing
+			to = args[0].recipient
+			msg = args[0].text
+		
+		# the < v0.4 arguments. maybe
+		# deprecate this one day
+		elsif args.length == 2
+			to, msg = *args
+		
+		else
+			raise ArgumentError,\
+				"The Gsm::Modem#send_sms method accepts" +\
+				"a single Gsm::Outgoing instance, " +\
+				"or recipient and text strings"
+		end
 		
 		# the number must be in the international
 		# format for some SMSCs (notably, the one
 		# i'm on right now) so maybe add a PLUS
 		#to = "+#{to}" unless(to[0,1]=="+")
 		
-		# 1..9 is a special number which does not
+		# 1..9 is a special number which does notm
 		# result in a real sms being sent (see inject.rb)
 		if to == "+123456789"
 			log "Not sending test message: #{msg}"
@@ -677,12 +731,16 @@ class GsmModem
 			# an escpae, to... escape
 			rescue Exception, Timeout::Error => err
 				log "Rescued #{err.desc}"
-				return false
-				#write 27.chr
-				#wait
+				write 27.chr
+				
+				# allow the error to propagate,
+				# so the application can catch
+				# it for more useful info
+				raise
+				
+			ensure
+				log_decr
 			end
-			
-			log_decr
 		end
 				
 		# if no error was raised,
@@ -699,16 +757,16 @@ class GsmModem
 	# for each.
 	#
 	#   class Receiver
-	#     def incoming(caller, datetime, message)
-	#       puts "From #{caller} at #{datetime}:", message
+	#     def incoming(msg)
+	#       puts "From #{msg.from} at #{msg.sent}:", msg.text
 	#     end
 	#   end
 	#   
 	#   # create the instances,
 	#   # and start receiving
 	#   rcv = Receiver.new
-	#   m = GsmModem.new "/dev/ttyS0"
-	#   m.receive inst.method :incoming
+	#   m = Gsm::Modem.new "/dev/ttyS0"
+	#   m.receive rcv.method :incoming
 	#   
 	#   # block until ctrl+c
 	#   while(true) { sleep 2 }
@@ -738,10 +796,10 @@ class GsmModem
 				# in the same format that they were built
 				# back in _parse_incoming_sms!_
 				unless @incoming.empty?
-					@incoming.each do |inc|
+					@incoming.each do |msg|
 						begin
-							callback.call *inc
-						
+							callback.call(msg)
+							
 						rescue StandardError => err
 							log "Error in callback: #{err}"
 						end
@@ -764,4 +822,5 @@ class GsmModem
 		# threaded (like debugging handsets)
 		@thr.join if join_thread
 	end
-end
+end # Modem
+end # Gsm

data/lib/rubygsm/errors.rb

@@ -4,7 +4,7 @@
 # vim: noet
 #++
 
-class GsmModem
+module Gsm
 	class Error < StandardError
 		ERRORS = {
 			"CME" => {
@@ -94,7 +94,11 @@ class GsmModem
 			       "[type=#{@type}] [code=#{code}]"
 		end
 		
-		alias :to_s :desc
+		# not the same as alias :to_s, :desc,
+		# because this works on subclasses
+		def to_s
+			desc
+		end
 	end
 	
 	# TODO: what the hell is going on with

data/lib/rubygsm/log.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 # vim: noet
 
-class GsmModem
+module Gsm
+class Modem
 	private
 	
-	# Symbols accepted by the GsmModem.new _verbosity_
+	# Symbols accepted by the Gsm::Modem.new _verbosity_
 	# argument. Each level includes all of the levels
 	# below it (ie. :debug includes all :warn messages)
 	LOG_LEVELS = {
@@ -14,6 +15,25 @@ class GsmModem
 		:warn    => 2,
 		:error   => 1 }
 	
+	def log_init
+		
+		fn_port = File.basename(@port)
+		fn_time = Time.now.strftime("%Y-%m-%d.%H-%M-%S")
+		
+		# (re-) open the full log file
+		filename = "rubygsm.#{fn_port}.#{fn_time}"
+		@log = File.new filename, "w"
+		
+		# dump some useful information
+		# at the top, for debugging
+		log "RUBYGSM"
+		log "  port: #{@port}"
+		log "  timeout: #{@read_timeout}"
+		log "  verbosity: #{@verbosity}"
+		log "  started at: #{Time.now}"
+		log "===="
+	end
+	
 	def log(msg, level=:debug)
 		ind = "  " * (@log_indents[Thread.current] or 0)
 		
@@ -36,7 +56,6 @@ class GsmModem
 		end
 	end
 	
-	
 	# log a message, and increment future messages
 	# in this thread. useful for nesting logic
 	def log_incr(*args)
@@ -56,4 +75,5 @@ class GsmModem
 		log(*args)
 		log_decr
 	end
-end
+end # Modem
+end # Gsm

data/lib/rubygsm/msg/incoming.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# vim: noet
+
+module Gsm
+	class Incoming
+		attr_reader :device, :sender, :sent, :received, :text
+		
+		def initialize(device, sender, sent, text)
+			
+			# move all arguments into read-only
+			# attributes. ugly, but Struct only
+			# supports read/write attrs
+			@device = device
+			@sender = sender
+			@sent = sent
+			@text = text
+			
+			# assume that the message was
+			# received right now, since we
+			# don't have an incoming buffer
+			@received = Time.now
+		end
+		
+		# Returns the sender of this message,
+		# so incoming and outgoing messages
+		# can be logged in the same way.
+		def number
+			sender
+		end
+	end
+end

data/lib/rubygsm/msg/outgoing.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# vim: noet
+
+module Gsm
+	class Outgoing
+		attr_accessor :recipient, :text
+		attr_reader :device, :sent
+		
+		def initialize(device, recipient=nil, text=nil)
+			
+			# check that the device is 
+			#raise ArgumentError, "Invalid device"\
+			#	unless device.respond_to?(:send_sms)
+			
+			# init the instance vars
+			@recipient = recipient
+			@device = device
+			@text = text
+		end
+		
+		def send!
+			@device.send_sms(self)
+			@sent = Time.now
+			
+			# once sent, allow no
+			# more modifications
+			freeze
+		end
+		
+		# Returns the recipient of this message,
+		# so incoming and outgoing messages
+		# can be logged in the same way.
+		def number
+			recipient
+		end
+	end
+end

data/rubygsm.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name     = "rubygsm"
-	s.version  = "0.3.1"
-	s.date     = "2009-01-09"
+	s.version  = "0.4"
+	s.date     = "2009-01-29"
 	s.summary  = "Send and receive SMS with a GSM modem"
 	s.email    = "adam.mckaig@gmail.com"
 	s.homepage = "http://github.com/adammck/rubygsm"
@@ -15,11 +15,15 @@ Gem::Specification.new do |s|
 		"lib/rubygsm/core.rb",
 		"lib/rubygsm/errors.rb",
 		"lib/rubygsm/log.rb",
-		"bin/gsm-modem-band"
+		"lib/rubygsm/msg/incoming.rb",
+		"lib/rubygsm/msg/outgoing.rb",
+		"bin/gsm-modem-band",
+		"bin/gsm-app-monitor"
 	]
 	
 	s.executables = [
-		"gsm-modem-band"
+		"gsm-modem-band",
+		"sms"
 	]
 	
 	s.add_dependency("toholio-serialport", ["> 0.7.1"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adammck-rubygsm
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: "0.4"
 platform: ruby
 authors: 
 - Adam Mckaig
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 -08:00
+date: 2009-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +25,7 @@ description:
 email: adam.mckaig@gmail.com
 executables: 
 - gsm-modem-band
+- sms
 extensions: []
 
 extra_rdoc_files: []
@@ -36,7 +37,10 @@ files:
 - lib/rubygsm/core.rb
 - lib/rubygsm/errors.rb
 - lib/rubygsm/log.rb
+- lib/rubygsm/msg/incoming.rb
+- lib/rubygsm/msg/outgoing.rb
 - bin/gsm-modem-band
+- bin/gsm-app-monitor
 has_rdoc: true
 homepage: http://github.com/adammck/rubygsm
 post_install_message: