burstsms 0.1.1

data/spec/contact_lists_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+
+
+describe BurstSms do
+  
+  before(:all) do
+    @burst = BurstSms::API.new("79798797897", "x")
+  end
+  
+  context "'contact-lists.get' - http://burstsms.com.au/api-documentation/contact-lists.get"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.get_lists_body(0,50)
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/offset', '//request/params/limit']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_get.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_get_success.txt'))
+      @response = @burst.get_lists()
+      @response.total.should == '2'
+      @response.lists.size.should == 2
+      @response.lists.first.id.should == "1"
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.get_lists()
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.add' - http://burstsms.com.au/api-documentation/contact-lists.add"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.add_list_body("some awesome list name")
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/name']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_add.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_add_success.txt'))
+      @response = @burst.add_list("some awesome list name")
+      @response.total.should == '1'
+      @response.list_id.should == '1211'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.add_list("some awesome list name")
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.delete' - http://burstsms.com.au/api-documentation/contact-lists.delete"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.delete_list_body("123")
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/id']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_delete.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_delete_success.txt'))
+      @response = @burst.delete_list("123")
+      @response.total.should == '1'
+      @response.response.should == 'DELETED'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.delete_list("123")
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.get-recipients' - http://burstsms.com.au/api-documentation/contact-lists.get-recipients"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.get_list_recipients_body("123", 0, 50)
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/id', '//request/params/offset', '//request/params/limit']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_get_recipients.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_get_recipients_success.txt'))
+      @response = @burst.get_list_recipients("123")
+      @response.total.should == '3'
+      @response.recipients.size.should == 3
+      @response.recipients.first.lastname.should == 'Doe'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.get_list_recipients("123")
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.get-unsubscribed' - http://burstsms.com.au/api-documentation/contact-lists.get-unsubscribed"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.get_list_unsubscribed_body("123", 0, 50)
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/id', '//request/params/offset', '//request/params/limit']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_get_unsubscribed.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_get_unsubscribed_success.txt'))
+      @response = @burst.get_list_unsubscribed("123")
+      @response.total.should == '3'
+      @response.recipients.size.should == 3
+      @response.recipients.first.lastname.should == 'Doe'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.get_list_unsubscribed("123")
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.add-recipient' - http://burstsms.com.au/api-documentation/contact-lists.add-recipient"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.add_list_recipient_body("123", '61412123123', :firstname => 'Bob', :lastname => 'Smith')
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/list_id', '//request/params/mobile', '//request/params/firstname', '//request/params/lastname']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_add_recipient.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_add_recipient_success.txt'))
+      @response = @burst.add_list_recipient("123", '61412123123', :firstname => 'Bob', :lastname => 'Smith')
+      @response.total.should == '1'
+      @response.result.should == 'ADDED'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.add_list_recipient("123", '61412123123', :firstname => 'Bob', :lastname => 'Smith')
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'contact-lists.delete-recipient' - http://burstsms.com.au/api-documentation/contact-lists.delete-recipient"  do
+    it "Builds correct XML structure" do
+      @request_body = @burst.delete_list_recipient_body("123", '61412123123')
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/key', '//request/secret', '//request/version', '//request/method', '//request/params/list_id', '//request/params/mobile']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Sends correct API request and parses XML response to ruby object" do
+      # This has the potential to fail in ruby-1.8 due to Hash ordering... or lack of it.
+      stub_request(:post, BurstSms::API_URL).with(:body => File.read('spec/fixtures/api_requests/lists_delete_recipient.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/lists_delete_recipient_success.txt'))
+      @response = @burst.delete_list_recipient("123", '61412123123')
+      @response.total.should == '1'
+      @response.result.should == 'DELETED'
+      @response.error.should == nil
+    end
+    
+    it "Create error from failed response" do
+      stub_request(:post, BurstSms::API_URL).to_return(:status => 200, :body => File.read("spec/fixtures/api_responses/generic_failure.txt"))
+      @response = @burst.delete_list_recipient("123", '61412123123')
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+end

data/spec/fixtures/api_requests/lists_add.txt

@@ -0,0 +1,10 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.add</method>
+  <params>
+    <name>some awesome list name</name>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_add_recipient.txt

@@ -0,0 +1,13 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.add-recipient</method>
+  <params>
+    <mobile>61412123123</mobile>
+    <list_id>123</list_id>
+    <firstname>Bob</firstname>
+    <lastname>Smith</lastname>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_delete.txt

@@ -0,0 +1,10 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.delete</method>
+  <params>
+    <id>123</id>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_delete_recipient.txt

@@ -0,0 +1,11 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.delete-recipient</method>
+  <params>
+    <mobile>61412123123</mobile>
+    <list_id>123</list_id>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_get.txt

@@ -0,0 +1,11 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.get</method>
+  <params>
+    <offset>0</offset>
+    <limit>50</limit>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_get_recipients.txt

@@ -0,0 +1,12 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.get-recipients</method>
+  <params>
+    <offset>0</offset>
+    <limit>50</limit>
+    <id>123</id>
+  </params>
+</request>

data/spec/fixtures/api_requests/lists_get_unsubscribed.txt

@@ -0,0 +1,12 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>contact-lists.get-unsubscribed</method>
+  <params>
+    <offset>0</offset>
+    <limit>50</limit>
+    <id>123</id>
+  </params>
+</request>

data/spec/fixtures/api_requests/message_responses.txt

@@ -0,0 +1,12 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>messages.responses</method>
+  <params>
+    <offset>0</offset>
+    <limit>50</limit>
+    <message_id>123</message_id>
+  </params>
+</request>

data/spec/fixtures/api_requests/messages_add.txt

@@ -0,0 +1,12 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>messages.add</method>
+  <params>
+    <caller_id>6147779990</caller_id>
+    <message>sms%20txt%0A%20of%20words%20and%20such%3A%2F</message>
+    <list_id>1075</list_id>
+  </params>
+</request>

data/spec/fixtures/api_requests/messages_get.txt

@@ -0,0 +1,11 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>messages.get</method>
+  <params>
+    <offset>0</offset>
+    <limit>50</limit>
+  </params>
+</request>

data/spec/fixtures/api_requests/messages_multiple.txt

@@ -0,0 +1,12 @@
+request=<?xml version="1.0"?>
+<request>
+  <version>0.3</version>
+  <key>79798797897</key>
+  <secret>x</secret>
+  <method>messages.multiple</method>
+  <params>
+    <caller_id>6147779990</caller_id>
+    <mobile>61490900900,61490900910,61414899766,61403855445,61487000777</mobile>
+    <message>sms%20txt%0A%20of%20words%20and%20such%3A%2F</message>
+  </params>
+</request>

data/spec/fixtures/api_responses/generic_failure.txt

@@ -0,0 +1,7 @@
+<?xml version='1.0'?>
+<xml>
+  <method>some.method</method>
+  <time>2012-01-23 03:27:42 GMT</time>
+  <timestamp>1327289262 GMT</timestamp>
+  <error>Authentication failed - key: 797987, secret: x</error>
+</xml>

data/spec/fixtures/api_responses/lists_add_recipient_success.txt

@@ -0,0 +1,11 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.add-recipient</method>
+	<total>1</total>
+	<time>2009-12-11 01:48:54 GMT</time>
+	<timestamp>1260496134 GMT</timestamp>
+	<data>
+		<result>ADDED</result>
+		<list_id>1076</list_id>
+	</data>
+</xml>

data/spec/fixtures/api_responses/lists_add_success.txt

@@ -0,0 +1,12 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.add</method>
+	<total>1</total>
+	<time>2009-12-11 01:47:57 GMT</time>
+	<timestamp>1260496077 GMT</timestamp>
+	<data>
+		<name>New List</name>
+		<recipient_count>0</recipient_count>
+		<id>1211</id>
+	</data>
+</xml>

data/spec/fixtures/api_responses/lists_delete_recipient_success.txt

@@ -0,0 +1,8 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.delete-recipient</method>
+	<total>1</total>
+	<time>2009-12-21 23:07:05 GMT</time>
+	<timestamp>1261436825 GMT</timestamp>
+	<result>DELETED</result>
+</xml>

data/spec/fixtures/api_responses/lists_delete_success.txt

@@ -0,0 +1,8 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.delete</method>
+	<total>1</total>
+	<time>2009-12-09 05:41:17 GMT</time>
+	<timestamp>1260337277 GMT</timestamp>
+	<response>DELETED</response>
+</xml>

data/spec/fixtures/api_responses/lists_get_recipients_success.txt

@@ -0,0 +1,33 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.get-recipients</method>
+	<total>3</total>
+	<time>2009-12-21 23:05:02 GMT</time>
+	<timestamp>1261436702 GMT</timestamp>
+	<dataset>
+		<data>
+			<mobile>61404800800</mobile>
+			<firstname>John</firstname>
+			<lastname>Doe</lastname>
+			<datetime_entry>2009-12-11 00:34:23</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+		<data>
+			<mobile>61404600600</mobile>
+			<firstname>Jane</firstname>
+			<lastname>Doe</lastname>
+			<datetime_entry>2009-11-26 13:10:56</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+		<data>
+			<mobile>61404300300</mobile>
+			<firstname>Jim</firstname>
+			<lastname>Citizen</lastname>
+			<datetime_entry>2009-11-26 13:11:11</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+	</dataset>
+</xml>

data/spec/fixtures/api_responses/lists_get_success.txt

@@ -0,0 +1,19 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.get</method>
+	<total>2</total>
+	<time>2009-12-11 02:47:22 GMT</time>
+	<timestamp>1260499642 GMT</timestamp>
+	<dataset>
+		<data>
+			<id>1</id>
+			<name>My SMS List</name>
+			<recipient_count>3</recipient_count>
+		</data>
+		<data>
+			<id>2</id>
+			<name>My SMS List 2</name>
+			<recipient_count>9</recipient_count>
+		</data>
+	</dataset>
+</xml>

data/spec/fixtures/api_responses/lists_get_unsubscribed_success.txt

@@ -0,0 +1,33 @@
+<?xml version='1.0'?>
+<xml>
+	<method>contact-lists.get-unsubscribed</method>
+	<total>3</total>
+	<time>2009-12-21 23:05:02 GMT</time>
+	<timestamp>1261436702 GMT</timestamp>
+	<dataset>
+		<data>
+			<mobile>61404800800</mobile>
+			<firstname>John</firstname>
+			<lastname>Doe</lastname>
+			<datetime_entry>2009-12-11 00:34:23</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+		<data>
+			<mobile>61404600600</mobile>
+			<firstname>Jane</firstname>
+			<lastname>Doe</lastname>
+			<datetime_entry>2009-11-26 13:10:56</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+		<data>
+			<mobile>61404300300</mobile>
+			<firstname>Jim</firstname>
+			<lastname>Citizen</lastname>
+			<datetime_entry>2009-11-26 13:11:11</datetime_entry>
+			<dest_country>AU</dest_country>
+			<bounce_count>0</bounce_count>
+		</data>
+	</dataset>
+</xml>