action_smser 1.0.1 → 1.1.0

data/README.md

@@ -1,6 +1,6 @@
 # ActionSmser
 
-Simple way to use SMS (Short Message Service) in the same way as ActionMailer (ActionSmser == ActionMailer).
+ActionSmser == SMS && ActionMailer. Simple way to use SMS (Short Message Service) in the same way as ActionMailer.
 Includes also delivery reports and easy way to add custom gateways. See examples below.
 
 [<img src="https://secure.travis-ci.org/holli/action_smser.png" />](http://travis-ci.org/holli/action_smser)
@@ -16,7 +16,7 @@ Gemfile ->
 gem 'action_smser'
 
 # To use delivery reports
-bundle exec rake railties:install:migrations FROM=ActionSmser
+bundle exec rake railties:install:migrations
 rake db:migrate
 ```
 
@@ -68,6 +68,37 @@ Optional delivery methods can be used by creating classes under "ActionSmser::De
 them as downcase infos. See example of :simple_http at
 https://github.com/holli/action_smser/blob/master/lib/action_smser/delivery_methods/simple_http.rb
 
+Simplest case is to use simple_http and override path
+
+```
+# Example of changing simple_http delivery path. Options are the same options that were presented above.
+
+module ActionSmser::DeliveryMethods
+  class SimpleHttp
+    def self.deliver_path(sms, options)
+      "/my_gateways_api/send?user=#{options[:username]}&password=#{options[:password]}&ValidityPeriod=24:00&sender=#{sms.from_encoded}&SMSText=#{sms.body_encoded_escaped}&GSM=#{sms.to_encoded}"
+    end
+  end
+end
+
+```
+
+**Nexmo** (http://nexmo.com/) is supported also.
+
+```
+  ActionSmser.delivery_options[:delivery_method] = :nexmo
+  ActionSmser.delivery_options[:nexmo] = {
+      :username => 'key', :password => "password"
+  }
+
+  # set callback url to nexmo http://localhost:3000/action_smser/delivery_reports/gateway_commit/nexmo
+  ActionSmser.delivery_options[:gateway_commit]['nexmo'] = ActionSmser::DeliveryMethods::Nexmo
+
+```
+
+If you add other common gateways to this framework, plz generate tests and send us a patch.
+
+
 ## Delivery reports
 
 Gem handles collecting and analysing of delivery reports. This enables you to make sure that your gateway works.
@@ -110,23 +141,24 @@ class ActionSmserConfigExample
   end
 end
 
-
 # This is simple proc that is used in a before filter, if it returns true it allows access to
 # http://localhost.inv:3000/action_smser/delivery_reports/ with infos about delivery reports
 ActionSmser.delivery_options[:admin_access] = ActionSmserConfigExample
 
-# This gives ActionSmser way to parse infos from pushed to gateway
-# Params is all params gotten in the request
-test_gateway = lambda
-
 # Parser is used with urls like
 # /action_smser/delivery_reports/gateway_commit/test_gateway
 # where 'test_gateway' is the part that is used for locating right parser.
-ActionSmser.delivery_options[:gateway_commit] = {'test_gateway' => test_gateway}
-
+ActionSmser.delivery_options[:gateway_commit]['test_gateway'] = ActionSmserConfigExample
 
 ```
 
+DeliveryReports can be searched by "dr = ::ActionSmser::DeliveryReport.where(xxx).first".
+Some helpers in delivery_reports include
+
+- dr.to_sms => creates new sms message from deliveryreport.
+- dr.resent(:gateway) => creates new sms and sends it through given gateway.
+
+
 ## Other options
 
 Observers can be used by implementing "delivery_observer" in your sms class
@@ -138,12 +170,32 @@ class TestSms < ActionSmser::Base
     sms(:to => to, :from => from, :body => str)
   end
 
+  def before_delivery()
+    puts "Called just before delivery"
+  end
+
   def after_delivery(response_from_delivery_method)
     puts "Done with delivery"
   end
 end
 ```
 
+Gateway committed status updates can also have observers
+
+```
+in /config/initializers/active_smser.rb
+
+class ActionSmserConfigGatewayObserver
+  def self.after_gateway_commit(delivery_reports)
+    puts delivery_reports.inspect
+  end
+end
+
+ActionSmser.gateway_commit_observer_add(ActionSmserConfigGatewayObserver)
+
+```
+
+
 ## Testing
 
 Default delivery method is "test_array". It saves delivered sms to ActionSmser::DeliveryMethods::TestArray.deliveries to help test your own software.

data/app/controllers/action_smser/delivery_reports_controller.rb

@@ -11,10 +11,11 @@ module ActionSmser
 
         ActionSmser::Logger.info("Gateway_commit found parser for gateway: #{params['gateway']}")
 
-        dr_array = ActionSmser.delivery_options[:gateway_commit][params['gateway']].send(:process_delivery_report, params)
+        dr_var_array = ActionSmser.delivery_options[:gateway_commit][params['gateway']].send(:process_delivery_report, params)
+        dr_array = []
 
-        if !dr_array.blank?
-          dr_array.each do |dr_update|
+        if !dr_var_array.blank?
+          dr_var_array.each do |dr_update|
             msg_id = dr_update["msg_id"]
             dr = ActionSmser::DeliveryReport.where(:msg_id => msg_id).first
 
@@ -23,9 +24,9 @@ module ActionSmser
                 dr.send("#{key}=", value) if dr.attribute_names.include?(key.to_s)
               end
 
-
               if dr.save
                 updated_count += 1
+                dr_array << dr
                 ActionSmser::Logger.info("Gateway_commit updated item with id: #{msg_id}, params: #{dr_update.inspect}")
               else
                 ActionSmser::Logger.info("Gateway_commit problem updating item with id: #{msg_id}, params: #{dr_update.inspect}")
@@ -35,6 +36,16 @@ module ActionSmser
             end
           end
         end
+
+        begin
+          ActionSmser.delivery_options[:gateway_commit_observers].each do |observer|
+            observer.after_gateway_commit(dr_array)
+          end
+        rescue Exception => e
+          ActionSmser::Logger.error("Problem with gateway_commit_observers: #{e}")
+        end
+
+
       end
 
       if updated_count > 0
@@ -44,12 +55,18 @@ module ActionSmser
       end
     end
 
+
     before_filter :admin_access_only, :except => :gateway_commit
 
     def index
 
     end
 
+    def list
+      
+    end
+
+
     def admin_access_only
       if !ActionSmser.delivery_options[:admin_access].blank? && ActionSmser.delivery_options[:admin_access].send(:admin_access, self)
         return true

data/app/models/action_smser/delivery_report.rb

@@ -1,15 +1,20 @@
 module ActionSmser
   class DeliveryReport < ActiveRecord::Base
 
+    has_many :re_deliveries, :class_name => self.to_s, :foreign_key => :re_delivery_of_delivery_report_id
+    puts self
+    belongs_to :re_delivery_of, :class_name => self.to_s, :foreign_key => :re_delivery_of_delivery_report_id
+
     def self.build_from_sms(sms, to, msg_id)
       @delivery_report = self.new
 
-      [:from, :body, :sms_type].each do |var|
+      [:from, :body, :sms_type, :re_delivery_of_delivery_report_id].each do |var|
         @delivery_report.send("#{var}=", sms.send(var))
       end
       @delivery_report.to = to
       @delivery_report.msg_id = msg_id
       @delivery_report.status = "LOCAL_SENT"
+      @delivery_report.gateway = sms.delivery_options[:delivery_method].to_s
       @delivery_report
     end
 
@@ -22,8 +27,36 @@ module ActionSmser
     def status=(stat, skip_log = false)
       self[:status] = stat
       self.status_updated_at = Time.now
+      add_log("#{Time.now.to_s(:db)}: #{stat}") unless skip_log
+    end
+
+    def add_log(str)
       self.log = "" if self.log.nil?
-      self.log += "#{Time.now.to_s(:db)}: #{stat}\n" if !skip_log
+      self.log += "#{str}\n"
+    end
+
+    # Copy this delivery_report information to a new sms object
+    def to_sms
+      sms_new = ActionSmser::Base.new()
+      [:sms_type, :to, :from, :body, :sms_type].each do |var|
+        sms_new.send("#{var}=", self.send(var))
+      end
+      sms_new
+    end
+
+    def re_deliver(gateway = :default)
+      ActionSmser::Logger.info("Re_delivering: #{self.inspect}")
+      self.update_attribute(:re_delivered, true)
+      
+      sms_new = self.to_sms
+      sms_new.sms_type = "#{sms_new.sms_type}.re_delivery"
+      sms_new.re_delivery_of_delivery_report_id = self.id
+
+      unless gateway == :default
+        sms_new.delivery_options[:delivery_method] = gateway
+      end
+
+      [sms_new, sms_new.deliver]
     end
 
   end

data/app/views/action_smser/delivery_reports/index.html.erb

@@ -14,28 +14,53 @@ time_span = case params['time_span'].to_s.downcase
   else
     1.week.ago..10.minutes.ago
   end
+
+  ar_timespan = ActionSmser::DeliveryReport.where(:created_at => time_span)
+
+  ar_gateway = ar_timespan
+  ar_gateway = ar_gateway.where(:gateway => params[:gateway]) if (params[:gateway] && params[:gateway].to_s != 'all')
+
 %>
 
 
-<h1>Delivery Reports Summary for <%= params['time_span'] %></h1>
+<h1>Delivery Reports Summary for <%= params['time_span'] %> <%= "for #{params[:gateway]}" unless params[:gateway].blank? %></h1>
 
 <p>
 Show summary:
-<%= link_to 'Last 24 hours', delivery_reports_path(:time_span => 'Last 24 Hours') %>,
-<%= link_to '24 hours before that', delivery_reports_path(:time_span => 'Previous 24 Hours') %>,
-<%= link_to 'Last week', delivery_reports_path(:time_span => 'Last Week') %>,
-<%= link_to 'Week before that', delivery_reports_path(:time_span => 'Previous Week') %> or
-<%= link_to 'Last month', delivery_reports_path(:time_span => 'Last Month') %>.
+<%= link_to 'Last 24 hours', delivery_reports_path(:time_span => 'Last 24 Hours', :gateway => params[:gateway]) %>,
+<%= link_to '24 hours before that', delivery_reports_path(:time_span => 'Previous 24 Hours', :gateway => params[:gateway]) %>,
+<%= link_to 'Last week', delivery_reports_path(:time_span => 'Last Week', :gateway => params[:gateway]) %>,
+<%= link_to 'Week before that', delivery_reports_path(:time_span => 'Previous Week', :gateway => params[:gateway]) %> or
+<%= link_to 'Last month', delivery_reports_path(:time_span => 'Last Month', :gateway => params[:gateway]) %>.
 </p>
 
-<h2>Delivered Within (hour:min:sec)</h2>
+<h2>Select gateway</h2>
 
-<%
-  ar = ActionSmser::DeliveryReport.where(:created_at => time_span)
-  ar_delivered = ar.where(:status => 'delivered')
-  total = ar.count
-  total_delivered = ar_delivered.count
-%>
+<ul>
+  <li>
+    <strong>
+        <%= link_to('all', delivery_reports_path(:time_span => params[:time_span]) ) %>
+    </strong>
+    &nbsp;&nbsp;
+    (you can select only gateways that have messages in this period)
+  </li>
+  <%
+     total = ar_timespan.count
+     grouped_by_status = ar_timespan.group(:gateway).count.each do |key, val| %>
+    <li>
+      <strong>
+        <%= link_to(key, delivery_reports_path(:time_span => params[:time_span], :gateway => key) ) %>
+      </strong>
+      &nbsp;&nbsp;
+      <%= val %> sms
+      &nbsp;&nbsp;
+      (<strong><%= number_to_percentage(100.0 * val / total, :precision => 2) %></strong>)
+    </li>
+  <% end %>
+</ul>
+
+
+<h2>Delivered Within (hour:min:sec)</h2>
 
 <% if ActiveRecord::Base.connection.adapter_name.downcase.to_s.include?("mysql") %>
 
@@ -47,6 +72,10 @@ Show summary:
       <th>% of delivered sms</th>
     </tr>
 
+    <% ar_delivered = ar_gateway.where(:status => 'delivered')
+       total = ar_gateway.count
+       total_delivered = ar_delivered.count
+    %>
     <% ["00:00:30", "00:01:00", "00:02:00", "00:10:00", "00:30:00", "00:90:00", "24:00:00", "48:00:00"].each do |time| %>
       <% dev_count = ar_delivered.where('TIMEDIFF(status_updated_at, created_at) < ?', time).count %>
       <tr>
@@ -66,9 +95,8 @@ Show summary:
 <h2>DeliveryReport Statuses</h2>
 <ul>
 <%
-   quest = ActionSmser::DeliveryReport.where(:created_at => time_span)
-   total = quest.count
-   grouped_by_status = quest.group(:status).count.each do |key, val| %>
+   total = ar_gateway.count
+   grouped_by_status = ar_gateway.group(:status).count.each do |key, val| %>
 
     <li>
       <strong><%= key %></strong>:
@@ -91,9 +119,8 @@ Show summary:
   </tr>
 
 <%
-   quest = ActionSmser::DeliveryReport.where(:created_at => time_span)
-   total = quest.count
-   grouped_by_status = quest.group(:sms_type).count.each do |key, val| %>
+   total = ar_gateway.count
+   grouped_by_status = ar_gateway.group(:sms_type).count.each do |key, val| %>
    <tr>
      <td><strong><%= key %></strong></td>
      <td><%= val %></td>
@@ -105,46 +132,3 @@ Show summary:
 </table>
 
 
-<hr>
-
-<% items_within_page = 20 %>
-<h1 id="delivery_reports_list"><%= items_within_page %> delivery_reports ordered by created_at</h1>
-
-<%
-offset = params[:offset].to_i
-offset = 0 if offset < -0
-%>
-
-<p>
-  <strong>List offset: <%= offset %>.</strong>
-  Add
-  <%= link_to("- #{items_within_page}",  delivery_reports_path(:offset => offset-items_within_page, :anchor => 'delivery_reports_list')) unless offset == 0 %>
-  <%= link_to "+ #{items_within_page}",  delivery_reports_path(:offset => offset+items_within_page, :anchor => 'delivery_reports_list') %>
-  to offset
-</p>
-
-<table style="margin-top: 20px;">
-  <tr>
-    <th>Created_at</th>
-    <th>Msg id</th>
-    <th>Status</th>
-    <th>Status updated at</th>
-    <th>Recipient</th>
-    <th>Sender</th>
-    <th>Text body</th>
-  </tr>
-
-<% ActionSmser::DeliveryReport.order('created_at DESC').offset(offset).first(items_within_page).each do |delivery_report| %>
-  <tr>
-    <td style="white-space: nowrap;"><%= delivery_report.created_at %></td>
-    <td><%= delivery_report.msg_id %></td>
-    <td><%= delivery_report.status %></td>
-    <td style="white-space: nowrap;"><%= delivery_report.status_updated_at %></td>
-    <td><%= delivery_report.to %></td>
-    <td><%= delivery_report.from %></td>
-    <td><%= delivery_report.body %></td>
-  </tr>
-<% end %>
-</table>
-
-

data/app/views/action_smser/delivery_reports/list.html.erb

@@ -0,0 +1,52 @@
+
+<% items_within_page = 20 %>
+<h1 id="delivery_reports_list"><%= items_within_page %> delivery_reports ordered by created_at</h1>
+
+<%
+offset = params[:offset].to_i
+offset = 0 if offset < -0
+%>
+
+<p>
+  <strong>List offset: <%= offset %>.</strong>
+  Add
+  <%= link_to("- #{items_within_page}",  list_delivery_reports_path(:offset => offset-items_within_page)) unless offset == 0 %>
+  <%= link_to "+ #{items_within_page}",  list_delivery_reports_path(:offset => offset+items_within_page) %>
+  to offset
+</p>
+
+<table style="margin-top: 20px; font-size: 10px;">
+  <tr>
+    <th>Id</th>
+    <th>Created_at</th>
+    <th>Msg id</th>
+    <th>Gateway</th>
+    <th>Status</th>
+    <th>Status updated at</th>
+    <th>Recipient</th>
+    <th>Sender</th>
+    <th>Sms Type</th>
+    <th>Re Delivered</th>
+    <th>Re Delivery Of</th>
+    <th>&nbsp;O</th>
+  </tr>
+
+<% ActionSmser::DeliveryReport.order('created_at DESC').offset(offset).first(items_within_page).each do |delivery_report| %>
+  <tr>
+    <td style="white-space: nowrap;"><%= delivery_report.id %></td>
+    <td style="white-space: nowrap;"><%= delivery_report.created_at %></td>
+    <td><%= delivery_report.msg_id %></td>
+    <td><%= delivery_report.gateway %></td>
+    <td><%= delivery_report.status %></td>
+    <td style="white-space: nowrap;"><%= delivery_report.status_updated_at %></td>
+    <td><%= delivery_report.to %></td>
+    <td><%= delivery_report.from %></td>
+    <td><%= delivery_report.sms_type %></td>
+    <td><%= delivery_report.re_delivered? %></td>
+    <td><%= delivery_report.re_delivery_of.msg_id unless delivery_report.re_delivery_of.blank? %></td>
+    <td title="<%= delivery_report.body %>">&nbsp;O</td>
+  </tr>
+<% end %>
+</table>
+
+

data/app/views/layouts/action_smser/delivery_reports.html.erb

@@ -14,7 +14,7 @@
     }
     th, td {
       border:  1px solid gray;
-      padding: 1px 10px 1px 3px;
+      padding: 1px 8px 1px 3px;
     }
 
     h1 { margin-top: 40px; }
@@ -29,6 +29,9 @@
 
     }
     hr { margin-top: 20px; margin-bottom: 10px; }
+
+    .menu { margin-top: 30px; }
+    .menu a { margin-right: 20px; font-size: 16px; }
     
   </STYLE>
 
@@ -37,7 +40,9 @@
 
 <h1>ActionSmser infos</h1>
 
-Back to <%= link_to 'Main application', '/' %>
+<div class="menu">
+<%= link_to 'Main application', '/' %> <%= link_to 'Summary of SMS', delivery_reports_path -%> <%= link_to 'List All SMS', list_delivery_reports_path %>
+</div>
 
 <hr>