akasha 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1294447dab3ae4202502a232dcc069d06dcdbf5d
-  data.tar.gz: 296cfc35578c3f15a90d55f0f0ed1db018458541
+  metadata.gz: '09372b1685568c249f091ff1bbbf4915bb574b91'
+  data.tar.gz: 982ef7993d2087b2bd55f424228ba5bdf31d867a
 SHA512:
-  metadata.gz: 0b177423fce21ab067cee6c37f0d50e1d132056611791af3af17c56b2b8a2ba6ea20d76a11462e99459814b1ce24259ea86d01bc794818110da1ea49283fcbbc
-  data.tar.gz: 3cbe93b9aeafeca8b3541d01feaacfb6bdd0395bf3ed92d9be73a5ee7df3dfdb593deb8ad55e9d9647748f51a069ae881c9fd970aa473fc73f5087f63d012c3e
+  metadata.gz: 59730ad9b8f01e86d5fdfd01945fea0586002972571595f03810d7af600f9d864a5d5c22fc1e7092a68067f6fd310c16f825980b8515d71f7933a05f2362dfc1
+  data.tar.gz: 1fb02d4091efe00a925af1ec4d15990c0cc0c61aaaf64a1c64de36a63dcc3eea3b73465d5e558880ad46393d90146dfb6a788d5e5544f7afcdf68bda67f38d78

data/.rubocop.yml

@@ -2,3 +2,5 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 Metrics/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Version 0.2.0
+
+* Synchronous event listeners (see `examples/sinatra/app.rb`).
+* HTTP-based Eventstore storage.
+
 
 ## Version 0.1.0
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    akasha (0.1.0)
+    akasha (0.2.0)
+      http_event_store
 
 GEM
   remote: https://rubygems.org/
@@ -9,7 +10,19 @@ GEM
     byebug (10.0.2)
     coderay (1.1.2)
     diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashie (3.5.7)
+    http_event_store (0.2.2)
+      faraday
+      faraday_middleware
+      hashie
+      json
+    json (2.1.0)
     method_source (0.9.0)
+    multipart-post (2.0.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -29,7 +29,7 @@ require 'sinatra'
 
 class User < Akasha::Aggregate
   def sign_up(email:, password:, admin: false, **)
-    changeset << Akasha::Event.new(:user_signed_up, email: email, password: password, admin: admin)
+    changeset.append(:user_signed_up, email: email, password: password, admin: admin)
   end
 
   def on_user_signed_up(email:, password:, admin:, **)
@@ -73,11 +73,13 @@ end
 ## Next steps
 
 - [x] Command routing (default and user-defined)
-- [ ] EventHandler (relying only on Eventstore)
-- [ ] HTTP Eventstore storage backend
+- [x] Synchronous EventHandler
+- [x] HTTP Eventstore storage backend
+- [ ] Telemetry (Dogstatsd)
+- [ ] Event#id for better idempotence (validate this claim)
 - [ ] Namespacing for events and aggregates
 - [ ] Version-based concurrency
-- [ ] Rake task for running EventHandlers
+- [ ] Async EventHandlers (storing cursors in Eventstore, configurable durability guarantees)
 - [ ] Socket-based Eventstore storage backend
 
 ## Development

data/akasha.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'http_event_store'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.7'

data/examples/sinatra/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'sinatra'
+gem 'akasha'

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akasha (0.1.0)
+    mustermann (1.0.2)
+    rack (2.0.5)
+    rack-protection (2.0.1)
+      rack
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  akasha
+  sinatra
+
+BUNDLED WITH
+   1.16.2

data/examples/sinatra/app.rb

@@ -0,0 +1,67 @@
+require 'akasha'
+require 'sinatra'
+
+class User < Akasha::Aggregate
+  attr_reader :email
+
+  def sign_up(email:, password:, admin: false, **)
+    changeset.append(:user_signed_up, email: email, password: password, admin: admin)
+  end
+
+  def on_user_signed_up(email:, password:, admin:, **)
+    @email = email
+    @password = password
+    @admin = admin
+  end
+end
+
+class Notifier < Akasha::EventListener
+  def on_user_signed_up(user_id, **)
+    notify_about_signup(user_id)
+  end
+
+  private
+
+  def notify_about_signup(user_id)
+    # Here we could just grab email from the event but let's demonstrate
+    # how to load an aggregate from events.
+    user = User.find_or_create(user_id)
+    email = <<~EOS
+      User #{user.email} just signed up!
+    EOS
+    # Let's not send any emails... :)
+    puts email
+  end
+end
+
+before do
+  @command_router = Akasha::CommandRouter.new
+
+  # Aggregates will load from and save to in-memory storage.
+  repository = Akasha::Repository.new(Akasha::Storage::MemoryEventStore.new)
+  Akasha::Aggregate.connect!(repository)
+
+  # Set up event listeners.
+  @event_router = Akasha::EventRouter.new
+  @event_router.register_event_listener(:user_signed_up, Notifier)
+  repository.subscribe(@event_router)
+
+  # This is how you link commands to aggregates.
+  @command_router.register_default_route(:sign_up, User)
+
+  # Nearly identital to the default handling above but we're setting the admin
+  # flag to demo custom command handling.
+  @command_router.register_route(:sign_up_admin) do |aggregate_id, **data|
+    user = User.find_or_create(aggregate_id)
+    user.sign_up(email: data[:email], password: data[:password], admin: true)
+    user.save!
+  end
+end
+
+post '/users/:user_id' do # With CQRS client pass unique aggregate ids.
+  @command_router.route!(:sign_up,
+                 params[:user_id],
+                 email: params[:email],
+                 password: params[:password])
+  'OK'
+end

data/lib/akasha.rb

@@ -1,5 +1,8 @@
 require 'akasha/event'
 require 'akasha/aggregate'
 require 'akasha/command_router'
+require 'akasha/event_listener'
+require 'akasha/event_router'
 require 'akasha/repository'
+require 'akasha/storage/http_event_store'
 require 'akasha/storage/memory_event_store'

data/lib/akasha/event.rb

@@ -12,6 +12,12 @@ module Akasha
       @data = data
     end
 
+    def metadata
+      {
+        created_at: @created_at
+      }
+    end
+
     def ==(other)
       self.class == other.class &&
         name == other.name &&

data/lib/akasha/event_listener.rb

@@ -0,0 +1,5 @@
+module Akasha
+  # Event listener base class.
+  class EventListener
+  end
+end

data/lib/akasha/event_router.rb

@@ -0,0 +1,38 @@
+module Akasha
+  # Routes events to event listeners.
+  class EventRouter
+    def initialize
+      @routes = Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    # Registers a new event listener, derived from
+    # `Akasha::EventListener`.
+    def register_event_listener(event_name, listener_class)
+      @routes[event_name] << listener_class
+    end
+
+    # Routes an event.
+    def route(event_name, aggregate_id, **data)
+      @routes[event_name].each do |listener_class|
+        listener = listener_class.new
+        begin
+          listener.public_send(:"on_#{event_name}", aggregate_id, **data)
+        rescue RuntimeError => e
+          log "Error handling event #{event_name.inspect}: #{e}"
+        end
+      end
+    end
+
+    # Routes an event (an Akasha::Event instance).
+    # This is interface allowing  subscription via `Akasha::Repository#subscribe`.
+    def call(aggregate_id, event)
+      route(event.name, aggregate_id, **event.data)
+    end
+
+    private
+
+    def log(msg)
+      puts msg
+    end
+  end
+end

data/lib/akasha/repository.rb

@@ -5,25 +5,43 @@ module Akasha
   class Repository
     STREAM_NAME_SEP = '-'.freeze
 
+    # Creates a new repository using the underlying `store` (e.g. `MemoryEventStore`).
     def initialize(store)
       @store = store
+      @subscribers = []
     end
 
+    # Loads an aggregate identified by `id` and `klass` from the repository.
+    # Returns an aggregate instance of class `klass` constructed by applying events from the corresponding
+    # stream.
     def load_aggregate(klass, id)
       agg = klass.new(id)
 
       start = 0
-      chunk_size = 100
-      stream(klass, id).read_events(start, chunk_size) do |events|
+      page_size = 20
+      stream(klass, id).read_events(start, page_size) do |events|
         agg.apply_events(events)
       end
 
       agg
     end
 
+    # Saves an aggregate to the repository, appending events to the corresponding stream.
     def save_aggregate(aggregate)
       changeset = aggregate.changeset
       stream(aggregate.class, changeset.aggregate_id).write_events(changeset.events)
+      notify_subscribers(aggregate)
+    end
+
+    # Subscribes to event streams passing either a lambda or a block.
+    # Example:
+    #
+    #   repo.subscribe do |aggregate_id, event|
+    #     ... handle the event ...
+    #   end
+    def subscribe(lambda = nil, &block)
+      callable = lambda || block
+      @subscribers << callable
     end
 
     private
@@ -35,5 +53,15 @@ module Akasha
     def stream(aggregate_klass, aggregate_id)
       @store.streams[stream_name(aggregate_klass, aggregate_id)]
     end
+
+    def notify_subscribers(aggregate)
+      id = aggregate.changeset.aggregate_id
+      events = aggregate.changeset.events
+      @subscribers.each do |subscriber|
+        events.each do |event|
+          subscriber.call(id, event)
+        end
+      end
+    end
   end
 end

data/lib/akasha/storage/http_event_store.rb

@@ -0,0 +1,24 @@
+require_relative 'http_event_store/stream'
+require 'http_event_store'
+
+module Akasha
+  module Storage
+    # HTTP-based interface to Eventstore (https://geteventstore.com)
+    class HttpEventStore
+      def initialize(host: 'localhost', port: 2113)
+        @client = ::HttpEventStore::Connection.new do |config|
+          config.endpoint = host
+          config.port = port
+        end
+      end
+
+      def streams
+        self # Use the `[]` method on self.
+      end
+
+      def [](stream_name)
+        Stream.new(@client, stream_name)
+      end
+    end
+  end
+end

data/lib/akasha/storage/http_event_store/stream.rb

@@ -0,0 +1,50 @@
+module Akasha
+  module Storage
+    class HttpEventStore
+      # HTTP Eventstore stream.
+      class Stream
+        def initialize(client, stream_name)
+          @client = client
+          @stream_name = stream_name
+        end
+
+        # Appends events to the stream.
+        def write_events(events)
+          event_hashes = events.map do |event|
+            {
+              event_type: event.name,
+              data: event.data,
+              metadata: event.metadata
+            }
+          end
+          @client.append_to_stream(@stream_name, event_hashes)
+        end
+
+        # Reads events from the stream starting from `start` inclusive.
+        # If block given, reads all events from the position in pages of `page_size`.
+        # If block not given, reads `size` events from the position.
+        def read_events(start, page_size)
+          if block_given?
+            position = start
+            loop do
+              events = read_events(position, page_size)
+              return if events.empty?
+              yield(events)
+              position += events.size
+            end
+          else
+            safe_read_events(start, page_size)
+          end
+        end
+
+        private
+
+        def safe_read_events(start, page_size)
+          @client.read_events_forward(@stream_name, start, page_size)
+        rescue ::HttpEventStore::StreamNotFound
+          []
+        end
+      end
+    end
+  end
+end

data/lib/akasha/storage/memory_event_store/stream.rb

@@ -12,15 +12,14 @@ module Akasha
           @events += events
         end
 
-        # Reads events from the stream starting from `position` inclusive.
-        # If block given, reads all events from the position in chunks
-        # of `size`.
-        # If block not given, reads `size` events from the position.
-        def read_events(position, size, &block)
+        # Reads events from the stream starting from `start` inclusive.
+        # If block given, reads all events from the start in pages of `page_size`.
+        # If block not given, reads `page_size` events from the start.
+        def read_events(start, page_size, &block)
           if block_given?
-            @events.lazy.drop(position).each_slice(size, &block)
+            @events.lazy.drop(start).each_slice(page_size, &block)
           else
-            @events[position..position + size]
+            @events[start..start + page_size]
           end
         end
       end

data/lib/akasha/version.rb

@@ -1,3 +1,3 @@
 module Akasha
-  VERSION='0.1.0'
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: akasha
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcin Bilski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: http_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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,9 @@ files:
 - akasha.gemspec
 - bin/console
 - bin/setup
+- examples/sinatra/Gemfile
+- examples/sinatra/Gemfile.lock
+- examples/sinatra/app.rb
 - lib/akasha.rb
 - lib/akasha/aggregate.rb
 - lib/akasha/aggregate/syntax_helpers.rb
@@ -108,7 +125,11 @@ files:
 - lib/akasha/command_router.rb
 - lib/akasha/command_router/default_handler.rb
 - lib/akasha/event.rb
+- lib/akasha/event_listener.rb
+- lib/akasha/event_router.rb
 - lib/akasha/repository.rb
+- lib/akasha/storage/http_event_store.rb
+- lib/akasha/storage/http_event_store/stream.rb
 - lib/akasha/storage/memory_event_store.rb
 - lib/akasha/storage/memory_event_store/stream.rb
 - lib/akasha/version.rb