sailthru-client 1.14 → 1.15

data/README.md

@@ -8,6 +8,7 @@ By default, it will make request in `JSON` format.
 It can make requests to following [API calls](http://docs.sailthru.com/api):
 
 * [email](http://docs.sailthru.com/api/email)
+* [user](http://docs.sailthru.com/api/user)
 * [send](http://docs.sailthru.com/api/send)
 * [blast](http://docs.sailthru.com/api/blast)
 * [template](http://docs.sailthru.com/api/template)
@@ -32,6 +33,40 @@ api_key = "api_key";
 api_secret = 'secret';
 api_url = "https://api.sailthru.com";
 sailthru = Sailthru::SailthruClient.new(api_key, api_secret, api_url)
+
+# GET http://docs.sailthru.com/api/user API call
+user_key = 'email'
+email = 'praj@sailthru.com'
+fields = {'vars' => 1, 'lists' => 1}
+data = {
+    'id' => email,
+    'key' => user_key,
+    'fields' => fields
+}
+response = sailthru.api_get('user', data)
+
+# POST http://docs.sailthru.com/api/user API call
+user_sid = '4e2879472d7acd6d97144f9e' #sailthru ID
+lists = {
+    "list-A" => 1,
+    "list-B" => 1,
+    "list-C" => 0 #optout of this list
+}
+vars = {
+    'name' => 'Prajwal Tuladhar',
+    'address' => {
+        'city': 'New York',
+        'state': 'NY',
+        'zipcode': 10011
+    }
+}
+data = {
+    'id' => user_sid,
+    'lists' => lists,
+    'vars' => vars
+}
+response = sailthru.api_post('user', data)
+
 ```
 
 ### [send](http://docs.sailthru.com/api/send)
@@ -60,6 +95,54 @@ options = {'test' => 1}
 response = sailthru.multi_send(template_name, emails, vars, options)
 ```
 
+### [user](http://docs.sailthru.com/api/user)
+```ruby
+#create new user profile
+options = {
+    'vars' => {
+        'name' => 'Prajwal Tuladhar',
+        'address' => 'New York, NY'
+    }
+}
+response = sailthru.create_new_user(options)
+
+#update existing user by Sailthru ID
+options = {
+    'keys' => {
+        'email' => 'praj@sailthru.com',
+        'twitter' => 'infynyxx',
+        'fb' => 726310296
+    },
+    'lists' => {
+        'list-1' => 1,
+        'list-2' => 1,
+    }
+}
+response = sailthru.save_user('4e2879472d7acd6d97144f9e', options)
+
+#update existing user by email
+options = {
+    'key' => 'email',
+    'lists' => {
+        'list-1' => 0
+    }
+}
+response = sailthru.save_user('praj@sailthru.com', options)
+
+#get user by Sailthru ID
+fields = {
+    'keys' => 1,
+    'vars' => 1,
+    'activity' => 1
+}
+response = sailthru.get_user_by_sid('4e2879472d7acd6d97144f9e')
+
+#get user by Custom key
+response = sailthru.get_user_by_key('praj@sailthru.com', 'email', fields)
+
+```
+
+
 ### [email](http://docs.sailthru.com/api/email)
 ``` ruby
 #get email

data/lib/sailthru.rb

@@ -9,7 +9,7 @@ require 'net/http/post/multipart'
 
 module Sailthru
 
-  Version = VERSION = '1.14'
+  Version = VERSION = '1.15'
 
   class SailthruClientException < Exception
   end
@@ -529,8 +529,7 @@ module Sailthru
     # sets horizon data
     def set_horizon(email, tags)
       data = {}
-      data[
-      :email] = email
+      data[:email] = email
       data[:tags] = (tags.class == Array) ? tags.join(',') : tags
       api_post(:horizon, data)
     end
@@ -609,7 +608,7 @@ module Sailthru
       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 = {}
@@ -618,6 +617,13 @@ module Sailthru
       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 = {}
+      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 = {}
@@ -637,6 +643,33 @@ module Sailthru
       api_get(:job, {'job_id' => job_id})
     end
 
+    # Get user by Sailthru ID
+    def get_user_by_sid(id, 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)
+    end
+
+    # Creates new user
+    def create_new_user(options = {})
+        options.delete('id')
+        api_post(:user, options)
+    end
+
+    # Save existing user
+    def save_user(id, options = {})
+        data = options
+        data['id'] = id
+        api_post(:user, data)
+    end
 
     # Perform API GET request
     def api_get(action, data)
@@ -764,7 +797,7 @@ module Sailthru
     def prepare_json_payload(data)
         payload = {
             :api_key => @api_key,
-            :format => 'json', #fuck XML
+            :format => 'json', #<3 XML
             :json => data.to_json
         }
         payload[:sig] = get_signature_hash(payload, @secret)

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 14
-  version: "1.14"
+  - 15
+  version: "1.15"
 platform: ruby
 authors: 
 - Prajwal Tuladhar
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-10 00:00:00 -05:00
+date: 2012-05-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency