cpi-event-connector 0.3.0 → 0.4.0

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in cpi-event-connector.gemspec
 gemspec

data/Gemfile.lock

@@ -1,25 +1,24 @@
 PATH
   remote: .
   specs:
-    cpi-event-connector (0.2.0)
-      activesupport (~> 3)
+    cpi-event-connector (0.3.0)
+      activesupport (~> 3.0)
       bunny (~> 0.8.0)
       nokogiri (~> 1.5)
       uuidtools (~> 2.1.2)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.8)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
-    backports (2.5.1)
     bunny (0.8.0)
     diff-lcs (1.1.3)
-    i18n (0.6.0)
+    i18n (0.6.1)
     justinf-unification_assertion (0.0.2)
-    multi_json (1.3.6)
-    nokogiri (1.5.5)
+    multi_json (1.7.6)
+    nokogiri (1.5.9)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -28,13 +27,12 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    uuidtools (2.1.3)
+    uuidtools (2.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  backports
   cpi-event-connector!
   justinf-unification_assertion
   rspec

data/README.md

@@ -0,0 +1,66 @@
+Cpi Event Connector
+===================
+
+A library that allows applications to easily send events to CPI.
+
+Usage
+-----
+
+Configure the Event Connector like so:
+
+```ruby
+require 'cpi_event_connector'
+require 'yaml'
+
+config_file = File.join(Rails.root, "config", "cpi_event_connector.yml")
+params = {:enabled => false}
+if File.exists?(config_file)
+  params.merge! YAML::load_file(config_file).symbolize_keys!
+end
+Cpi::EventConnector.configure(params)
+```
+
+With a YAML file that looks like this:
+
+```ruby
+# RabbitMQ connection settings
+# When connecting to an unsecured localhost, you actually don't need any of these
+host: localhost
+port: 5672
+user: guest
+password: guest
+
+# Cpi Event Connector settings
+enabled: false
+queue: 'net.nulogy.cpi.events.development'
+```
+
+And then send events like so:
+
+
+```ruby
+event = Cpi::Event.new(
+  event_uid: 'unique_id', 
+  event_type: 'type', 
+  source_tenant_uid: 'tenant_uid', 
+  content: 'some content')
+Cpi::EventConnector.send_event(event, :queue => 'system_queue_name')
+```
+Note that the queue parameter is optional if it was specified in the YAML config.
+
+Or with raw xml like so:
+
+```ruby
+xml = <<-XML
+<cpi_event>
+  <header>
+    <event_uid>unique_id</event_uid>
+    <event_type>type</event_type>
+    <source_tenant_uid>tenant_uid</source_tenant_uid>
+  </header>
+  <content>some content</content>
+</cpi_event>
+XML
+Cpi::EventConnector.send_event_xml(xml, :queue => 'system_queue_name')
+```
+

data/cpi-event-connector.gemspec

@@ -18,11 +18,10 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
-  s.add_development_dependency "backports"
   s.add_development_dependency "justinf-unification_assertion"
 
   s.add_runtime_dependency "bunny", "~> 0.8.0"
-  s.add_runtime_dependency "activesupport", "~> 3"
+  s.add_runtime_dependency "activesupport", "~> 3.0"
   s.add_runtime_dependency "uuidtools", "~> 2.1.2"
   s.add_runtime_dependency "nokogiri", "~> 1.5"
 end

data/lib/cpi/event.rb

@@ -2,21 +2,17 @@ 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
+  module EventParser
+    extend self
 
-    def source_tenant_uid
-      @xml_doc.xpath('//header/source_tenant_uid').text
-    end
-
-    def event_uid
-      nil_if_blank(@xml_doc.xpath('//header/event_uid').text)
+    def parse(xml)
+      xml_doc = parse_xml(xml)
+      attrs = {
+        event_type: xml_doc.xpath('//header/event_type').text,
+        source_tenant_uid: xml_doc.xpath('//header/source_tenant_uid').text,
+        event_uid: nil_if_blank(xml_doc.xpath('//header/event_uid').text)
+      }
+      Event.new(attrs)
     end
 
     private
@@ -31,4 +27,29 @@ module Cpi
       end
     end
   end
+
+  class Event
+    attr_accessor :event_type, :source_tenant_uid, :event_uid, :content
+
+    def initialize(attrs=nil)
+      @event_type = attrs[:event_type]
+      @source_tenant_uid = attrs[:source_tenant_uid]
+      @event_uid = attrs[:event_uid]
+      @content = attrs[:content]
+    end
+
+    def xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.cpi_event {
+          xml.header {
+            xml.event_uid event_uid
+            xml.event_type event_type
+            xml.source_tenant_uid source_tenant_uid
+          }
+          xml.content content
+        }
+      end
+      builder.doc.root.to_xml
+    end
+  end
 end

data/lib/cpi/event_connector.rb

@@ -19,6 +19,12 @@ module Cpi
       self.connection_params = params
     end
 
+    # DEPRECATED: Please use send_event instead
+    #
+    # This method does not add the correct routing header that CPI requires in the content
+    # of the event.
+    #
+    # This method will be made private eventually
     def self.transmit(event_type, tenant_uid, content, options=nil)
       options ||= {}
       if !@enabled
@@ -33,6 +39,12 @@ module Cpi
       @logger.debug "Transmission complete"
     end
 
+    # Sends a Cpi::Event
+    def self.send_event(event, options=nil)
+      return send_event_xml(event, options) if event.is_a? String # for backwards compatibility with 0.3.0
+      transmit_event(event, event.xml, options)
+    end
+
     # This method expects a routing header to be present in the xml document
     #
     # <cpi_event>
@@ -43,11 +55,9 @@ module Cpi
     #   </header>
     #   <content>some content</content>
     # </cpi_event>
-    def self.send_event(xml, options=nil)
-      options ||= {}
-      d = Event.new(xml)
-
-      transmit(d.event_type, d.source_tenant_uid, xml, {:queue => options.delete(:queue), :uid => d.event_uid})
+    def self.send_event_xml(xml, options=nil)
+      event = EventParser.parse(xml)
+      transmit_event(event, xml, options)
     end
 
     def self.test_connectivity
@@ -60,6 +70,11 @@ module Cpi
 
     private
 
+    def self.transmit_event(event, xml, options)
+      options ||= {}
+      transmit(event.event_type, event.source_tenant_uid, xml, {:queue => options.delete(:queue), :uid => event.event_uid})
+    end
+
     def self.connector
       Thread.current[THREAD_LOCAL_VARIABLE] ||= Cpi::Connector.new(self.connection_params, @logger)
     end

data/lib/cpi/version.rb

@@ -1,3 +1,3 @@
 module Cpi
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/event_connector_spec.rb

@@ -46,7 +46,7 @@ describe Cpi::EventConnector do
       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
+    it "send_event_xml does not require a uid or a queue in the routing envelope" do
       xml = <<-XML
 <cpi_event>
   <header>
@@ -56,13 +56,49 @@ describe Cpi::EventConnector do
   <content>some content</content>
 </cpi_event>
       XML
-      Cpi::EventConnector.send_event(xml)
+      Cpi::EventConnector.send_event_xml(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
+    it "send_event_xml generates and sends an event" do
+      xml = <<-XML
+<cpi_event>
+  <header>
+    <event_uid>unique_id</event_uid>
+    <event_type>type</event_type>
+    <source_tenant_uid>tenant_uid</source_tenant_uid>
+  </header>
+  <content>some content</content>
+</cpi_event>
+      XML
+      Cpi::EventConnector.send_event_xml(xml, :queue => 'system_queue_name')
+
+      h = get_event_from_rabbimq("system_queue_name")
+      h.should unify({"event_type" => "type", "tenant" => "tenant_uid", "content" => xml, "uid" => 'unique_id'})
+    end
+
+    it "send_event_xml generates and sends an event" do
+      event = Cpi::Event.new(event_uid: 'unique_id', event_type: 'type', source_tenant_uid: 'tenant_uid', content: 'some content')
+      Cpi::EventConnector.send_event(event, :queue => 'system_queue_name')
+
+      h = get_event_from_rabbimq("system_queue_name")
+
+      xml = <<-XML
+<cpi_event>
+  <header>
+    <event_uid>unique_id</event_uid>
+    <event_type>type</event_type>
+    <source_tenant_uid>tenant_uid</source_tenant_uid>
+  </header>
+  <content>some content</content>
+</cpi_event>
+      XML
+      h.should unify({"event_type" => "type", "tenant" => "tenant_uid", "content" => xml.strip, "uid" => 'unique_id'})
+    end
+
+    it "send_event works when given xml" do
       xml = <<-XML
 <cpi_event>
   <header>

data/spec/event_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../lib/cpi/event'
 
-describe Cpi::Event do
+describe Cpi::EventParser do
 
   let(:xml) do
     <<-XML
@@ -15,22 +15,42 @@ describe Cpi::Event do
     XML
   end
 
-  let(:doc) { Cpi::Event.new(xml) }
+  let(:event) { Cpi::EventParser.parse(xml) }
 
   describe "source_tenant_uid" do
     it "get extracted" do
-      doc.source_tenant_uid.should == 'tenant_uid'
+      event.source_tenant_uid.should == 'tenant_uid'
     end
   end
 
   describe "uid" do
     it "get extracted" do
-      doc.event_uid.should == 'unique_id'
+      event.event_uid.should == 'unique_id'
     end
 
     it "is nil when not present" do
-      doc = Cpi::Event.new('')
-      doc.event_uid.should be_nil
+      event = Cpi::EventParser.parse('')
+      event.event_uid.should be_nil
+    end
+  end
+end
+
+describe Cpi::Event do
+  describe "xml" do
+    it "serializes to xml" do
+      event = Cpi::Event.new(event_type: 'type', source_tenant_uid: 'tenant_uid', event_uid: 'uid', content: 'some content')
+
+      xml = <<-XML
+<cpi_event>
+  <header>
+    <event_uid>uid</event_uid>
+    <event_type>type</event_type>
+    <source_tenant_uid>tenant_uid</source_tenant_uid>
+  </header>
+  <content>some content</content>
+</cpi_event>
+      XML
+      event.xml.should == xml.strip
     end
   end
 end

data/spec/generator_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'backports'
 require_relative '../lib/cpi/generator'
 require 'active_support'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpi-event-connector
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: backports
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: justinf-unification_assertion
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +117,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - cpi-event-connector.gemspec
 - lib/cpi/connector.rb