tsig_api 1.0.5

data/test/tsig_api_group_test.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), '/test_helper')
+
+class TsigApiGroupTest < ActiveSupport::TestCase
+
+  def setup
+    response_xml = <<-EOS
+    <?xml version='1.0'?>
+<txtsig_response version="1.0">
+  <content type="response">
+    <item type="groups">
+      <element name='success'>
+          true
+      </element>
+      <element name='group_a'>
+          Group A
+      </element>
+      <element name='group_b'>
+          Foo
+      </element>
+      <element name='group_c'>
+          Group C
+      </element>
+      <element name='group_d'>
+          Group D
+      </element>
+      <element name='group_e'>
+          Group E
+      </element>
+    </item>
+  </content>
+</txtsig_response>
+    EOS
+    
+    error_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="error">
+        <item  type="error_description">
+          <element name="error_code">10</element>
+          <element name="error_text"><![CDATA[General Fault]]></element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    net_response = stub("net_response")
+    net_response.body{response_xml}
+    net_error = stub("net_error")
+    net_error.body{error_xml}
+    
+    @valid_response = TsigApi::RemoteActions::Response.new(true, net_response)
+    stub(@valid_response).body{response_xml}
+    @error_response = TsigApi::RemoteActions::Response.new(true, net_error)
+    stub(@error_response).body{error_xml}
+
+    TsigApi::Base.establish_connection(1234, 'joe', '123456789012345678901234567890ab')
+  end
+  
+  def test_should_initialize_carrier
+    g = TsigApi::Group.new
+    assert_equal TsigApi::Group, g.class
+    assert_equal :groups, g.class.remote_type
+  end
+  
+  def test_should_build_query_xml
+    g = TsigApi::Group.new
+    request = g.query
+    assert request.body.include?('<action type="list_groups">')
+    assert request.body.include?('<client_id><![CDATA[1234]]></client_id>')
+    assert request.body.include?('<api_username><![CDATA[joe]]></api_username>')
+    assert request.body.include?('<api_password><![CDATA[123456789012345678901234567890ab]]></api_password>')
+  end
+  
+  def test_should_send_request_and_parse_response
+    g = TsigApi::Group.new
+    request = g.query
+    stub(request).send_request{@valid_response}
+    content_type, response_hash = g.parse_response(request.send_request)
+    assert_equal content_type, "response"
+    assert_equal response_hash["group_a"], "Group A"
+    assert_equal response_hash["group_b"], "Foo"
+
+    # now we fake an error response
+    stub(request).send_request{@error_response}
+    content_type, response_hash = g.parse_response(request.send_request)
+    assert_equal content_type, "error"
+    assert_equal response_hash["error_code"], "10"
+  end
+    
+end

data/test/tsig_api_message_test.rb

@@ -0,0 +1,167 @@
+require File.join(File.dirname(__FILE__), '/test_helper')
+
+class TsigApiMessageTest < ActiveSupport::TestCase
+  
+  def setup
+    
+    @tsig_message = TsigApi::Message.new("Group A")
+    
+    create_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="message">
+          <element name='success'>1</element>
+          <element name='message_id'>15</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    query_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="message">
+          <element name='success'>1</element>
+          <element name='group'>a</element>
+          <element name='status'>PENDING</element>
+          <element name='date_sent'>2007-08-19 18:50:00</element>
+          <element name='broadcast_type'>team</element>
+          <element name='message'><![CDATA[sending messages is awesome]]></element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    update_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="message">
+          <element name='success'>1</element>
+          <element name='message_id'>15</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    delete_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="message">
+          <element name='success'>1</element>
+          <element name='message_id'>15</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    error_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="error">
+        <item  type="error_description">
+          <element name="error_code">10</element>
+          <element name="error_text"><![CDATA[General Fault]]></element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    create_response = stub("create_response")
+    create_response.body{create_response_xml}
+    query_response = stub("query_response")
+    query_response.body{query_response_xml}
+    update_response = stub("update_response")
+    update_response.body{update_response_xml}
+    delete_response = stub("delete_response")
+    delete_response.body{delete_response_xml}
+    net_error = stub("net_error")
+    net_error.body{error_xml}
+    
+    @valid_create_response = TsigApi::RemoteActions::Response.new(true, create_response)
+    stub(@valid_create_response).body{create_response_xml}
+    @valid_query_response = TsigApi::RemoteActions::Response.new(true, query_response)
+    stub(@valid_query_response).body{query_response_xml}
+    @valid_update_response = TsigApi::RemoteActions::Response.new(true, update_response)
+    stub(@valid_update_response).body{update_response_xml}
+    @valid_delete_response = TsigApi::RemoteActions::Response.new(true, delete_response)
+    stub(@valid_delete_response).body{delete_response_xml}
+    @error_response = TsigApi::RemoteActions::Response.new(true, net_error)
+    stub(@error_response).body{error_xml}
+    
+    @valid_message = {:broadcast_type => "team", :date_sent => Time.now + 3600, :send_now => false, :message => "sending messages is awesome"}
+  end
+  
+  def test_should_initialize_message
+    assert_equal @tsig_message.class, TsigApi::Message
+    assert_equal @tsig_message.class.remote_type, :message
+  end  
+  
+  def test_should_build_create_xml
+    message_hash = @valid_message.merge({:has_contacts => [15], :has_teams => ["Team A"]})
+    request = @tsig_message.create(message_hash)
+    doc = REXML::Document.new(request.body)
+    assert_equal "Team A", REXML::XPath.first(doc, "//param[@name='has_teams']/team").get_text.to_s
+  end
+  
+  def test_should_send_create_request_and_parse_response
+    message_hash = @valid_message.merge({:has_contacts => [15], :has_teams => ["Team A"]})
+    request = @tsig_message.create(message_hash)
+    stub(request).send_request{@valid_create_response}
+    content_type, response_hash = @tsig_message.parse_response(request.send_request)
+    assert_equal content_type, "response"
+    assert_equal response_hash["success"], "1"
+    assert_equal response_hash["message_id"], "15"
+    # now we fake an error response
+    stub(request).send_request{@error_response}
+    content_type, response_hash = @tsig_message.parse_response(request.send_request)
+    assert_equal content_type, "error"
+    assert_equal response_hash["error_code"], "10"
+  end
+    
+  def test_should_send_query_and_parse_response
+    request = @tsig_message.query(:message_id => 15)
+    stub(request).send_request{@valid_query_response}
+    content_type, response_hash = @tsig_message.parse_response(request.send_request)
+    assert_equal "response", content_type
+    assert_equal response_hash["success"], "1"
+    assert_equal response_hash["group"], "a"
+    assert_equal "sending messages is awesome", response_hash["message"]
+  end
+  
+  def test_should_send_delete_and_parse_response
+    request = @tsig_message.delete(15)
+    stub(request).send_request{@valid_delete_response}
+    content_type, response_hash = @tsig_message.parse_response(request.send_request)
+    assert_equal "response", content_type
+    assert_equal response_hash["success"], "1"
+  end
+  
+  def test_should_send_update_request_and_parse_response
+    request = @tsig_message.update(15, :send_now => true)
+    stub(request).send_request{@valid_update_response}
+    content_type, response_hash = @tsig_message.parse_response(request.send_request)
+    assert_equal content_type, "response"
+    assert_equal response_hash["success"], "1"
+    assert_equal response_hash["message_id"], "15"
+  end
+
+  test 'create should return expected params' do
+    request = @tsig_message.create(
+        :broadcast_type => "team",
+        :send_at => '2020-01-02 03:04 PM',
+        :send_now => '0',
+        :message => 'This is a message',
+        :has_teams => [1]
+    )
+    assert_match %r(<param name='group'><!\[CDATA\[Group A\]\]></param>)im, request.body
+    assert_match %r(<param name='broadcast_type'>team</param>)im, request.body
+    assert_match %r(<param name='send_at'>2020-01-02 03:04 PM</param>)im, request.body
+    assert_match %r(<param name='send_now'>false</param>)im, request.body
+    assert_match %r(<param name='message'><!\[CDATA\[This is a message\]\]></param>)im, request.body
+  end
+
+end

data/test/tsig_api_team_test.rb

@@ -0,0 +1,182 @@
+require File.join(File.dirname(__FILE__), '/test_helper')
+
+class TsigApiTeamTest < ActiveSupport::TestCase
+  
+  def setup
+
+    list_response_xml = <<-EOS
+    <?xml version='1.0'?>
+<txtsig_response version="1.0">
+  <content type="response">
+    <item type="team">
+      <element name='success'>
+          true
+      </element>
+      <element name='team_1'>
+          Team One
+      </element>
+      <element name='team_2'>
+          Team Two
+      </element>
+      <element name='team_3'>
+          Team Three
+      </element>
+    </item>
+  </content>
+</txtsig_response>
+    EOS
+
+    create_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="team">
+          <element name="success">1</element>
+          <element name="team_id">15</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    query_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="team">
+          <element name="success">1</element>
+          <element name="group">a</element>
+          <element name="team_name">Excellent Team</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    update_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="team">
+          <element name="success">1</element>
+          <element name="team_id">15</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    delete_response_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="response">
+        <item type="message">
+          <element name='success'>1</element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+    
+    error_xml = <<-EOS
+    <?xml version='1.0'?>
+    <txtsig_response version="1.0">
+      <content type="error">
+        <item  type="error_description">
+          <element name="error_code">10</element>
+          <element name="error_text"><![CDATA[General Fault]]></element>
+        </item>
+      </content>
+    </txtsig_response>
+    EOS
+
+    list_response = stub('list_response')
+    list_response.body(list_response_xml)
+    create_response = stub('create_response')
+    create_response.body(create_response_xml)
+    query_response = stub('query_response')
+    query_response.body(query_response_xml)
+    update_response = stub('update_response')
+    update_response.body(update_response_xml)
+    delete_response = stub('delete_response')
+    delete_response.body(delete_response_xml)
+    error_response = stub('error_response')
+    error_response.body(error_xml)
+
+    @valid_list_response = TsigApi::RemoteActions::Response.new(true, list_response)
+    stub(@valid_list_response).body{list_response_xml}
+    @valid_create_response = TsigApi::RemoteActions::Response.new(true, create_response)
+    stub(@valid_create_response).body{create_response_xml}
+    @valid_query_response = TsigApi::RemoteActions::Response.new(true, query_response)
+    stub(@valid_query_response).body{query_response_xml}
+    @valid_update_response = TsigApi::RemoteActions::Response.new(true, update_response)
+    stub(@valid_update_response).body{update_response_xml}
+    @valid_delete_response = TsigApi::RemoteActions::Response.new(true, delete_response)
+    stub(@valid_delete_response).body{delete_response_xml}
+    @error_response = TsigApi::RemoteActions::Response.new(true, error_response)
+    stub(@error_response).body{error_xml}
+    
+    @tsig_team = TsigApi::Team.new("group a")
+    
+    @valid_team = {:name => "Excellent Team"}
+  end
+  
+  test 'should_initialize_team' do
+    assert_equal @tsig_team.class, TsigApi::Team
+    assert_equal @tsig_team.class.remote_type, :team
+  end  
+  
+  test 'should_build_create_xml' do
+    team_hash = @valid_team.merge({:has_contacts => [1, 2]})
+    request = @tsig_team.create(team_hash)
+    doc = REXML::Document.new(request.body)
+    assert_equal "Excellent Team", REXML::XPath.first(doc, "//param[@name='team_name']").get_text.to_s
+  end
+
+  test 'should_send_list_request_and_parse_response' do
+    request = @tsig_team.list
+    stub(request).send_request{@valid_list_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+
+    assert_equal 'response', content_type
+    assert_equal 3, response_hash.select{|k,v| k =~ /^team_\d/}.size
+    assert_equal 'Team One', response_hash['team_1']
+  end
+
+  test 'should_send_create_request_and_parse_response' do
+    team_hash = @valid_team.merge({:has_contacts => [1, 2]})
+    request = @tsig_team.create(team_hash)
+    stub(request).send_request{@valid_create_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+    assert_equal content_type, "response"
+    assert_equal response_hash["success"], "1"
+    assert_equal response_hash["team_id"], "15"
+    # now we fake an error response
+    stub(request).send_request{@error_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+    assert_equal content_type, "error"
+    assert_equal response_hash["error_code"], "10"
+  end
+    
+  test 'should_send_query_and_parse_response' do
+    request = @tsig_team.query(:team_id => 15)
+    stub(request).send_request{@valid_query_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+    assert_equal "response", content_type
+    assert_equal response_hash["success"], "1"
+    assert_equal "Excellent Team", response_hash["team_name"]
+  end
+  
+  test 'should_send_delete_and_parse_response' do
+    request = @tsig_team.delete(15)
+    stub(request).send_request{@valid_delete_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+    assert_equal "response", content_type
+    assert_equal response_hash["success"], "1"
+  end
+  
+  test 'should_send_update_request_and_parse_response' do
+    request = @tsig_team.update(15, {:name => "Woo"})
+    stub(request).send_request{@valid_query_response}
+    content_type, response_hash = @tsig_team.parse_response(request.send_request)
+    assert_equal content_type, "response"
+    assert_equal response_hash["success"], "1"
+  end
+
+end

data/test/tsig_api_test.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '/test_helper')
+
+class TsigApiTest < ActiveSupport::TestCase
+
+  def test_text_from_flash
+    str = "
+    <div id=\\'error-message-container\\'><div class=\\'flash error\\'>
+    <a class=\\\"float-right small-text\\\" href=\\\"#\\\" onclick=\\\"hideErrorMessage(); return false;\\\">[Hide this]</a>
+    <div class=\\\"message-title\\\"><span class=\\\"error-icon\\\">!</span></div>
+    <div class=\\\"message-contents\\\">Please correct the following error(s):
+    <ul><li>Please make one or more selections for Teams.</li></ul></div>
+    <div class=\\\"clear\\\">&nbsp;</div></div></div>
+    "
+    assert_equal ['Please make one or more selections for Teams.'], TsigApi::text_from_flash(str)
+
+    str = "
+    <div id=\\'error-message-container\\'><div class=\\'flash error\\'>
+    <a class=\\\"float-right small-text\\\" href=\\\"#\\\" onclick=\\\"hideErrorMessage(); return false;\\\">[Hide this]</a>
+    <div class=\\\"message-title\\\"><span class=\\\"error-icon\\\">!</span></div>
+    <div class=\\\"message-contents\\\">Please correct the following error(s):
+    <ul><li>First message</li> <li>Second message</li>
+    <li>Third</li></ul></div>
+    <div class=\\\"clear\\\">&nbsp;</div></div></div>
+    "
+    assert_equal ['First message', 'Second message', 'Third'], TsigApi::text_from_flash(str)
+
+    str = "
+    <div id=\\'error-message-container\\'><div class=\\'flash error\\'>
+    <a class=\\\"float-right small-text\\\" href=\\\"#\\\" onclick=\\\"hideErrorMessage(); return false;\\\">[Hide this]</a>
+    <div class=\\\"message-title\\\"><span class=\\\"error-icon\\\">!</span></div>
+    <div class=\\\"message-contents\\\">Please correct the following error(s):</div>
+    <div class=\\\"clear\\\">&nbsp;</div></div></div>
+    "
+    assert_equal [], TsigApi::text_from_flash(str)
+  end
+
+end