kannel_rails 0.0.2 → 0.0.3

data/README.md

@@ -20,10 +20,12 @@ Sample content:
 
 ```yaml
 development:
-  kannel_url: http://kannel_server:13013 # Kannel smsbox sendsms-port
+  kannel_url: http://kannel_server # Kannel server host
+  sendsms_port: 13013 # Kannel sendsms port
   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:
@@ -50,6 +52,12 @@ Sending an SMS is as simple as:
 KannelRails.send_message("+639001234567", "Hello World!")
 ```
 
+You can pass extra parameters that Kannel accepts. For example, to send a flash message:
+
+```ruby
+KannelRails.send_message("+639001234567", "Hello Flash!", :mclass => 0)
+```
+
 ### Receiving SMS
 
 To handle incoming SMS, create handler classes and register them.
@@ -65,3 +73,15 @@ Register the handler class in config/initializers/sms_handlers.rb (or some other
 ```ruby
 KannelRails::Handlers.register HandlerClass
 ```
+
+### Delivery Reports
+
+To receive delivery reports, you must have the dlr_mask set. Check Kannel docs for possible values.
+
+```ruby
+dlr_url = "http://rails_app/some_endpoint?msg_id=123&type=%d&smsc_id=%i"
+
+KannelRails.send_message("+639001234567", "Hello World!", 'dlr-url' => dlr_url)
+```
+
+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.

data/lib/kannel_rails/config.rb

@@ -1,16 +1,25 @@
+require 'uri'
+
 class KannelRails::Config
 
   attr_accessor :kannel_url
+  attr_accessor :sendsms_port
+
   attr_accessor :username
   attr_accessor :password
-  attr_accessor :dlr_url
+
+  attr_accessor :dlr_mask
   attr_accessor :api_secret
 
   def initialize(config_hash = {})
-    self.kannel_url = config_hash['kannel_url']
+    url = config_hash['kannel_url']
+    self.kannel_url = url.is_a?(URI) ? url : URI.parse(url)
+    self.sendsms_port = config_hash['sendsms_port']
+
     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.2"
+  VERSION = "0.0.3"
 end

data/lib/kannel_rails.rb

@@ -6,16 +6,28 @@ require "net/http"
 
 module KannelRails
 
-  def self.send_message(recipient, message)
-    request_url = config.kannel_url.chomp('/') + "/cgi-bin/sendsms?" +
-                  "username=#{CGI.escape(config.username.to_s)}&password=#{CGI.escape(config.password.to_s)}" +
-                  "&to=#{CGI.escape(recipient.to_s)}&text=#{CGI.escape(message.to_s)}"
-
-    response = Net::HTTP.get_response(URI.parse(
-      request_url
-    ))
-
-    response.is_a? Net::HTTPSuccess
+  def self.send_message(recipient, message, options = {})
+    query_hash = {
+      :username   => config.username,
+      :password   => config.password,
+      :to         => recipient,
+      :text       => message,
+      :'dlr-mask' => config.dlr_mask
+    }.merge!(options)
+
+    query_hash.delete_if { |k, v| v.to_s.blank? }
+
+    request_url = config.kannel_url.merge('/cgi-bin/sendsms')
+    request_url.query = query_hash.to_query
+    request_url.port = config.sendsms_port
+
+    response = Net::HTTP.get_response(request_url)
+
+    if response.is_a? Net::HTTPSuccess
+      return response
+    else
+      return false
+    end
   end
 
   def self.config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kannel_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -35,7 +35,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -51,7 +51,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false