siffer 0.0.4

data/spec/messaging_spec.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+# The messaging is best tested doing a full request/response
+# cycle using both Server and Agent components
+
+[Siffer::Server, Siffer::Agent].each do |component|
+  
+  # Stage the component a little bit:
+  #    Agents require Servers
+  #    Both require central-admin 
+  component = component.new("admin" => 'none', "servers" => '')
+  msg = Siffer::Messages::Message.new("source")
+  msg.content do |xml|
+    xml.SIF_BogusType
+  end
+  
+  describe component, "Messaging - response" do
+    it "should always return Ack for proper SIF_Messages" do
+      for_every_path(:on => component, :input => msg) do |res|
+        res.body.should match(/SIF_Ack/)
+      end
+    end
+  end
+  
+  describe component, "Messaging - content-type" do
+    it "should always respond with application/xml" do
+      for_every_path(:on => component, :input => msg) do |res|
+        res.content_type.should == Siffer::Messaging::MIME_TYPES["appxml"]
+      end
+    end
+    
+    it "should only receive application/xml" do
+      for_every_path(:on => component,"CONTENT_TYPE" => "x") do |res|
+        res.should be_client_error
+        res.status.should == 406
+      end
+    end
+  end
+  
+  describe component, "Messaging - validation" do
+    
+    it "should return Xml Error code for bad message (xml)" do
+      %w[<Junk>>>> <Junk> </Junk> Junk !@ex].each do |msg|
+        for_every_path(:on => component, :input => msg) do |res|
+          res.body.should match(/SIF_Error/)
+          res.body.should match(/SIF_Category>1<\/SIF_Category/)
+          res.body.should match(/SIF_Code>2<\/SIF_Code>/)
+          res.body.should match(/Message is not well-formed/)
+          # spec says Oringals should be included and empty
+          res.body.should match(/SIF_OriginalSourceId\s*\/>/)
+          res.body.should match(/SIF_OriginalMsgId\s*\/>/)
+        end
+      end
+    end
+    
+    it "should validaate message is SIF_Message" do
+      msg = "<someotherkind><of>XML</of></someotherkind>"
+      for_every_path(:on => component, :input => msg) do |res|
+        res.body.should match(/SIF_Category>12/)
+        res.body.should match(/SIF_Code>2/)
+      end
+    end
+    
+    it "should validate message xmlns" do
+      msg = Siffer::Messages::Register.new(
+                                      "bad-xmlns",
+                                      component.name,
+                                      :xmlns => 'http://bogus.xmlns')
+      for_every_path(:on => component, :input => msg) do |res|
+        res.body.should match(/SIF_Category>1<\/SIF_Category/)
+        res.body.should match(/SIF_Code>4<\/SIF_Code/)
+        res.body.should match(/SIF_ExtendedDesc>XMLNS not compatible with SIF/)
+      end
+    end
+    
+    it "should validate SIF version" do
+      msg = Siffer::Messages::Register.new(
+                                      "bad-version", 
+                                      component.name, 
+                                      :version => '99.99')
+      for_every_path(:on => component, :input => msg) do |res|
+        res.body.should match(/SIF_Category>12<\/SIF_Category/)
+        res.body.should match(/SIF_Code>3<\/SIF_Code>/)
+      end
+    end
+  end
+
+end

data/spec/protocol_spec.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+[Siffer::Server, Siffer::Agent].each do |component|
+  
+  # Stage the component a little bit:
+  #    Agents require Servers
+  #    Both require central-admin 
+  component = component.new("admin" => 'none', "servers" => '')
+  # setup messages to use for mock requests 
+  ping = "<SIF_Message><SIF_SystemControl><SIF_Ping /></SIF_SystemControl></SIF_Message>"
+  status = "<SIF_Message><SIF_SystemControl><SIF_Status /></SIF_SystemControl></SIF_Message>"
+  register = "<SIF_Message><SIF_Register /></SIF_Message>"
+
+  describe component, "Protocol - /unknown_path" do
+    it "should return 404" do
+      res = Rack::MockRequest.new(component).post("/bad_path")
+      res.should be_not_found
+    end
+  end
+  
+  describe component, "Protocol - Accepted Paths" do
+    it "should only allow POST method" do
+      Siffer::Protocol::ACCEPTABLE_PATHS.each do |name,path|
+        res = Rack::MockRequest.new(component).get(path)
+        res.should be_client_error
+      end
+    end
+    
+    it "should be identified by predicate through body" do
+      Siffer::Protocol::ACCEPTABLE_PATHS.each do |name,path|
+        unless name == :root
+          component.call({"rack.input" => eval(name.to_s)})
+          component.should eval("be_#{name.to_s}")
+        end
+      end
+    end
+    
+    it "should be identified by predicate through path-info" do
+      Siffer::Protocol::ACCEPTABLE_PATHS.each do |name,path|
+        unless name == :root
+          component.call({
+            "rack.input" => "<SIF_Message><SIF_#{name.to_s} /></SIF_Message>", 
+            "PATH_INFO" => path})
+          component.should eval("be_#{name.to_s}")
+        end
+      end
+    end
+  end
+end

data/spec/registration_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+# Registration is best tested through the Siffer::Server component
+
+describe Siffer::Registration do
+  
+  before(:each) do
+    @server = Siffer::Server.new("admin" => "none")
+  end
+  
+  it "should determine agent registration" do
+    @server.registered?("Default Agent").should be_false
+    @server.agents["Default Agent"] = "http://localhost"
+    @server.registered?("Default Agent").should be_true
+  end
+  
+  it "should return not registered message for non-registered agents" do
+    msg = Siffer::Messages::Message.new("Default Agent")
+    msg.content do |xml|
+      xml.SIF_Ping
+    end
+    res = Rack::MockRequest.new(@server).post("/",:input => msg)
+    res.body.should match(/SIF_Category>4/)
+    res.body.should match(/SIF_Code>9/)
+  end
+  
+  it "should return ACL for successful registration" do
+    msg = Siffer::Messages::Register.new("Default Agent", "Default Agent")
+    res = Rack::MockRequest.new(@server).post("/",:input => msg)
+    res.body.should match(/SIF_Ack/)
+    res.body.should match(/SIF_Status/)
+  end
+end

data/spec/request_logger_spec.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Siffer::RequestLogger do
+  msg = "<SIF_Message><SIF_SystemControl><SIF_Ping /></SIF_SystemControl></SIF_Message>"
+
+  it "should log requests" do
+    log = []
+    app = Rack::Builder.new do
+      use Siffer::RequestLogger, log
+      run Siffer::Server.new("admin" => "none")
+    end
+    res = Rack::MockRequest.new(app).post("/", :input => msg)
+    log.size.should == 1
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Siffer::Request do  
+  it "should provide access to the body as a SIF_Message (Siffer::Message)" do
+    msg = Siffer::Messages::Register.new("register-source","source-name")
+    request = Siffer::Request.new('rack.input' => msg)
+    request.message.type.should == "Register"
+    request.message.source_id.should == "register-source"
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+require 'webrick'
+
+Thread.abort_on_exception = true
+
+describe Siffer::Response do
+  it "should default content-type to application/xml" do
+    response = Siffer::Response.new()
+    response.content_type.should == Siffer::Messaging::MIME_TYPES["appxml"]
+  end
+  
+  it "should receive response from url,data" do
+    with_fake_server do |url|
+      response = Siffer::Response.from(url,"Hello World")
+      response.should be_successful
+      response.body.each { |line| line.should == "Hello World" }  
+    end
+  end
+  
+  it "should return 500 for bad url" do
+    response = Siffer::Response.from("http://localhost:9999","Hello World")
+    response.should be_server_error
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Siffer::Server do  
+  it "should instantiate with default host, port, name, min_buffer" do
+    server = Siffer::Server.new("admin" => 'none')
+    server.host.should == "localhost"
+    server.port.should == 8300
+    server.name.should == "Default Server"
+    server.min_buffer.should == 1024
+  end
+  
+  it "should allow defaults to be overriden" do
+    server = Siffer::Server.new("admin" => 'none',
+                                "name" => "name", 
+                                "host" => "test", 
+                                "port" => 222,
+                                "min_buffer" => 2048)
+    server.host.should == "test"
+    server.port.should == 222
+    server.name.should == "name"
+    server.min_buffer.should == 2048
+  end
+  
+  it "should require an admin URL" do
+    lambda {
+      server = Siffer::Server.new
+    }.should raise_error("Administration URL required")
+  end
+  
+  it "should respond to uri" do
+    server = Siffer::Server.new("admin" => 'none')
+    server.uri.should == "http://localhost:8300"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__),"..", "lib","siffer")
+require 'spec'
+
+# Configures a WEBrick server and yields URL. When passed a block
+# starts and stops the server for the context. It returns what it 
+# receives from the request.
+def with_fake_server(app = nil)
+  fake_app = app || lambda { |env| [200,{},env["rack.input"].read] }
+  server = WEBrick::HTTPServer.new(:Host => '0.0.0.0',:Port => 9202)
+  server.mount "/", Rack::Handler::WEBrick, fake_app
+  Thread.new { server.start }
+  trap(:INT) { server.shutdown }
+  yield "http://localhost:9202/" if block_given?
+  server.shutdown
+end
+
+# Helper method to iterate all of the ACCEPTABLE_PATHS
+# on the specified component(Server/Agent). Yields
+# the Response object for each Request.
+def for_every_path(options = {}, &block)
+  component = options.delete(:on)
+  Siffer::Protocol::ACCEPTABLE_PATHS.each do |name,path|
+    res = Rack::MockRequest.new(component).post(path,options)
+    yield res
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: siffer
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Clint Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: clint.hill@h3osoftware.com
+executables: 
+- siffer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- spec/agent_spec.rb
+- spec/cli_spec.rb
+- spec/container_spec.rb
+- spec/default_agent
+- spec/default_server
+- spec/message_specs
+- spec/message_specs/ack_spec.rb
+- spec/message_specs/error_spec.rb
+- spec/message_specs/header_spec.rb
+- spec/message_specs/message_spec.rb
+- spec/message_specs/register_spec.rb
+- spec/message_specs/request_body_spec.rb
+- spec/message_specs/status_spec.rb
+- spec/messaging_spec.rb
+- spec/protocol_spec.rb
+- spec/registration_spec.rb
+- spec/request_logger_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+- lib/agent.rb
+- lib/container.rb
+- lib/messages
+- lib/messages/ack.rb
+- lib/messages/acl.rb
+- lib/messages/error.rb
+- lib/messages/message.rb
+- lib/messages/register.rb
+- lib/messages/request_body.rb
+- lib/messages/status.rb
+- lib/messages.rb
+- lib/messaging.rb
+- lib/protocol.rb
+- lib/registration.rb
+- lib/request.rb
+- lib/request_logger.rb
+- lib/response.rb
+- lib/server.rb
+- lib/siffer.rb
+- doc/rdoc
+- doc/rdoc/classes
+- doc/rdoc/classes/Siffer
+- doc/rdoc/classes/Siffer/Agent.html
+- doc/rdoc/classes/Siffer/Container.html
+- doc/rdoc/classes/Siffer/Messages
+- doc/rdoc/classes/Siffer/Messages/Ack.html
+- doc/rdoc/classes/Siffer/Messages/Acl.html
+- doc/rdoc/classes/Siffer/Messages/Error.html
+- doc/rdoc/classes/Siffer/Messages/Message
+- doc/rdoc/classes/Siffer/Messages/Message/Header.html
+- doc/rdoc/classes/Siffer/Messages/Message.html
+- doc/rdoc/classes/Siffer/Messages/Register.html
+- doc/rdoc/classes/Siffer/Messages/RequestBody.html
+- doc/rdoc/classes/Siffer/Messages/Status.html
+- doc/rdoc/classes/Siffer/Messages.html
+- doc/rdoc/classes/Siffer/Messaging.html
+- doc/rdoc/classes/Siffer/Protocol
+- doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html
+- doc/rdoc/classes/Siffer/Protocol/UnknownPath.html
+- doc/rdoc/classes/Siffer/Protocol.html
+- doc/rdoc/classes/Siffer/Registration.html
+- doc/rdoc/classes/Siffer/Request.html
+- doc/rdoc/classes/Siffer/RequestLogger.html
+- doc/rdoc/classes/Siffer/Response.html
+- doc/rdoc/classes/Siffer/Server.html
+- doc/rdoc/classes/Siffer.html
+- doc/rdoc/created.rid
+- doc/rdoc/files
+- doc/rdoc/files/lib
+- doc/rdoc/files/lib/agent_rb.html
+- doc/rdoc/files/lib/container_rb.html
+- doc/rdoc/files/lib/messages
+- doc/rdoc/files/lib/messages/ack_rb.html
+- doc/rdoc/files/lib/messages/acl_rb.html
+- doc/rdoc/files/lib/messages/error_rb.html
+- doc/rdoc/files/lib/messages/message_rb.html
+- doc/rdoc/files/lib/messages/register_rb.html
+- doc/rdoc/files/lib/messages/request_body_rb.html
+- doc/rdoc/files/lib/messages/status_rb.html
+- doc/rdoc/files/lib/messages_rb.html
+- doc/rdoc/files/lib/messaging_rb.html
+- doc/rdoc/files/lib/protocol_rb.html
+- doc/rdoc/files/lib/registration_rb.html
+- doc/rdoc/files/lib/request_logger_rb.html
+- doc/rdoc/files/lib/request_rb.html
+- doc/rdoc/files/lib/response_rb.html
+- doc/rdoc/files/lib/server_rb.html
+- doc/rdoc/files/lib/siffer_rb.html
+- doc/rdoc/files/LICENSE.html
+- doc/rdoc/files/README_rdoc.html
+- doc/rdoc/fr_class_index.html
+- doc/rdoc/fr_file_index.html
+- doc/rdoc/fr_method_index.html
+- doc/rdoc/index.html
+- doc/rdoc/rdoc-style.css
+- doc/SIF ImplementationSpecification.pdf
+has_rdoc: false
+homepage: http://h3osoftware.com/siffer
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: siffer
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Siffer - School Interoperability Framework by h3o(software)
+test_files: []
+