event_store_client 0.2.7 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82d6c3f0f05d70cafc2e28ace794847de37a8fddfdc8b2f60fe52cfb89d9cee
-  data.tar.gz: 85c7cbca113143890c843ba0e07f783eb3dd7754ff8c7ee92dff7e49abf69252
+  metadata.gz: e97364d118166a05b3bda769d8d63389e3e5da1035317f7f4620d1e4d7c1a5fb
+  data.tar.gz: eac9bb8cc42cf8f26b13524dfbd84e1dcaf29e6712437a743add53d68034b2fc
 SHA512:
-  metadata.gz: ee4e7d182f5f6e1ce239020391ac71b62718e8c8d654b90345e015bd4246012f09c904bce11b33db1161f064a2e92a29276e784afb0d8ccc50756948ad01a780
-  data.tar.gz: da128977ff1fed3e55c92ed07fb881fcc9223b3d1a4b04ed0a4de279ede84f4f6290469914dd40baf3f12c41a06a1f6b8dd7bf9526f8414f15deeb39c9dde8f0
+  metadata.gz: d10553a93c2fd65497e88def8a1c8b0205e7d01a89d7ae45caa422f5d95a5d0966bc0d7796e5ed9b967f7617793fc4f3a01a6619e30b91aa59d7e9fa5de555a6
+  data.tar.gz: 1c82a1eba935ffacf3bd6d265c3734ed970931e84b1c730ad397bbbf3f93901d55f318ee3531a0033f88ac3214f310879e8cf77fb96038b58810fbb6d91ee703

data/README.md

@@ -5,6 +5,12 @@
 
 An easy-to use API client for connecting ruby applications with https://eventstore.org/
 
+## Supported adapters
+
+- GRPC - default
+- [HTTP](https://github.com/yousty/event_store_client/tree/master/lib/event_store_client/adapters/http/README.md) - Deprecated
+- Memory - for testing
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -24,6 +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
@@ -32,33 +40,13 @@ $ gem install event_store_client
 
 2. Run the Event Store server
 
-`docker run --name eventstore -it -p 2113:2113 -p 1113:1113 eventstore/eventstore`
-
-3. Set Basic HTTP auth enviornment variables #below are defaults
-  - export EVENT_STORE_USER=admin
-  - export EVENT_STORE_PASSWORD=changeit
+`docker run --env EVENTSTORE_INSECURE=true --name eventstore -it -p 2113:2113 -p 1113:1113 eventstore/eventstore`
 
-Ref: https://eventstore.org/docs/http-api/security
-
-4. Login to admin panel http://localhost:2113 and enable Projections for Event-Types
-
-### Configure EventStoreClient
-
-Before you start, add this to the `initializer` or to the top of your script:
-
-`EventStoreClient.configure`
-
-For testing, you can use the InMemory adapter. To do it you should change the configuration.
-
-```ruby
-EventStoreClient.configure do |config|
-  config.adapter = EventStoreClient::StoreAdapter::InMemory.new(host: 'http://localhost', port: '2113')
-end
-```
+4. Visit the admin panel http://localhost:2113 and enable Projections for Event-Types
 
 ### Create Dummy event and dummy Handler
 
-To test out the behavior, you'll need a sample event and handler to work with:
+To test out the behavior, you'll need a sample event and event handler to work with:
 
 ```ruby
 
@@ -83,7 +71,7 @@ with an event being passed as an argument.
 
 ```ruby
 class DummyHandler
-  def self.call(event)
+  def call(event)
     puts "Handled #{event.class.name}"
   end
 end
@@ -110,7 +98,7 @@ events = client.read('newstream')
 **Changing reading direction**
 
 ```ruby
-events = client.read('newstream', direction: 'backward') #default 'forward'
+events = client.read('newstream', direction: 'backwards') #default 'forwards'
 ```
 
 **Reading all events from a stream**
@@ -122,12 +110,12 @@ events = client.read('newstream', all: true) #default 'false'
 ### Subscribing to events
 
 ```ruby
-client.subscribe(DummyHandler, to: [SomethingHappened])
+client.subscribe(DummyHandler.new, to: [SomethingHappened])
 
-# now try to publish several events
+# Now In another terminal seesion try to publish several events
 10.times { client.publish(stream: 'newstream', events: [event]) }
 
-You can also publish multiple events at once
+# You can also publish multiple events at once
 
 events = (1..10).map { event }
 client.publish(stream: 'newstream', events: events)
@@ -141,22 +129,24 @@ client.publish(stream: 'newstream', events: events)
 client.stop_polling
 ```
 
-### Linking existing events to the streem
+### Configure EventStoreClient
+
+Before you start, add this to the `initializer` or to the top of your script:
 
-Event to be linked properly has to coantians original event id.
-Real events could be mixed with linked events in the same stream.
+For testing, you can use the InMemory adapter. To do it you should change the configuration.
 
 ```ruby
-exisiting_event1 = client.read('newstream').last
-client.link_to(stream: 'anotherstream', events: [exisiting_event1, ...])
+EventStoreClient.configure do |config|
+  config.adapter = EventStoreClient::InMemory.new(host: 'http://localhost', port: '2113')
+end
 ```
 
-When you read from stream where links are placed. By default Event Store Client always resolve links for you returning the event that points to the link. You can use the ES-ResolveLinkTos: false HTTP header during readin stream to tell Event Store Client to return you the actual link and to not resolve it.
-More info: [ES-ResolveLinkTos](https://eventstore.org/docs/http-api/optional-http-headers/resolve-linkto/index.html?tabs=tabid-1%2Ctabid-3).
-
 ## Event Mappers
 
-We offer two types of mappers - default and encrypted.
+At the moment we offer two types of mappers:
+
+- default
+- encrypted
 
 ### Default Mapper
 

data/lib/event_store_client.rb

@@ -12,8 +12,6 @@ require 'event_store_client/mapper'
 
 require 'event_store_client/configuration'
 
-require 'event_store_client/store_adapter'
-
 require 'event_store_client/subscription'
 require 'event_store_client/subscriptions'
 require 'event_store_client/broker'

data/lib/event_store_client/adapters/grpc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'event_store_client/value_objects/read_direction.rb'
+
+require 'event_store_client/adapters/grpc/commands/streams/append'
+require 'event_store_client/adapters/grpc/commands/streams/delete'
+require 'event_store_client/adapters/grpc/commands/streams/link_to'
+require 'event_store_client/adapters/grpc/commands/streams/read'
+require 'event_store_client/adapters/grpc/commands/streams/read_all'
+require 'event_store_client/adapters/grpc/commands/streams/tombstone'
+
+require 'event_store_client/adapters/grpc/commands/persistent_subscriptions/create'
+require 'event_store_client/adapters/grpc/commands/persistent_subscriptions/update'
+require 'event_store_client/adapters/grpc/commands/persistent_subscriptions/delete'
+require 'event_store_client/adapters/grpc/commands/persistent_subscriptions/read'
+
+require 'event_store_client/adapters/grpc/commands/projections/create'
+require 'event_store_client/adapters/grpc/commands/projections/update'
+require 'event_store_client/adapters/grpc/commands/projections/delete'
+
+require 'event_store_client/adapters/grpc/client'

data/lib/event_store_client/adapters/grpc/Protos/cluster.proto

@@ -0,0 +1,149 @@
+syntax = "proto3";
+package event_store.cluster;
+option java_package = "com.eventstore.dbclient.proto.cluster";
+
+import "shared.proto";
+
+service Gossip {
+	rpc Update (GossipRequest) returns (ClusterInfo);
+	rpc Read (event_store.client.shared.Empty) returns (ClusterInfo);
+}
+
+service Elections {	
+	rpc ViewChange (ViewChangeRequest) returns (event_store.client.shared.Empty);
+	rpc ViewChangeProof (ViewChangeProofRequest) returns (event_store.client.shared.Empty);
+	rpc Prepare (PrepareRequest) returns (event_store.client.shared.Empty);
+	rpc PrepareOk (PrepareOkRequest) returns (event_store.client.shared.Empty);
+	rpc Proposal (ProposalRequest) returns (event_store.client.shared.Empty);
+	rpc Accept (AcceptRequest) returns (event_store.client.shared.Empty);
+	
+	rpc LeaderIsResigning (LeaderIsResigningRequest) returns (event_store.client.shared.Empty);
+	rpc LeaderIsResigningOk (LeaderIsResigningOkRequest) returns (event_store.client.shared.Empty);
+}
+
+message GossipRequest {
+	ClusterInfo info = 1;
+	EndPoint server = 2;
+}
+
+message ViewChangeRequest {
+	event_store.client.shared.UUID server_id = 1;
+	EndPoint server_http = 2;
+	int32 attempted_view = 3;
+}
+
+message ViewChangeProofRequest {
+	event_store.client.shared.UUID server_id = 1;
+	EndPoint server_http = 2;
+	int32 installed_view = 3;
+}
+
+message PrepareRequest {
+	event_store.client.shared.UUID server_id = 1;
+	EndPoint server_http = 2;
+	int32 view = 3;
+}
+
+message PrepareOkRequest {
+	int32 view = 1;
+	event_store.client.shared.UUID server_id = 2;
+	EndPoint server_http = 3;
+	int32 epoch_number = 4;
+	int64 epoch_position = 5;
+	event_store.client.shared.UUID epoch_id = 6;
+	event_store.client.shared.UUID epoch_leader_instance_id = 7;
+	int64 last_commit_position = 8;
+	int64 writer_checkpoint = 9;
+	int64 chaser_checkpoint = 10;
+	int32 node_priority = 11;
+	ClusterInfo cluster_info = 12;
+}
+
+message ProposalRequest {
+	event_store.client.shared.UUID server_id = 1;
+	EndPoint server_http = 2;
+	event_store.client.shared.UUID leader_id = 3;
+	EndPoint leader_http = 4;
+	int32 view = 5;
+	int32 epoch_number = 6;
+	int64 epoch_position = 7;
+	event_store.client.shared.UUID epoch_id = 8;
+	event_store.client.shared.UUID epoch_leader_instance_id = 9;
+	int64 last_commit_position = 10;
+	int64 writer_checkpoint = 11;
+	int64 chaser_checkpoint = 12;
+	int32 node_priority = 13;
+}
+
+message AcceptRequest {
+	event_store.client.shared.UUID server_id = 1;
+	EndPoint server_http = 2;
+	event_store.client.shared.UUID leader_id = 3;
+	EndPoint leader_http = 4;
+	int32 view = 5;
+}
+
+message LeaderIsResigningRequest {
+	event_store.client.shared.UUID leader_id = 1;
+	EndPoint leader_http = 2;
+}
+
+message LeaderIsResigningOkRequest {
+	event_store.client.shared.UUID leader_id = 1;
+	EndPoint leader_http = 2;
+	event_store.client.shared.UUID server_id = 3;
+	EndPoint server_http = 4;
+}
+
+message ClusterInfo {
+	repeated MemberInfo members = 1;
+}
+
+message EndPoint {
+	string address = 1;
+	uint32 port = 2;
+}
+
+message MemberInfo {
+	enum VNodeState {
+		Initializing = 0;
+		DiscoverLeader = 1;
+		Unknown = 2;
+		PreReplica = 3;
+		CatchingUp = 4;
+		Clone = 5;
+		Follower = 6;
+		PreLeader = 7;
+		Leader = 8;
+		Manager = 9;
+		ShuttingDown = 10;
+		Shutdown = 11;
+		ReadOnlyLeaderless = 12;
+		PreReadOnlyReplica = 13;
+		ReadOnlyReplica = 14;
+		ResigningLeader = 15;
+	}
+	event_store.client.shared.UUID instance_id = 1;
+	int64 time_stamp = 2;
+	VNodeState state = 3;
+	bool is_alive = 4;
+	EndPoint http_end_point = 5;
+	EndPoint internal_tcp = 6;
+	EndPoint external_tcp = 7;
+	bool internal_tcp_uses_tls = 8;
+	bool external_tcp_uses_tls = 9;
+	
+    int64 last_commit_position = 10;
+    int64 writer_checkpoint = 11;
+	int64 chaser_checkpoint = 12;
+    int64 epoch_position = 13;
+    int32 epoch_number = 14;
+    event_store.client.shared.UUID epoch_id = 15;
+
+    int32 node_priority = 16;
+    bool is_read_only_replica = 17;
+    string advertise_host_to_client_as = 18;
+    uint32 advertise_http_port_to_client_as = 19;
+    uint32 advertise_tcp_port_to_client_as = 20;
+}
+

data/lib/event_store_client/adapters/grpc/Protos/gossip.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+package event_store.client.gossip;
+option java_package = "com.eventstore.dbclient.proto.gossip";
+
+import "shared.proto";
+
+service Gossip {
+	rpc Read (event_store.client.shared.Empty) returns (ClusterInfo);
+}
+
+message ClusterInfo {
+	repeated MemberInfo members = 1;
+}
+
+message EndPoint {
+	string address = 1;
+	uint32 port = 2;
+}
+
+message MemberInfo {
+	enum VNodeState {
+		Initializing = 0;
+		DiscoverLeader = 1;
+		Unknown = 2;
+		PreReplica = 3;
+		CatchingUp = 4;
+		Clone = 5;
+		Follower = 6;
+		PreLeader = 7;
+		Leader = 8;
+		Manager = 9;
+		ShuttingDown = 10;
+		Shutdown = 11;
+		ReadOnlyLeaderless = 12;
+		PreReadOnlyReplica = 13;
+		ReadOnlyReplica = 14;
+		ResigningLeader = 15;
+	}
+	event_store.client.shared.UUID instance_id = 1;
+	int64 time_stamp = 2;
+	VNodeState state = 3;
+	bool is_alive = 4;
+	EndPoint http_end_point = 5;
+}

data/lib/event_store_client/adapters/grpc/Protos/operations.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+package event_store.client.operations;
+option java_package = "com.eventstore.dbclient.proto.operations";
+
+import "shared.proto";
+
+service Operations {
+	rpc StartScavenge (StartScavengeReq) returns (ScavengeResp);
+	rpc StopScavenge (StopScavengeReq) returns (ScavengeResp);
+	rpc Shutdown (event_store.client.shared.Empty) returns (event_store.client.shared.Empty);
+	rpc MergeIndexes (event_store.client.shared.Empty) returns (event_store.client.shared.Empty);
+	rpc ResignNode (event_store.client.shared.Empty) returns (event_store.client.shared.Empty);
+	rpc SetNodePriority (SetNodePriorityReq) returns (event_store.client.shared.Empty);
+	rpc RestartPersistentSubscriptions (event_store.client.shared.Empty) returns (event_store.client.shared.Empty);
+}
+
+message StartScavengeReq {
+	Options options = 1;
+	message Options {
+		int32 thread_count = 1;
+		int32 start_from_chunk = 2;
+	}
+}
+
+message StopScavengeReq {
+	Options options = 1;
+	message Options {
+		string scavenge_id = 1;
+	}
+}
+
+message ScavengeResp {
+	string scavenge_id = 1;
+	ScavengeResult scavenge_result = 2;
+
+	enum ScavengeResult {
+		Started = 0;
+		InProgress = 1;
+		Stopped = 2;
+	}
+}
+
+message SetNodePriorityReq {
+	int32 priority = 1;
+}

data/lib/event_store_client/adapters/grpc/Protos/persistent.proto

@@ -0,0 +1,180 @@
+syntax = "proto3";
+package event_store.client.persistent_subscriptions;
+option java_package = "com.eventstore.dbclient.proto.persistentsubscriptions";
+
+import "shared.proto";
+
+service PersistentSubscriptions {
+	rpc Create (CreateReq) returns (CreateResp);
+	rpc Update (UpdateReq) returns (UpdateResp);
+	rpc Delete (DeleteReq) returns (DeleteResp);
+	rpc Read (stream ReadReq) returns (stream ReadResp);
+}
+
+message ReadReq {
+	oneof content {
+		Options options = 1;
+		Ack ack = 2;
+		Nack nack = 3;
+	}
+
+	message Options {
+		event_store.client.shared.StreamIdentifier stream_identifier = 1;
+		string group_name = 2;
+		int32 buffer_size = 3;
+		UUIDOption uuid_option = 4;
+
+		message UUIDOption {
+			oneof content {
+				event_store.client.shared.Empty structured = 1;
+				event_store.client.shared.Empty string = 2;
+			}
+		}
+	}
+
+	message Ack {
+		bytes id = 1;
+		repeated event_store.client.shared.UUID ids = 2;
+	}
+
+	message Nack {
+		bytes id = 1;
+		repeated event_store.client.shared.UUID ids = 2;
+		Action action = 3;
+		string reason = 4;
+
+		enum Action {
+			Unknown = 0;
+			Park = 1;
+			Retry = 2;
+			Skip = 3;
+			Stop = 4;
+		}
+	}
+}
+
+message ReadResp {
+	oneof content {
+		ReadEvent event = 1;
+		SubscriptionConfirmation subscription_confirmation = 2;
+	}
+	message ReadEvent {
+		RecordedEvent event = 1;
+		RecordedEvent link = 2;
+		oneof position {
+			uint64 commit_position = 3;
+			event_store.client.shared.Empty no_position = 4;
+		}
+		oneof count {
+			int32 retry_count = 5;
+			event_store.client.shared.Empty no_retry_count = 6;
+		}
+		message RecordedEvent {
+			event_store.client.shared.UUID id = 1;
+			event_store.client.shared.StreamIdentifier stream_identifier = 2;
+			uint64 stream_revision = 3;
+			uint64 prepare_position = 4;
+			uint64 commit_position = 5;
+			map<string, string> metadata = 6;
+			bytes custom_metadata = 7;
+			bytes data = 8;
+		}
+	}
+	message SubscriptionConfirmation {
+		string subscription_id = 1;
+	}
+}
+
+message CreateReq {
+	Options options = 1;
+
+	message Options {
+		event_store.client.shared.StreamIdentifier stream_identifier = 1;
+		string group_name = 2;
+		Settings settings = 3;
+	}
+
+	message Settings {
+		bool resolve_links = 1;
+		uint64 revision = 2;
+		bool extra_statistics = 3;
+		int32 max_retry_count = 5;
+		int32 min_checkpoint_count = 7;
+		int32 max_checkpoint_count = 8;
+		int32 max_subscriber_count = 9;
+		int32 live_buffer_size = 10;
+		int32 read_batch_size = 11;
+		int32 history_buffer_size = 12;
+		ConsumerStrategy named_consumer_strategy = 13;
+		oneof message_timeout {
+			int64 message_timeout_ticks = 4;
+			int32 message_timeout_ms = 14;
+		}
+		oneof checkpoint_after {
+			int64 checkpoint_after_ticks = 6;
+			int32 checkpoint_after_ms = 15;
+		}
+	}
+
+	enum ConsumerStrategy {
+		DispatchToSingle = 0;
+		RoundRobin = 1;
+		Pinned = 2;
+	}
+}
+
+message CreateResp {
+}
+
+message UpdateReq {
+	Options options = 1;
+
+	message Options {
+		event_store.client.shared.StreamIdentifier stream_identifier = 1;
+		string group_name = 2;
+		Settings settings = 3;
+	}
+
+	message Settings {
+		bool resolve_links = 1;
+		uint64 revision = 2;
+		bool extra_statistics = 3;
+		int32 max_retry_count = 5;
+		int32 min_checkpoint_count = 7;
+		int32 max_checkpoint_count = 8;
+		int32 max_subscriber_count = 9;
+		int32 live_buffer_size = 10;
+		int32 read_batch_size = 11;
+		int32 history_buffer_size = 12;
+		ConsumerStrategy named_consumer_strategy = 13;
+		oneof message_timeout {
+			int64 message_timeout_ticks = 4;
+			int32 message_timeout_ms = 14;
+		}
+		oneof checkpoint_after {
+			int64 checkpoint_after_ticks = 6;
+			int32 checkpoint_after_ms = 15;
+		}
+	}
+
+	enum ConsumerStrategy {
+		DispatchToSingle = 0;
+		RoundRobin = 1;
+		Pinned = 2;
+	}
+}
+
+message UpdateResp {
+}
+
+message DeleteReq {
+	Options options = 1;
+
+	message Options {
+		event_store.client.shared.StreamIdentifier stream_identifier = 1;
+		string group_name = 2;
+	}
+}
+
+message DeleteResp {
+}