last bit of notes

one more note

more notes

fix formatting in readme

add notes from IRC about the future of this project

fix formatting in readme

add another todo

feat: add readme description. Closes #1

Update README.md

Merge branch 'COUCHDB-3288-remove-public-db-record'

Remove public db record

COUCHDB-3288

Merge remote-tracking branch 'github/pr/9'

Don't exit on timeout callback in cassim metadata cache

Previously changes feed process exited after timeout message then a new
listener process was spawned after 5 seconds.

COUCHDB-3267

Fix changes callback function clause for stop event

Enable cassim by default

COUCHDB-2879

Fix warnings about unknown cassim metrics

Due to typo in file name it wasn't handled properly.

Reuse database security check routines from couch_db

COUCHDB-2534

Integrate with Travis CI

Handle waiting_for_updates in callback

COUCHDB-2724

Merge branch 'add-manual-migration-logic'

Add stats for doc migrations and metadata cache lookups

Add manual security doc migration logic

Add enable cassim feature flag

Treat deleted security docs the same as missing

The same logic to migrate new security docs works as well for deleted docs.

Export migrate_security_props/2

Add get_security retry logic for handling conflicts

Handle deleted and other unexpected responses

Move fabric:open_doc calls outside of gen_server

COUCHDB-2657

Add prefix for security metadata documents

Because such documents starts with database name, metadata documents
for system databases violates CouchDB restriction for document id which
cannot starts with underscore unless they are not _design/ ones.

COUCHDB-2422

Merge remote-tracking branch 'kxepal/rename-system-databases'

This closes #3

Rename _cassim database to _metadata

COUCHDB-2620

Add underscore prefix for cassim database name

That's how we name system databases and there should be no exceptions.

COUCHDB-2619

Use ADMIN_CTX and ADMIN_USER macros from couch_db.hrl

Fix LICENSE indention

Use couch_log instead of ?LOG_*

Remove Cloudant specific auth

Update all docs callbacks for new fabric

Use the correct warning log function

Don't break if we terminate during a changes reader restart

Remove Cloudant copyright as prereq to ASF donation

Don't fallback to using fabric:set_security

The return values from cassim:set_security are different than those in
fabric:set_security. This removes the fallback clause to simplify the
logic and moves the is_enabled check out into chttpd.

BugzId: 32070

Add cassim:is_enabled

BugzId: 32070

Delete old security docs when we set security

When we set security, we now also call out to cleanup old docs, which
will find all docs with same meta group id, where a meta group is a
user/database/type name, or more simply, a meta id with the suffix
removed. We use the meta group to fetch all previous security docs and
then delete the non current docs.

Note that the winning security doc may not in fact have the newest
suffix, as we could get into a situation with conflicts where the
winning rev is not the newest, so instead of sorting by suffix and
deleting everything but the newest, we instead delete everything
besides the meta id we know is the winner. We know the winning meta id
because in the set_security update we fetch the current known winning
id and pass that along to cleanup_old_docs/1.

The meta id format has been changed slightly, to append the suffix at
the end of the user/database/type group name, so that we can just chop
off the suffix and have the group.

Also, this moves the security_meta_id function into the
cassim_metadata_cache module. The motivation for this is that we're
using the suffix now to distinguish between different database
versions, which is general to all potential metadata types, not just
security, and so we want to keep the id definitions local to the cache
so we can more easily ensure all future id formats end in the suffix.

BugzId: 29571

Use shard suffix in the security metadata id

The primary purpose here is to be able to distinguish between
different version of the same database name. We shouldn't have
security properties be inherited when a database is recreated. Adding
the suffix to the metadata id allows us to make this distinction, but
it also allows us to lazily deal with clearing out security docs for
old deleted database.

Add top level API and security logic

BugzId: 29571

Add metadata cache

BugzId: 29571

Initial app structure

BugzId: 29571

Initial commit