sailthru-client 2.0.0 → 3.0.0

data/sailthru-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sailthru', __FILE__)
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = "sailthru-client"
+  s.version = Sailthru::VERSION
+
+  s.authors = ["Prajwal Tuladhar", "Dennis Yu"]
+  s.date = Date.today.to_s
+  s.email = "praj@sailthru.com"
+  s.extra_rdoc_files = ["README.md"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.homepage = "http://docs.sailthru.com"
+  s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.summary = "A simple client library to remotely access the Sailthru REST API."
+  s.license = "MIT"
+
+  s.add_dependency(%q<json>, [">= 0"])
+  s.add_dependency(%q<multipart-post>, [">= 0"])
+  s.add_development_dependency(%q<fakeweb>, [">= 0"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+end

data/test/fixtures/blast_delete_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown blast_id: 42499","error":13}

data/test/fixtures/blast_delete_valid.json

@@ -0,0 +1 @@
+{"ok":true,"blast_id":42499}

data/test/fixtures/blast_get_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown blast_id: 42182","error":13}

data/test/fixtures/blast_get_valid.json

@@ -0,0 +1 @@
+{"name":"Default Blast","list":null,"from_name":null,"is_google_analytics":true,"subject":null,"report_email":null,"content_html":"","blast_id":665215,"replyto":null,"status":"created","is_link_tracking":true,"from_email":"dynamism360@gmail.com","content_text":""}

data/test/fixtures/blast_post_invalid_email.json

@@ -0,0 +1 @@
+{"errormsg":"Invalid email: praj","error":11}

data/test/fixtures/blast_post_invalid_list.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown blast_id: 42182","error":13}

data/test/fixtures/blast_post_update_valid.json

@@ -0,0 +1 @@
+{"name":"blast name changed","list":"default-list","from_name":"prajwal tuladhar","is_google_analytics":false,"subject":"Hello World!","report_email":null,"content_html":"aaaa\n<p><small>If you believe this has been sent to you in error, please safely <a href=\"{optout_confirm_url}\">unsubscribe</a>.</small></p>","blast_id":42499,"replyto":null,"status":"scheduled","is_link_tracking":false,"from_email":"praj@sailthru.com","schedule_time":"Tue, 25 Jan 2011 08:12:29 -0500","content_text":"aa\n\nIf you believe this has been sent to you in error, please click <{optout_confirm_url}> to safely unsubscribe."}

data/test/fixtures/blast_post_valid.json

@@ -0,0 +1 @@
+{"name":"Default Blast 222","list":"default-list","from_name":"Daily Newsletter","is_google_analytics":false,"subject":"Hello World!","report_email":null,"content_html":"aaaa\n<p><small>If you believe this has been sent to you in error, please safely <a href=\"{optout_confirm_url}\">unsubscribe</a>.</small></p>","blast_id":42499,"replyto":null,"status":"scheduled","is_link_tracking":false,"from_email":"praj@sailthru.com","schedule_time":"Tue, 25 Jan 2011 08:12:29 -0500","content_text":"aa\n\nIf you believe this has been sent to you in error, please click <{optout_confirm_url}> to safely unsubscribe."}

data/test/fixtures/content_valid.json

@@ -0,0 +1 @@
+{"content":[{"title":"unix is awesome","vars":{"price":55,"description":"Hello World"},"url":"http://example.com/hello-world","tags":["unix","linux"],"date":"Wed, 02 Feb 2011 01:55:43 -0500","client_id":1}]}

data/test/fixtures/email_get_listed_email.json

@@ -0,0 +1 @@
+{"lists":{"default":1},"vars":[],"optout":"none","verified":0,"hardbounce":0,"email":"praj@sailthru.com"}

data/test/fixtures/email_get_not_listed_email.json

@@ -0,0 +1 @@
+{"vars":[],"optout":"none","verified":0,"hardbounce":0,"email":"apraj@sailthru.com"}

data/test/fixtures/list_delete_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown list: invalid-list","error":15}

data/test/fixtures/list_delete_valid.json

@@ -0,0 +1 @@
+{"list":"my-list","ok":true}

data/test/fixtures/list_get_all.json

@@ -0,0 +1,14 @@
+{
+    "lists": [
+        {
+            "name": "list1",
+            "email_count": 837080,
+            "create_time": "Wed, 10 Aug 2011 14:19:44 -0400"
+        },
+        {
+            "name": "list2",
+            "email_count": 5,
+            "create_time": "Thu, 17 Mar 2011 11:17:10 -0400"
+        }
+    ]
+}

data/test/fixtures/list_get_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown list: invalid-list","error":15}

data/test/fixtures/list_get_invalid.txt

@@ -0,0 +1,4 @@
+
+
+
+

data/test/fixtures/list_get_valid.json

@@ -0,0 +1,8 @@
+{
+"list": "list1",
+"create_time": "Wed, 10 Aug 2011 14:19:44 -0400",
+"send_time": "Tue, 27 Sep 2011 12:00:05 -0400",
+"count": 837080,
+"type": "normal",
+"primary": true
+}

data/test/fixtures/list_get_valid.txt

@@ -0,0 +1,3 @@
+ian@sailthru.com	unknown	Wed, 02 Feb 2011 18:20:55 -0500
+dynamism360@gmail.com	unknown	Wed, 02 Feb 2011 18:20:55 -0500
+praj@sailthru.com	unknown	Wed, 02 Feb 2011 18:19:11 -0500

data/test/fixtures/list_save_valid.json

@@ -0,0 +1,8 @@
+{
+"list": "new-list2",
+"create_time": "Fri, 10 Feb 2012 12:40:32 -0500",
+"send_time": null,
+"count": null,
+"type": "normal",
+"primary": true
+}

data/test/fixtures/purchase_post_invalid_email.json

@@ -0,0 +1 @@
+{"errormsg":"Invalid email: prajsailthru.com","error":11}

data/test/fixtures/purchase_post_invalid_empty_items.json

@@ -0,0 +1 @@
+{"errormsg":"No items in purchase","error":99}

data/test/fixtures/purchase_post_valid_multiple_items.json

@@ -0,0 +1 @@
+{"purchase":{"qty":24,"price":25178,"items":[{"price":1099,"qty":22,"title":"High-Impact Water Bottle","url":"http://example.com/234/high-impact-water-bottle","id":"234"},{"price":500,"qty":2,"title":"Lorem Ispum","url":"http://example.com/2304/lorem-ispum","id":"2304"}],"time":"Tue, 25 Jan 2011 12:04:07 -0500","_id":"4d3f02876763d9c10f000900"}}

data/test/fixtures/purchase_post_valid_single_item.json

@@ -0,0 +1 @@
+{"purchase":{"qty":22,"price":24178,"items":[{"price":1099,"qty":22,"title":"High-Impact Water Bottle","url":"http://example.com/234/high-impact-water-bottle","id":"234"}],"time":"Tue, 25 Jan 2011 11:36:06 -0500","_id":"4d3efbf66763d9020e0006ea"}}

data/test/fixtures/send_cancel.json

@@ -0,0 +1 @@
+{"send_id":"TT4gSGdj2Z17AAGb","ok":true}

data/test/fixtures/send_get_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown send_id: aaaaTT1ClGdj2bRHAAP6","error":12}

data/test/fixtures/send_get_valid.json

@@ -0,0 +1 @@
+{"send_id":"TT1ClGdj2bRHAAP6","view_url":"http://link.sailthru.com/view/TT1ClGdj2bRHAAP6/3f7f9f72","send_time":"Mon, 24 Jan 2011 04:12:59 -0500","template":"default","status":"delivered","email":"praj@sailthru.com"}

data/test/fixtures/send_post_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown template: invalid","error":14}

data/test/fixtures/send_post_multiple_valid.json

@@ -0,0 +1 @@
+{"sent_count":2,"send_ids":{"example@example.com":"TT4YnGdj2RVrAASU","example3@example.com":"TT4YnGdj2RVrAAST"},"template":"default"}

data/test/fixtures/stat_get_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown stat: lista","error":99}

data/test/fixtures/stat_get_valid.json

@@ -0,0 +1 @@
+{"lists_signup_count":0,"active_count":0,"list":"","email_count":0,"passive_count":0,"optout_count":0,"optout_loss_count":0,"hardbounce_count":0,"day":20110125,"disengaged_count":0,"count_time":"Tue, 25 Jan 2011 05:40:50 -0500","lists_count":0,"lists_remove_count":0,"engaged_count":0,"dormant_count":0}

data/test/fixtures/stats_lists_invalid.json

@@ -0,0 +1 @@
+{"errormsg":"Unable to find stats for not-listed","error":99}

data/test/fixtures/stats_lists_valid.json

@@ -0,0 +1 @@
+{"lists_signup_count":0,"active_count":0,"list":"","email_count":0,"passive_count":0,"optout_count":0,"optout_loss_count":0,"hardbounce_count":0,"day":20110114,"disengaged_count":0,"count_time":"Fri, 14 Jan 2011 00:09:25 -0500","lists_count":0,"lists_remove_count":0,"engaged_count":0,"dormant_count":0}

data/test/fixtures/template_delete_invalid.json

@@ -0,0 +1 @@
+{"error":14, "errormsg": "Unknown template: my-template"}

data/test/fixtures/template_delete_valid.json

@@ -0,0 +1 @@
+{"template": "my-template", "ok": true}

data/test/fixtures/template_invalid_get.json

@@ -0,0 +1 @@
+{"errormsg":"Unknown template: invalid","error":14}

data/test/fixtures/template_save.json

@@ -0,0 +1 @@
+{"name":"my-template-new","sample":"","verify_post_url":"","from_name":"prajwal tuladhar","is_google_analytics":false,"is_unviewable":false,"error_url":"","subject":"Hello world","content_html":"Hi {email} \n\n<p/>\n{beacon}\n<p><small>If you believe this has been sent to you in error, please safely <a href=\"{optout_confirm_url}\">unsubscribe</a>.</small></p>","is_disabled":false,"replyto_email":"","is_link_tracking":true,"from_email":"praj@sailthru.com","is_invite":false,"success_url":"","content_sms":"","content_text":""}

data/test/fixtures/template_valid_get.json

@@ -0,0 +1 @@
+{"name":"default","sample":"","verify_post_url":"","from_name":"","is_google_analytics":false,"is_unviewable":false,"error_url":"","subject":"Hello world","content_html":"Hi {email} \n\n<p/>\n{beacon}\n<p><small>If you believe this has been sent to you in error, please safely <a href=\"{optout_confirm_url}\">unsubscribe</a>.</small></p>","is_disabled":false,"replyto_email":"","is_link_tracking":true,"from_email":"praj@sailthru.com","is_invite":false,"success_url":"","content_sms":"","content_text":""}

data/test/fixtures/user_update_post_valid.json

@@ -0,0 +1,3 @@
+{"email" : "test@test.com", "vars" : {"name" : "Dan"}}
+{"email" : "test2@test.com", "vars" : {"name" : "Dan 2"}}
+{"email" : "test3@test.com", "vars" : {"name" : "Dan 3"}}

data/test/fixtures/user_update_valid.json

@@ -0,0 +1 @@
+{"job_id" : "502c618ddd6a49b9200003c4", "name" : "Bulk Update", "update" : [], "status" : "pending"}

data/test/sailthru/blast_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+class BlastTest < Minitest::Test
+  describe "API Call: blast" do
+    before do
+      api_url = 'http://api.sailthru.com'
+      @secret = 'my_secret'
+      @api_key = 'my_api_key'
+      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @api_call_url = sailthru_api_call_url(api_url, 'blast')
+    end
+
+    it "can get the status of a blast when blast_id is valid" do
+      valid_blast_id = '665215'
+      params = {'blast_id' => valid_blast_id}
+      query_string = create_json_payload(@api_key, @secret, params)
+      stub_get(@api_call_url + '?' + query_string, 'blast_get_valid.json')
+      response = @sailthru_client.get_blast(valid_blast_id)
+      refute_nil response['name']
+      assert_equal valid_blast_id, response['blast_id'].to_s
+    end
+
+    it "can get blast error message when blast_id is invalid" do
+      invalid_blast_id = '88787'
+      params = {'blast_id' => invalid_blast_id}
+      query_string = create_json_payload(@api_key, @secret, params)
+      stub_get(@api_call_url + '?' + query_string, 'blast_get_invalid.json')
+      response =  @sailthru_client.get_blast(invalid_blast_id)
+      refute_nil response['error']
+      refute_nil response['errormsg']
+    end
+
+    it "can schedule blast with given blast name, list, schedule_time, from name, from email, subject, content html, content text" do
+      blast_name = 'Default Blast 222'
+      list = 'default-list'
+      schedule_time = '+3 hours'
+      from_name = 'Daily Newsletter'
+      from_email = 'praj@sailthru.com'
+      subject = 'Hello World!'
+      content_html = '<p>Hello World</p>'
+      content_text= 'Hello World'
+      stub_post(@api_call_url, 'blast_post_valid.json')
+      response = @sailthru_client.schedule_blast(blast_name, list, schedule_time, from_name, from_email, subject, content_html, content_text)
+      assert_equal blast_name, response['name']
+      assert_equal list, response['list']
+      assert_equal from_email, response['from_email']
+      assert_equal from_name, response['from_name']
+    end
+
+    it "cannot schedule blast with invalid email" do
+      blast_name = 'Default Blast 222'
+      list = 'default-list'
+      schedule_time = '+3 hours'
+      from_name = 'Daily Newsletter'
+      from_email_invalid = 'praj@'
+      subject = 'Hello World!'
+      content_html = '<p>Hello World</p>'
+      content_text= 'Hello World'
+      stub_post(@api_call_url, 'blast_post_invalid_email.json')
+      response = @sailthru_client.schedule_blast(blast_name, list, schedule_time, from_name, from_email_invalid, subject, content_html, content_text)
+      refute_nil response['error']
+      refute_nil response['errormsg']
+    end
+
+    it "cannot schedule blast with invalid list" do
+      blast_name = 'Default Blast 222'
+      list_invalid = 'this-list-does-not-exist'
+      schedule_time = '+3 hours'
+      from_name = 'Daily Newsletter'
+      from_email = 'praj@'
+      subject = 'Hello World!'
+      content_html = '<p>Hello World</p>'
+      content_text= 'Hello World'
+      stub_post(@api_call_url, 'blast_post_invalid_list.json')
+      response = @sailthru_client.schedule_blast(blast_name, list_invalid, schedule_time, from_name, from_email, subject, content_html, content_text)
+      refute_nil response['error']
+      refute_nil response['errormsg']
+    end
+
+    it "can update blast with valid blast_id" do
+      blast_id = 42499
+      name = 'blast name changed'
+      from_name = 'prajwal tuladhar'
+      stub_post(@api_call_url, 'blast_post_update_valid.json')
+      response = @sailthru_client.update_blast(blast_id = blast_id, from_name = from_name)
+      assert_equal(name, response['name'])
+    end
+
+    it "can delete valid blast" do
+      blast_id = 42499
+      params = {'blast_id' => blast_id}
+      query_string = create_json_payload(@api_key, @secret, params)
+      stub_delete(@api_call_url + '?' + query_string, 'blast_delete_valid.json')
+      response = @sailthru_client.delete_blast(blast_id)
+      assert_equal(blast_id, response['blast_id'])
+    end
+
+    it "cannot delete invalid blast" do
+      invalid_blast_id = '88787'
+      params = {'blast_id' => invalid_blast_id}
+      query_string = create_json_payload(@api_key, @secret, params)
+      stub_delete(@api_call_url + '?' + query_string, 'blast_delete_invalid.json')
+      response = @sailthru_client.delete_blast(invalid_blast_id)
+      refute_nil response['error']
+      refute_nil response['errormsg']
+    end
+
+    it "can cancel a valid blast" do
+      blast_id = 42499
+      stub_post(@api_call_url, 'blast_post_update_valid.json')
+      response = @sailthru_client.cancel_blast(blast_id)
+      assert_equal(blast_id, response['blast_id'])
+    end
+
+  end
+end

data/test/sailthru/content_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class ContentTest < Minitest::Test
+  describe "API Call: content" do
+    before do
+      api_url = 'http://api.sailthru.com'
+      @secret = 'my_secret'
+      @api_key = 'my_api_key'
+      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @api_call_url = sailthru_api_call_url(api_url, 'content')
+    end
+
+    it "can push content with title, url, *array* tags and vars" do
+      title = 'unix is awesome'
+      url = 'http://example.com/hello-world'
+      date = nil
+      tags = ['unix', 'linux']
+      vars = {:price => 55, :description => 'Hello World'}
+      stub_post(@api_call_url, 'content_valid.json')
+      response = @sailthru_client.push_content(title, url, date = nil, tags = tags, vars = vars)
+      refute_nil response['content']
+    end
+
+    it "can push content with title, url, *string* tags and vars" do
+      title = 'unix is awesome'
+      url = 'http://example.com/hello-world'
+      date = nil
+      tags = 'unix, linux'
+      vars = {:price => 55, :description => 'Hello World'}
+      stub_post(@api_call_url, 'content_valid.json')
+      response = @sailthru_client.push_content(title, url, date = nil, tags = tags, vars = vars)
+      refute_nil response['content']
+    end
+
+  end
+end

data/test/sailthru/email_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class EmailTest < Minitest::Test
+  describe "API Call: email" do
+    before do
+      api_url = 'http://api.sailthru.com'
+      @api_key = 'my_api_key'
+      @secret = 'my_secret'
+      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @api_call_url = sailthru_api_call_url(api_url, 'email')
+    end
+
+    it "can get email information for one of the client's user" do
+      email = 'praj@sailthru.com'
+      params = {'email' => email}
+      query_string = create_json_payload(@api_key, @secret, params)
+      stub_get(@api_call_url + '?' + query_string, 'email_get_listed_email.json')
+      response = @sailthru_client.get_email(email)
+      refute_nil response['verified']
+      assert_equal email, response['email']
+    end
+  end
+end

data/test/sailthru/error_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ErrorTest < Minitest::Test
+  describe "Server is misbehaving" do
+    before do
+      api_url = 'http://api.sailthru.com'
+      @secret = 'my_secret'
+      @api_key = 'my_api_key'
+      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @api_call_url = sailthru_api_call_url(api_url, 'blast')
+    end
+
+    it "raises an error when server misbehaves" do
+      stub_exception(@api_call_url, 'blast_post_update_valid.json')
+      assert_raises Sailthru::SailthruClientException do
+        @sailthru_client.cancel_blast(123)
+      end
+    end
+
+    it "shows the true origin of the exception" do
+      stub_exception(@api_call_url, 'blast_post_update_valid.json')
+      begin
+        @sailthru_client.cancel_blast(123)
+      rescue Exception => e
+        assert(e.message =~ /Exception from FakeWeb/)
+      end
+    end
+  end
+end
+

data/test/sailthru/file_upload_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+require 'mocha/setup'
+
+class FileUploadTest < Minitest::Test
+
+  describe "API Call: blast" do
+
+    before do
+      @secret = 'my_secret'
+      @api_key = 'my_api_key'
+      @sailthru_client = Sailthru::SailthruClient.new(
+        @api_key, @secret, 'http://api.sailthru.com'
+      )
+      @api_call_url = sailthru_api_call_url(
+        'http://api.sailthru.com', 'job'
+      )
+    end
+
+    it "can upload a file of data" do
+      Net::HTTP::Post::Multipart.expects(:new).with(
+          instance_of(String),
+          has_entries({
+            "file" => instance_of(UploadIO)
+          })
+        )
+      Net::HTTP.stubs(:Proxy).returns(Net::HTTP)
+      Net::HTTP.any_instance.stubs(
+          :request => stub(
+            "body" => JSON.unparse({"job_id" => "123"})
+          )
+        )
+
+      data = {
+        "job" => "update",
+        "file" => fixture_file_path('user_update_post_valid.json')
+      }
+      response = @sailthru_client.api_post(
+        :job, data, 'file'
+      )
+      refute_nil response['job_id']
+    end
+
+    it "can upload a string of data" do
+      Net::HTTP::Post::Multipart.expects(:new).with(
+          instance_of(String),
+          has_entries({
+            "file" => instance_of(UploadIO)
+          })
+        )
+      Net::HTTP.stubs(:Proxy).returns(Net::HTTP)
+      Net::HTTP.any_instance.stubs(
+          :request => stub(
+            "body" => JSON.unparse({"job_id" => "123"})
+          )
+        )
+
+      email = {
+        "email" => "dan.langevin@lifebooker.com",
+        "vars" => {
+          "first_name" => "Dan"
+        }
+      }
+      data = {
+        "job" => "update",
+        "file" => StringIO.new(JSON.unparse(email))
+      }
+
+      response = @sailthru_client.api_post(
+        :job, data, 'file'
+      )
+      refute_nil response['job_id']
+    end
+
+  end
+end