entity_store 0.0.15 → 0.1.0

data/lib/entity_store/entity.rb

@@ -1,5 +1,7 @@
 module EntityStore
   module Entity
+    include Hatchet
+    
     attr_accessor :id
     
     def self.included(klass)

data/lib/entity_store/event_bus.rb

@@ -1,36 +1,65 @@
 module EntityStore
   class EventBus
-    class << self
-      def publish(entity_type, event)
-        publish_externally entity_type, event
+    include Hatchet
 
-        EntityStore.logger.debug { "publishing #{event.inspect}" }
+    def publish(entity_type, event)
+      publish_externally entity_type, event
 
-        subscribers_to(event.receiver_name).each do |s|
-          begin
-            s.new.send(event.receiver_name, event)
-            EntityStore.logger.debug { "called #{s.name}##{event.receiver_name} with #{event.inspect}" }
-          rescue => e
-            EntityStore.logger.error { "#{e.message} when calling #{s.name}##{event.receiver_name} with #{event.inspect}" }
-          end
+      logger.debug { "publishing #{event.inspect}" }
+
+      subscribers_to(event.receiver_name).each do |s|
+        begin
+          s.new.send(event.receiver_name, event)
+          logger.debug { "called #{s.name}##{event.receiver_name} with #{event.inspect}" }
+        rescue => e
+          logger.error "#{e.message} when calling #{s.name}##{event.receiver_name} with #{event.inspect}", e
         end
       end
+    end
 
-      def subscribers_to(event_name)
-        subscribers.select { |s| s.instance_methods.include?(event_name.to_sym) }
-      end
+    def subscribers_to(event_name)
+      subscribers.select { |s| s.instance_methods.include?(event_name.to_sym) }
+    end
 
-      def subscribers
-        EntityStore.event_subscribers
-      end
+    def subscribers
+      EntityStore.event_subscribers
+    end
 
-      def publish_externally(entity_type, event)
-        external_store.add_event(entity_type, event)
-      end
+    def publish_externally(entity_type, event)
+      external_store.add_event(entity_type, event)
+    end
+
+    def external_store
+      @_external_store ||= ExternalStore.new
+    end
 
-      def external_store
-        @_external_store ||= ExternalStore.new
+    # Public - replay events of a given type to a given subscriber
+    # 
+    # since             - Time reference point
+    # type              - String type name of event
+    # subscriber        - Class of the subscriber to replay events to 
+    # 
+    # Returns nothing
+    def replay(since, type, subscriber)
+      max_items = 100
+      event_data_objects = external_store.get_events(since, type, max_items)
+
+      while event_data_objects.count > 0 do 
+        event_data_objects.each do |event_data_object|
+          begin
+            event = get_type_constant(event_data_object.type).new(event_data_object.attrs)
+            subscriber.new.send(event.receiver_name, event)
+            logger.info { "replayed #{event.inspect} to #{subscriber.name}##{event.receiver_name}" }
+          rescue => e
+            logger.error "#{e.message} when replaying #{event_data_object.inspect} to #{subscriber}", e         
+          end
+        end
+        event_data_objects = external_store.get_events(event_data_objects.last.id, type, max_items)
       end
     end
+
+    def get_type_constant(type_name)
+      type_name.split('::').inject(Object) {|obj, name| obj.const_get(name) }
+    end
   end
 end

data/lib/entity_store/event_data_object.rb

@@ -7,7 +7,7 @@ module EntityStore
     end
     
     def id
-      attrs['_id']
+      attrs['_id'].to_s
     end
     
     def entity_type

data/lib/entity_store/external_store.rb

@@ -29,13 +29,23 @@ module EntityStore
       )
     end
     
-    def get_events(opts={})
-      query = {}
-      query['_id'] = { '$gt' => opts[:after] } if opts[:after]
-      query['_type'] = opts[:type] if opts[:type]
+    # Public - get events since a Time or ID
+    # 
+    # since         - Time or String id to filter events from 
+    # type          - String optionally filter the event type to return (default=nil)
+    # max_items     - Fixnum max items to return (default=100)
+    # 
+    # Returns Enumerable EventDataObject
+    def get_events(since, type=nil, max_items=100)
+      since_id = since.is_a?(Time) ? BSON::ObjectId.from_time(since) : BSON::ObjectId.from_string(since)
+
+      query = { '_id' => { '$gt' => since_id } }
+      query['_type'] = type if type
       
-      options = {:sort => [['_id', -1]]}
-      options[:limit] = opts[:limit] || 100
+      options = {
+        :sort => [['_id', Mongo::ASCENDING]],
+        :limit => max_items
+      }
       
       collection.find(query, options).collect { |e| EventDataObject.new(e)}
     end

data/lib/entity_store/mongo_entity_store.rb

@@ -4,6 +4,7 @@ require 'uri'
 module EntityStore
   class MongoEntityStore
     include Mongo
+    include Hatchet
 
     def open_connection
       @db ||= open_store
@@ -79,7 +80,7 @@ module EntityStore
           begin
             event.apply(entity) 
           rescue => e
-            EntityStore.logger.error { "Failed to apply #{event.class.name} #{event.attributes} to #{id} with #{e.inspect}" }
+            logger.error "Failed to apply #{event.class.name} #{event.attributes} to #{id} with #{e.inspect}", e
           end
           entity.version = event.entity_version
         end
@@ -107,8 +108,7 @@ module EntityStore
         begin
           get_type_constant(attrs['_type']).new(attrs)
         rescue => e
-          logger = Logger.new(STDERR)
-          logger.error "Error loading type #{attrs['_type']}"
+          logger.error "Error loading type #{attrs['_type']}", e
           nil
         end
       end.select { |e| !e.nil? }

data/lib/entity_store/store.rb

@@ -1,5 +1,7 @@
 module EntityStore
   class Store
+    include Hatchet
+
     def storage_client
       @_storage_client ||= MongoEntityStore.new
     end
@@ -9,7 +11,7 @@ module EntityStore
       add_events(entity)
       entity
     rescue => e
-      EntityStore.logger.error { "Store#add error: #{e.inspect} - #{entity.inspect}" }
+      logger.error { "Store#add error: #{e.inspect} - #{entity.inspect}" }
       raise e
     end
 
@@ -33,12 +35,12 @@ module EntityStore
       end
       entity
     rescue => e
-      EntityStore.logger.error { "Store#do_save error: #{e.inspect} - #{entity.inspect}" }
+      logger.error { "Store#do_save error: #{e.inspect} - #{entity.inspect}" }
       raise e
     end
 
     def snapshot_entity(entity)
-      EntityStore.logger.info { "Store#snapshot_entity : Snapshotting #{entity.id}"}
+      logger.info { "Store#snapshot_entity : Snapshotting #{entity.id}"}
       storage_client.snapshot_entity(entity)
     end
 
@@ -52,7 +54,7 @@ module EntityStore
         e.entity_version = entity.version
         storage_client.add_event(e)
       end
-      entity.pending_events.each {|e| EventBus.publish(entity.type, e) }
+      entity.pending_events.each {|e| event_bus.publish(entity.type, e) }
       entity.clear_pending_events
     end
 
@@ -77,5 +79,8 @@ module EntityStore
       @_storage_client = nil
     end
 
+    def event_bus
+      @_event_bus ||= EventBus.new
+    end
   end
 end

data/lib/entity_store/version.rb

@@ -1,3 +1,3 @@
 module EntityStore
-  VERSION = "0.0.15".freeze
+  VERSION = "0.1.0".freeze
 end

data/lib/entity_store.rb

@@ -1,5 +1,6 @@
 module EntityStore
-  require 'logger'
+
+  require 'hatchet'
   require 'entity_store/entity'
   require 'entity_store/entity_value'
   require 'entity_store/event'
@@ -47,26 +48,6 @@ module EntityStore
       @_snapshot_threshold = value
     end
 
-    def log_level
-      @_log_level ||= Logger::INFO
-    end
-    
-    def log_level=(value)
-      @_log_level = value
-    end
-    
-    def logger
-      unless @_logger
-        @_logger = Logger.new(STDOUT)
-        @_logger.progname = "Entity_Store"
-        @_logger.level = log_level
-      end
-      @_logger
-    end
-    
-    def logger=(value)
-      @_logger = value
-    end
   end
 
 

data/spec/entity_store/event_bus_spec.rb

@@ -15,17 +15,18 @@ describe EventBus do
   before(:each) do
     @entity_type = random_string
     @event = DummyEvent.new(:name => random_string)
+    @event_bus = EventBus.new
   end
   describe ".publish" do
     before(:each) do
       @subscriber = mock("Subscriber", :dummy_event => true)
       DummySubscriber.stub(:new) { @subscriber }
       @subscriber_class2 = mock("SubscriberClass", :instance_methods => ['bilge'], :name => "SubscriberClass")
-      EventBus.stub(:subscribers).and_return([DummySubscriber, @subscriber_class2])
-      EventBus.stub(:publish_externally)
+      @event_bus.stub(:subscribers).and_return([DummySubscriber, @subscriber_class2])
+      @event_bus.stub(:publish_externally)
     end
     
-    subject { EventBus.publish(@entity_type, @event) }
+    subject { @event_bus.publish(@entity_type, @event) }
     
     it "calls the receiver method on the subscriber" do
       @subscriber.should_receive(:dummy_event).with(@event)
@@ -36,7 +37,7 @@ describe EventBus do
       subject
     end
     it "publishes event to the external event push" do
-      EventBus.should_receive(:publish_externally).with(@entity_type, @event)
+      @event_bus.should_receive(:publish_externally).with(@entity_type, @event)
       subject
     end
   end
@@ -44,14 +45,41 @@ describe EventBus do
   describe ".publish_externally" do
     before(:each) do
       @external_store = mock(ExternalStore)
-      EventBus.stub(:external_store) { @external_store }
+      @event_bus.stub(:external_store) { @external_store }
     end
     
-    subject { EventBus.publish_externally @entity_type, @event }
+    subject { @event_bus.publish_externally @entity_type, @event }
     
     it "should publish to the external store" do
       @external_store.should_receive(:add_event).with(@entity_type, @event)
       subject
     end
   end
+
+  describe "#replay" do
+    before(:each) do
+      @since = random_time
+      @type = 'DummyEvent'
+      @subscriber = mock("Subscriber", :dummy_event => true)
+      DummySubscriber.stub(:new) { @subscriber }
+
+      @external_store = mock(ExternalStore)
+      @id = random_object_id
+      @external_store.stub(:get_events) { |since| since == @id ? [] : [
+        EventDataObject.new('_id' => @id, '_type' => DummyEvent.name, 'name' => random_string) 
+      ]}
+      @event_bus.stub(:external_store) { @external_store }
+    end 
+
+    subject { @event_bus.replay(@since, @type, DummySubscriber) }
+
+    it "gets the events for that period" do
+      @external_store.should_receive(:get_events).with(@since, @type, 100)
+      subject
+    end
+    it "publishes them to the subscriber" do
+      @subscriber.should_receive(:dummy_event).with(an_instance_of(DummyEvent))
+      subject
+    end
+  end
 end

data/spec/entity_store/external_store_spec.rb

@@ -36,63 +36,89 @@ describe ExternalStore do
   
   describe "#get_events" do
     before(:each) do
-      @entity_type = random_string
-      @events = [
-        DummyEvent.new(:name => random_string, :entity_id => random_object_id),
-        DummyEventTwo.new(:name => random_string, :entity_id => random_object_id),
-        DummyEvent.new(:name => random_string, :entity_id => random_object_id),
-        DummyEventTwo.new(:name => random_string, :entity_id => random_object_id),
-        DummyEvent.new(:name => random_string, :entity_id => random_object_id)
-      ]
-      
-      @events.each { |e| @store.add_event(@entity_type, e)}
-    end
-    
-    context "when no options" do
+      @reference_time = Time.now
+      @ids = (-2..2).collect { |i| BSON::ObjectId.from_time(@reference_time + i) }
 
-      subject { @store.get_events }
+      @store.collection.insert({'_id' => @ids[0], '_type' => 'DummyEvent'})
+      @store.collection.insert({'_id' => @ids[1], '_type' => 'DummyEventTwo'})
+      @store.collection.insert({'_id' => @ids[2], '_type' => 'DummyEvent'})
+      @store.collection.insert({'_id' => @ids[3], '_type' => 'DummyEventTwo'})
+      @store.collection.insert({'_id' => @ids[4], '_type' => 'DummyEvent'})
+    end
+       
+    subject { @store.get_events @since, @type }
 
-      it "returns all of the events" do
-        subject.count.should eq(@events.count)
+    context "when time passed as since" do
+      before(:each) do
+        @since = @reference_time
       end
-    end
-    
-    context "when options passed" do
-      subject { @store.get_events(@options) }
-      
-      context "when limit option passed" do
+      context "when no type filter" do
+        before(:each) do
+          @type = nil
+          @results = subject
+        end
+        it "returns two records" do
+          @results.count.should eq(2)
+        end
+        it "it returns the 4th item first" do
+          @results.first.id.should eq(@ids[3].to_s)
+        end
+        it "it returns the 5th item second" do
+          @results[1].id.should eq(@ids[4].to_s)
+        end
+      end
+      context "when type filter 'DummyEventTwo' passed" do
         before(:each) do
-          @options = {:limit => 3}
+          @type = "DummyEventTwo"
+          @results = subject
         end
-        
-        it "returns limited records records" do
-          subject.count.should eq(@options[:limit])
+        it "returns 1 record" do
+          @results.count.should eq(1)
         end
+        it "returns the 4th item" do
+          @results.first.id.should eq(@ids[3].to_s)
+        end
+      end
+    end
+
+    context "when id passed as since" do
+      before(:each) do
+        @since = @ids[1].to_s
       end
-      
-      context "when after index passed" do
+      context "when no type filter passed" do
         before(:each) do
-          items = @store.get_events(:limit => 3)
-          @options = {:after => items[2].id}
+          @type = nil
+          @results = subject
+        end
+        it "returns 3 records" do
+          @results.count.should eq(3)
+        end
+        it "it returns the 3rd item first" do
+          @results.first.id.should eq(@ids[2].to_s)
         end
-        
-        it "returns limited records records" do
-          subject.count.should eq(2)
+        it "it returns the 4th item second" do
+          @results[1].id.should eq(@ids[3].to_s)
         end
-      end  
-      
-      context "when type passed" do
+        it "it returns the 5th item second" do
+          @results[2].id.should eq(@ids[4].to_s)
+        end
+      end
+      context "when type filter 'DummyEvent' passed" do
         before(:each) do
-          @options = {:type => @events[2].class.name}
+          @type = "DummyEvent"
+          @results = subject
+        end
+        it "returns 2 records" do
+          @results.count.should eq(2)
         end
-        
-        it "returns type records records" do
-          subject.count.should eq(3)
+        it "returns the 3rd item" do
+          @results.first.id.should eq(@ids[2].to_s)
         end
-      end      
-          
+        it "returns the 5th item" do
+          @results[1].id.should eq(@ids[4].to_s)
+        end
+      end
     end
-
   end
 
 end

data/spec/entity_store/store_spec.rb

@@ -43,7 +43,8 @@ describe Store do
       @storage_client = mock("StorageClient", :add_event => true)
       @store = Store.new
       @store.stub(:storage_client) { @storage_client }
-      EventBus.stub(:publish)
+      @event_bus = mock(EventBus, :publish => true)
+      @store.stub(:event_bus) { @event_bus}
     end
 
     subject { @store.add_events(@entity) }
@@ -68,7 +69,7 @@ describe Store do
     end
     it "publishes each event to the EventBus" do
       @entity.pending_events.each do |e|
-        EventBus.should_receive(:publish).with(@entity.type, e)
+        @event_bus.should_receive(:publish).with(@entity.type, e)
       end
       subject
     end

data/spec/entity_store_spec.rb

@@ -2,14 +2,7 @@ require 'spec_helper'
 
 describe EntityStore do
   describe ".setup" do
-    before(:each) do
-      EntityStore.setup do |config|
-        config.log_level = Logger::WARN
-      end
-    end
-    it "has a log_level of WARN" do
-      EntityStore.log_level.should eq(Logger::WARN)
-    end
+
   end
   
 end

data/spec/spec_helper.rb

@@ -6,6 +6,18 @@ RSpec.configure do |config|
   config.color_enabled = true
 end
 
+Hatchet.configure do |config|
+  # Reset the logging configuration
+  config.reset!
+  config.level :error
+  # Use the format without time, etc so we don't duplicate it
+  config.formatter = Hatchet::SimpleFormatter.new
+  # Set up a STDOUT appender
+  config.appenders << Hatchet::LoggerAppender.new do |appender|
+    appender.logger = Logger.new(STDOUT)
+  end
+end
+
 include EntityStore
 
 def random_string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entity_store
 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-10-31 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: hatchet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.20
 description: Event sourced entity store with a Mongo body
 email: adam.bird@gmail.com
 executables: []