ficonabses 0.1.4 → 0.1.5

data/README.rdoc

@@ -2,29 +2,44 @@
 
 * http://github.com/semdinsp/ficonabses
 
+== WARNING NOT PRODUCTION READY:
 == DESCRIPTION:
 
-A simple way to send emails from your application using amazon ses.  Register at admin.ses.sg.estormtech.com to create your account.
+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.
 
 == 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 http://admin.ses.sg.estormtech.com
+* 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]
+
+* 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.
 
 == SYNOPSIS HTML EMAIL:
 
-*    res =FiconabSES::Base.send_htmlemail('acccount','password','scott.sproule@estormtech.com','This is the subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
-*    for multiple sends use set_credentials(account,password), then send_html
-*	eg:  f=FiconabSES::Base.new
-*	     f.set_credentials(account,passwd)
-*	     f.send_htmlemail('scott.sproule@estormtech.com','This is the subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
+*   res =FiconabSES::Base.send_htmlemail('acccount','password','destination@xxxxx.com','This is the subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
+*   for multiple sends use set_credentials(account,password), then send_html
+*   or similarly functionality eg:  
+      f=FiconabSES::Base.new
+      f.set_credentials(account,passwd)
+      f.send_htmlemail(@destination,'This is the subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
 
 == SYNOPSIS TEXT EMAIL:
 
-*    res =FiconabSES::Base.send_textemail_direct('acccount','password','scott.sproule@estormtech.com','This is the subject','contents of the email')
-or similarly
-*	eg:  f=FiconabSES::Base.new
-*	     f.set_credentials(account,passwd)
-*	     f.send_textemail('scott.sproule@estormtech.com','This is the subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
+*   res =FiconabSES::Base.send_textemail_direct('acccount','password',@destination,'This is the subject','contents of the email') 
+*  or similarly functionality eg:  
+      f=FiconabSES::Base.new
+      f.set_credentials(account,passwd)
+      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
+
+*    res =FiconabSES::Base.send_template_direct(@account,@passwd,@destination,templatename)
+*   or similarly using objects
+      f=FiconabSES::Base.new
+      f.set_credentials(@account,@passwd)
+      res =f.send_template(@destination,'testtemplate')
+
+== SYNOPSIS USING A TEMPLATE PLUS PARAMETERS
 
 == REQUIREMENTS:
 
@@ -35,7 +50,10 @@ or similarly
 * sudo gem install ficonabses httpclient
 
 == DEPENDENCY:   
-	dependency on httpclient.
+*   dependency on httpclient.
+
+== TESTS
+*   See the tests files attached to the gem or on this website
 
 == LICENSE:
 

data/lib/ficonabses/base.rb

@@ -31,6 +31,11 @@ module FiconabSES
         f.set_credentials(account,password)
         f.send_htmlemail(destination,subject,htmlcontents,textcontents)
    end
+   def self.send_template_direct(account,password,destination,templatename)
+         f=FiconabSES::Base.new
+         f.set_credentials(account,password)
+         f.send_template(destination,templatename)
+    end
   def perform(url)
      @uri=URI.parse(url)
      raise 'credentials not set' if @account==nil
@@ -51,8 +56,16 @@ module FiconabSES
          res
     
   end
+  def action_url(action,destination)
+    url="http://#{@@host}/#{action}?destination=#{URI.encode(destination)}"
+    url
+  end
   def text_url(destination,subject,contents)
-    url="http://#{@@host}/ficonabsendemail?destination=#{URI.encode(destination)}&text=#{URI.encode(contents)}&subject=#{URI.encode(subject)}" 
+    url="#{self.action_url('ficonabsendemail',destination)}&subject=#{URI.encode(subject)}&text=#{URI.encode(contents)}" 
+    url
+  end
+  def template_url(destination,templatename)
+    url="#{self.action_url('ficonabsimpletemplate',destination)}&template=#{URI.encode(templatename)}" 
     url
   end
   def html_url(destination,subject,contents,html)
@@ -61,16 +74,21 @@ module FiconabSES
   end
   def send_textemail(destination,subject,contents)
     url=self.text_url(destination,subject,contents)
-    puts "url is: #{url}"
-   
-     perform(url)
+    #puts "url is: #{url}"
+    perform(url)
      #  res
   end
+  def send_template(destination,templatename)
+     url=self.template_url(destination,templatename)
+     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)
-     puts "url is: #{url}"
-    
-      perform(url)
+     #puts "url is: #{url}" 
+     perform(url)
       #  res
    end
 

data/test/test_ficonabses.rb

@@ -4,40 +4,53 @@ require File.dirname(__FILE__) + '/test_secret.rb'  #FILL IN ACCOUNT/PASSWD AS G
 class TestFiconabses < Test::Unit::TestCase
 
   def setup
-    @account=ACCOUNT   #in test_secret.rb put ACCOUNT='youraccount'
+    @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'
+    
+  end
+  def test_creds
     puts "CREDENTIALS ARE: account: #{@account} passwd: #{@passwd}"
+   # self assert true
   end
-  
   def test_send_text_direct
-    res =FiconabSES::Base.send_textemail_direct(@account,@passwd,'scott.sproule@gmail.com','This is the subject','contents of the email')
-    puts "RES is: #{res}"
+    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
-    res =FiconabSES::Base.send_htmlemail_direct(@account,@passwd,'scott.sproule@gmail.com','This is the HTML subject','<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
-    puts "RES is: #{res}"
+    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')
+    #puts "RES is: #{res}"
     assert res.include? '200'
+    assert false==(res.include? 'Error')
+  end
   end
   def test_send_html_nil_text
-     res =FiconabSES::Base.send_htmlemail_direct(@account,@passwd,'scott.sproule@gmail.com','This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
+     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
      puts "RES is: #{res}"
      assert res.include? '200'
+     assert false==(res.include? 'Error')
+   end
    end
    def test_send_emails
         f=FiconabSES::Base.new
         f.set_credentials(@account,@passwd)
-       res =f.send_htmlemail('scott.sproule@gmail.com','This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
-       puts "RES is: #{res}"
+       res =f.send_htmlemail(@destination,'This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
+       #puts "RES is: #{res}"
        assert res.include? '200'
-       res =f.send_textemail('scott.sproule@gmail.com','This is TEXT Subject nil text','contents')  #no text portion
-        puts "RES is: #{res}"
+       res =f.send_textemail(@destination,'This is TEXT Subject nil text','contents')  #no text portion
+       # puts "RES is: #{res}"
         assert res.include? '200'
+        assert false==(res.include? 'Error')
+      end
      end
       def test_no_credentials
            f=FiconabSES::Base.new
            assert_raise RuntimeError do   #should raise runtime error
-              res =f.send_htmlemail('scott.sproule@gmail.com','This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
+              res =f.send_htmlemail(@destination,'This is HTML Subject nil text','<h1>HTML Contents</h1><p>hi from paragraph</p>')  #no text portion
             end
        end    
 end

data/test/test_localhost.rb

@@ -6,18 +6,38 @@ class TestFiconabses < Test::Unit::TestCase
     @f=FiconabSES::Base.new
     @f.set_credentials('scott','scott123')
     @f.set_debug
+    @destination='scott.sproule@gmail.com'
+    @tsipid ='7923044488'
   end
   
   def test_local_send_text
-    res= @f.send_textemail('scott.sproule@gmail.com',"'LOCALHOST': #{@f.host}",'contents of the email')
+    res= @f.send_textemail(@destination,"'LOCALHOST': #{@f.host}",'contents of the email')
     puts "RES is: #{res}"
     assert res.include? '200'
+    assert false==(res.include? 'Error')
   end
   
   def test_local_send_html
-    res =@f.send_htmlemail('scott.sproule@gmail.com',"'HTML:LOCALHOST': #{@f.host}",'<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
+    res =@f.send_htmlemail(@destination,"'HTML:LOCALHOST': #{@f.host}",'<h1>HTML Contents</h1><p>hi from paragraph</p>','text contents of the email')
     puts "RES is: #{res}"
     assert res.include? '200'
+     assert false==(res.include? 'Error')
   end
+  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
+     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     
 
 end

data/test/test_secret.rb

@@ -1,2 +1,4 @@
 ACCOUNT='scott'
-PASSWD='scott123'
+PASSWD='scott123'
+DESTINATION='scott.sproule@gmail.com'
+TSIPID =   '7923044488'

data/test/test_templates.rb

@@ -0,0 +1,28 @@
+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'
+    puts "CREDENTIALS ARE: account: #{@account} passwd: #{@passwd}"
+    @destination=DESTINATION
+    @tsipid=TSIPID
+  end
+  
+  def test_send_template_direct
+    res =FiconabSES::Base.send_template_direct(@account,@passwd,@destination,'testtemplate')
+    puts "RES is: #{res}"
+    assert res.include? '200'
+  end
+  
+   def test_send_template
+        f=FiconabSES::Base.new
+        f.set_credentials(@account,@passwd)
+       res =f.send_template(@destination,'testtemplate')  #no text portion
+       puts "RES is: #{res}"
+       assert res.include? '200'
+      
+     end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Scott Sproule
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-15 00:00:00 +08:00
+date: 2011-11-18 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - test/test_helper.rb
 - test/test_localhost.rb
 - test/test_secret.rb
+- test/test_templates.rb
 - History.txt
 - Manifest.txt
 - PostInstall.txt