ficonabses 0.1.5 → 0.1.6

data/README.rdoc

@@ -31,7 +31,7 @@ A simple way to send emails from your application using amazon ses.  Register at
       f.send_textemail(@destination,'This is the subject','text contents of the email')
 
 == SYNOPSIS USING A TEMPLATE:
-* The subject and contents of the template are defined on the system.  See admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com].  As well as a bcc variable is also possible to be defined to automatically copy an adress
+* The subject and contents of the template are defined on the system.  See admin.ses.sg.estormtech.com[http:admin.ses.sg.estormtech.com].  As well as a bcc variable is also possible to be defined to automatically copy an addresss.  The template may be an email or an apple push notification.
 
 *    res =FiconabSES::Base.send_template_direct(@account,@passwd,@destination,templatename)
 *   or similarly using objects
@@ -40,6 +40,15 @@ A simple way to send emails from your application using amazon ses.  Register at
       res =f.send_template(@destination,'testtemplate')
 
 == SYNOPSIS USING A TEMPLATE PLUS PARAMETERS
+* This allows you to have a dynamic template and fill in the details in the template dynamically.  (eg insert url, customer name) into the template just by attaching the values to the call in a ruby hash.
+
+*    res =FiconabSES::Base.send_template_params_direct(@account,@passwd,@destination,templatename,options)
+*   or similarly using objects
+      f=FiconabSES::Base.new
+      options={}
+      options['customername']='Mr Test'  #in the template {customername} will be replaced with Mr Test
+      f.set_credentials(@account,@passwd,options)
+      res =f.send_template(@destination,'testtemplate')
 
 == REQUIREMENTS:
 

data/lib/ficonabses/base.rb

@@ -4,7 +4,19 @@ gem 'httpclient'
 require 'httpclient'
 gem 'nokogiri'
 require 'nokogiri'
-
+class Object
+  def to_query(key)
+    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+    "#{CGI.escape(key.to_s)}=#{CGI.escape(self.to_s)}"
+  end
+end
+class Hash
+  def to_param(namespace = nil)
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end
 module FiconabSES
   class Base
     attr_accessor :host,:account,:password,:uri,:clnt,:extheader
@@ -36,6 +48,11 @@ module FiconabSES
          f.set_credentials(account,password)
          f.send_template(destination,templatename)
     end
+     def self.send_template_params_direct(account,password,destination,templatename,options={})
+           f=FiconabSES::Base.new
+           f.set_credentials(account,password)
+           f.send_template(destination,templatename,options)
+      end    
   def perform(url)
      @uri=URI.parse(url)
      raise 'credentials not set' if @account==nil
@@ -68,6 +85,10 @@ module FiconabSES
     url="#{self.action_url('ficonabsimpletemplate',destination)}&template=#{URI.encode(templatename)}" 
     url
   end
+  def template_url_params(destination,templatename,options)
+    url="#{self.action_url('ficonabcomplextemplate',destination)}&template=#{URI.encode(templatename)}&#{options.to_param}" 
+    url
+  end
   def html_url(destination,subject,contents,html)
     contents='' if contents==nil
     url="#{self.text_url(destination,subject,contents)}&html=#{URI.encode(html)}"
@@ -80,10 +101,16 @@ module FiconabSES
   end
   def send_template(destination,templatename)
      url=self.template_url(destination,templatename)
-     puts "url is: #{url}"
+   #  puts "url is: #{url}"
      perform(url)
       #  res
    end
+   def send_template_params(destination,templatename,options={})
+      url=self.template_url_params(destination,templatename,options)
+      puts "url is: #{url}"
+      perform(url)
+       #  res
+    end
   def send_htmlemail(destination,subject,htmlcontents,textcontents=nil)
       textcontents='-' if textcontents==nil
      url=self.html_url(destination,subject,textcontents,htmlcontents)

data/test/test_ficonabses.rb

@@ -7,18 +7,20 @@ class TestFiconabses < Test::Unit::TestCase
     @account=ACCOUNT   #in test_secret.rb put ACCOUNT='youraccount' or insert your parameters direclty here  eg @ACCOUNT='myaccount'
     @passwd=PASSWD   #in test_secret.rb put PASSWD='yourpasswd'
     @destination=DESTINATION   # eg your email address 'xxx@yyyy.com'
-    
+    @tsipid = TSIPID
   end
   def test_creds
     puts "CREDENTIALS ARE: account: #{@account} passwd: #{@passwd}"
    # self assert true
   end
+  
   def test_send_text_direct
     puts 'SEND TEXT DIRECT'
     res =FiconabSES::Base.send_textemail_direct(@account,@passwd,@destination,'This is the subject','contents of the email')
     #puts "RES is: #{res}"
     assert res.include? '200'
   end
+  
   def test_send_html_direct
     puts "SEND HTML DIRECT"
     res =FiconabSES::Base.send_htmlemail_direct(@account,@passwd,@destination,'This is the HTML subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
@@ -26,7 +28,7 @@ class TestFiconabses < Test::Unit::TestCase
     assert res.include? '200'
     assert false==(res.include? 'Error')
   end
-  end
+
   def test_send_html_nil_text
      puts "SEND HTML with NIL text"
      res =FiconabSES::Base.send_htmlemail_direct(@account,@passwd,@destination,'This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
@@ -34,7 +36,7 @@ class TestFiconabses < Test::Unit::TestCase
      assert res.include? '200'
      assert false==(res.include? 'Error')
    end
-   end
+ 
    def test_send_emails
         f=FiconabSES::Base.new
         f.set_credentials(@account,@passwd)
@@ -46,7 +48,17 @@ class TestFiconabses < Test::Unit::TestCase
         assert res.include? '200'
         assert false==(res.include? 'Error')
       end
-     end
+ 
+       def test_apn_template_params
+                  options={}
+                  options['hello']='TESTING'
+                   f=FiconabSES::Base.new
+                    f.set_credentials(@account,@passwd)
+                  res =f.send_template_params(@tsipid,'apn_template',options)  #no text portion
+                  puts "RES is: #{res}"
+                  assert res.include? '200'
+                   assert false==(res.include? 'Error')
+       end
       def test_no_credentials
            f=FiconabSES::Base.new
            assert_raise RuntimeError do   #should raise runtime error

data/test/test_hashparams.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require File.dirname(__FILE__) + '/test_secret.rb'  #FILL IN ACCOUNT/PASSWD AS GLOBALS IN THIS
+
+class TestFiconabses < Test::Unit::TestCase
+
+  def setup
+    @account=ACCOUNT   #in test_secret.rb put ACCOUNT='youraccount' or insert your parameters direclty here  eg @ACCOUNT='myaccount'
+    @passwd=PASSWD   #in test_secret.rb put PASSWD='yourpasswd'
+    @destination=DESTINATION   # eg your email address 'xxx@yyyy.com'
+     @f=FiconabSES::Base.new
+      @f.set_credentials('scott','scott123')
+      @f.set_debug
+      @destination='scott.sproule@gmail.com'
+      @tsipid ='7923044488'  
+  end
+  def test_hash
+      options={}
+      options['hello']='TESTING'
+      res=options.to_param
+      assert  res=="hello=TESTING","res is: #{res}"
+        options['hello2']='TESTING2'
+        res=options.to_param
+        assert  res=="hello2=TESTING2&hello=TESTING","res is: #{res}"
+  end
+   def test_local_apn_template_params
+            options={}
+            options['hello']='TESTING'
+            res =@f.send_template_params(@tsipid,'apn_template',options)  #no text portion
+            puts "RES is: #{res}"
+            assert res.include? '200'
+             assert false==(res.include? 'Error')
+
+    end
+  
+end

data/test/test_localhost.rb

@@ -23,21 +23,37 @@ class TestFiconabses < Test::Unit::TestCase
     assert res.include? '200'
      assert false==(res.include? 'Error')
   end
-  def test_local_send_template
-       
+  def test_local_send_template     
        res =@f.send_template(@destination,'testtemplate')  #no text portion
        puts "RES is: #{res}"
        assert res.include? '200'
-         assert false==(res.include? 'Error')
-      
-     end
+         assert false==(res.include? 'Error')   
+  end
      def test_local_apn_template
-
           res =@f.send_template(@tsipid,'apn_template')  #no text portion
           puts "RES is: #{res}"
           assert res.include? '200'
            assert false==(res.include? 'Error')
-
         end     
+        
+        def test_local_apn_template_params
+                options={}
+                options['hello']='TESTING'
+                res =@f.send_template_params(@tsipid,'apn_template',options)  #no text portion
+                puts "RES is: #{res}"
+                assert res.include? '200'
+                 assert false==(res.include? 'Error')
+
+        end 
+     def test_local_apn_template_params
+                    options={}
+                    options['hello']='TESTING'
+                    options['bcinfo']='+6590683565'
+                    res =@f.send_template_params(@tsipid,'apn_template',options)  #no text portion
+                    puts "RES is: #{res}"
+                    assert res.include? '200'
+                    assert false==(res.include? 'Error')
+
+     end   
 
 end

data/test/test_templates.rb

@@ -6,7 +6,7 @@ class TestFiconabses < Test::Unit::TestCase
   def setup
     @account=ACCOUNT   #in test_secret.rb put ACCOUNT='youraccount' or insert your parameters direclty here  eg @ACCOUNT='myaccount'
     @passwd=PASSWD   #in test_secret.rb put PASSWD='yourpasswd'
-    puts "CREDENTIALS ARE: account: #{@account} passwd: #{@passwd}"
+   # puts "CREDENTIALS ARE: account: #{@account} passwd: #{@passwd}"
     @destination=DESTINATION
     @tsipid=TSIPID
   end
@@ -25,4 +25,15 @@ class TestFiconabses < Test::Unit::TestCase
        assert res.include? '200'
       
      end
+     
+      def test_apn_template_params
+                 options={}
+                 options['hello']='TESTING'
+                 f=FiconabSES::Base.new
+                 f.set_credentials(@account,@passwd)
+                 res =f.send_template_params(@tsipid,'apn_template',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
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Scott Sproule
@@ -30,6 +30,7 @@ files:
 - lib/ficonabses/base.rb
 - lib/ficonabses.rb
 - test/test_ficonabses.rb
+- test/test_hashparams.rb
 - test/test_helper.rb
 - test/test_localhost.rb
 - test/test_secret.rb