cpi-event-connector 0.0.15 → 0.1.0

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    cpi-event-connector (0.0.14)
+    cpi-event-connector (0.0.15)
       activesupport (~> 3)
       bunny (~> 0.8.0)
+      nokogiri (~> 1.5)
       uuidtools (~> 2.1.2)
 
 GEM
@@ -18,6 +19,7 @@ GEM
     i18n (0.6.0)
     justinf-unification_assertion (0.0.2)
     multi_json (1.3.6)
+    nokogiri (1.5.5)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)

data/cpi-event-connector.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "cpi_event_connector/version"
+require "cpi/version"
 
 Gem::Specification.new do |s|
   s.name        = "cpi-event-connector"
@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "bunny", "~> 0.8.0"
   s.add_runtime_dependency "activesupport", "~> 3"
   s.add_runtime_dependency "uuidtools", "~> 2.1.2"
+  s.add_runtime_dependency "nokogiri", "~> 1.5"
 end

data/lib/{cpi_event_connector → cpi}/connector.rb

@@ -22,7 +22,7 @@ module Cpi
       end
     end
 
-    def connectivity_test
+    def test_connectivity
       @started = false
       start
       "Event Connector can connect to AMQP server at #{@params[:host]}:#{@params[:port]}"

data/lib/cpi/event.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/string'
+require 'nokogiri'
+
+module Cpi
+  class Event
+    def initialize(xml)
+      @xml_doc = parse_xml(xml)
+    end
+
+    def event_type
+      @xml_doc.xpath('//header/event_type').text
+    end
+
+    def source_tenant_uid
+      @xml_doc.xpath('//header/source_tenant').text
+    end
+
+    def event_uid
+      nil_if_blank(@xml_doc.xpath('//header/event_uid').text)
+    end
+
+    def queue
+      nil_if_blank(@xml_doc.xpath('//header/queue').text)
+    end
+
+    private
+
+    def nil_if_blank(str)
+      str.blank? ? nil : str
+    end
+
+    def parse_xml(xml)
+      Nokogiri::XML(xml) do |config|
+        config.strict
+      end
+    end
+  end
+end

data/lib/{cpi_event_connector/event.rb → cpi/event_connector.rb}

@@ -3,7 +3,7 @@ require 'active_support/core_ext/string'
 module Cpi
   THREAD_LOCAL_VARIABLE = :cpi_connector
 
-  class Event
+  class EventConnector
     class << self
       attr_accessor :connection_params
       attr_accessor :logger
@@ -19,25 +19,43 @@ module Cpi
       self.connection_params = params
     end
 
-    def self.transmit(event_type, tenant_uid, root_path, options=nil)
+    def self.transmit(event_type, tenant_uid, content, options=nil)
+      options ||= {}
       if !@enabled
         @logger.debug "Aborting transmit because CPI Event Connector not enabled"
         return
       end
       raise ArgumentError, "Tenant UID must be specified" if tenant_uid.blank?
 
-      event_json = Cpi::Generator.create_event(event_type, tenant_uid, root_path)
+      event_json = Generator.create_event(event_type, tenant_uid, content, options.delete(:uid))
       @logger.debug "Transmitting message '#{event_json}'"
       self.connector.transmit(event_json, options)
       @logger.debug "Transmission complete"
     end
 
-    def self.connectivity_test
+    # This method expects a routing header to be present in the xml document
+    #
+    # <cpi_event>
+    #   <header>
+    #     <event_uid>unique_id</event_uid> - optional
+    #     <event_type>type</event_type>
+    #     <source_tenant>tenant_uid</source_tenant>
+    #     <queue>system_queue_name</queue> - optional
+    #   </header>
+    #   <content>some content</content>
+    # </cpi_event>
+    def self.send_event(xml)
+      d = Event.new(xml)
+
+      transmit(d.event_type, d.source_tenant_uid, xml, {:queue => d.queue, :uid => d.event_uid})
+    end
+
+    def self.test_connectivity
       if !@enabled
         return 'Event Connector is not enabled.'
       end
 
-      self.connector.connectivity_test
+      self.connector.test_connectivity
     end
 
     private

data/lib/{cpi_event_connector → cpi}/generator.rb

@@ -3,9 +3,8 @@ require 'uuidtools'
 
 module Cpi
   class Generator
-
-    def self.create_event(event_type, tenant_uid, content)
-      uid = UUIDTools::UUID.timestamp_create().to_s
+    def self.create_event(event_type, tenant_uid, content, uid=nil)
+      uid ||= UUIDTools::UUID.timestamp_create().to_s
 
       hash = {"event_type" => event_type, "tenant" => tenant_uid, "content" => content, "uid" => uid}
 

data/lib/cpi/version.rb

@@ -0,0 +1,3 @@
+module Cpi
+  VERSION = "0.1.0"
+end

data/lib/cpi_event_connector.rb

@@ -1,7 +1,5 @@
-require "cpi_event_connector/version"
-require "cpi_event_connector/generator"
-require "cpi_event_connector/connector"
-require "cpi_event_connector/event"
-
-module Cpi
-end
+require "cpi/version"
+require "cpi/generator"
+require "cpi/connector"
+require "cpi/event"
+require "cpi/event_connector"

data/spec/connector_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require_relative '../lib/cpi_event_connector/connector'
+require_relative '../lib/cpi/connector'
 require 'bunny'
 
 describe Cpi::Connector do

data/spec/event_connector_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+require_relative '../lib/cpi/event_connector'
+require 'active_support'
+require 'unification_assertion'
+
+describe Cpi::EventConnector do
+  let(:config) { { :enabled => true, :key => "value" } }
+  let(:logger) { stub("Logger", debug: nil, info: nil) }
+  let(:real_config) { {
+      host: "localhost",
+      port: "5672",
+      username: "guest",
+      password: "guest",
+      queue: "connector-test",
+      enabled: "true"
+    } }
+
+  describe ".configure" do
+    let(:connector) { double(Cpi::Connector) }
+
+    it "accepts a hash of connection information" do
+      Cpi::EventConnector.configure(config)
+
+      Cpi::EventConnector.connection_params.should == { :key => "value" }
+    end
+
+    it "accepts a logger and sets it as a class variable" do
+      Cpi::EventConnector.configure({}, logger)
+
+      Cpi::EventConnector.logger.should == logger
+    end
+  end
+
+  describe "acceptance tests" do
+    let(:content) { "<test />" }
+
+    before do
+      Cpi::EventConnector.configure(real_config)
+    end
+
+    it "transmit generates and sends an event" do
+      Cpi::EventConnector.transmit("shipment_shipped", "stuff", content)
+
+      h = get_event_from_rabbimq("connector-test")
+
+      h.should unify({"event_type" => "shipment_shipped", "tenant" => "stuff", "content" => content, "uid" => :_x})
+    end
+
+    it "send_event does not require a uid or a queue in the routing envelope" do
+      xml = <<-XML
+<cpi_event>
+  <header>
+    <event_type>type</event_type>
+    <source_tenant>tenant_uid</source_tenant>
+  </header>
+  <content>some content</content>
+</cpi_event>
+      XML
+      Cpi::EventConnector.send_event(xml)
+
+      h = get_event_from_rabbimq("connector-test")
+      h.should unify({"event_type" => "type", "tenant" => "tenant_uid", "content" => xml, "uid" => :_x})
+    end
+
+    it "send_event generates and sends an event" do
+      xml = <<-XML
+<cpi_event>
+  <header>
+    <event_uid>unique_id</event_uid>
+    <event_type>type</event_type>
+    <source_tenant>tenant_uid</source_tenant>
+    <queue>system_queue_name</queue>
+  </header>
+  <content>some content</content>
+</cpi_event>
+      XML
+      Cpi::EventConnector.send_event(xml)
+
+      h = get_event_from_rabbimq("system_queue_name")
+      h.should unify({"event_type" => "type", "tenant" => "tenant_uid", "content" => xml, "uid" => 'unique_id'})
+    end
+  end
+
+  def get_event_from_rabbimq(queue)
+    b = Bunny.new
+    b.start
+    q = b.queue(queue, :durable => true)
+    message = q.pop
+    return nil if message[:payload] == :queue_empty
+    h = ActiveSupport::JSON.decode(message[:payload])
+    b.stop
+    h
+  end
+
+  describe ".transmit" do
+    it "creates a connection for each thread" do
+      Cpi::EventConnector.configure(config)
+      connector1 = double("connector 1")
+      connector2 = double("connector 2")
+      Cpi::Connector.stub(:new).and_return(connector1, connector2)
+
+      connector1.should_receive(:transmit)
+      connector2.should_receive(:transmit)
+
+      Thread.new do
+        Cpi::EventConnector.transmit("message", "tenant_uid", "content")
+      end.join
+
+      Thread.new do
+        Cpi::EventConnector.transmit("message", "tenant_uid", "content")
+      end.join
+    end
+
+    it "does not transmit when it is not enabled" do
+      Cpi::EventConnector.configure({enabled: false})
+      Cpi::Generator.should_not_receive(:create_event)
+      # And there shouldn't be an exception
+
+      Cpi::EventConnector.transmit("message", "tenant_uid", "content")
+    end
+
+    it "does nothing when called before being configured" do
+      Cpi::EventConnector.logger = stub(debug: nil)
+      Cpi::Generator.should_not_receive(:create_event)
+      Cpi::EventConnector.transmit("message", "tenant_uid", "content")
+    end
+
+    it "raises exception when no tenant_uid is passed in" do
+      Cpi::EventConnector.configure(config)
+      Cpi::Generator.should_not_receive(:create_event)
+      expect {Cpi::EventConnector.transmit("message", nil, "content")}.to raise_error(ArgumentError)
+    end
+  end
+
+  describe ".test_connectivity" do
+    it "tells you when the connector is not enabled" do
+      Cpi::EventConnector.configure({enabled: false})
+      Cpi::EventConnector.test_connectivity.should == 'Event Connector is not enabled.'
+    end
+
+    it "tells you when the connection params are correct" do
+      Cpi::EventConnector.configure(real_config)
+      Cpi::EventConnector.test_connectivity.should == 'Event Connector can connect to AMQP server at localhost:5672'
+    end
+
+    it "returns false when the connection params are incorrect" do
+      real_config[:host] = "doesntwork"
+      Cpi::EventConnector.configure(real_config)
+      Cpi::EventConnector.test_connectivity.should == "getaddrinfo: Name or service not known"
+    end
+  end
+end

data/spec/event_spec.rb

@@ -1,112 +1,48 @@
-require 'spec_helper'
-require_relative '../lib/cpi_event_connector'
-require 'active_support'
-require 'unification_assertion'
+require_relative '../lib/cpi/event'
 
 describe Cpi::Event do
-  let(:config) { { :enabled => true, :key => "value" } }
-  let(:logger) { stub("Logger", debug: nil, info: nil) }
-  let(:real_config) { {
-      host: "localhost",
-      port: "5672",
-      username: "guest",
-      password: "guest",
-      queue: "connector-test",
-      enabled: "true"
-    } }
 
-  describe ".configure" do
-    let(:connector) { double(Cpi::Connector) }
-
-    it "accepts a hash of connection information" do
-      Cpi::Event.configure(config)
-
-      Cpi::Event.connection_params.should == { :key => "value" }
-    end
-
-    it "accepts a logger and sets it as a class variable" do
-      Cpi::Event.configure({}, logger)
-
-      Cpi::Event.logger.should == logger
-    end
+  let(:xml) do
+    <<-XML
+<cpi_event>
+  <header>
+    <event_uid>unique_id</event_uid>
+    <event_type>type</event_type>
+    <source_tenant>tenant_uid</source_tenant>
+    <queue>system_queue_name</queue>
+  </header>
+  <content>some content</content>
+</cpi_event>
+    XML
   end
 
-  describe ".transmit" do
-    
-    let(:content) { "<test />" }
+  let(:doc) { Cpi::Event.new(xml) }
 
-    it "generates and sends an event" do
-      Cpi::Event.configure(real_config)
-
-      Cpi::Event.transmit("shipment_shipped", "stuff", content)
-
-      b = Bunny.new
-      b.start
-      q = b.queue("connector-test", :durable => true)
-      message = q.pop
-      h = ActiveSupport::JSON.decode(message[:payload])
-      b.stop
-
-      h.should unify({"event_type" => "shipment_shipped", "tenant" => "stuff", "content" => content, "uid" => :_x})
-    end
-
-    it "creates a connection for each thread" do
-      Cpi::Event.configure(config)
-
-      connector1 = double("connector 1")
-      connector2 = double("connector 2")
-      Cpi::Connector.stub(:new).and_return(connector1, connector2)
-
-      connector1.should_receive(:transmit)
-      connector2.should_receive(:transmit)
-
-      Thread.new do
-        Cpi::Event.transmit("message", "tenant_uid", "content")
-      end.join
-
-      Thread.new do
-        Cpi::Event.transmit("message", "tenant_uid", "content")
-      end.join
-    end
-
-    it "does not transmit when it is not enabled" do
-      real_config[:enabled] = false
-
-      Cpi::Event.configure(real_config)
-      Cpi::Generator.should_not_receive(:create_event)
-      # And there shouldn't be an exception
-
-      Cpi::Event.transmit("message", "tenant_uid", "content")
+  describe "source_tenant_uid" do
+    it "get extracted" do
+      doc.source_tenant_uid.should == 'tenant_uid'
     end
+  end
 
-    it "does nothing when called before being configured" do
-      Cpi::Event.logger = stub(debug: nil)
-      Cpi::Generator.should_not_receive(:create_event)
-      Cpi::Event.transmit("message", "tenant_uid", "content")
+  describe "queue" do
+    it "get extracted" do
+      doc.queue.should == 'system_queue_name'
     end
 
-    it "raises exception when no tenant_uid is passed in" do
-      Cpi::Event.configure(real_config)
-      Cpi::Generator.should_not_receive(:create_event)
-      expect {Cpi::Event.transmit("message", nil, "content")}.to raise_error(ArgumentError)
+    it "is nil when not present" do
+      doc = Cpi::Event.new('')
+      doc.queue.should be_nil
     end
   end
-
-  describe ".connectivity_test" do
-    it "tells you when the connector is not enabled" do
-      Cpi::Event.configure({enabled: false})
-      Cpi::Event.connectivity_test.should == 'Event Connector is not enabled.'
-    end
-
-    it "tells you when the connection params are correct" do
-      Cpi::Event.configure(real_config)
-      Cpi::Event.connectivity_test.should == 'Event Connector can connect to AMQP server at localhost:5672'
+  
+  describe "uid" do
+    it "get extracted" do
+      doc.event_uid.should == 'unique_id'
     end
 
-    it "returns false when the connection params are incorrect" do
-      real_config[:host] = "doesntwork"
-      Cpi::Event.configure(real_config)
-      Cpi::Event.connectivity_test.should == "getaddrinfo: Name or service not known"
+    it "is nil when not present" do
+      doc = Cpi::Event.new('')
+      doc.event_uid.should be_nil
     end
   end
 end

data/spec/generator_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 require 'backports'
-require_relative '../lib/cpi_event_connector/generator'
+require_relative '../lib/cpi/generator'
 require 'active_support'
 
 describe Cpi::Generator do
@@ -21,10 +21,17 @@ describe Cpi::Generator do
     result["uid"].should_not be_nil
   end
 
-  it "generates a different uid for each event" do
+  it "generates a different default uid for each event" do
     event1 = ActiveSupport::JSON.decode(Cpi::Generator.create_event(event_type, tenant_uid, content))
     event2 = ActiveSupport::JSON.decode(Cpi::Generator.create_event(event_type, tenant_uid, content))
 
     event1["uid"].should_not == event2["uid"]
   end
+
+  it "allows the uid to be specified" do
+    event = Cpi::Generator.create_event(event_type, tenant_uid, content, 'specified')
+
+    result = ActiveSupport::JSON.decode(event)
+    result["uid"].should == 'specified'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpi-event-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -107,6 +107,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: see summary
 email:
 - engineering@nulogy.com
@@ -119,12 +135,14 @@ files:
 - Gemfile.lock
 - Rakefile
 - cpi-event-connector.gemspec
+- lib/cpi/connector.rb
+- lib/cpi/event.rb
+- lib/cpi/event_connector.rb
+- lib/cpi/generator.rb
+- lib/cpi/version.rb
 - lib/cpi_event_connector.rb
-- lib/cpi_event_connector/connector.rb
-- lib/cpi_event_connector/event.rb
-- lib/cpi_event_connector/generator.rb
-- lib/cpi_event_connector/version.rb
 - spec/connector_spec.rb
+- spec/event_connector_spec.rb
 - spec/event_spec.rb
 - spec/generator_spec.rb
 - spec/integration_spec.rb

data/lib/cpi_event_connector/version.rb

@@ -1,3 +0,0 @@
-module Cpi
-  VERSION = "0.0.15"
-end