event_store_client 1.0.6 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 073a691ef952647fd7be92fad2526a279dccfe05867c524ccab6a86aee815dd2
-  data.tar.gz: 75c51d92577ceb57488e07761466dd58bf1b8cb52e23ee11a82d40bdfb387039
+  metadata.gz: 7046a3740fb53a00a8c30786e4bf6af390ba8a93be973412514baff7065731d1
+  data.tar.gz: ba04c6804ebfa8d7e876f14766f87f806adff2dee66e2f1e02a6d0644acad357
 SHA512:
-  metadata.gz: c9ba15429219f65fc9a7473642ff2e7a0c048cf14a0246f00ecac62ad5daf38ab9c0a800993911d14cd142706ec1d3f5e233e092279391c7c7d9d43683468a05
-  data.tar.gz: 27f4088d4e92c6a0cef51a93970559a4253d44789e5d9c3a744afebc59de027f3f1853e0c527de5438ede1031bd5cf9ad36aff2e6f8f82856202c23a45b47025
+  metadata.gz: 3657c4a696a35b85f37995cae37af7fd31d7c287f751a8444e1e63c640d7ec5dd9e874164c5448aa0cee5030029d8b80797308676a528a5ec42af71800ea5677
+  data.tar.gz: d17ed0da65846b1e79caa8bbef2ad9968de9627605c3eb0b7b64eee6558e1768171e087604e9c2563666334da4f148913e82df8d35acd6a74852b548af641cc1

data/README.md

@@ -3,19 +3,19 @@
 
 # EventStoreClient
 
-An easy-to use API client for connecting ruby applications with https://eventstore.org/
+An easy-to use API client for connecting ruby applications with [EventStoreDB](https://eventstore.com/)
 
 ## Supported adapters
 
-- GRPC - default
+- [GRPC](https://github.com/yousty/event_store_client/tree/master/lib/event_store_client/adapters/grpc/README.md) - default
 - [HTTP](https://github.com/yousty/event_store_client/tree/master/lib/event_store_client/adapters/http/README.md) - Deprecated
-- Memory - for testing
+- InMemory - for testing
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'event_store_client'
+gem 'event_store_client', '~> 1.0'
 ```
 
 And then execute:
@@ -30,19 +30,8 @@ $ gem install event_store_client
 
 ## Usage
 
-Before you start, make sure you have a running EventStoreDB instance on your machine
-
-### EventStore engine setup
-
-1. Download Event Store From https://eventstore.org/downloads/ or docker
-
-` docker pull eventstore/eventstore`
-
-2. Run the Event Store server
-
-`docker run --env EVENTSTORE_INSECURE=true --name eventstore -it -p 2113:2113 -p 1113:1113 eventstore/eventstore`
-
-4. Visit the admin panel http://localhost:2113 and enable Projections for Event-Types
+Before you start, make sure you are connecting to a running EventStoreDB instance. For a detailed guide see:
+[EventStoreServerSetup](https://github.com/yousty/event_store_client/blob/master/docs/eventstore_server_setup.md)
 
 ### Create Dummy event and dummy Handler
 
@@ -76,71 +65,99 @@ class DummyHandler
   end
 end
 ```
-## Usage
+
 
 ```ruby
-# initialize the client
-client = EventStoreClient::Client.new
-```
 
-### Publishing events
+require 'event_store_client'
+require "event_store_client/adapters/grpc"
 
-```ruby
-client.publish(stream: 'newstream', events: [event])
-```
+EventStoreClient.configure do |config|
+  config.eventstore_url = ENV['EVENTSTORE_URL']
+  config.eventstore_user = ENV['EVENTSTORE_USER']
+  config.eventstore_password = ENV['EVENTSTORE_PASSWORD']
+  config.verify_ssl = false # remove this line if your server does have the host verified
+end
 
-### Reading from a stream
+event_store = EventStoreClient::Client.new
 
-```ruby
-events = client.read('newstream')
+event_store.subscribe(
+  DummyHandler.new,
+  to: [SomethingHappened]
+)
+
+event_store.listen
 ```
 
-**Changing reading direction**
+## Features
 
-```ruby
-events = client.read('newstream', direction: 'backwards') #default 'forwards'
-```
+## Basic Usage
 
-**Reading all events from a stream**
+The main interface allows for actions listed below which is enough for basic useage.
+The actual adapter allows for more actions. Contributions as always welcome!
 
 ```ruby
-events = client.read('newstream', all: true) #default 'false'
-```
+# Publishing to a stream
+event_store.publish(stream: 'newstream', events: [event])
 
-### Subscribing to events
+# Reading from a stream
+events = event_store.read('newstream').value!
 
-```ruby
-client.subscribe(DummyHandler.new, to: [SomethingHappened])
+# Reading all events from a stream
+events = event_store.read('newstream', options: { all: true }).value! #default 'false'
 
-# Now In another terminal seesion try to publish several events
-10.times { client.publish(stream: 'newstream', events: [event]) }
+# Linking existing events to a new stream
+event_store.link_to(stream_name, events)
 
-# You can also publish multiple events at once
+# Subscribing to events
+event_store.subscribe(DummyHandler.new, to: [SomethingHappened])
 
-events = (1..10).map { event }
-client.publish(stream: 'newstream', events: events)
+# Listening to new events for all registered subscriptions
+event_store.listen
 
+# In the new terminal session publish some events
+events = (1..10).map { event }
+event_store.publish(stream: 'newstream', events: events)
 # .... wait a little bit ... Your handler should be called for every single event you publish
 ```
 
-### Stop polling for new events
+### Extended usage
 
-```ruby
-client.stop_polling
+You can get access to more features by calling the adapter directly, for example:
+
+```
+event_store.connection.delete_stream(stream)
+event_store.connection.tombstone_stream(stream)
 ```
 
-### Configure EventStoreClient
+See the adapters method list for the possible usage.
 
-Before you start, add this to the `initializer` or to the top of your script:
+- [HTTP](https://github.com/yousty/event_store_client/blob/master/lib/event_store_client/adapters/http/client.rb)
+- [GRPC](https://github.com/yousty/event_store_client/blob/master/lib/event_store_client/adapters/grpc/client.rb)
 
-For testing, you can use the InMemory adapter. To do it you should change the configuration.
+### Configuration
+
+There are several configuration options you can pass to customize your client's instance.
+All the config options can be passed the same way:
 
 ```ruby
 EventStoreClient.configure do |config|
-  config.adapter = EventStoreClient::InMemory.new(host: 'http://localhost', port: '2113')
+  config.adapter = :grpc
 end
 ```
 
+| name        | value           | default   | description |
+|:-------------:|:-------------:|:-----:|:-------------:|
+| adapter      | `:grpc`, `:http` or `:in_memory` | `:grpc` | different ways to connect with an event_store_db. The in_memory is a mock server useful for testing |
+| verify_ssl   | Boolean      | true | Useful for self-signed certificates (Kubernetes, local development) |
+| error_handler | Any callable ruby object | EvenStoreClient::ErrorHandler | You can pass a custom error handler for reacting on event_handler errors.|
+| eventstore_url| String| 'http://localhost:2113'| An url for the server instance|
+| user| String| 'admin' | a user used to connect the application with the server|
+| password| String| 'changeit'| a password used to connect the application with the server|
+| per_page| Integer| 20 | a batch size for events subscriptions |
+| service_name| String| 'default' | a prefix (namespace) added to the subscriptions names|
+| mapper| `Mapper::Default` or `Mapper::Encrypted`| `Mapper::Default.new` | an engine used to parse events.
+
 ## Event Mappers
 
 At the moment we offer two types of mappers:
@@ -156,86 +173,7 @@ Event parsable by event_store and the other way around.
 ### Encrypted Mapper
 
 This is implemented to match GDPR requirements. It allows you to encrypt any event using your
-encryption_key repository.
-
-```ruby
-mapper = EventStoreClient::Mapper::Encrypted.new(key_repository)
-EventStoreClient.configure do |config|
-  config.mapper = mapper
-end
-```
-
-The Encrypted mapper uses the encryption key repository to encrypt data in your events according to the event definition.
-
-Here is the minimal repository interface for this to work.
-
-```ruby
-class DummyRepository
-  class Key
-    attr_accessor :iv, :cipher, :id
-    def initialize(id:, **)
-      @id = id
-    end
-  end
-
-  def find(user_id)
-    Key.new(id: user_id)
-  end
-
-  def encrypt(*)
-    'darthvader'
-  end
-
-  def decrypt(*)
-    { first_name: 'Anakin', last_name: 'Skylwalker'}
-  end
-end
-```
-
-Now, having that, you only need to define the event encryption schema:
-
-```ruby
-class EncryptedEvent < EventStoreClient::DeserializedEvent
-  def schema
-    Dry::Schema.Params do
-      required(:user_id).value(:string)
-      required(:first_name).value(:string)
-      required(:last_name).value(:string)
-      required(:profession).value(:string)
-    end
-  end
-
-  def self.encryption_schema
-    {
-      key: ->(data) { data['user_id'] },
-      attributes: %i[first_name last_name email]
-    }
-  end
-end
-
-event = EncryptedEvent.new(
-  user_id: SecureRandom.uuid,
-  first_name: 'Anakin',
-  last_name: 'Skylwalker',
-  profession: 'Jedi'
-)
-```
-
-When you'll publish this event, in the store will be saved:
-
-```ruby
-{
-  'data' => {
-    'user_id' => 'dab48d26-e4f8-41fc-a9a8-59657e590716',
-    'first_name' => 'encrypted',
-    'last_name' => 'encrypted',
-    'profession' => 'Jedi',
-    'encrypted' => '2345l423lj1#$!lkj24f1'
-  },
-  type: 'EncryptedEvent'
-  metadata: { ... }
-}
-```
+encryption_key repository. For the detailed guide see the: [Encrypting Events](https://github.com/yousty/event_store_client/blob/master/docs/encrypting_events.md).
 
 ## Contributing
 
@@ -245,6 +183,8 @@ Do you want to contribute? Welcome!
 2. Create Issue
 3. Create PR ;)
 
+For running the client in the dev mode, see: [Development Guide](https://github.com/yousty/event_store_client/blob/master/docs/eventstore_server_setup.md)
+
 ### Publishing new version
 
 1. Push commit with updated `version.rb` file to the `release` branch. The new version will be automatically pushed to [rubygems](https://rubygems.org).

data/lib/event_store_client.rb

@@ -4,13 +4,14 @@ module EventStoreClient
 end
 
 require 'event_store_client/types'
-require 'event_store_client/event'
-require 'event_store_client/deserialized_event'
+
 require 'event_store_client/serializer/json'
 
 require 'event_store_client/mapper'
 
 require 'event_store_client/configuration'
+require 'event_store_client/event'
+require 'event_store_client/deserialized_event'
 
 require 'event_store_client/subscription'
 require 'event_store_client/subscriptions'

data/lib/event_store_client/adapters/grpc/README.md

@@ -0,0 +1,16 @@
+### GRPC adapter
+
+This adapter targets the EventstoreDB version `>= "20.*"
+
+### Configuration
+
+As by default EventStoreClient uses GRPC adapter. No need to configure anything if you want to use it,
+however to set it explicitly, place the snippet below in your initializer or when you boot your application.
+
+```ruby
+require 'event_store_client/adapters/grpc'
+
+EventStoreClient.configure do |config|
+  config.adapter = :grpc
+end
+```

data/lib/event_store_client/adapters/grpc/commands/streams/append.rb

@@ -44,8 +44,8 @@ module EventStoreClient
                     id: {
                       string: SecureRandom.uuid
                     },
-                    data: event.data,
-                    custom_metadata:   JSON.generate(custom_metadata),
+                    data: event.data.b,
+                    custom_metadata: JSON.generate(custom_metadata),
                     metadata: event_metadata
                   }
                 )

data/lib/event_store_client/adapters/http/README.md

@@ -1,8 +1,6 @@
 ### HTTP adapter
 
-This adapter targets the EventstoreDB version `>= "5.*"
-
-For detailed docs about the http protocol see [EventStoreDB Http Documentation](https://developers.eventstore.com/server/5.0.8/http-api/)
+This adapter targets the EventstoreDB version `>= "20.*"
 
 ### Configuration
 
@@ -10,7 +8,9 @@ As by default EventStoreClient uses gRPC adapter, to switch to http you need to
 Place the snippet below in your initializer or when you boot your application.
 
 ```ruby
+require 'event_store_client/adapters/http'
+
 EventStoreClient.configure do |config|
-  config.adapter = :api
+  config.adapter = :http
 end
 ```

data/lib/event_store_client/adapters/http/client.rb

@@ -47,9 +47,7 @@ module EventStoreClient
       # @return Dry::Monads::Result::Success with returned events or Dry::Monads::Result::Failure
       #
       def read(stream_name, options: {})
-        Commands::Streams::Read.new(connection).call(
-          stream_name, options: options
-        )
+        Commands::Streams::Read.new(connection).call(stream_name, options: options)
       end
 
       # Reads all events from the given stream

data/lib/event_store_client/adapters/http/commands/streams/read.rb

@@ -11,10 +11,8 @@ module EventStoreClient
             count = options[:count] || config.per_page
             start = options[:start].to_i
             direction = options[:direction] || 'forward'
-            headers = {
-              'ES-ResolveLinkTos' => options[:resolve_links].to_s,
-              'Accept' => 'application/vnd.eventstore.atom+json'
-            }
+            headers = { 'Accept' => 'application/vnd.eventstore.atom+json' }
+            headers['ES-ResolveLinkTos'] = true if options.key?(:resolve_links)
 
             response =
               connection.call(

data/lib/event_store_client/configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry-configurable'
-
+require 'event_store_client/error_handler'
 module EventStoreClient
   extend Dry::Configurable
 
@@ -10,7 +10,7 @@ module EventStoreClient
   setting :adapter, :grpc
   setting :verify_ssl, true
 
-  setting :error_handler
+  setting :error_handler, ErrorHandler.new
   setting :eventstore_url, 'http://localhost:2113' do |value|
     value.is_a?(URI) ? value : URI(value)
   end

data/lib/event_store_client/deserialized_event.rb

@@ -19,7 +19,9 @@ module EventStoreClient
 
     def initialize(**args)
       validation = schema.call(args[:data] || {})
-      raise InvalidDataError.new(message: validation.errors.to_h) if validation.errors.any?
+      if validation.errors.any?
+        raise InvalidDataError.new(message: "#{schema.class.name} #{validation.errors.to_h}")
+      end
 
       @data = args.fetch(:data) { {} }
       @metadata = args.fetch(:metadata) { {} }.merge(

data/lib/event_store_client/error_handler.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EventStoreClient
+  class ErrorHandler
+    def call(error)
+      puts error
+      puts error.backtrace
+    end
+  end
+end

data/lib/event_store_client/subscription.rb

@@ -13,7 +13,8 @@ module EventStoreClient
         else
           subscriber.class.name
         end
-      @name = "#{service}-#{subscriber_class}"
+      @name = subscriber_class.to_s
+      @name = "#{service}-" + @name if service != ''
       @subscriber = subscriber
       @stream = name
       @observed_streams = event_types.reduce([]) { |r, type| r << "$et-#{type}" }

data/lib/event_store_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventStoreClient
-  VERSION = '1.0.6'
+  VERSION = '1.0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.11
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -156,6 +156,7 @@ files:
 - lib/event_store_client/adapters/grpc/Protos/shared.proto
 - lib/event_store_client/adapters/grpc/Protos/streams.proto
 - lib/event_store_client/adapters/grpc/Protos/users.proto
+- lib/event_store_client/adapters/grpc/README.md
 - lib/event_store_client/adapters/grpc/client.rb
 - lib/event_store_client/adapters/grpc/command_registrar.rb
 - lib/event_store_client/adapters/grpc/commands/command.rb
@@ -212,6 +213,7 @@ files:
 - lib/event_store_client/data_encryptor.rb
 - lib/event_store_client/deserialized_event.rb
 - lib/event_store_client/encryption_metadata.rb
+- lib/event_store_client/error_handler.rb
 - lib/event_store_client/event.rb
 - lib/event_store_client/mapper.rb
 - lib/event_store_client/mapper/default.rb
@@ -242,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Ruby integration for https://eventstore.org