es-readmodel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce71465c7b242c0f599a132a464e568187dcbf1d
+  data.tar.gz: d03c5db89e11c92f309a614585a1e25bec1e8756
+SHA512:
+  metadata.gz: 4b318c8c2eda6b6f3aeef8a246084389d14985cf135c1352486848154d07cc85bfebb62ffd7d798741fa0a4f04486c7bb9c9c1ec651206cfbbb5ef3a4a24a060
+  data.tar.gz: 03555d442fbc240cd190579ae02f01718ab4b0981bf4b0b87f442a61f843aeb70f089fe65a828c71085bf170e936672a38bb5cad0bc9602b479ad9695c1e6007

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Kevin Rutherford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# EsReadModel
+
+An opinionated read model framework for EventStore.
+
+Your reducer can be anything that responds to #call.
+It will receive two arguments -- the current state and the event.
+The current state will be nil if no events have bee processed yet.
+The reducer function must return the new state.
+
+## Exmple usage
+
+```[ruby]
+require 'rack/cors'
+require_relative './lib/es_readmodel'
+require_relative './active_users'
+require_relative './list_users'
+require_relative './get_user_details'
+
+ENV['RACK_ENV'] = 'none'
+ENV['readmodel.name'] = 'users'
+
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: :any, max_age: 0
+  end
+end
+
+use EsReadModel::Subscriber,
+  es_host:     ENV['ES_HOST'],
+  es_port:     ENV['ES_PORT'],
+  es_username: ENV['ES_USERNAME'],
+  es_password: ENV['ES_PASSWORD'],
+  reducer:     ActiveUsers.new,
+  listener:    EsReadModel::Logger.new
+
+run EsReadModel::Api.new(
+  '/users'          => ListUsers.new,
+  '/users/:user_id' => GetUserDetails.new
+)
+
+```
+

data/es-readmodel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'es-readmodel'
+  spec.version       = '0.0.1'
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Kevin Rutherford']
+  spec.email         = ['kevin@rutherford-software.com']
+
+  spec.summary       = %q{An opinionated read model framework for use with EventStore}
+  spec.description   = %q{An opinionated read model framework for use with EventStore}
+  spec.homepage      = "https://github.com/kevinrutherford/es-readmodel"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '3.5.0'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.13'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.12'
+  spec.add_runtime_dependency 'hashie', '~> 3.5'
+  spec.add_runtime_dependency 'json', '~> 2.1'
+  spec.add_runtime_dependency 'mustermann', '~> 1.0'
+
+end
+

data/lib/es_readmodel/api.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'mustermann'
+
+module EsReadModel
+
+  class Api
+
+    def initialize(routes)
+      @routes = routes
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+      path = @request.path_info
+      @routes.each do |route, handler|
+        pattern = Mustermann.new(route)
+        args = pattern.params(path)
+        if args
+          return json_response(503, {status: env['readmodel.status']}) unless env['readmodel.available'] == true
+          result = handler.call(@request.env['readmodel.state'], @request.params.merge(args))
+          return result ? json_response(200, result) : json_response(404, {error: 'not found'})
+        end
+      end
+      return json_response(404, {error: 'not found'})
+    end
+
+    private
+
+    def json_response(status_code, body)
+      result = body.merge({
+        _links: { self: @request.fullpath }
+      })
+      [
+        status_code,
+        {
+          'Content-Type' => 'application/json'
+        },
+        [result.to_json]
+      ]
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/connection.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'base64'
+
+module EsReadModel
+
+  class Connection
+
+    def initialize(endpoint, username=nil, password=nil)
+      @endpoint = endpoint
+      @headers = {
+        'Accept'       => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+      if username && password
+        token = Base64.encode64("#{username}:#{password}")[0..-2]
+        @headers.merge!({ 'Authorization' => "Basic #{token}" })
+      end
+    end
+
+    def get(uri, etag)
+      connection = Faraday.new(url: @endpoint) do |faraday|
+        faraday.options[:timeout] = 2
+        faraday.response :json, content_type: 'application/json'
+        faraday.response :mashify
+        faraday.adapter Faraday.default_adapter
+      end
+      response = connection.get(uri) do |req|
+        req.headers = @headers
+        req.headers.merge({ 'If-None-Match' => etag }) if etag
+        req.body = {}.to_json
+        req.params['embed'] = 'body'
+      end
+      response
+    end
+
+    def to_s
+      @endpoint
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/event.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module EsReadModel
+
+  class Event < Struct.new(:id, :type, :data, :updated, :number, :uri, :stream_id)
+
+    def self.load_from(hash)
+      return nil unless hash['data']
+      data = JSON.parse(hash['data'], symbolize_names: true)
+      event = Event.new(hash['eventId'], hash['eventType'], data, hash['updated'], hash['eventNumber'].to_i, hash['id'], hash['streamId'])
+      event
+    end
+
+    def occurred_at
+      data[:occurredAt]
+    end
+
+    private
+
+    def initialize(id, type, data, updated=nil, number=nil, uri=nil, stream_id=nil)
+      super
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/logger.rb

@@ -0,0 +1,24 @@
+module EsReadModel
+
+  class Logger
+
+    def call(ctx)
+      ctx = {
+        time: Time.now
+      }.merge(ctx)
+      extras = ENV.select {|k,v| k =~ /^readmodel/i }
+      ctx = ctx.merge(extras)
+      STDERR.puts ctx.map {|k,v| format(k, v.to_s) }.join(' ')
+    end
+
+    private
+
+    def format(k, v)
+      value = (v =~ / /) ? "\"#{v}\"" : v
+      "#{k}=#{value}"
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/page.rb

@@ -0,0 +1,42 @@
+require_relative './event'
+
+module EsReadModel
+
+  class Page
+
+    def initialize(body)
+      @body = body
+    end
+
+    def first_event_uri
+      find_link('last')
+    end
+
+    def newer_events_uri
+      find_link('previous')
+    end
+
+    def empty?
+      @body['entries'].nil? || @body['entries'].empty?
+    end
+
+    def each_event(&block)
+      @body['entries']
+        .reverse!
+        .map {|e| Event.load_from(e)}
+        .compact
+        .select {|e| e.type !~ /^\$/ }
+        .each {|e| yield e }
+    end
+
+    private
+
+    def find_link(rel)
+      link = @body['links'].detect { |l| l['relation'] == rel }
+      link.nil? ? nil : link['uri']
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/stream.rb

@@ -0,0 +1,69 @@
+require_relative './page'
+
+module EsReadModel
+
+  class Stream
+
+    def Stream.open(name, connection, listener)
+      Stream.new("/streams/#{name}", connection, listener)
+    end
+
+    def initialize(head_uri, connection, listener)
+      @connection = connection
+      @listener = listener
+      @current_etag = nil
+      @listener.call({
+        level: 'info',
+        tag:   'connecting',
+        msg:   "Connecting to #{head_uri} on #{connection}"
+      })
+      fetch_first_page(head_uri)
+    end
+
+    def wait_for_new_events
+      while @current_page.empty?
+        sleep 1
+        fetch(@current_uri)
+      end
+    end
+
+    def each_event(&blk)
+      while !@current_page.empty?
+        @current_page.each_event(&blk)
+        fetch(@current_page.newer_events_uri) if @current_page.newer_events_uri
+      end
+    end
+
+    private
+
+    def fetch_first_page(uri)
+      back_off = 1
+      loop do
+        begin
+          fetch(uri)
+          last = @current_page.first_event_uri
+          fetch(last) if last
+          return
+        rescue Exception => ex
+          @listener.call({
+            level: 'error',
+            tag:   'connection.error',
+            msg:   "#{ex.class}: #{ex.message}. Retry in #{back_off}s."
+          })
+          sleep back_off
+          back_off *= 2
+        end
+      end
+    end
+
+    def fetch(uri)
+      response = @connection.get(uri, @current_etag)
+      @current_page = Page.new(response.body)
+      @current_uri = uri
+      @current_etag = response.headers['etag']
+    end
+
+  end
+
+end
+

data/lib/es_readmodel/subscriber.rb

@@ -0,0 +1,102 @@
+require 'rack'
+require 'json'
+require_relative './connection'
+require_relative './stream'
+
+module EsReadModel
+
+  class Subscriber
+
+    attr_reader :status
+
+    def initialize(app, options)
+      @app = app
+      @listener = options[:listener]
+      url = "http://#{options[:es_host]}:#{options[:es_port]}"
+      @status = {
+        available: false,
+        startedAt: Time.now,
+        eventsReceived: 0,
+        eventStore: {
+          url: url,
+          connected: true,
+          disconnects: 0
+        }
+      }
+      @connection = Connection.new(url, options[:es_username], options[:es_password])
+      @reducer = options[:reducer]
+      Thread.new { subscribe }
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+      if env['PATH_INFO'] == '/status'
+        status, headers, body = json_response(200, @status)
+      else
+        env['readmodel.state'] = @state
+        env['readmodel.available'] = @status[:available]
+        env['readmodel.status'] = 'OK'
+        status, headers, body = @app.call(env)
+      end
+      @listener.call({
+        level:  'info',
+        tag:    'http.request',
+        msg:    "#{env['REQUEST_METHOD']} #{@request.fullpath}",
+        status: status
+      })
+      [status, headers, body]
+    end
+
+    private
+
+    def subscribe
+      loop do
+        begin
+          @status[:available] = false
+          @status[:eventStore][:connected] = false
+          @state = nil
+          @stream = Stream.open("$all", @connection, @listener)
+          @status[:eventStore][:connected] = true
+          @status[:eventStore][:lastConnect] = Time.now
+          subscribe_to_all_events
+        rescue Exception => ex
+          @listener.call({
+            level: 'error',
+            tag:   'connection.error',
+            msg:   "#{ex.class}: #{ex.message}"
+          })
+          @status[:eventStore][:disconnects] = @status[:eventStore][:disconnects] + 1
+          @status[:eventStore][:lastDisconnect] = Time.now
+        end
+      end
+    end
+
+    def subscribe_to_all_events
+      loop do
+        @status[:available] = true
+        @stream.wait_for_new_events
+        @status[:available] = false
+        @stream.each_event do |evt|
+          @state = @reducer.call(@state, evt)
+          @status[:eventsReceived] = @status[:eventsReceived] + 1
+        end
+      end
+    end
+
+    def json_response(status_code, body)
+      result = body.merge({
+        _links: { self: @request.fullpath }
+      })
+      [
+        status_code,
+        {
+          'Content-Type' => 'application/json'
+        },
+        [result.to_json]
+      ]
+    end
+
+  end
+
+end
+

data/lib/es_readmodel.rb

@@ -0,0 +1,7 @@
+require_relative './es_readmodel/subscriber'
+require_relative './es_readmodel/api'
+require_relative './es_readmodel/logger'
+
+module EsReadModel
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: es-readmodel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Rutherford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: An opinionated read model framework for use with EventStore
+email:
+- kevin@rutherford-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- es-readmodel.gemspec
+- lib/es_readmodel.rb
+- lib/es_readmodel/api.rb
+- lib/es_readmodel/connection.rb
+- lib/es_readmodel/event.rb
+- lib/es_readmodel/logger.rb
+- lib/es_readmodel/page.rb
+- lib/es_readmodel/stream.rb
+- lib/es_readmodel/subscriber.rb
+homepage: https://github.com/kevinrutherford/es-readmodel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: An opinionated read model framework for use with EventStore
+test_files: []