pswincom 0.1.3 → 0.1.4

data/README.md

@@ -20,6 +20,13 @@ This piece of code demonstrates how to send a simple SMS message:
     api = PSWinCom::API.new 'username', 'password'
     api.send_sms 4712345678, 'This is a test SMS' 
 
+You can also send multiple messages in a single request, like this:
+
+    api = PSWinCom::API.new 'username', 'password'
+    api.add_sms 4712345678, 'This is a test SMS' 
+    api.add_sms 4712345679, 'This is another test SMS' 
+    api.send_sms 
+
 Properties
 ----------
 Receiver and message text are the two mandatory properties when sending a message. You may specify additional properties by using a hash as the last argument to `send_sms`.
@@ -52,6 +59,23 @@ For testing purposes the API provides a couple of modes you can set globally to
 
 .. will make the API output debug information to standard out.
 
+Command-line SMS tool
+---------------------
+The PSWinCom gem also comes with a command-line tool that will allow you to send an SMS directly from the command-line.
+
+To simplify the usage of the tool you may create a YAML configuration file in your home directory, in a file called .pswincom that resembles the following:
+
+    username: your_username
+    password: your_password
+    from: your_nick_or_something
+    host: optionally_override_api_host
+
+If you don't provide these options in the .pswincom file, you can specify them directly at the command-line.And only username and password are required. Run 'sms' without any arguments for a full list of options.
+
+You can then use the sms tool to send a message:
+
+    sms 4712345678 "Message from PSWinCom"
+
 License
 -------
 This code is free to use under the terms of the MIT license.

data/bin/sms

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+local_libs = [
+ File.join(File.dirname(__FILE__), *%w[../lib/pswincom]),
+ File.join(File.dirname(__FILE__), *%w[../lib/pswincom/utility/options]) 
+]
+
+if File.exist?(local_libs.first)
+  local_libs.each { |lib| require lib }
+else
+  require 'rubygems'
+  require 'pswincom'
+  require 'pswincom/utility/options'
+end
+
+# parse command line options
+options = PSWinCom::Utility::Options.parse(ARGV)
+
+PSWinCom::API.api_host = options.host if options.host
+
+# authenticate and load the API
+api = PSWinCom::API.new options.username, options.password
+
+begin
+  puts "Sending '#{options.message}' to #{options.recipient}.."
+  additional_opts = {}
+  additional_opts[:sender] = options.from if options.from
+  result = api.send_sms options.recipient, options.message, additional_opts
+  puts result.body
+  exit 0
+
+rescue StandardError => e
+  puts e
+
+end

data/lib/pswincom/api.rb

@@ -17,6 +17,9 @@ module PSWinCom
     self.debug_mode = false;
 
     def initialize user, password
+      if user.to_s.empty? or password.to_s.empty?
+        raise ArgumentError, "You must specify username and password" 
+      end
       @user, @password = user, password
       @request = Request.new :user => @user, :passwd => @password      
     end

data/lib/pswincom/utility/options.rb

@@ -0,0 +1,94 @@
+require 'optparse'
+require 'ostruct'
+require 'yaml'
+
+module PSWinCom
+  module Utility
+    class Options
+      class << self
+        
+        def parse(args)          
+          @options = self.default_options
+          parser = OptionParser.new do |opts|
+            opts.banner = "Usage: sms [options] recipient(s) message"
+            opts.separator "  Recipients can be a comma-separated list, up to 100 max."
+            opts.separator ""
+            opts.separator "Specific options:"
+          
+            opts.on('-u', '--username USERNAME',
+              "Specify the pswincom username (overrides ~/.pswincom setting)") do |username|
+               @options.username = username 
+            end
+          
+            opts.on('-p', '--password PASSWORD',
+              "Specify the pswincom password (overrides ~/.pswincom setting)") do |password|
+               @options.password = password
+            end
+                      
+            opts.on('-f', '--from NAME_OR_NUMBER',
+              "Specify the name or number that the SMS will appear from") do |from|
+               @options.from = from 
+            end
+            
+            opts.on('-s', '--host URL',
+              "Specify the gateway endpoint to use") do |host|
+              @options.host = host
+            end
+
+            opts.on('-d', '--debug') do
+               PSWinCom::API.debug_mode = true
+            end
+
+            opts.on('-t', '--test') do
+               PSWinCom::API.test_mode = true
+            end
+          
+            opts.on_tail('-h', '--help', "Show this message") do
+              puts opts
+              exit
+            end          
+          end
+          
+          #@options.recipient = args[-2].split(',').map { |r| r.gsub(/^\+/, '') } rescue nil
+          @options.recipient = args[-2]
+          @options.message   = args[-1]
+          
+          parser.parse!(args)
+        
+          if (@options.message.nil? || @options.recipient.nil?)
+            puts "You must specify a recipient and message!"
+            puts parser
+            exit
+          end
+
+          return @options
+        
+        rescue OptionParser::MissingArgument => e
+          switch_given = e.message.split(':').last.strip
+          puts "The #{switch_given} option requires an argument."
+          puts parser
+          exit
+        end
+      
+        def default_options
+          options = OpenStruct.new          
+          config = load_defaults
+          options.username = config['username']
+          options.password = config['password']
+          options.from     = config['from']
+          options.host     = config['host']
+          return options
+        rescue Errno::ENOENT
+          return options
+        end
+
+        def load_defaults
+          config_file = File.open(File.join(ENV['HOME'], '.pswincom'))
+          YAML.load(config_file)
+        end
+        
+      end
+    end
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pswincom
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - PSWinCom AS
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +01:00
-default_executable: 
+date: 2011-02-16 00:00:00 +01:00
+default_executable: sms
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -36,17 +36,19 @@ dependencies:
   version_requirements: *id001
 description: An easy to use API for the PSWinCom SMS Gateway, allowing you to send SMS messages.
 email: 
-- support@pswin.com
-executables: []
-
+- post@pswin.com
+executables: 
+- sms
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
+- bin/sms
 - lib/pswincom/api.rb
 - lib/pswincom/httpsender.rb
 - lib/pswincom/request.rb
+- lib/pswincom/utility/options.rb
 - lib/pswincom.rb
 - LICENSE
 - README.md