rails_event_store 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f134f7a328395f2aaaee363409e3174c781ced
-  data.tar.gz: c0a7f0ac41fbe5688cc0407cd3ed07a62437d9f1
+  metadata.gz: b92227a5b22816861dab6e283090912863e3c60f
+  data.tar.gz: 460ea96f8e15e7a79a406c1e12dcb43293c2f518
 SHA512:
-  metadata.gz: fae4e8a9c0f3d414720795c557e7a6c2647b6d5b28f2197eba9715d54579b4028b063d6ed8a357055a158c1d694c71a1e0238f03fa8687d6251061101671019a
-  data.tar.gz: d4336f83e8c4a6e366ccb9e9e2f0a2c2deb545e766f21446354460fb92b288ec7e4129d8e03063cad436b64c78a18586c75c42536e8618fd2fe54d180cd1e2c8
+  metadata.gz: 0f9162341516cb547bd46adf076ceeb48c36309beb5947be4a7f89bc52a2eeba48a47e9fed59e35c31478ad05b91f5c3604754a51b03c9f2cedeefd5f155a8c5
+  data.tar.gz: 273c27809b1c4695b4c1c99e6b3e17319c3575706fba7cb426fa46cd8208400d43d6357082bffa16085ccb5eaf15943d2b78e069ff34c79a62380591d0151628

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 rvm:
-  - 2.1.5
-
+- 2.1.5
 before_install: gem install bundler
-
-gemfile:
-  Gemfile
-
-script: bundle exec rspec
+gemfile: Gemfile
+notifications:
+  slack:
+    secure: i/GM4u6oCfgdt9ablmOx4ov3Y9bHJjHabXxWXt+GLRlfW5MDdzwEH0QOx2mveVbit+00rKKqZzBAbEQ1yLo4MLLovHyJvCzoluC10u0MRIR7e8ZlCdlww+IL3JmD8E7G1a/fKEMoKwfLrYUXa5K0oAeKpJ3RwP+tTD+g3KxQfIA=
+env:
+  - CODECLIMATE_REPO_TOKEN=24ac54c50ae022eb008ebd1f1e5da043d6419759136d4027d0266426c6198ef2

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+### HEAD
+
+### 0.1.2 (26.05.2015)
+
+* Moved most core features to the separate gem `ruby_event_store`. We left only rails related implementation here.
+* It's now assumed that `event_id` has a unique index in the database (the same is applied to the initial migration generator)
+* Model is no longer validating uniqueness of `event_id` via ActiveRecord
+* Event does not need any data now, it can be created just like `OrderCreated.new` (without any arguments)
+* Migration generator is no more generating the `updated_at` field in the `event_store_events` table. We also advise to remove this column, since events shouldn't be *ever* modified.
+* In the event's metadata there's a new field `published_at`
+* Added the `subscribe_to_all_events` method to `RailsEventStore::Client`
+* Subscribing to only one event via `client.subscribe(subscriber, 'OrderCreated')` no longer works. You should use `client.subscribe(subscriber, ['OrderCreated'])` instead.
+* Default event's name is no longer `OrderCreated` for the `OrderCreated` event in the `Orders` namespace, now it's `Orders::OrderCreated`
+
+### 0.1.1 (22.04.2015)
+
+Initial release.

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
 gemspec
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) Arkency
+
+Rails EventStore is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -1,3 +1,9 @@
+[![Build Status](https://travis-ci.org/arkency/rails_event_store.svg?branch=master)](https://travis-ci.org/arkency/rails_event_store)
+[![Gem Version](https://badge.fury.io/rb/rails_event_store.svg)](http://badge.fury.io/rb/rails_event_store)
+[![Code Climate](https://codeclimate.com/github/arkency/rails_event_store/badges/gpa.svg)](https://codeclimate.com/github/arkency/rails_event_store)
+[![Test Coverage](https://codeclimate.com/github/arkency/rails_event_store/badges/coverage.svg)](https://codeclimate.com/github/arkency/rails_event_store)
+[![Join the chat at https://gitter.im/arkency/rails_event_store](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/arkency/rails_event_store?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 # EventStore
 
 A Ruby implementation of an EventStore based on Active Record.
@@ -71,7 +77,7 @@ client.publish_event(event, stream_name, expected_version)
 
 ```ruby
 stream_name = "order_1"
-start = 1
+start = "850c347f-423a-4158-a5ce-b885396c5b73"
 count = 40
 client.read_all_events(stream_name, start, count)
 ```
@@ -93,19 +99,46 @@ This method allows us to load all stored events ascending.
 client.read_all_streams
 ```
 
+#### Deleting stream
+
+You can permanently delete all events from a specific stream. Use this wisely.
+
+```ruby
+stream_name = "product_1"
+client.delete_stream(stream_name)
+```
+
 #### Subscribing to events
 
 To listen on specific events synchronously you have to create subscriber reprezentation. The only requirement is that subscriber class has to implement the 'handle_event(event)' method.
 
 ```ruby
 class InvoiceReadModel
-	def handle_event(event)
-		#we deal here with event's data
-	end
+  def handle_event(event)
+    #we deal here with event's data
+  end
 end
 ```
 
+* You can subscribe on specific set of events
+
 ```ruby
 invoice = InvoiceReadModel.new
 client.subscribe(invoice, ['PriceChanged', 'ProductAdded'])
-```
+```
+
+* You can also listen on all incoming events
+
+```ruby
+invoice = InvoiceReadModel.new
+client.subscribe(invoice)
+```
+
+#### Resources
+
+There're already few blogposts about Rails EventStore. Check them out:
+
+* [Why use Event Sourcing](http://blog.arkency.com/2015/03/why-use-event-sourcing/)
+* [The Event Store for Rails developers](http://blog.arkency.com/2015/04/the-event-store-for-rails-developers/)
+* [Fast introduction to Event Sourcing for Ruby programmers](http://blog.arkency.com/2015/03/fast-introduction-to-event-sourcing-for-ruby-programmers/)
+* [Why I want to introduce mutation testing to the rails_event_store gem](http://blog.arkency.com/2015/04/why-i-want-to-introduce-mutation-testing-to-the-rails-event-store-gem/)

data/Rakefile

@@ -1,3 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 
 

data/lib/rails_event_store.rb

@@ -4,11 +4,10 @@ require 'rails_event_store/generators/templates/migration_template'
 require 'rails_event_store/version'
 require 'rails_event_store/event'
 require 'rails_event_store/repositories/event_repository'
-require 'rails_event_store/actions/append_event_to_stream'
-require 'rails_event_store/actions/read_all_events'
-require 'rails_event_store/actions/read_events_batch'
-require 'rails_event_store/actions/delete_stream_events'
-require 'rails_event_store/actions/read_all_streams'
-require 'rails_event_store/pub_sub/broker'
+require 'rails_event_store/repositories/aggregate_repository'
+require 'rails_event_store/event_handlers/slack_event_handler'
+require 'rails_event_store/aggregate_root'
 require 'rails_event_store/errors'
 require 'rails_event_store/client'
+require 'rails_event_store/constants'
+require 'rails_event_store/utils/string_utils'

data/lib/rails_event_store/aggregate_root.rb

@@ -0,0 +1,26 @@
+module RailsEventStore
+  module AggregateRoot
+    def apply(event)
+      apply_event(event)
+      unpublished_events << event
+    end
+
+    def apply_old_event(event)
+      apply_event(event)
+    end
+
+    def unpublished_events
+      @unpublished_events ||= []
+    end
+
+    private
+
+    def apply_event(event)
+      public_send("apply_#{StringUtils.underscore(event.event_type)}")
+    end
+
+    def generate_uuid
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/rails_event_store/client.rb

@@ -4,36 +4,40 @@ module RailsEventStore
     def initialize(repository = Repositories::EventRepository.new)
       @repository = repository
     end
+    attr_reader :repository
 
-    def publish_event(event_data, stream_name = 'all', expected_version = nil)
-      event = Actions::AppendEventToStream.new(@repository).call(stream_name, event_data, expected_version)
-      event_broker.notify_subscribers(event)
+    def publish_event(event_data, stream_name = GLOBAL_STREAM, expected_version = nil)
+      event_store.publish_event(event_data, stream_name, expected_version)
     end
 
     def delete_stream(stream_name)
-      Actions::DeleteStreamEvents.new(@repository).call(stream_name)
+      event_store.delete_stream(stream_name)
     end
 
     def read_events(stream_name, start, count)
-      Actions::ReadEventsBatch.new(@repository).call(stream_name, start, count)
+      event_store.read_events(stream_name, start, count)
     end
 
     def read_all_events(stream_name)
-      Actions::ReadAllEvents.new(@repository).call(stream_name)
+      event_store.read_all_events(stream_name)
     end
 
     def read_all_streams
-      Actions::ReadAllStreams.new(@repository).call
+      event_store.read_all_streams
     end
 
-    def subscribe(subscriber, event_types = [])
-      event_broker.add_subscriber(subscriber, event_types)
+    def subscribe(subscriber, event_types)
+      event_store.subscribe(subscriber, event_types)
+    end
+
+    def subscribe_to_all_events(subscriber)
+      event_store.subscribe_to_all_events(subscriber)
     end
 
     private
 
-    def event_broker
-      @event_broker ||= PubSub::Broker.new
+    def event_store
+      @event_store ||= RubyEventStore::Facade.new(repository)
     end
   end
 end

data/lib/rails_event_store/constants.rb

@@ -0,0 +1,3 @@
+module RailsEventStore
+  GLOBAL_STREAM = 'all'.freeze
+end

data/lib/rails_event_store/errors.rb

@@ -1,8 +1,3 @@
 module RailsEventStore
-  WrongExpectedEventVersion  = Class.new(StandardError)
-  IncorrectStreamData        = Class.new(StandardError)
   EventCannotBeSaved         = Class.new(StandardError)
-  EventNotFound              = Class.new(StandardError)
-  SubscriberNotExist         = Class.new(StandardError)
-  MethodNotDefined           = Class.new(StandardError)
 end

data/lib/rails_event_store/event.rb

@@ -1,44 +1,3 @@
-require 'securerandom'
+require 'ruby_event_store'
 
-module RailsEventStore
-  class Event
-
-    def initialize(event_data)
-      @event_type = event_data.fetch(:event_type, event_name)
-      @event_id = event_data.fetch(:event_id, generate_id).to_s
-      @metadata = event_data.fetch(:metadata, nil)
-      @data = event_data.fetch(:data, nil)
-    end
-
-    attr_reader :event_type, :event_id, :metadata, :data
-
-    def validate!
-      [event_type, event_id, data].each do |attribute|
-        raise IncorrectStreamData if is_invalid?(attribute)
-      end
-    end
-
-    def to_h
-      {
-          event_type: event_type,
-          event_id: event_id,
-          metadata: metadata,
-          data: data
-      }
-    end
-
-    private
-
-    def is_invalid?(attribute)
-      attribute.nil? || attribute.empty?
-    end
-
-    def generate_id
-      SecureRandom.uuid
-    end
-
-    def event_name
-      self.class.name
-    end
-  end
-end
+RailsEventStore::Event = RubyEventStore::Event

data/lib/rails_event_store/event_entity.rb

@@ -6,6 +6,5 @@ module RailsEventStore
     self.table_name = 'event_store_events'
     serialize :metadata
     serialize :data
-    validates_uniqueness_of :event_id
   end
 end

data/lib/rails_event_store/event_handlers/slack_event_handler.rb

@@ -0,0 +1,41 @@
+require 'net/http'
+require 'json'
+
+module RailsEventStore
+  module EventHandlers
+    class SlackEventHandler
+      class HTTPClient
+        def post(url, params)
+          uri = URI.parse(url)
+
+          req = Net::HTTP::Post.new(uri)
+          req.set_form_data(params)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+
+          http.request(req)
+        end
+      end
+
+      def initialize(webhook_url)
+        @webhook_url = webhook_url
+        @http_client = HTTPClient.new
+      end
+
+      attr_reader :webhook_url, :http_client
+
+      def handle_event(event)
+        event_name = event.event_type
+        payload = {
+          text: "Event #{event_name} raised.",
+          username: "Rails EventStore Bot",
+        }
+
+        @http_client.post(@webhook_url, {
+          payload: payload.to_json
+        })
+      end
+    end
+  end
+end

data/lib/rails_event_store/generators/templates/migration_template.rb

@@ -7,10 +7,10 @@ class CreateEventsTable < ActiveRecord::Migration
       t.string      :event_id,    null: false
       t.text        :metadata
       t.text        :data,        null: false
-      t.timestamps
+      t.datetime    :created_at,  null: false
     end
     add_index :event_store_events, :stream
-    add_index :event_store_events, :event_id
+    add_index :event_store_events, :event_id, unique: true
   end
 
   def self.down

data/lib/rails_event_store/repositories/aggregate_repository.rb

@@ -0,0 +1,28 @@
+module RailsEventStore
+  module Repositories
+    class AggregateRepository
+      def initialize(event_store = default_event_store)
+        @event_store = event_store
+      end
+
+      def store(aggregate)
+        aggregate.unpublished_events.each do |event|
+          event_store.publish_event(event, aggregate.id)
+        end
+      end
+
+      def load(aggregate)
+        events = event_store.read_all_events(aggregate.id)
+        events.each do |event|
+          aggregate.apply_old_event(event)
+        end
+      end
+
+      attr_accessor :event_store
+
+      def default_event_store
+        Client.new
+      end
+    end
+  end
+end

data/lib/rails_event_store/repositories/event_repository.rb

@@ -2,8 +2,8 @@ module RailsEventStore
   module Repositories
     class EventRepository
 
-      def initialize(adapter = EventEntity)
-        @adapter = adapter
+      def initialize
+        @adapter = EventEntity
       end
       attr_reader :adapter
 
@@ -12,9 +12,11 @@ module RailsEventStore
       end
 
       def create(data)
-        model = adapter.new(data)
-        raise EventCannotBeSaved unless model.valid?
-        model.save
+        begin
+          adapter.create(data)
+        rescue ActiveRecord::RecordNotUnique
+          raise EventCannotBeSaved
+        end
       end
 
       def delete(condition)

data/lib/rails_event_store/utils/string_utils.rb

@@ -0,0 +1,14 @@
+module StringUtils
+  def self.underscore(camel_cased_word)
+    acronym_regex = /(?=a)b/
+    return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+    word = camel_cased_word.to_s.gsub(/::/, '/')
+    word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)(#{acronym_regex})(?=\b|[^a-z])/) { "#{$1 && '_'}#{$2.downcase}" }
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word.gsub!(/[^A-Za-z0-9_]/, '_')
+    word
+  end
+end

data/lib/rails_event_store/version.rb

@@ -1,3 +1,3 @@
 module RailsEventStore
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/rails_event_store.gemspec

@@ -23,4 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rails', '~> 4.2.1'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_dependency 'ruby_event_store'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_event_store
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - rybex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: ruby_event_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Implementation of Event Store in Ruby
 email:
 - tomek.rybka@gmail.com
@@ -89,23 +117,24 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/rails_event_store.rb
-- lib/rails_event_store/actions/append_event_to_stream.rb
-- lib/rails_event_store/actions/delete_stream_events.rb
-- lib/rails_event_store/actions/read_all_events.rb
-- lib/rails_event_store/actions/read_all_streams.rb
-- lib/rails_event_store/actions/read_events_batch.rb
+- lib/rails_event_store/aggregate_root.rb
 - lib/rails_event_store/client.rb
+- lib/rails_event_store/constants.rb
 - lib/rails_event_store/errors.rb
 - lib/rails_event_store/event.rb
 - lib/rails_event_store/event_entity.rb
+- lib/rails_event_store/event_handlers/slack_event_handler.rb
 - lib/rails_event_store/generators/migrate_generator.rb
 - lib/rails_event_store/generators/templates/migration_template.rb
-- lib/rails_event_store/pub_sub/broker.rb
+- lib/rails_event_store/repositories/aggregate_repository.rb
 - lib/rails_event_store/repositories/event_repository.rb
+- lib/rails_event_store/utils/string_utils.rb
 - lib/rails_event_store/version.rb
 - rails_event_store.gemspec
 homepage: ''

data/lib/rails_event_store/actions/append_event_to_stream.rb

@@ -1,34 +0,0 @@
-module RailsEventStore
-  module Actions
-    class AppendEventToStream
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def call(stream_name, event, expected_version)
-        raise WrongExpectedEventVersion if version_incorrect?(stream_name, expected_version)
-        event.validate!
-        save_event(event, stream_name)
-        return event
-      end
-
-      private
-      attr_reader :repository
-
-      def version_incorrect?(stream_name, expected_version)
-        unless expected_version.nil?
-          find_last_event_version(stream_name) != expected_version
-        end
-      end
-
-      def find_last_event_version(stream_name)
-        repository.last_stream_event(stream_name).event_id
-      end
-
-      def save_event(event, stream_name)
-        repository.create(event.to_h.merge!(stream: stream_name))
-      end
-    end
-  end
-end

data/lib/rails_event_store/actions/delete_stream_events.rb

@@ -1,23 +0,0 @@
-module RailsEventStore
-  module Actions
-    class DeleteStreamEvents
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def call(stream_name)
-        raise IncorrectStreamData if stream_name.nil? || stream_name.empty?
-        delete_stream(stream_name)
-      end
-
-      private
-      attr_reader :repository
-
-      def delete_stream(stream_name)
-        repository.delete({stream: stream_name})
-      end
-    end
-  end
-end
-

data/lib/rails_event_store/actions/read_all_events.rb

@@ -1,22 +0,0 @@
-module RailsEventStore
-  module Actions
-    class ReadAllEvents
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def call(stream_name)
-        raise IncorrectStreamData if stream_name.nil? || stream_name.empty?
-        get_all_events(stream_name)
-      end
-
-      private
-      attr_reader :repository
-
-      def get_all_events(stream_name)
-        repository.load_all_events_forward(stream_name)
-      end
-    end
-  end
-end

data/lib/rails_event_store/actions/read_all_streams.rb

@@ -1,21 +0,0 @@
-module RailsEventStore
-  module Actions
-    class ReadAllStreams
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def call
-        get_all_events.group_by { |event| event.stream }
-      end
-
-      private
-      attr_reader :repository
-
-      def get_all_events
-        repository.get_all_events
-      end
-    end
-  end
-end

data/lib/rails_event_store/actions/read_events_batch.rb

@@ -1,29 +0,0 @@
-module RailsEventStore
-  module Actions
-    class ReadEventsBatch
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def call(stream_name, start, count)
-        raise IncorrectStreamData if stream_name.nil? || stream_name.empty?
-        event = find_event(start)
-        get_events_batch(stream_name, event.id, count)
-      end
-
-      private
-      attr_reader :repository
-
-      def get_events_batch(stream_name, start, count)
-        repository.load_events_batch(stream_name, start, count)
-      end
-
-      def find_event(start)
-        event = repository.find({event_id: start})
-        raise EventNotFound if event.nil?
-        event
-      end
-    end
-  end
-end

data/lib/rails_event_store/pub_sub/broker.rb

@@ -1,33 +0,0 @@
-module RailsEventStore
-  module PubSub
-    class Broker
-
-      def initialize
-        @subscribers = {}
-      end
-
-      def add_subscriber(subscriber, event_types)
-        raise SubscriberNotExist  if subscriber.nil?
-        raise MethodNotDefined    unless subscriber.methods.include? :handle_event
-        subscribe(subscriber, [*event_types])
-      end
-
-      def notify_subscribers(event)
-        if subscribers.key? event.event_type
-          subscribers[event.event_type].each do |subscriber|
-            subscriber.handle_event(event)
-          end
-        end
-      end
-
-      private
-      attr_reader :subscribers
-
-      def subscribe(subscriber, event_types)
-        event_types.each do |type|
-          (subscribers[type] ||= []) << subscriber
-        end
-      end
-    end
-  end
-end