kannel_rails 0.0.3 → 0.0.4

data/README.md

@@ -25,7 +25,6 @@ development:
   username: username # Kannel sendsms-user username
   password: password # Kannel sendsms-user password
   api_secret: testing # A secret key you will also configure in Kannel for extra security
-  dlr_mask: 31 # Set this if you want to receive delivery reports from Kannel.
 ```
 
 In config/routes.rb, add:
@@ -62,13 +61,13 @@ KannelRails.send_message("+639001234567", "Hello Flash!", :mclass => 0)
 
 To handle incoming SMS, create handler classes and register them.
 
-Classes have an invoke method which is called when handle? is true
+Classes have an `invoke` method which is called when `handle?` is true
 
-The return value of invoke will be the response to Kannel, which will be sent back to the sender as SMS. omit-empty is set in the sms-service so that empty strings will not be sent back.
+The return value of `invoke` will be the response to Kannel, which will be sent back to the sender as SMS. omit-empty is set in the sms-service so that empty strings will not be sent back.
 
-Sample handler is in spec/dummy/lib/echo_handler.rb
+Sample handler is in `spec/dummy/lib/echo_handler.rb`
 
-Register the handler class in config/initializers/sms_handlers.rb (or some other place if you want):
+Register the handler class in `config/initializers/sms_handlers.rb` (or some other place if you want):
 
 ```ruby
 KannelRails::Handlers.register HandlerClass
@@ -76,12 +75,21 @@ KannelRails::Handlers.register HandlerClass
 
 ### Delivery Reports
 
-To receive delivery reports, you must have the dlr_mask set. Check Kannel docs for possible values.
+To receive delivery reports, you must have the dlr_mask and dlr_url set. Check Kannel docs for possible values.
 
-```ruby
-dlr_url = "http://rails_app/some_endpoint?msg_id=123&type=%d&smsc_id=%i"
+In your config:
 
-KannelRails.send_message("+639001234567", "Hello World!", 'dlr-url' => dlr_url)
+```yaml
+development:
+  ...
+  dlr_url: http://rails_app/some_endpoint?msg_id=$msg_id&type=%d&smsc_id=%i
+  dlr_mask: 31
+```
+
+Note: The `$msg_id` in the DLR URL is a special string that will be replaced with the value of `:msg_id` option when you call `send_message`.
+
+```ruby
+KannelRails.send_message("+639001234567", "Hello World!", :msg_id => '1234')
 ```
 
-Refer to kannel docs for %d, %i, etc. You want to provide a unique msg id here (doesnt have to be called msg_id) so that you can match the delivery report to the corresponding message you sent.
+This will result in Kannel calling something similar to the URL: `http://rails_app/some_endpoint?msg_id=1234&type=1&smsc_id=the_smsc_id`

data/lib/kannel_rails/config.rb

@@ -8,7 +8,9 @@ class KannelRails::Config
   attr_accessor :username
   attr_accessor :password
 
+  attr_accessor :dlr_url
   attr_accessor :dlr_mask
+
   attr_accessor :api_secret
 
   def initialize(config_hash = {})
@@ -19,7 +21,9 @@ class KannelRails::Config
     self.username = config_hash['username']
     self.password = config_hash['password']
 
+    self.dlr_url = config_hash['dlr_url']
     self.dlr_mask = config_hash['dlr_mask']
+
     self.api_secret = config_hash['api_secret']
   end
 

data/lib/kannel_rails/version.rb

@@ -1,3 +1,3 @@
 module KannelRails
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/kannel_rails.rb

@@ -12,9 +12,15 @@ module KannelRails
       :password   => config.password,
       :to         => recipient,
       :text       => message,
+      :'dlr-url'  => config.dlr_url,
       :'dlr-mask' => config.dlr_mask
-    }.merge!(options)
+    }
 
+    if config.dlr_url and options[:msg_id]
+      query_hash[:'dlr-url'] = config.dlr_url.sub('$msg_id', options[:msg_id])
+    end
+
+    query_hash.merge!(options)
     query_hash.delete_if { |k, v| v.to_s.blank? }
 
     request_url = config.kannel_url.merge('/cgi-bin/sendsms')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kannel_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails