feat: s/Eventsourcingdb/EventSourcingDB/ (#24)

Author: gossi

.gitignore

@@ -11,6 +11,7 @@ tmp/
 erl_crash.dump
 *.ez
 eventsourcingdb-*.tar
+EventSourcingDB-*.tar
 
 # OS generated files and directories
 .DS_Store

README.md

@@ -1,23 +1,23 @@
-# eventsourcingdb
+# EventSourcingDB
 
-The official Elixir client SDK for [EventSourcingDB](https://www.eventsourcingdb.io) – a purpose-built database for event sourcing.
+The official Elixir client SDK for [EventSourcingDB](https://www.EventSourcingDB.io) – a purpose-built database for event sourcing.
 
 EventSourcingDB enables you to build and operate event-driven applications with
 native support for writing, reading, and observing events. This client SDK
-provides convenient access to its capabilities in Elixir (read the [Elixir SDK documentation](https://hexdocs.pm/eventsourcingdb)).
+provides convenient access to its capabilities in Elixir (read the [Elixir SDK documentation](https://hexdocs.pm/EventSourcingDB)).
 
-For more information on EventSourcingDB, see its [official documentation](https://docs.eventsourcingdb.io/).
+For more information on EventSourcingDB, see its [official documentation](https://docs.EventSourcingDB.io/).
 
 This client SDK includes support for [Testcontainers](https://testcontainers.com/) to spin up EventSourcingDB instances in integration tests. For details, see [Using Testcontainers](#using-testcontainers).
 
 ## Getting Started
 
-The package can be installed by adding `eventsourcingdb` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `EventSourcingDB` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:eventsourcingdb, "~> 0.1.0"}
+    {:EventSourcingDB, "~> 0.1.0"}
   ]
 end
 ```
@@ -28,7 +28,7 @@ EventSourcingDB instance:
 ```elixir
 base_url = "localhost:3000"
 api_token = "secret"
-client = Eventsourcingdb.Client.new(base_url, api_token)
+client = EventSourcingDB.Client.new(base_url, api_token)
 ```
 
 Now every request will take the client as its first param.
@@ -38,15 +38,15 @@ Now every request will take the client as its first param.
 Call the `write_events` function and hand over a list with one or more events. You do not have to provide all event fields – some are automatically added by the server.
 
 Specify `source`, `subject`, `type`, and `data` according to the
-[CloudEvents](https://docs.eventsourcingdb.io/fundamentals/cloud-events/)
+[CloudEvents](https://docs.EventSourcingDB.io/fundamentals/cloud-events/)
 format.
 
 The function returns the written events, including the fields added by the
 server:
 
 ```elixir
-event = %Eventsourcingdb.EventCandidate{
-  source: "https://library.eventsourcingdb.io",
+event = %EventSourcingDB.EventCandidate{
+  source: "https://library.EventSourcingDB.io",
   subject: "/books/42",
   type: "io.eventsourcingdb.library.book-acquired",
   data: %{
@@ -56,7 +56,7 @@ event = %Eventsourcingdb.EventCandidate{
   }
 }
 
-written = Eventsourcingdb.write_events(client, [event])
+written = EventSourcingDB.write_events(client, [event])
 
 case written do
   {:ok, events} -> # ...
@@ -69,10 +69,10 @@ end
 If you only want to write events in case a subject (such as `/books/42`) does not yet have any events, use the `IsSubjectPristine` precondition to create a precondition and pass it in a vector as the second argument:
 
 ```elixir
-written = Eventsourcingdb.write_events(
+written = EventSourcingDB.write_events(
   client,
   [event],
-  [%Eventsourcingdb.IsSubjectPristine{subject: "/books/42"}]
+  [%EventSourcingDB.IsSubjectPristine{subject: "/books/42"}]
 )
 
 case written do
@@ -86,10 +86,10 @@ end
 If you only want to write events in case a subject (such as `/books/42`) already has at least one event, use the `IsSubjectPopulated` precondition to create a precondition and pass it in a vector as the second argument:
 
 ```elixir
-written = Eventsourcingdb.write_events(
+written = EventSourcingDB.write_events(
   client,
   [event],
-  [%Eventsourcingdb.IsSubjectPopulated{subject: "/books/42"}]
+  [%EventSourcingDB.IsSubjectPopulated{subject: "/books/42"}]
 )
 
 case written do
@@ -103,10 +103,10 @@ end
 If you only want to write events in case the last event of a subject (such as `/books/42`) has a specific ID (e.g., `0`), use the `IsSubjectOnEventId` precondition to create a precondition and pass it in a vector as the second argument:
 
 ```elixir
-written = Eventsourcingdb.write_events(
+written = EventSourcingDB.write_events(
   client,
   [event],
-  [%Eventsourcingdb.IsSubjectOnEventId{subject: "/books/42", event_id: "0"}]
+  [%EventSourcingDB.IsSubjectOnEventId{subject: "/books/42", event_id: "0"}]
 )
 
 case written do
@@ -122,10 +122,10 @@ end
 If you want to write events depending on an EventQL query, use the `IsEventQLQueryTrue` precondition to create a precondition and pass it in a vector as the second argument:
 
 ```elixir
-written = Eventsourcingdb.write_events(
+written = EventSourcingDB.write_events(
   client,
   [event],
-  [%Eventsourcingdb.IsEventQLQueryTrue{
+  [%EventSourcingDB.IsEventQLQueryTrue{
     query: "FROM e IN events WHERE e.type == 'io.eventsourcingdb.library.book-borrowed' PROJECT INTO COUNT () < 10"
    }]
 )
@@ -144,7 +144,7 @@ subject and an options object.
 The function returns a stream from which you can retrieve one event at a time:
 
 ```elixir
-result = Eventsourcingdb.read_events(client, "/books/42")
+result = EventSourcingDB.read_events(client, "/books/42")
 
 case result do
   {:ok, events} -> Enum.to_list(events)
@@ -157,10 +157,10 @@ end
 If you want to read not only all the events of a subject, but also the events of all nested subjects, set the `recursive` option to `true`:
 
 ```elixir
-result = Eventsourcingdb.read_events(
+result = EventSourcingDB.read_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ReadEventsOptions{recursive: true}
+  %EventSourcingDB.ReadEventsOptions{recursive: true}
 )
 ```
 
@@ -169,10 +169,10 @@ result = Eventsourcingdb.read_events(
 By default, events are read in chronological order. To read in anti-chronological order, provide the `order` option and set it using the `:antichronological` ordering:
 
 ```elixir
-result = Eventsourcingdb.read_events(
+result = EventSourcingDB.read_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ReadEventsOptions{
+  %EventSourcingDB.ReadEventsOptions{
     recursive: false,
     order: :antichronological
   }
@@ -188,16 +188,16 @@ Sometimes you do not want to read all events, but only a range of events. For th
 Specify the ID and whether to include or exclude it, for both the lower and upper bound:
 
 ```elixir
-result = Eventsourcingdb.read_events(
+result = EventSourcingDB.read_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ReadEventsOptions{
+  %EventSourcingDB.ReadEventsOptions{
     recursive: false,
-    lower_bound: %Eventsourcingdb.BoundOptions{
+    lower_bound: %EventSourcingDB.BoundOptions{
       type: :inclusive,
       id: "100"
     },
-    upper_bound: %Eventsourcingdb.BoundOptions{
+    upper_bound: %EventSourcingDB.BoundOptions{
       type: :exclusive,
       id: "200"
     }
@@ -212,12 +212,12 @@ To read starting from the latest event of a given type, provide the `from_latest
 Possible options are `:read_nothing`, which skips reading entirely, or `:read_everything`, which effectively behaves as if `from_latest_event` was not specified:
 
 ```elixir
-result = Eventsourcingdb.read_events(
+result = EventSourcingDB.read_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ReadEventsOptions{
+  %EventSourcingDB.ReadEventsOptions{
     recursive: false,
-    from_latest_event: %Eventsourcingdb.FromLatestEventOptions{
+    from_latest_event: %EventSourcingDB.FromLatestEventOptions{
       subject: "/books/42",
       type: "io.eventsourcingdb.library.book-borrowed"
       if_event_is_missing: :read_everything
@@ -233,7 +233,7 @@ result = Eventsourcingdb.read_events(
 To run an EventQL query, call the `run_eventql_query` function and provide the query as argument. The function returns a stream.
 
 ```elixir
-result = Eventsourcingdb.run_eventql_query(client, "FROM e IN events PROJECT INTO e")
+result = EventSourcingDB.run_eventql_query(client, "FROM e IN events PROJECT INTO e")
 
 case result do
   {:ok, events} -> Enum.to_list(events)
@@ -248,7 +248,7 @@ To observe all events of a subject, call the `observe_events` function with the
 The function returns a stream from which you can retrieve one event at a time:
 
 ```elixir
-result = Eventsourcingdb.observe_events(client, "/books/42")
+result = EventSourcingDB.observe_events(client, "/books/42")
 
 case result do
   {:ok, events} -> Enum.to_list(events)
@@ -261,10 +261,10 @@ end
 If you want to observe not only all the events of a subject, but also the events of all nested subjects, set the `recursive` option to `true`:
 
 ```elixir
-result = Eventsourcingdb.observe_events(
+result = EventSourcingDB.observe_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ObserveEventsOptions{
+  %EventSourcingDB.ObserveEventsOptions{
     recursive: true
   }
 )
@@ -281,12 +281,12 @@ Sometimes you do not want to observe all events, but only a range of events. For
 Specify the ID and whether to include or exclude it:
 
 ```elixir
-result = Eventsourcingdb.observe_events(
+result = EventSourcingDB.observe_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ObserveEventsOptions{
+  %EventSourcingDB.ObserveEventsOptions{
     recursive: false,
-    lower_bound: %Eventsourcingdb.BoundOptions{
+    lower_bound: %EventSourcingDB.BoundOptions{
       type: :inclusive,
       id: "100"
     }
@@ -301,12 +301,12 @@ To observe starting from the latest event of a given type, provide the `from_lat
 Possible options are `:wait_for_event`, which waits for an event of the given type to happen, or `:read_everything`, which effectively behaves as if `from_latest_event` was not specified:
 
 ```elixir
-result = Eventsourcingdb.observe_events(
+result = EventSourcingDB.observe_events(
   client,
   "/books/42",
-  %Eventsourcingdb.ObserveEventsOptions{
+  %EventSourcingDB.ObserveEventsOptions{
     recursive: false,
-    from_latest_event: %Eventsourcingdb.FromLatestEventOptions{
+    from_latest_event: %EventSourcingDB.FromLatestEventOptions{
       subject: "/books/42",
       type: "io.eventsourcingdb.library.book-borrowed",
       if_event_is_missing: :read_everything
@@ -322,7 +322,7 @@ result = Eventsourcingdb.observe_events(
 To register an event schema, call the `register_event_schema` function and hand over an event type and the desired schema:
 
 ```elixir
-Eventsourcingdb.register_event_schema(
+EventSourcingDB.register_event_schema(
   client,
   "io.eventsourcingdb.library.book-acquired",
   %{
@@ -347,7 +347,7 @@ Eventsourcingdb.register_event_schema(
 To list all subjects, call the `list_subjects` function with `/` as the base subject. The function returns a stream from which you can retrieve one subject at a time:
 
 ```elixir
-result = Eventsourcingdb.read_subjects(client, "/")
+result = EventSourcingDB.read_subjects(client, "/")
 
 case result do
   {:ok, subjects} -> Enum.to_list(subjects)
@@ -358,15 +358,15 @@ end
 If you only want to list subjects within a specific branch, provide the desired base subject instead:
 
 ```elixir
-result = Eventsourcingdb.read_subjects(client, "/books")
+result = EventSourcingDB.read_subjects(client, "/books")
 ```
 
 ## Reading a Specific Event Type
 
 To list a specific event type, call the `read_event_type` function. The function returns the detailed event type, which includes the schema:
 
 ```elixir
-result = Eventsourcingdb.read_event_types(client, "io.eventsourcingdb.library.book-acquired")
+result = EventSourcingDB.read_event_types(client, "io.eventsourcingdb.library.book-acquired")
 
 case result do
   {:ok, event_types} -> Enum.to_list(event_types)
@@ -390,7 +390,7 @@ Then you are ready to use the provideded `TestContainer` in your tests:
 
 ```elixir
 defmodule YourTest do
-  alias Eventsourcingdb.TestContainer
+  alias EventSourcingDB.TestContainer
   use ExUnit.Case
 
   import Testcontainers.ExUnit
@@ -402,7 +402,7 @@ defmodule YourTest do
 
     # do sth with client
 
-    assert Eventsourcingdb.ping(client) == :ok
+    assert EventSourcingDB.ping(client) == :ok
   end
 end
 ```