lleidasms 1.1.0 → 1.1.6

data/README.md

@@ -48,6 +48,8 @@ gem 'lleidasms'
 
 # Examples
 ## Demo
+From the command line
+
 ```shell
   lleidasms YOUR_USER YOUR_PASSWORD
 ```
@@ -96,5 +98,54 @@ or
 	end
 ```
 
+### Special method raw command
+Allow you to send to server any command not implemented.
+
+```ruby
+  cmd_raw 'PING', time
+```
+
+### Special event :unknow
+To detect unknow commands.
+
+```ruby
+  event :unknow, :new_unknow
+
+  def new_unknow label, cmd, args
+  end
+```
+
+### Enabling debug
+Use debug to capture debug events at :in, :out or :all messages
+
+```ruby
+	class SMS < Lleidasms::Gateway
+	  debug :all, :debugger
+	  debug :in, :debugger_in
+	  debug :out, :debugger_out
+
+    def debugger line
+      puts line
+    end
+
+    def debugger_in line
+      puts line
+    end
+
+    def debugger_out line
+      puts line
+    end
+	end
+
+	sms = SMS.new
+	sms.connect
+	sms.listener
+	sms.cmd_login <YOUR_USER>, <YOUR_PASSWORD>
+
+	while sms.conected?
+		# Some tasks
+	end
+```
+
 # License
 Released under the MIT license: [http://www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)

data/lib/lleidasms/client.rb

@@ -6,8 +6,10 @@ module Lleidasms
     event :all, :new_event
     event :acuse, :new_acuse
     event :incomingmo, :new_incomingmo
+    event :unknow, :new_unknow
+    debug :all, :debugger
 
-    attr_accessor :timeout
+    attr_accessor :timeout, :debug
 
     def connect user, password, timeout = 2.4
       super()
@@ -16,6 +18,12 @@ module Lleidasms
       self.timeout= timeout
       @acuse = []
       @incomingmo = []
+      @unknow = []
+      @debug = false
+    end
+
+    def debugger line
+      puts line
     end
 
     def saldo
@@ -24,7 +32,7 @@ module Lleidasms
       return @response_args[0]
     end
 
-    # *number*
+    # number
     #   The telephone number
     def tarifa number
       cmd_tarifa number
@@ -32,11 +40,11 @@ module Lleidasms
       return @response_args
     end
 
-    # *number*
+    # number
     #   The telephone number
-    # *message*
+    # message
     #   The string to send
-    # *opts*
+    # opts
     #   - nowait: (default false) no wait for response
     #   - sender: The sender telephone number
     #   - date: Date and time to send message in format YYYYMMDDhhmm[+-]ZZzz
@@ -83,11 +91,11 @@ module Lleidasms
       end
     end
 
-    # *number*
+    # number
     #   The telephone number
-    # *url*
+    # url
     #   The URL to content. Usually a image, tone or application
-    # *message*
+    # message
     #   Information text before downloading content
     def send_waplink number, url, message
       cmd_waplink number, url, message
@@ -136,7 +144,7 @@ module Lleidasms
     end
 
     # Set file content (base64 encded) as message for the massive send list
-    #  *data* file contenten base64 encoded
+    #  data file contenten base64 encoded
     # Available types:
     #  * :jpeg        image JPEG
     #  * :gif         image GIF
@@ -224,6 +232,10 @@ module Lleidasms
       @incomingmo.count > 0
     end
 
+    def unknow?
+      @unknow.count > 0
+    end
+
     # Return hash or false
     #   - :id
     #   - :destino
@@ -248,6 +260,12 @@ module Lleidasms
         }
     end
 
+    # Return array or false
+    def unknow
+      return false unless unknow?
+      @unknow.shift
+    end
+
     # - wait: (default false) no wait for response
     # - action
     #     * :begin
@@ -343,5 +361,10 @@ module Lleidasms
       cmd_incomingmoack args[0]
     end
 
+    def new_unknow label, cmd, args
+      args.unshift cmd
+      @unknow << args
+    end
+
   end
 end

data/lib/lleidasms/gateway.rb

@@ -4,6 +4,8 @@ require "io/wait"
 
 module Lleidasms
   class Gateway
+    $callbacks = {}
+
     # Client
     def initialize host = 'sms.lleida.net', port = 2048
       @host = host
@@ -21,7 +23,7 @@ module Lleidasms
       end
       $writer      = lambda do |buffer|
         $server.puts "#{buffer}\r\n"
-        puts "<#{buffer}\r\n"
+        do_debug :out, "<#{buffer}"
         buffer.replace ''
       end
     end
@@ -60,33 +62,20 @@ module Lleidasms
     end
     # Client end
 
-    # Callbacks
-    $callbacks = {}
-
-     def self.event name, method_name
+    def self.event name, method_name
        $callbacks[name] = [] unless $callbacks[name]
       $callbacks[name] << method_name
     end
 
-    def do_event name
-      run_event name.to_sym, @label, @cmd, @args
-    end
-
-    def run_event name, *args
-      run_event_for name.to_sym, self, *args
-    end
-
-    def run_event_for name, scope, *args
-      return unless $callbacks[name.to_sym]
-      $callbacks[name.to_sym].each do |callback|
-        if callback.kind_of? Symbol
-          scope.send callback, *args
-        else
-          scope.instance_exec *args, &callback
-        end
-      end
+    # Available types:
+    #  * :in
+    #  * :out
+    #  * :all
+    def self.debug type, method_name
+      name = "debug_#{type.to_s}".to_sym
+      $callbacks[name] = [] unless $callbacks[name]
+      $callbacks[name] << method_name
     end
-    # Callbacks end
 
     def new_label
       @my_label += 1
@@ -273,7 +262,7 @@ module Lleidasms
     def parser
       until $input_buffer.empty?
         line = $input_buffer.shift
-        puts ">#{line}\r\n"
+        do_debug :in, ">#{line}"
         @args = line.split ' '
         @label = @args.shift
         @cmd   = @args.shift
@@ -308,7 +297,7 @@ module Lleidasms
         # CMD Recepcion SMS (premium)
 
         else
-          # unknow
+          do_event :unknow
         end
         do_event @cmd.downcase
         do_event :all
@@ -316,6 +305,31 @@ module Lleidasms
     end
 
     private
+    def do_debug type, line
+      name = "debug_#{type.to_s}".to_sym
+      run_event_for name, self, line
+      run_event_for 'debug_all', self, line
+    end
+
+    def do_event name
+      run_event name.to_sym, @label, @cmd, @args
+    end
+
+    def run_event name, *args
+      run_event_for name.to_sym, self, *args
+    end
+
+    def run_event_for name, scope, *args
+      return unless $callbacks[name.to_sym]
+      $callbacks[name.to_sym].each do |callback|
+        if callback.kind_of? Symbol
+          scope.send callback, *args
+        else
+          scope.instance_exec *args, &callback
+        end
+      end
+    end
+
     def mimetype type
       case type
         when :jpeg

data/lib/lleidasms/version.rb

@@ -1,3 +1,3 @@
 module Lleidasms
-  VERSION = "1.1.0"
+  VERSION = "1.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lleidasms
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000Z
+date: 2012-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17522540 !ruby/object:Gem::Requirement
+  requirement: &17953140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *17522540
+  version_requirements: *17953140
 description: Receive and send standar and premium SMS/MMS using Lleida.net services.
 email:
 - mabarroso@mabarroso.com