burstsms 0.1.1

data/lib/burstsms/lists_get.rb

@@ -0,0 +1,38 @@
+require 'happymapper'
+
+module BurstSms
+  module ListsGet
+
+    def get_lists(offset=0, limit=50)
+      response = post_to_api(get_lists_body(offset, limit))
+      Response.parse(response.body)
+    end
+    
+    def get_lists_body(offset, limit)
+      build_request("contact-lists.get", :offset => offset,
+                                         :limit => limit )
+    end
+
+    class Lists
+      include HappyMapper
+    
+      element :id, String
+      element :name, String
+      element :recipient_count, Integer
+    
+    end
+  
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :total, String
+      element :time, Time
+      element :timestamp, String
+      element :error, String
+    
+      has_many :lists, Lists, :tag => 'data'
+    
+    end
+  end
+end

data/lib/burstsms/lists_get_recipients.rb

@@ -0,0 +1,42 @@
+require 'happymapper'
+
+module BurstSms
+  module ListsGetRecipients
+
+    def get_list_recipients(id, offset=0, limit=50)
+      response = post_to_api(get_list_recipients_body(id, offset, limit))
+      Response.parse(response.body)
+    end
+    
+    def get_list_recipients_body(id, offset, limit)
+      build_request("contact-lists.get-recipients", :id => id,
+                                                :offset => offset,
+                                                :limit => limit )
+    end
+
+    class Recipients
+      include HappyMapper
+    
+      element :mobile, String
+      element :firstname, String
+      element :lastname, String
+      element :datetime_entry, String
+      element :dest_country, String
+      element :bounce_count, Integer
+    
+    end
+  
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :total, String
+      element :time, Time
+      element :timestamp, String
+      element :error, String
+    
+      has_many :recipients, Recipients, :tag => 'data'
+    
+    end
+  end
+end

data/lib/burstsms/lists_get_unsubscribed.rb

@@ -0,0 +1,42 @@
+require 'happymapper'
+
+module BurstSms
+  module ListsGetUnsubscribed
+
+    def get_list_unsubscribed(id, offset=0, limit=50)
+      response = post_to_api(get_list_unsubscribed_body(id, offset, limit))
+      Response.parse(response.body)
+    end
+    
+    def get_list_unsubscribed_body(id, offset, limit)
+      build_request("contact-lists.get-unsubscribed", :id => id,
+                                                      :offset => offset,
+                                                      :limit => limit )
+    end
+
+    class Recipients
+      include HappyMapper
+    
+      element :mobile, String
+      element :firstname, String
+      element :lastname, String
+      element :datetime_entry, String
+      element :dest_country, String
+      element :bounce_count, Integer
+    
+    end
+  
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :total, String
+      element :time, Time
+      element :timestamp, String
+      element :error, String
+    
+      has_many :recipients, Recipients, :tag => 'data'
+    
+    end
+  end
+end

data/lib/burstsms/message_responses.rb

@@ -0,0 +1,41 @@
+require 'happymapper'
+
+module BurstSms
+  module MessageResponses
+
+    def message_responses(message_id, offset=0, limit=50)
+      response = post_to_api(message_responses_body(message_id, offset, limit))
+      Response.parse(response.body)
+    end
+    
+    def message_responses_body(message_id, offset, limit)
+      build_request("messages.responses", :message_id => message_id,
+                                          :offset => offset,
+                                          :limit => limit )
+    end
+
+    class Replies
+      include HappyMapper
+    
+      element :firstname, String
+      element :lastname, String
+      element :mobile, String
+      element :datetime_entry_orig, String
+      element :message, String
+    
+    end
+  
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :total, String
+      element :time, Time
+      element :timestamp, String
+      element :error, String
+    
+      has_many :replies, Replies, :tag => 'data'
+    
+    end
+  end
+end

data/lib/burstsms/messages_add.rb

@@ -0,0 +1,39 @@
+require 'happymapper'
+
+module BurstSms
+  module MessagesAdd
+    
+    def add_message(from, list_id, message, options={})
+      @response = post_to_api(add_message_body(from, list_id, message, options))
+      Response.parse(@response.body)
+    end
+    
+    def add_message_body(from, list_id, message, options={})
+      build_request("messages.add", :caller_id => check_valid_sender(from), 
+                                    :list_id => list_id, 
+                                    :message => encode_msg(message),
+                                    :sendtime => (options.has_key?(:sendtime) ? options[:sendtime] : nil),
+                                    :contact_list => (options.has_key?(:contact_list) ? options[:contact_list] : nil))
+    end
+
+    class Response
+      include HappyMapper
+      tag 'xml'
+      
+      element :error, String
+      element :total, String
+      element :time, String
+      element :timestamp, String
+      
+      element :result, String, :xpath => "data/result"
+      element :message_id, String, :xpath => "data/message_id"
+      element :list_id, String, :xpath => "data/list_id"
+      element :message, String, :xpath => "data/message"
+      element :cost, String, :xpath => "data/cost"
+      element :balance, String, :xpath => "data/balance"
+      element :charge_error, String, :xpath => "data/charge_error"
+      
+    
+    end
+  end
+end

data/lib/burstsms/messages_get.rb

@@ -0,0 +1,44 @@
+require 'happymapper'
+
+module BurstSms
+  module MessagesGet
+
+    def get_messages(offset=0, limit=50)
+      response = post_to_api(get_messages_body(offset, limit))
+      Response.parse(response.body)
+    end
+    
+    def get_messages_body(offset, limit)
+      build_request("messages.get", :offset => offset,
+                                    :limit => limit )
+    end
+
+    class Messages
+      include HappyMapper
+    
+      element :id, String
+      element :list_id, String
+      element :mobile_from, String
+      element :message, String
+      element :datetime_send, Time
+      element :datetime_actioned, Time
+      element :recipient_count, Integer
+      element :status, String
+      element :schedule, String
+    
+    end
+  
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :total, String
+      element :time, Time
+      element :timestamp, String
+      element :error, String
+    
+      has_many :messages, Messages, :tag => 'data'
+    
+    end
+  end
+end

data/lib/burstsms/messages_multiple.rb

@@ -0,0 +1,32 @@
+require 'happymapper'
+
+module BurstSms
+  module MessagesMultiple
+    
+    def send_message(from, recipients, message, options={})
+      @response = post_to_api(send_message_body(from, recipients, message, options))
+      Response.parse(@response.body)
+    end
+    
+    def send_message_body(from, recipients, message, options={})
+      build_request("messages.multiple",  :caller_id => check_valid_sender(from), 
+                                          :mobile => sanitize_numbers(recipients), 
+                                          :message => encode_msg(message),
+                                          :sendtime => (options.has_key?(:sendtime) ? options[:sendtime] : nil),
+                                          :contact_list => (options.has_key?(:contact_list) ? options[:contact_list] : nil))
+    end
+
+    class Response
+      include HappyMapper
+      tag 'xml'
+  
+      element :result, String, :xpath => "data/result"
+      element :total_recipients, String, :xpath => "data/total_recipients"
+      element :total_recipients_queued, String, :xpath => "data/total_recipients_queued"
+      element :message_id, String, :xpath => "data/message_id"
+      element :contact_list_addition, String, :xpath => "data/contact_list_addition"
+      element :error, String
+      
+    end
+  end
+end

data/lib/burstsms/version.rb

@@ -0,0 +1,3 @@
+module BurstSms
+  VERSION = "0.1.1"
+end

data/spec/burst_sms_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+
+describe BurstSms do
+  
+  before(:all) do
+    @burst = BurstSms::API.new("79798797897", "x")
+  end
+  
+  context "Burst API credentials" do
+  
+    it "Populates the API credentials in XML requests" do
+      @request_body = @burst.get_messages_body(0,50)
+      @nok_parsed = Nokogiri::XML(@request_body)
+      @nok_parsed.should have_xml('//request/key', '79798797897')
+      @nok_parsed.should have_xml('//request/secret', 'x')
+    end
+     
+  end
+  
+  context "'messages.multiple' - http://burstsms.com/api-documentation/messages.multiple" do 
+    
+    before(:all) do
+      #numbers cocktail has numbers which are valid(5 out of 10 in array) + too short, too long, landlines, duplicates, non-numerical. tests gsub formula
+      @numbers_cocktail = ['61490900900', '61490900910', '+61 414 899 766', '0403 855 445', '0403-855-445', '0487-000-777', '0987 788 665', '0455 777 3334', '0455 678 87', '09AB 009 456']
+      @request_body = @burst.send_message_body('6147779990', @numbers_cocktail, "sms txt\n of words and such:/" )
+      @nok_parsed = Nokogiri::XML(@request_body)
+    end
+  
+    it "Builds correct XML structure" do
+      nodes = ['//request/method', '//request/params/mobile', '//request/params/message', '//request/params/caller_id']
+      nodes.each { |n| @nok_parsed.should have_xml(n)}
+    end
+    
+    it "Add sendtime and contact_list if present" do
+    time = Time.now
+    @request_body = @burst.send_message_body('6147779990', @numbers_cocktail, "sms txt\n of words and such:/", :sendtime => time, :contact_list => "123456")
+    nok_request = Nokogiri::XML(@request_body)
+    nok_request.should have_xml("//request/params/sendtime")
+    nok_request.should have_xml("//request/params/contact_list")
+    end
+  
+    it "Processes Recipient Numbers: Sanitises format, deletes invalid and duplicates" do
+      @nok_parsed.should have_xml('//params/mobile', "61490900900,61490900910,61414899766,61403855445,61487000777")
+    end
+    
+    it "Handles single recipient number" do
+      @single_num = @burst.send_message_body('6147779990', '0404 678 876', "sms" )
+      Nokogiri::XML(@single_num).should have_xml('//params/mobile', '61404678876')
+    end
+  
+    it "Encodes message body to URI format" do
+      @nok_parsed.should have_xml('//params/message', 'sms%20txt%0A%20of%20words%20and%20such%3A%2F')
+    end
+  
+    it "Checks sender ID Length" do
+      expect {@burst.send_message_body('61477799900a', @numbers_cocktail, "sms" ) }.to raise_error("Sender ID is too Long")
+      expect {@burst.send_message_body('6147779990012345', @numbers_cocktail, "sms" ) }.to raise_error("Sender Number is too Long")
+      
+    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/messages_multiple.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/send_message_success.txt'))
+      @response = @burst.send_message('6147779990', @numbers_cocktail, "sms txt\n of words and such:/" )
+      @response.result.should == 'queued'
+      @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.send_message('6147779990', @numbers_cocktail, "sms txt\n of words and such:/" )
+      @response.result.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'messages.get' - http://burstsms.com/api-documentation/messages.get" do
+  
+    it "Builds correct XML structure" do
+      @request_body = @burst.get_messages_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/messages_get.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/messages_get_success.txt'))
+      @response = @burst.get_messages()
+      @response.total.should == '67'
+      @response.messages.size.should == 4
+      @response.messages.first.id.should == "28153"
+      @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_messages()
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+  
+  context "'messages.add' - http://burstsms.com/api-documentation/messages.add" do
+    
+    it "Builds correct XML structure" do
+      @request_body = @burst.add_message_body('6147779990', 123 , "sms txt\n of words and such:/")
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/method', '//request/params/list_id', '//request/params/caller_id', '//request/params/message']
+      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/messages_add.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/messages_add_success.txt'))
+      @response = @burst.add_message('6147779990', 1075 , "sms txt\n of words and such:/")
+      @response.total.should == '1'
+      @response.result.should == 'queued'
+      @response.list_id.should == "1075"
+      @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_message('6147779990', 1075 , "sms txt\n of words and such:/")
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+    
+    it "Encodes message body to URI format" do
+      @request_body = @burst.add_message_body('6147779990', 123 , "sms txt\n of words and such:/")
+      @nok_parsed = Nokogiri::XML(@request_body)
+      @nok_parsed.should have_xml('//params/message', 'sms%20txt%0A%20of%20words%20and%20such%3A%2F')
+    end
+  
+    it "Checks sender ID Length" do
+      expect {@burst.add_message_body('61477799900a', 1075, "sms" ) }.to raise_error("Sender ID is too Long")
+      expect {@burst.add_message_body('6147779990012345', 1075, "sms" ) }.to raise_error("Sender Number is too Long")
+      
+    end
+  end
+  
+  context "'messages.responses' - http://burstsms.com/api-documentation/messages.responses" do
+    
+    it "Builds correct XML structure" do
+      @request_body = @burst.message_responses_body('123', 0 , 50)
+      @nok_parsed = Nokogiri::XML(@request_body)
+      nodes = ['//request/method', '//request/params/message_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/message_responses.txt')).to_return(:status => 200, :body => File.read('spec/fixtures/api_responses/message_responses_success.txt'))
+      @response = @burst.message_responses('123')
+      @response.total.should == '4'
+      @response.replies.size.should == 1
+      @response.replies.first.firstname.should == "Bob"
+      @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.message_responses('123')
+      @response.total.should == nil
+      @response.error.should == 'Authentication failed - key: 797987, secret: x'
+    end
+  end
+
+end