exetel_sms 1.02 → 1.03

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.03. Support message retrieval (check sent status). Update hostname.
+
 v1.02. Fixed requirements for gem
 
 v1.01. Initial version

data/Manifest

@@ -9,5 +9,6 @@ lib/config.rb
 lib/deleter.rb
 lib/exetel_sms.rb
 lib/receiver.rb
+lib/retriever.rb
 lib/sender.rb
 Manifest

data/README

@@ -2,30 +2,46 @@
 exetel_sms:  Send and receive messages via Exetel's SMS API
 -----------------------------------------------------------
 
-require 'exetel_sms/sender'
-require 'exetel_sms/config'
+gem install 'exetel_sms'
+
 
 Send a message:
 --------------
-
+ require 'exetel_sms'
  config = ExetelSms::Config.new('username', 'password')
  sender = ExetelSms::Sender.new(config)
  result = sender.send(
-   destination_mobile_number,
-   message,
-   from_string,
-   sender.class.new_reference_number(reference_number)
+   'destination mobile number',
+   'message',
+   'from string',
+   sender.class.new_reference_number('application_identifier')
  )
-
- if result[:status] == '1'
-  puts "Message sent successfully!"
+ if result.success?
+   puts "Message sent successfully!"
  else
-  puts "Error sending message: #{result[:notes]}"
+   puts "Error sending message: #{result[:notes]}"
  end
 
 
-Contact
--------
+
+Was it really sent?
+-------------------
+ retriever = ExetelSms::Retriever.new(config)
+ result = retriever.check_sent('reference_number')
+ result[:message_status]
+ => 'Sent'
+
+
+Receiving messages from a Virtual Mobile Number
+-----------------------------------------------
+ receiver = ExetelSms::Receiver.new(config)
+ if result = receiver.receive('my virtual mobile number')
+   puts "Received from #{result[:from_mobile_number]}: #{result[:message]}"
+ end
+ 
+
+Contact the author
+------------------
 
 Andrew Snow <andrew@modulus.org>
 Andys^ on irc.freenode.net

data/README.textile

@@ -1,27 +1,47 @@
 
 h2. exetel_sms:  Send and receive messages via Exetel's SMS API
 
-bc. require 'exetel_sms/sender'
- require 'exetel_sms/config'
+bc. gem install 'exetel_sms'
+ 
 
 h3. Send a message:
 
-bc. config = ExetelSms::Config.new('username', 'password')
+bc. require 'exetel_sms'
+ config = ExetelSms::Config.new('username', 'password')
  sender = ExetelSms::Sender.new(config)
  result = sender.send(
-   destination_mobile_number,
-   message,
-   from_string,
-   sender.class.new_reference_number(reference_number)
+   'destination mobile number',
+   'message',
+   'from string',
+   sender.class.new_reference_number('application_identifier')
  )
- if result[:status] == '1'
-  puts "Message sent successfully!"
+ if result.success?
+   puts "Message sent successfully!"
  else
-  puts "Error sending message: #{result[:notes]}"
+   puts "Error sending message: #{result[:notes]}"
  end
 
 
-h3. Contact
+
+h3. Was it really sent?
+
+bc. retriever = ExetelSms::Retriever.new(config)
+ result = retriever.check_sent('reference_number')
+ result[:message_status]
+ #=> 'Sent' / 'Delivered' / 'Queued' / 'Failed'
+
+
+h3. Receiving messages from a Virtual Mobile Number
+
+bc. receiver = ExetelSms::Receiver.new(config)
+ if result = receiver.receive('my virtual mobile number')
+   puts "Received from #{result[:from_mobile_number]}: #{result[:message]}"
+ end
+ 
+
+
+
+h3. Contact the author
 
 Andrew Snow <andrew@modulus.org>
 Andys^ on irc.freenode.net

data/exetel_sms.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exetel_sms}
-  s.version = "1.02"
+  s.version = "1.03"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Snow"]
-  s.date = %q{2010-08-25}
+  s.date = %q{2011-01-28}
   s.description = %q{Ruby gem to send and receive SMS via Exetel's API}
   s.email = %q{andrew@modulus.org}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "README.textile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/sender.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "README", "README.textile", "Rakefile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/sender.rb", "Manifest", "exetel_sms.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "README.textile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "README", "README.textile", "Rakefile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb", "Manifest", "exetel_sms.gemspec"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Exetel_sms", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/class_methods.rb

@@ -21,10 +21,15 @@ module ExetelSms
     end
     
     def response_to_hash(fields)
-      raise 'Missing fields in response body' unless fields.length >= response_fields.length
+      raise "Missing fields in response body?  Expected #{response_fields.map(&:to_s).join(',')}, got #{fields.inspect}" unless fields.length >= response_fields.length
       ret = {}
       response_fields.each {|field| ret[field] = fields.shift }
       ret[:other] = fields
+      class << ret
+        def success?
+          self[:status] == '1'
+        end
+      end
       ret
     end
       

data/lib/client.rb

@@ -20,7 +20,7 @@ module ExetelSms
           body = response.body
         end
         raise "No body" unless body && body =~ /|/
-        body.chomp.gsub(/<br>$/i, '').split('|').map {|str| str.strip }
+        body.chomp.gsub(/<br>$/i, '').split('|',-1).map {|str| str.strip }
       end
     end
   end

data/lib/deleter.rb

@@ -31,7 +31,7 @@ module ExetelSms
       end
 
       def exetel_url
-        'https://www.exetel.com.au/sendsms/api_sms_mvn_delete.php?'
+        'https://smsgw.exetel.com.au/sendsms/api_sms_mvn_delete.php?'
       end
 
     end

data/lib/exetel_sms.rb

@@ -1,5 +1,5 @@
 
-['client', 'class_methods', 'sender', 'config', 'receiver', 'deleter'].each do |x|
+['client', 'class_methods', 'sender', 'config', 'receiver', 'deleter', 'retriever'].each do |x|
   require("#{File.dirname(__FILE__)}/" + x)
 end
 

data/lib/receiver.rb

@@ -30,7 +30,7 @@ module ExetelSms
       end
 
       def exetel_url
-        'https://www.exetel.com.au/sendsms/api_sms_mvn_inbox.php?'
+        'https://smsgw.exetel.com.au/sendsms/api_sms_mvn_inbox.php?'
       end
 
     end

data/lib/retriever.rb

@@ -0,0 +1,38 @@
+
+module ExetelSms
+  
+  class Retriever
+    extend ExetelSms::ClassMethods
+  
+    attr_reader :config
+    def initialize(config)
+      @config = config
+    end
+    
+    def check_sent(reference_number)
+      url = self.class.build_url(
+        :username => @config.username,
+        :password => @config.password,
+        :referencenumber => reference_number
+      )
+      
+      self.class.response_to_hash(ExetelSms::Client.request(url))
+    end
+    
+    class << self
+      
+      def response_fields
+        [:status, :exetel_id, :reference_number, :sender, :to_mobile_number, :received_at, :message_status, :charge, :notes]
+      end
+      
+      def request_fields
+        [:username, :password, :referencenumber]
+      end
+
+      def exetel_url
+        'https://smsgw.exetel.com.au/sendsms/api_sms_detail.php?'
+      end
+
+    end
+  end
+end

data/lib/sender.rb

@@ -22,7 +22,7 @@ module ExetelSms
       
       self.class.response_to_hash(ExetelSms::Client.request(url))
     end
-    
+
     class << self
       
       def response_fields
@@ -34,7 +34,7 @@ module ExetelSms
       end
 
       def exetel_url
-        'https://www.exetel.com.au/sendsms/api_sms.php?'
+        'https://smsgw.exetel.com.au/sendsms/api_sms.php?'
         #username=xxxxxxxx&password=xxxxxxxx&mobilenumber=xxxxxxxx&message=xxxxxxxx&sender=xxxxxxxxx&messagetype=Text&referencenumber=xxxxxx'
       end
 

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: exetel_sms
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 2
-  version: "1.02"
+  - 3
+  version: "1.03"
 platform: ruby
 authors: 
 - Andrew Snow
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 +10:00
+date: 2011-01-28 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +34,7 @@ extra_rdoc_files:
 - lib/deleter.rb
 - lib/exetel_sms.rb
 - lib/receiver.rb
+- lib/retriever.rb
 - lib/sender.rb
 files: 
 - CHANGELOG
@@ -48,6 +48,7 @@ files:
 - lib/deleter.rb
 - lib/exetel_sms.rb
 - lib/receiver.rb
+- lib/retriever.rb
 - lib/sender.rb
 - Manifest
 - exetel_sms.gemspec
@@ -70,7 +71,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -79,7 +79,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
       - 1
       - 2