ficonabses 0.4.0 → 0.4.1

data/README.rdoc

@@ -5,13 +5,13 @@
 == REASONABLY PRODUCTION READY:
 == DESCRIPTION:
 
-A simple way to send emails from your application using amazon ses.  Register at admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com] to create your account.  Templates can be emails or Apple Push Notifications.  APNs require more configuration so please contact estormtech directly to implement this functionality but the same code will send either  in your application.
+A simple way to send transactional notifications from your application using amazon ses, sms and apple push notifications.  Register at admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com] to create your account.  Templates can be emails, sms, or Apple Push Notifications.  APNs require more configuration so please contact estormtech (info@estormtech.com) directly to implement this functionality but the same code will send either  in your application.
 
 == FEATURES/PROBLEMS:
 
-* A simple way to send text and html emails from your application.  Templates for the contents of the email can be configured at admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com].  
+* Templates for the contents of the email can be configured at admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com].  
 
-* You can send spontaneous emails directly in your code.  Or more elegantly you can set up a template on the system and send it with contents inserted in the parameters of the call.  That way you can change the template (eg have a different design for Halloween or Eid or Christmas) while not touching your production code.
+* You can send spontaneous emails, sms, APNs directly in your code.  Or more elegantly you can set up a template on the system and send it with contents inserted in the parameters of the call.  That way you can change the template (eg have a different design for Halloween or Eid or Christmas) while not touching your production code.
 
 == SYNOPSIS HTML EMAIL:
 
@@ -55,7 +55,7 @@ A simple way to send emails from your application using amazon ses.  Register at
 *    res =FiconabSES::Addons.send_exception_direct(@account,@passwd,@destination,exception)
 
 == CAMPAIGN FLOWS
-* This allows you structure a sequence of emails/customer interaction based on parameters. (eg you could email the customer something and send them an apple push notification at the same time)
+* This allows you structure a sequence of emails/customer interaction based on parameters. (eg you could email the customer something and send them an apple push notification at the same time)  (CAVEAT - as destination can be modified during the campaign flow we insert automatically destination into the options hash array.  This should have no impact on your code.  You can for example, change the destination to another parameter in the campaign flow).  The campaign flows can include time delays between sending emails or sms.  (Eg week1 welcome to the system, week2, did you know that etc.)
 
 *   Exactly the same calling sequence as for templates.
       f=FiconabSES::Base.new
@@ -64,6 +64,12 @@ A simple way to send emails from your application using amazon ses.  Register at
       f.set_credentials(@account,@passwd)
        res =@f.send_campaign_flow(@destination,'testcampaign',options) 
 
+== BULK DATA
+*     Send a bulk data file for processing the same template
+*    Similar to templates:
+       bulkdata={'xmllist' => "<destinations><destination address='scott.sproule@gmail.com' sendtime='12:00'></destination><destination address='scott.sproule@estormtech.com' sendtime='12:00'></destination></destinations>", "template"=>"expiring_trial"} 
+       res= FiconabSES::Addons.send_bulk(@f,bulkdata)   
+
 
 
 ==BINARY FILES

data/lib/ficonabses/addons.rb

@@ -5,6 +5,15 @@ module FiconabSES
          f.set_credentials(account,password)
          FiconabSES::Addons.send_ruby_exception(f,exception,destination,nil)
     end
+    def self.send_bulk_direct(account,password,bulkdata)
+         f=FiconabSES::Base.new
+         f.set_credentials(account,password)
+         FiconabSES::Addons.send_bulk(f,bulkdata)
+    end
+    def self.send_bulk(ficonab_obj,bulkdata)
+      puts "BULK DATA is #{bulkdata}"
+      res =ficonab_obj.send_bulk(bulkdata)
+    end
     def self.readfile(filename)
         csvfile=File.open(filename,'r') 
         rawfile= FasterCSV.parse(csvfile.read, { :headers           => true})

data/lib/ficonabses/base.rb

@@ -71,7 +71,13 @@ module FiconabSES
    end
       @clnt
   end 
-  def perform(url)
+  def client_action(postflag,postdata)
+    puts "FLAG: #{postflag} DATA: #{postdata}"
+     result=self.clnt.get_content(self.uri,self.extheader) if !postflag
+     result = self.clnt.post_content(self.uri, postdata,{'Content-Type' => 'application/x-www-form-urlencoded'}) if postflag
+     result
+  end
+  def perform(url,postflag=false,postdata={})
      @uri=URI.parse(url)
     # puts "url is #{url}"
      raise 'credentials not set' if @account==nil
@@ -80,7 +86,8 @@ module FiconabSES
        # Don't take longer than 60 seconds  -- incase there is a problem with our server continue
          @clnt=self.build_client 
        Timeout::timeout(60) do    
-         res=self.clnt.get_content(self.uri,self.extheader)
+          # original res=self.clnt.get_content(self.uri,self.extheader)
+         res=self.client_action(postflag,postdata)
        end
      rescue Timeout::Error,HTTPClient::BadResponseError
           
@@ -89,7 +96,8 @@ module FiconabSES
           puts "BAD RESPONSE or Timeout - retrying once #{self.uri} after five seconds"
          sleep(5)   # take a break to see if it is too busy
          Timeout::timeout(25) do   
-            res=self.clnt.get_content(self.uri,self.extheader)
+           # original res=self.clnt.get_content(self.uri,self.extheader)
+              res=self.client_action(postflag,postdata)
             puts "RETRY: second chance res is #{res}"
           end
          # bad response  - try it again?
@@ -109,6 +117,11 @@ module FiconabSES
     url="#{self.action_url('ficonabsendemail',destination)}&subject=#{URI.encode(subject)}&text=#{URI.encode(contents)}" 
     url
   end
+  def bulk_url
+    url="http://#{@@host}/ficonabbulkmanager?"
+    puts "BULK URL: #{url}"
+    url  
+  end
   def global_blacklist_url(destination,username)
     url="#{self.action_url('ficonabaction',destination)}&type=globalunsubscribe&user=#{URI.encode(username)}" 
     url
@@ -139,6 +152,11 @@ module FiconabSES
     perform(url)
      #  res
   end
+  def send_bulk(bulkdata)
+     url=self.bulk_url
+     perform(url,true,bulkdata)
+      #  res
+   end
   def send_template(destination,templatename)
      url=self.template_url(destination,templatename)
    #  puts "url is: #{url}"

data/test/test_bulk.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestFiconabses < Test::Unit::TestCase
+
+  def setup
+    @f=FiconabSES::Base.new
+    @f.set_credentials('scott','scott123')
+  #  @f.set_debug
+    @destination='scott.sproule@gmail.com'
+    @tsipid ='7923044488'
+  end
+  
+      def test_bulk
+     #  bulkdata="xmllist=<destinations><destination address='scott.sproule@gmail.com' sendtime='12:00'></destination><destination address='scott.sproule@estormtech.com' sendtime='12:00'></destination></destinations>&template=expiring_trial"
+        bulkdata={'xmllist' => "<destinations><destination address='scott.sproule@gmail.com' sendtime='12:00'></destination><destination address='scott.sproule@estormtech.com' sendtime='12:00'></destination></destinations>", "template"=>"expiring_trial"} 
+        res= FiconabSES::Addons.send_bulk(@f,bulkdata)   
+        puts "RES is #{res}"
+        assert res.include? '200'
+      end
+end

data/test/test_localhost.rb

@@ -65,7 +65,7 @@ class TestFiconabses < Test::Unit::TestCase
                      options={}
                      options['hello']='TESTING'
                      options['bcinfo']='+6590683565'
-                     res =@f.send_campaign_flow(@destination,'testcampaign',options)  #no text portion
+                     res =@f.send_campaign_flow(@destination,'testthreeminutes',options)  #no text portion
                      puts "RES is: #{res}"
                      assert res.include? '200'
                      assert false==(res.include? 'Error')

data/test/testcampaignnew.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestFiconabses < Test::Unit::TestCase
+
+  def setup
+    @f=FiconabSES::Base.new
+    @f.set_credentials('scott','scott123')
+    @f.set_debug
+    @destination='scott.sproule@gmail.com'
+    @tsipid ='7923044488'
+  end
+  
+   def test_local_campaign_flownew
+                   options={}
+                   options['hello']='TESTING'
+                   options['bcinfo']='+6590683565'
+                   res =@f.send_campaign_flow(@destination,'testthreeminutes',options)  #no text portion
+                   puts "RES is: #{res}"
+                   assert res.include? '200'
+                   assert false==(res.include? 'Error')
+
+    end
+     def test_local_sendtime_tempate
+                     options={'sendtime' => "18:00"}
+                     options['hello']='TESTING'
+                     options['bcinfo']='+6590683565'
+                     res =@f.send_template_params(@destination,'expiring_trial',options)  #no text portion
+                     puts "RES is: #{res}"
+                     assert res.include? '200'
+                     assert false==(res.include? 'Error')
+
+      end
+     
+
+end

data/test/testcampaignnewremote.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestFiconabses < Test::Unit::TestCase
+
+  def setup
+    @f=FiconabSES::Base.new
+    @f.set_credentials('scott','scott123')
+    @destination='scott.sproule@gmail.com'
+    @tsipid ='7923044488'
+  end
+  
+   def test_local_campaign_flownew
+                   options={}
+                   options['hello']='TESTING'
+                   options['bcinfo']='+6590683565'
+                   res =@f.send_campaign_flow(@destination,'testthreeminutes',options)  #no text portion
+                   puts "RES is: #{res}"
+                   assert res.include? '200'
+                   assert false==(res.include? 'Error')
+
+    end
+     
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Scott Sproule
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-17 00:00:00 +08:00
+date: 2012-07-06 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - lib/ficonabses/base.rb
 - lib/ficonabses/support.rb
 - lib/ficonabses.rb
+- test/test_bulk.rb
 - test/test_ficonabses.rb
 - test/test_hashparams.rb
 - test/test_helper.rb
@@ -43,6 +44,8 @@ files:
 - test/test_smartroam.rb
 - test/test_smartroam2.rb
 - test/test_templates.rb
+- test/testcampaignnew.rb
+- test/testcampaignnewremote.rb
 - bin/ficonabses_blacklist.rb
 - bin/ficonabses_campaign_flow_test.rb
 - bin/ficonabses_csv.rb