sailthru-client 2.0.0 → 3.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODBmMmIwZjBhOTdlZTdmZjEzMDFjZmEzYWVmYzM1MTZiZmI2N2FhOA==
+  data.tar.gz: !binary |-
+    ZjhhMTg5ZDBmNTlhODU1ZmJiZGZlYmExOGM0YWViNDk3ZjBjZDEzNg==
+SHA512:
+  metadata.gz: !binary |-
+    MWFkZmE3MzMyNWFlNzk1NTc0ZGViNmNlYzI1YjVkZjdjNTAwYzc0MzRlNmJi
+    ZDljM2MxMzQyYjRjOWIzMDQxYjkwZTU4NjdjYWRjZmM0ODVlNjA3OWE5OGRh
+    NGUxNDI2NzY0MDBhOWIzMGE4Mjg1OWJmYWI3YjVhNjFkN2ZkZjc=
+  data.tar.gz: !binary |-
+    NjY4NGRhMDNjMGIwYWE0NmU4MzgwM2QyYzFhNDUwMmIzNDNlZDc3MjNmYWNm
+    ZjQ2YjNjNTEzYzZiZjQ5MTg1YzExN2ZjMGM1YjU1OWYxNDAyMjYyYzA2MTk5
+    ZjYwOTA2YzUwYjQwMGQyNjhjZDhlMTYyZWUyNjBlZDI0NTg5YzU=

data/.gitignore

@@ -0,0 +1,6 @@
+.*.sw[a-z]
+*.un~
+.rvmrc
+*.gem
+.loadpath
+rdoc

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+## 2.0.0 (Sep 6, 2013)
+  - Added triggers and events
+  - Changed push_content to handle additional parameters
+  - Added verification for postbacks
+  - Removed Horizon calls
+  - Remvoed create_new_user method
+  - Added change_email method
+  - Added stats_send method
+
+## 1.14 (Feb 10, 2012)
+  - Remove contact API call
+  - Update list API call: save_list() cannot be used for saving emails
+  - Added get_lists() for retrieving all available lists information
+
+## 1.13 (September 8, 2011)
+  - Explicitly convert Exception to string for Ruby 1.9 (Robert Coker)
+  - Update purchase() call
+
+
+## 1.12 (July 22, 2011)
+  - Fix send / multisend api call bug
+
+## 1.11 (June 15, 2011)
+  - Job API docs
+  - SSL verification disabled
+  - Typed variable values can be passed now
+
+## 1.10 (May 14, 2011)
+ - Support for Job API call
+ - Support for typed parameters
+ - By default, make request to https://api.sailthru.com so, default constructor call would be Sailthru::SailthruClient.new("api-key", "api_secret")

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'multipart-post'
+
+group :test do
+  gem 'json'
+  gem 'fakeweb'
+  gem 'minitest'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    json (1.8.1)
+    metaclass (0.0.4)
+    minitest (5.3.4)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multipart-post (2.0.0)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  json
+  minitest
+  mocha
+  multipart-post
+  rake

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sailthru, Inc., http://www.sailthru.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,13 +1,20 @@
-sailthru-ruby-client
-====================
+# 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/api](http://getstarted.sailthru.com/developers/api)
 
-By default, it will make request in `JSON` format.
+By default, it will make requests in `JSON` format.
+
+## Installation
 
-### Installing from rubygems.org (Tested with Ruby 1.8.7)
     $ gem install sailthru-client
 
+## Requirements
+
+This gem supports Ruby 1.9.3 and up.
+
+## License
+
+Please see MIT-LICENSE for license.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rdoc/task'
+
+CLOBBER.include 'pkg'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs = %w(lib test)
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end

data/lib/sailthru.rb

@@ -9,11 +9,14 @@ require 'net/http/post/multipart'
 
 module Sailthru
 
-  Version = VERSION = '2.0.0'
+  Version = VERSION = '3.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:
@@ -138,13 +142,14 @@ module Sailthru
     #     test: send as test email (subject line will be marked, will not count towards stats)
     # returns:
     #   Hash, response data from server
-    def send_email(template_name, email, vars={}, options = {}, schedule_time = nil)
+    def send_email(template_name, email, vars={}, options = {}, schedule_time = nil, limit = {})
       post = {}
       post[:template] = template_name
       post[:email] = email
       post[:vars] = vars if vars.length >= 1
       post[:options] = options if options.length >= 1
       post[:schedule_time] = schedule_time if !schedule_time.nil?
+      post[:limit] = limit if limit.length >= 1
       return self.api_post(:send, post)
     end
 
@@ -321,7 +326,7 @@ module Sailthru
       data[:templates] = templates unless templates.empty?
       self.api_post(:email, data)
     end
-    
+
     # params:
     #   new_email, String
     #   old_email, String
@@ -336,7 +341,7 @@ module Sailthru
       data[:change_email] = old_email
       self.api_post(:email, data)
     end
-    
+
     # params:
     #   template_name, String
     # returns:
@@ -384,6 +389,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])
@@ -409,13 +415,14 @@ module Sailthru
         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
@@ -428,6 +435,7 @@ module Sailthru
         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
@@ -575,16 +583,16 @@ 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, {})
+      return api_get(:list, {})
     end
 
     # params
@@ -594,7 +602,7 @@ module Sailthru
     def save_list(list, options = {})
       data = options
       data[:list] = list
-     return api_post(:list, data)
+      return api_post(:list, data)
     end
 
     # params
@@ -669,42 +677,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
@@ -716,94 +724,94 @@ module Sailthru
 
     # Get user by Sailthru ID
     def get_user_by_sid(id, fields = {})
-        api_get(:user, {'id' => id, 'fields' => fields})
+      api_get(:user, {'id' => id, 'fields' => fields})
     end
 
     # Get user by specified key
     def get_user_by_key(id, key, fields = {})
-        data = {
-            'id' => id,
-            'key' => key,
-            'fields' => fields
-        }
-        api_get(:user, data)
+      data = {
+          'id' => id,
+          'key' => key,
+          'fields' => fields
+      }
+      api_get(:user, data)
     end
 
     # Create new user, or update existing user
     def save_user(id, options = {})
-        data = options
-        data['id'] = id
-        api_post(:user, data)
+      data = options
+      data['id'] = id
+      api_post(:user, data)
     end
 
-  # params
-  # Get an existing trigger
+    # params
+    # Get an existing trigger
     def get_triggers()
-        api_get(:trigger, {})
+      api_get(:trigger, {})
     end
 
-  # params
-  #   template, String
-  #   trigger_id, String
-  # Get an existing trigger
+    # params
+    #   template, String
+    #   trigger_id, String
+    # Get an existing trigger
     def get_trigger_by_template(template, trigger_id = nil)
-        data = {}
-        data['template'] = template
-        if trigger_id != nil then data['trigger_id'] = trigger_id end
-        api_get(:trigger, data)
+      data = {}
+      data['template'] = template
+      if trigger_id != nil then data['trigger_id'] = trigger_id end
+      api_get(:trigger, data)
     end
 
-  # params
-  #   event, String
-  # Get an existing trigger
+    # params
+    #   event, String
+    # Get an existing trigger
     def get_trigger_by_event(event)
-        data = {}
-        data['event'] = event
-        api_get(:trigger, data)
-    end
-
-  # params
-  #   template, String
-  #   time, String
-  #   time_unit, String
-  #   event, String
-  #   zephyr, String
-  # Create or update a trigger
+      data = {}
+      data['event'] = event
+      api_get(:trigger, data)
+    end
+
+    # params
+    #   template, String
+    #   time, String
+    #   time_unit, String
+    #   event, String
+    #   zephyr, String
+    # Create or update a trigger
     def post_template_trigger(template, time, time_unit, event, zephyr)
-        data = {}
-        data['template'] = template
-        data['time'] = time
-        data['time_unit'] = time_unit
-        data['event'] = event
-        data['zephyr'] = zephyr
-        api_post(:trigger, data)
-    end
-
-  # params
-  #   template, String
-  #   time, String
-  #   time_unit, String
-  #   zephyr, String
-  # Create or update a trigger
+      data = {}
+      data['template'] = template
+      data['time'] = time
+      data['time_unit'] = time_unit
+      data['event'] = event
+      data['zephyr'] = zephyr
+      api_post(:trigger, data)
+    end
+
+    # params
+    #   template, String
+    #   time, String
+    #   time_unit, String
+    #   zephyr, String
+    # Create or update a trigger
     def post_event_trigger(event, time, time_unit, zephyr)
-        data = {}
-        data['time'] = time
-        data['time_unit'] = time_unit
-        data['event'] = event
-        data['zephyr'] = zephyr
-        api_post(:trigger, data)
-    end
-
-  # params
-  #   id, String
-  #   event, String
-  #   options, Hash (Can contain vars, Hash and/or key)
-  # Notify Sailthru of an Event
+      data = {}
+      data['time'] = time
+      data['time_unit'] = time_unit
+      data['event'] = event
+      data['zephyr'] = zephyr
+      api_post(:trigger, data)
+    end
+
+    # params
+    #   id, String
+    #   event, String
+    #   options, Hash (Can contain vars, Hash and/or key)
+    # Notify Sailthru of an Event
     def post_event(id, event, options = {})
-        data = options
-        data['id'] = id
-        data['event'] = event
-        api_post(:event, data)
+      data = options
+      data['id'] = id
+      data['event'] = event
+      api_post(:event, data)
     end
 
     # Perform API GET request
@@ -870,7 +878,7 @@ module Sailthru
 
         if binary_data.is_a?(StringIO)
           data[binary_key] = UploadIO.new(
-            binary_data, "text/plain"
+            binary_data, "text/plain", "local.path"
           )
         else
           data[binary_key] = UploadIO.new(
@@ -924,12 +932,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
@@ -942,18 +956,18 @@ module Sailthru
     end
 
     def http_multipart_request(uri, data)
-      req = Net::HTTP::Post::Multipart.new url.path,
+      Net::HTTP::Post::Multipart.new url.path,
         "file" => UploadIO.new(data['file'], "application/octet-stream")
     end
 
     def prepare_json_payload(data)
-        payload = {
-            :api_key => @api_key,
-            :format => 'json', #<3 XML
-            :json => data.to_json
-        }
-        payload[:sig] = get_signature_hash(payload, @secret)
-        payload
+      payload = {
+          :api_key => @api_key,
+          :format => 'json', #<3 XML
+          :json => data.to_json
+      }
+      payload[:sig] = get_signature_hash(payload, @secret)
+      payload
     end
   end
 end