nibbme 1.1.0 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,6 +1,11 @@
 = Nibbme - Changelog
 
 
+== nibbme v1.2.0 released 2010/05/16
+
+* adding SMS status tracking interface (SmsLog)
+
+
 == nibbme v1.1.0 released 2010/05/15
 
 * adding a "Simple SMS Gateway" interface

data/README.rdoc

@@ -73,6 +73,7 @@ You can request data simply by calling a +find+ method.
   groups = Nibbme::Group.find(:all) 
   groups = Nibbme::Group.find(:first) 
   groups = Nibbme::Group.find(:last) 
+  group  = Nibbme::Group.find(15) # Where 15 is a Group ID number
 
 Note that this will return only the items on the first page. You can pass the +page+ variable to
 get the items on the subpage. If the request is empty you know there is no more items.
@@ -114,6 +115,7 @@ You can request data simply by calling a +find+ method.
   clients = Nibbme::Client.find(:all) 
   clients = Nibbme::Client.find(:first) 
   clients = Nibbme::Client.find(:last) 
+  client  = Nibbme::Client.find(15) # Where 15 is a Client ID number
 
 Note that this will return only the items on the first page. You can pass the +page+ variable to
 get the items on the subpage. If the request is empty you know there is no more items.
@@ -155,6 +157,7 @@ You can request data simply by calling a +find+ method.
   messages = Nibbme::Message.find(:all) 
   messages = Nibbme::Message.find(:first) 
   messages = Nibbme::Message.find(:last) 
+  message  = Nibbme::Message.find(15) # Where 15 is a Message ID number
 
 Note that this will return only the items on the first page. You can pass the +page+ variable to
 get the items on the subpage. If the request is empty you know there is no more items.
@@ -211,6 +214,44 @@ Similar to ActiveRecord all errors are logged as part of +errors+ variable.
 
 You can find more about error handling {here}[http://api.rubyonrails.org/classes/ActiveResource/Validations.html].
 
+=== Logs (Tracking SMS Status)
+
+You can request data simply by calling a +find+ method.
+
+  logs = Nibbme::SmsLog.find(:all) 
+  logs = Nibbme::SmsLog.find(:first) 
+  logs = Nibbme::SmsLog.find(:last)
+  logs = Nibbme::SmsLog.find(15) # Where 15 is a SmsLog ID number
+
+Note that this will return only the items on the first page. You can pass the +page+ variable to
+get the items on the subpage. If the request is empty you know there is no more items.
+
+  # Request the second page
+  logs = Nibbme::SmsLog.find(:all, :params => { :page => 1 })
+
+You can also filter the list through a +tags+ variable.
+
+  # Request the second page but filter only the items containing the word '313'
+  logs = Nibbme::SmsLog.find(:all, :params => { :page => 1, :tags => '313' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the SmsLog with ID=1 exists
+  exists = Nibbme::SmsLog.exists?(1)
+
+Usually you will know a message and client ID. You can check an SMS status as follows
+  
+  # Find log for a message with ID=14 and client ID=50
+  log = Nibbme::SmsLog.find_one(14, 50)
+
+  # Check if the message has been delivered
+  log.delivered?
+
+  # Check if the message has failed
+  log.failed?
+  
+  # Show the message state
+  log.state
 
 == Links
 

data/lib/nibbme/sms_log.rb

@@ -0,0 +1,23 @@
+module Nibbme
+  class SmsLog < Nibbme::AbstractBase
+
+    def self.find_one(message_id, client_id)
+      self.find(message_id, :params => { :client_id => client_id })
+    end
+    
+    def delivered?
+      !self.delivered_at.nil?
+    end
+
+    def failed?
+      !self.failed_at.nil?
+    end
+
+    def state
+      return 'delivered' if self.delivered?
+      return 'failed' if self.failed?
+      'in_progress'
+    end
+
+  end
+end

data/lib/nibbme/version.rb

@@ -1,7 +1,7 @@
 module Nibbme #:nodoc:
   module Version #:nodoc:
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Kristijan Sedlak
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-15 00:00:00 +02:00
+date: 2010-05-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - lib/nibbme/gateway.rb
 - lib/nibbme/group.rb
 - lib/nibbme/message.rb
+- lib/nibbme/sms_log.rb
 - lib/nibbme/tasks.rb
 - lib/nibbme/version.rb
 - lib/nibbme.rb