danest-sailthru-client 1.16 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 837599b172f021e53746c666ee63ba91b3356caa
-  data.tar.gz: 79ca81519104cb8c4eb6b8c1087c3647a657dbf4
+  metadata.gz: 22e99cd96c83b06498bd6bdb4e872178927fb480
+  data.tar.gz: f96e18491e65d1f290b24705e129599f0ce6b6c5
 SHA512:
-  metadata.gz: 7e30c5cbc539336514f506e02451c5af3fd15563b1183df4192fd8e75ed326b5a66fb74d2879996b1ea8b89c50a1c45798cca1132991aa0b083472cf4bf8bb86
-  data.tar.gz: ed06a75b6eabd368501eaf9c7becb34d4d37772e0ed12afa0c9f0d064006b04777bb678107d573b895c475011dbd06fe868033144e7166be1f2a3b2559f4f26f
+  metadata.gz: db9bddf036e7faf8ae917a812ca24d57689723825bf7572c9ba7d1322c4d4e2a5cd02e828b4060bbe8a35e8c882591237e165d23057a4d9cb8fe7e49bca7be99
+  data.tar.gz: f00b3c0aad2636a4be59d5d3f20e287f4191507a6e6d297f5cbe65d466594fc505fa71d92a449f2dcc33eba35b3bbd0820d3ccd544d65a9f2e6b46570af02481

data/README.md

@@ -6,7 +6,7 @@ sailthru-ruby-client
 For installation instructions, documentation, and examples please visit:
 [http://getstarted.sailthru.com/developers/api-libraries/ruby](http://getstarted.sailthru.com/developers/api-libraries/ruby)
 
-A simple client library to remotely access the `Sailthru REST API` as per [http://getstarted.sailthru.com/developers/api](http://getstarted.sailthru.com/developers/api)
+A simple client library to remotely access the `Sailthru REST API` as per [http://getstarted.sailthru.com/api](http://getstarted.sailthru.com/developers/api)
 
 By default, it will make request in `JSON` format.
 

data/lib/sailthru.rb

@@ -9,11 +9,14 @@ require 'net/http/post/multipart'
 
 module Sailthru
 
-  Version = VERSION = '1.15'
+  Version = VERSION = '2.0.0'
 
   class SailthruClientException < Exception
   end
 
+  class SailthruUnavailableException < Exception
+  end
+
   module Helpers
     # params:
     #   params, Hash
@@ -102,13 +105,14 @@ module Sailthru
     #   api_uri, String
     #
     # Instantiate a new client; constructor optionally takes overrides for key/secret/uri and proxy server settings.
-    def initialize(api_key, secret, api_uri=nil, proxy_host=nil, proxy_port=nil)
+    def initialize(api_key, secret, api_uri=nil, proxy_host=nil, proxy_port=nil, opts={})
       @api_key = api_key
       @secret  = secret
       @api_uri = if api_uri.nil? then 'https://api.sailthru.com' else api_uri end
       @proxy_host = proxy_host
       @proxy_port = proxy_port
       @verify_ssl = true
+      @opts = opts
     end
 
     # params:
@@ -126,7 +130,7 @@ module Sailthru
     # http://docs.sailthru.com/api/send
     def send(template_name, email, vars={}, options = {}, schedule_time = nil)
       warn "[DEPRECATION] `send` is deprecated. Please use `send_email` instead."
-      send_email(template_name, email, vars={}, options = {}, schedule_time = nil)
+      send_email(template_name, email, vars, options, schedule_time)
     end
 
     # params:
@@ -321,7 +325,7 @@ module Sailthru
       data[:templates] = templates unless templates.empty?
       self.api_post(:email, data)
     end
-    
+
     # params:
     #   new_email, String
     #   old_email, String
@@ -336,7 +340,7 @@ module Sailthru
       data[:change_email] = old_email
       self.api_post(:email, data)
     end
-    
+
     # params:
     #   template_name, String
     # returns:
@@ -384,6 +388,7 @@ module Sailthru
         return false unless params[:action] == :verify
 
         sig = params.delete(:sig)
+        sig = sig.delete_if {|key, value| key == :controller}
         return false unless sig == get_signature_hash(params, @secret)
 
         _send = self.get_send(params[:send_id])
@@ -406,16 +411,17 @@ module Sailthru
       if request.post?
         [:action, :email, :sig].each { |key| return false unless params.has_key?(key) }
 
-        return false unless params[:action] == :optout
+        return false unless params[:action] == 'optout'
 
         sig = params.delete(:sig)
+        sig = sig.delete_if {|key, value| key == :controller}
         return false unless sig == get_signature_hash(params, @secret)
         return true
       else
         return false
       end
     end
-    
+
     # params:
     #   params, Hash
     #   request, String
@@ -425,9 +431,10 @@ module Sailthru
       if request.post?
         [:action, :email, :sig].each { |key| return false unless params.has_key?(key) }
 
-        return false unless params[:action] == :hardbounce
+        return false unless params[:action] == 'hardbounce'
 
         sig = params.delete(:sig)
+        sig = sig.delete_if {|key, value| key == :controller}
         return false unless sig == get_signature_hash(params, @secret)
         return true
       else
@@ -586,14 +593,14 @@ module Sailthru
     # params
     #   list, String
     #
-    # Get information about a list. 
+    # Get information about a list.
     def get_list(list)
       return api_get(:list, {:list => list})
     end
 
     # params
     #
-    # Get information about all lists 
+    # Get information about all lists
     def get_lists()
         return api_get(:list, {})
     end
@@ -680,42 +687,42 @@ module Sailthru
       end
       api_post(:job, data, binary_key)
     end
-    
+
     # params
     #   emails, String | Array
-    # implementation for import_job  
-    def process_import_job(list, emails, report_email = nil, postback_url = nil)
-      data = {}
+    # implementation for import_job
+    def process_import_job(list, emails, report_email = nil, postback_url = nil, options = {})
+      data = options
       data['list'] = list
       data['emails'] = Array(emails).join(',')
       process_job(:import, data, report_email, postback_url)
     end
 
     # implementation for import job using file upload
-    def process_import_job_from_file(list, file_path, report_email = nil, postback_url = nil)
-      data = {}
+    def process_import_job_from_file(list, file_path, report_email = nil, postback_url = nil, options = {})
+      data = options
       data['list'] = list
       data['file'] = file_path
       process_job(:import, data, report_email, postback_url, 'file')
     end
 
     # implementation for update job using file upload
-    def process_update_job_from_file(file_path, report_email = nil, postback_url = nil)
-      data = {}
+    def process_update_job_from_file(file_path, report_email = nil, postback_url = nil, options = {})
+      data = options
       data['file'] = file_path
       process_job(:update, data, report_email, postback_url, 'file')
     end
 
     # implementation for snapshot job
-    def process_snapshot_job(query = {}, report_email = nil, postback_url = nil)
-      data = {}
+    def process_snapshot_job(query = {}, report_email = nil, postback_url = nil, options = {})
+      data = options
       data['query'] = query
       process_job(:snapshot, data, report_email, postback_url)
     end
 
     # implementation for export list job
-    def process_export_list_job(list, report_email = nil, postback_url = nil)
-      data = {}
+    def process_export_list_job(list, report_email = nil, postback_url = nil, options = {})
+      data = options
       data['list'] = list
       process_job(:export_list_data, data, report_email, postback_url)
     end
@@ -935,12 +942,18 @@ module Sailthru
         if _uri.scheme == 'https'
             http.use_ssl = true
             http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @verify_ssl != true  # some openSSL client doesn't work without doing this
+            http.ssl_timeout = @opts[:http_ssl_timeout] || 5
         end
+        http.open_timeout = @opts[:http_open_timeout] || 5
+        http.read_timeout = @opts[:http_read_timeout] || 10
+        http.close_on_empty_response = @opts[:http_close_on_empty_response] || true
 
         response = http.start {
             http.request(req)
         }
 
+      rescue Timeout::Error, Errno::ETIMEDOUT => e
+        raise SailthruUnavailableException.new(["Timed out: #{_uri}", e.inspect, e.backtrace].join("\n"));
       rescue Exception => e
         raise SailthruClientException.new(["Unable to open stream: #{_uri}", e.inspect, e.backtrace].join("\n"));
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danest-sailthru-client
 version: !ruby/object:Gem::Version
-  version: '1.16'
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Urrutia
@@ -110,9 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.3
 signing_key: 
 specification_version: 3
 summary: A simple client library to remotely access the Sailthru REST API. Updated
   with latest git master.
 test_files: []
+has_rdoc: