biju 0.0.1 → 0.0.2

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 ## Usage
 
 ```
-@modem = Biju::Modem.new("/dev/tty.HUAWEIMobile-Modem")
+@modem = Biju::Modem.new(:port => "/dev/tty.HUAWEIMobile-Modem")
 
 # method to list all messages
 @modem.messages.each do |sms|

data/lib/biju/modem.rb

@@ -3,6 +3,12 @@ require_relative 'sms'
 
 module Biju
   class Modem
+
+    # @param [Hash] Options to serial connection.
+    # @option options [String] :port The modem port to connect
+    #
+    #   Biju::Modem.new(:port => '/dev/ttyUSB0')
+    #
     def initialize(options={})
       raise Exception.new("Port is required") unless options[:port]
       @connection = connection(options)
@@ -10,15 +16,12 @@ module Biju
       cmd("AT+CMGF=1")
     end
 
-    def connection(options)
-      port = options.delete(:port)
-      SerialPort.new(port, default_options.merge!(options))
-    end
-
+    # Close the serial connection.
     def close
       @connection.close
     end
 
+    # Return an Array of Sms if there is messages nad return nil if not.
     def messages
       sms = cmd("AT+CMGL=\"ALL\"")
       msgs = sms.scan(/\+CMGL\:\s*?(\d+)\,.*?\,\"(.+?)\"\,.*?\,\"(.+?)\".*?\n(.*)/)
@@ -26,7 +29,18 @@ module Biju
       msgs.collect!{ |msg| Biju::Sms.new(:id => msg[0], :phone_number => msg[1], :datetime => msg[2], :message => msg[3].chomp) }
     end
 
+    # Delete a sms message by id.
+    # @param [Fixnum] Id of sms message on modem.
+    def delete(id)
+      cmd("AT+CMGD=#{id}")
+    end
+
     private
+    def connection(options)
+      port = options.delete(:port)
+      SerialPort.new(port, default_options.merge!(options))
+    end
+
     def default_options
       { :baud => 9600, :data_bits => 8, :stop_bits => 1, :parity => SerialPort::NONE }
     end

data/lib/biju/version.rb

@@ -1,3 +1,3 @@
 module Biju
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biju
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2156178580 !ruby/object:Gem::Requirement
+  requirement: &2151898080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156178580
+  version_requirements: *2151898080
 - !ruby/object:Gem::Dependency
   name: serialport
-  requirement: &2156178040 !ruby/object:Gem::Requirement
+  requirement: &2151897520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,7 +32,7 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2156178040
+  version_requirements: *2151897520
 description: An easiest way to mount a GSM modem to send and to receive sms message
 email:
 - rodrigopqn@gmail.com