event_store 0.1.0 → 0.1.1

data/README.md

@@ -1,34 +1,50 @@
 # EventStore
 
-Ruby implementation of an EventSource (A+ES) for the Nexia Ecosystem.
+A Very Fast Ruby implementation of an EventStore (A+ES).
+For more detail on what an EventStore is checkout what Gregg Young has to stay about it:
+http://codebetter.com/gregyoung/2010/02/20/why-use-event-sourcing/
 
 # Usage
 
-Currently, `EventStore` supports `postgres` adapters. Define your adapter and the connection parameters in the `EventStore` configure block.
+Currently, `EventStore` supports `postgres` and `vertica` adapters.
 
-### Connecting
+### Connecting in Development or Test
 ```ruby
-EventStore.connect {
-  :adapter  => :postgres,
-  :database => "my_database",
-  :host     => "db.example.com",
-  :username => "user1234",
-  :password => "password",
-  :port     => 5432
-}
+EventStore.postgres(:development)
+EventStore.postgres #test
+
+EventStore.vertica(:development)
+EventStore.vertica #test
+
+#Production
+EventStore.connect_db(redis_config, database_config) #The redis and database configs are the standard hashes expected by the databases -- we just pass them directly in
 ```
-The arguments to `EventStore#connect` are the same as those to `Sequel#connect`
 
 ### Notes on Connecting
 
+- `EventStore` expects a database called `history_store` to exist.
+- `postgres` will try to connect in dev and test mode as 'nexia:Password1@localhost'
 - `postgres` will assume a port of `5432` if one is not supplied.
 
+- `vertica` expects to find an environment variable (VERTICA_HOST) to be set and will use this as the host in dev and test mode
+- `vertica` will assume its default port if one is not supplied.
+- `vertica` will try to connect in dev and test mode as 'dbadmin:password@[vertica_host]'
+- To find the ip address of vertica on your local box (running in a vm):
+  1. open Settings -> Network and select Wi-Fi
+  2. open a terminal in the VM
+  3. do /sbin/ifconfig (ifconfig is not in $PATH)
+  4. the inet address for en0 is what you want
+  Hint: if it just hangs, you have have the wrong IP
+
 ### Creating a client
 
 ```ruby
 client = EventStore::Client.new(aggregate_id)
 
-# Get an aggregate's event stream
+# Get a list of events representing a snapshot of the aggregate's current state (fast)
+client.snapshot
+
+# Get an aggregate's entire event stream (can be very large)
 client.event_stream
 
 # Get an aggregate's event stream starting from a version
@@ -42,12 +58,10 @@ client.peek
 
 # Append events to an aggregate's event stream
 client.append(events, expected_version)
-```
-
-### Migrating your database
 
-With the `sequel` gem installed, you have access to its command line tool. To migrate your database, enter the following command:
-`$ sequel -m path/to/migrations/folder postgres://username:password@localhost:5432/event_store_test`
+# Get the current version of an aggregate
+client.version
 
-- The first argument is the path to the folder containing migrations, not a specific file. An example migration can be found at [001_create_event_store_events.rb](https://github.com/nexiahome/event_store/blob/master/db/migrations/001_create_event_store_events.rb)
-- The second argument is your full database connection url
+# Drop all the events associated with an aggregate, including its snapshot
+client.destroy!
+```

data/lib/event_store/version.rb

@@ -1,3 +1,3 @@
 module EventStore
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/event_store.rb

@@ -95,7 +95,7 @@ module EventStore
       #3. do /sbin/ifconfig (ifconfig is not in $PATH)
       #4. the inet address for en0 is what you want
       #Hint: if it just hangs, you have have the wrong IP
-      db_config['host'] = vertica_host
+      db_config['host'] = ENV['VERTICA_HOST'] || vertica_host
       @migrations_dir = 'db/migrations'
     else
       @migrations_dir = 'db/pg_migrations'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: