statelydb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5716a868b12a20de48e33bddf16396bac216172edc29ee5302eb3477380c7943
+  data.tar.gz: 98ca1b24cd5bdaa79409de8bf36e10bc573bc6c0b80bf8194bb08eeddc91cf0a
+SHA512:
+  metadata.gz: 13a52d97a5ac5c309a3249dcbd1f5cb15392edc40c87a65a34064be54dfc44e5d6dd5ed6bff63fd4793f6e85297dbff92660fdc50a490d994c4af41e4ed9159c
+  data.tar.gz: cb8ce77af551b2c015c06ab75114517fe05376c26f1d8b228dde017b25da3685d7d8ee551bc140b50dc15fe06982618d485aab43dc88e7f63ebd47bdbd04769c

data/lib/api/db/continue_list_pb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/continue_list.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x16\x64\x62/continue_list.proto\x12\nstately.db\"u\n\x13\x43ontinueListRequest\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12?\n\tdirection\x18\x02 \x01(\x0e\x32!.stately.db.ContinueListDirectionR\tdirection*N\n\x15\x43ontinueListDirection\x12\x19\n\x15\x43ONTINUE_LIST_FORWARD\x10\x00\x12\x1a\n\x16\x43ONTINUE_LIST_BACKWARD\x10\x01\x42l\n\x0e\x63om.stately.dbB\x11\x43ontinueListProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    ContinueListRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ContinueListRequest").msgclass
+    ContinueListDirection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ContinueListDirection").enummodule
+  end
+end

data/lib/api/db/delete_pb.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/delete.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x0f\x64\x62/delete.proto\x12\nstately.db\"b\n\rDeleteRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12\x30\n\x07\x64\x65letes\x18\x03 \x03(\x0b\x32\x16.stately.db.DeleteItemR\x07\x64\x65letesJ\x04\x08\x04\x10\x05\"\'\n\nDeleteItem\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPath\"/\n\x0c\x44\x65leteResult\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPathJ\x04\x08\x02\x10\x03\"D\n\x0e\x44\x65leteResponse\x12\x32\n\x07results\x18\x01 \x03(\x0b\x32\x18.stately.db.DeleteResultR\x07resultsBf\n\x0e\x63om.stately.dbB\x0b\x44\x65leteProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    DeleteRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteRequest").msgclass
+    DeleteItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteItem").msgclass
+    DeleteResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteResult").msgclass
+    DeleteResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteResponse").msgclass
+  end
+end

data/lib/api/db/get_pb.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/get.proto
+
+require 'google/protobuf'
+
+require 'db/item_pb'
+
+
+descriptor_data = "\n\x0c\x64\x62/get.proto\x12\nstately.db\x1a\rdb/item.proto\"w\n\nGetRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12\'\n\x04gets\x18\x02 \x03(\x0b\x32\x13.stately.db.GetItemR\x04gets\x12\x1f\n\x0b\x61llow_stale\x18\x03 \x01(\x08R\nallowStaleJ\x04\x08\x04\x10\x05\"$\n\x07GetItem\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPath\"5\n\x0bGetResponse\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05itemsBc\n\x0e\x63om.stately.dbB\x08GetProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    GetRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetRequest").msgclass
+    GetItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetItem").msgclass
+    GetResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetResponse").msgclass
+  end
+end

data/lib/api/db/item_pb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/item.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/struct_pb'
+
+
+descriptor_data = "\n\rdb/item.proto\x12\nstately.db\x1a\x1cgoogle/protobuf/struct.proto\"u\n\x04Item\x12\x1b\n\titem_type\x18\x01 \x01(\tR\x08itemType\x12\x16\n\x05proto\x18\x02 \x01(\x0cH\x00R\x05proto\x12-\n\x04json\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructH\x00R\x04jsonB\t\n\x07payloadBd\n\x0e\x63om.stately.dbB\tItemProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    Item = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.Item").msgclass
+  end
+end

data/lib/api/db/item_property_pb.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/item_property.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x16\x64\x62/item_property.proto\x12\nstately.db*\x8b\x02\n\x10SortableProperty\x12\x1e\n\x1aSORTABLE_PROPERTY_KEY_PATH\x10\x00\x12+\n\'SORTABLE_PROPERTY_LAST_MODIFIED_VERSION\x10\x01\x12)\n%SORTABLE_PROPERTY_GROUP_LOCAL_INDEX_1\x10\x08\x12)\n%SORTABLE_PROPERTY_GROUP_LOCAL_INDEX_2\x10\t\x12)\n%SORTABLE_PROPERTY_GROUP_LOCAL_INDEX_3\x10\n\x12)\n%SORTABLE_PROPERTY_GROUP_LOCAL_INDEX_4\x10\x0b\x42l\n\x0e\x63om.stately.dbB\x11ItemPropertyProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    SortableProperty = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SortableProperty").enummodule
+  end
+end

data/lib/api/db/list_pb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/list.proto
+
+require 'google/protobuf'
+
+require 'db/item_pb'
+require 'db/item_property_pb'
+require 'db/list_token_pb'
+
+
+descriptor_data = "\n\rdb/list.proto\x12\nstately.db\x1a\rdb/item.proto\x1a\x16\x64\x62/item_property.proto\x1a\x13\x64\x62/list_token.proto\"\x91\x02\n\x10\x42\x65ginListRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12&\n\x0fkey_path_prefix\x18\x02 \x01(\tR\rkeyPathPrefix\x12\x14\n\x05limit\x18\x03 \x01(\rR\x05limit\x12\x1f\n\x0b\x61llow_stale\x18\x04 \x01(\x08R\nallowStale\x12\x41\n\rsort_property\x18\x05 \x01(\x0e\x32\x1c.stately.db.SortablePropertyR\x0csortProperty\x12@\n\x0esort_direction\x18\x06 \x01(\x0e\x32\x19.stately.db.SortDirectionR\rsortDirection\"\x8b\x01\n\x0cListResponse\x12\x37\n\x06result\x18\x01 \x01(\x0b\x32\x1d.stately.db.ListPartialResultH\x00R\x06result\x12\x36\n\x08\x66inished\x18\x02 \x01(\x0b\x32\x18.stately.db.ListFinishedH\x00R\x08\x66inishedB\n\n\x08response\";\n\x11ListPartialResult\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05items\";\n\x0cListFinished\x12+\n\x05token\x18\x01 \x01(\x0b\x32\x15.stately.db.ListTokenR\x05token*8\n\rSortDirection\x12\x12\n\x0eSORT_ASCENDING\x10\x00\x12\x13\n\x0fSORT_DESCENDING\x10\x01\x42\x64\n\x0e\x63om.stately.dbB\tListProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    BeginListRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.BeginListRequest").msgclass
+    ListResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListResponse").msgclass
+    ListPartialResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListPartialResult").msgclass
+    ListFinished = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListFinished").msgclass
+    SortDirection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SortDirection").enummodule
+  end
+end

data/lib/api/db/list_token_pb.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/list_token.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x13\x64\x62/list_token.proto\x12\nstately.db\"h\n\tListToken\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12!\n\x0c\x63\x61n_continue\x18\x02 \x01(\x08R\x0b\x63\x61nContinue\x12\x19\n\x08\x63\x61n_sync\x18\x03 \x01(\x08R\x07\x63\x61nSyncBi\n\x0e\x63om.stately.dbB\x0eListTokenProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    ListToken = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListToken").msgclass
+  end
+end

data/lib/api/db/put_pb.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/put.proto
+
+require 'google/protobuf'
+
+require 'db/item_pb'
+
+
+descriptor_data = "\n\x0c\x64\x62/put.proto\x12\nstately.db\x1a\rdb/item.proto\"P\n\nPutRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12\'\n\x04puts\x18\x02 \x03(\x0b\x32\x13.stately.db.PutItemR\x04puts\"/\n\x07PutItem\x12$\n\x04item\x18\x01 \x01(\x0b\x32\x10.stately.db.ItemR\x04item\"5\n\x0bPutResponse\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05itemsBc\n\x0e\x63om.stately.dbB\x08PutProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    PutRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutRequest").msgclass
+    PutItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutItem").msgclass
+    PutResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutResponse").msgclass
+  end
+end

data/lib/api/db/scan_root_paths_pb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/scan_root_paths.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x18\x64\x62/scan_root_paths.proto\x12\nstately.db\"r\n\x14ScanRootPathsRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12\x14\n\x05limit\x18\x02 \x01(\rR\x05limit\x12)\n\x10pagination_token\x18\x03 \x01(\x0cR\x0fpaginationToken\"|\n\x15ScanRootPathsResponse\x12\x38\n\x07results\x18\x01 \x03(\x0b\x32\x1e.stately.db.ScanRootPathResultR\x07results\x12)\n\x10pagination_token\x18\x02 \x01(\x0cR\x0fpaginationToken\"/\n\x12ScanRootPathResult\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPathBm\n\x0e\x63om.stately.dbB\x12ScanRootPathsProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    ScanRootPathsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsRequest").msgclass
+    ScanRootPathsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsResponse").msgclass
+    ScanRootPathResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathResult").msgclass
+  end
+end

data/lib/api/db/service_pb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/service.proto
+
+require 'google/protobuf'
+
+require 'db/continue_list_pb'
+require 'db/delete_pb'
+require 'db/get_pb'
+require 'db/list_pb'
+require 'db/put_pb'
+require 'db/scan_root_paths_pb'
+require 'db/sync_list_pb'
+require 'db/transaction_pb'
+
+
+descriptor_data = "\n\x10\x64\x62/service.proto\x12\nstately.db\x1a\x16\x64\x62/continue_list.proto\x1a\x0f\x64\x62/delete.proto\x1a\x0c\x64\x62/get.proto\x1a\rdb/list.proto\x1a\x0c\x64\x62/put.proto\x1a\x18\x64\x62/scan_root_paths.proto\x1a\x12\x64\x62/sync_list.proto\x1a\x14\x64\x62/transaction.proto2\xee\x04\n\x0f\x44\x61tabaseService\x12;\n\x03Put\x12\x16.stately.db.PutRequest\x1a\x17.stately.db.PutResponse\"\x03\x90\x02\x02\x12;\n\x03Get\x12\x16.stately.db.GetRequest\x1a\x17.stately.db.GetResponse\"\x03\x90\x02\x01\x12\x44\n\x06\x44\x65lete\x12\x19.stately.db.DeleteRequest\x1a\x1a.stately.db.DeleteResponse\"\x03\x90\x02\x02\x12J\n\tBeginList\x12\x1c.stately.db.BeginListRequest\x1a\x18.stately.db.ListResponse\"\x03\x90\x02\x01\x30\x01\x12P\n\x0c\x43ontinueList\x12\x1f.stately.db.ContinueListRequest\x1a\x18.stately.db.ListResponse\"\x03\x90\x02\x01\x30\x01\x12L\n\x08SyncList\x12\x1b.stately.db.SyncListRequest\x1a\x1c.stately.db.SyncListResponse\"\x03\x90\x02\x01\x30\x01\x12T\n\x0bTransaction\x12\x1e.stately.db.TransactionRequest\x1a\x1f.stately.db.TransactionResponse\"\x00(\x01\x30\x01\x12Y\n\rScanRootPaths\x12 .stately.db.ScanRootPathsRequest\x1a!.stately.db.ScanRootPathsResponse\"\x03\x90\x02\x01\x42g\n\x0e\x63om.stately.dbB\x0cServiceProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+  end
+end

data/lib/api/db/service_services_pb.rb

@@ -0,0 +1,101 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: db/service.proto for package 'Stately.Db'
+
+require 'grpc'
+require 'db/service_pb'
+
+module Stately
+  module Db
+    module DatabaseService
+      # DatabaseService is the service for creating, reading, updating and deleting data
+      # in a StatelyDB Store. Creating and modifying Stores is done by
+      # stately.dbmanagement.ManagementService.
+      class Service
+
+        include ::GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'stately.db.DatabaseService'
+
+        # Put adds one or more Items to the Store, or replaces the Items if they
+        # already exist. This will fail if the caller does not have permission to
+        # create or update Items, if there is no schema registered for the provided
+        # item type, or if an item is invalid. All puts are applied atomically;
+        # either all will fail or all will succeed. If an item's schema specifies an
+        # `initialValue` for one or more properties used in its key paths, and the
+        # item is new, you should not provide those values - the database will choose
+        # them for you, and Data must be provided as either serialized binary
+        # protobuf or JSON.
+        rpc :Put, ::Stately::Db::PutRequest, ::Stately::Db::PutResponse
+        # Get retrieves one or more Items by their key paths. This will return any of
+        # the Items that exist. It will fail if the caller does not have permission
+        # to read Items. Use the List APIs if you want to retrieve multiple items but
+        # don't already know the full key paths of the items you want to get.
+        rpc :Get, ::Stately::Db::GetRequest, ::Stately::Db::GetResponse
+        # Delete removes one or more Items from the Store by their key paths. This
+        # will fail if the caller does not have permission to delete Items.
+        # Tombstones will be saved for deleted items for  time, so
+        # that SyncList can return information about deleted items. Deletes are
+        # always applied atomically; all will fail or all will succeed.
+        rpc :Delete, ::Stately::Db::DeleteRequest, ::Stately::Db::DeleteResponse
+        # BeginList retrieves Items that start with a specified key path prefix. The
+        # key path prefix must minimally contain a Group Key (an item type and an
+        # item ID). BeginList will return an empty result set if there are no items
+        # matching that key prefix. This API returns a token that you can pass to
+        # ContinueList to expand the result set, or to SyncList to get updates within
+        # the result set. This can fail if the caller does not have permission to
+        # read Items.
+        # buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+        rpc :BeginList, ::Stately::Db::BeginListRequest, stream(::Stately::Db::ListResponse)
+        # ContinueList takes the token from a BeginList call and returns more results
+        # based on the original query parameters and pagination options. It has very
+        # few options of its own because it is a continuation of a previous list
+        # operation. It will return a new token which can be used for another
+        # ContinueList call, and so on. The token is the same one used by SyncList -
+        # each time you call either ContinueList or SyncList, you should pass the
+        # latest version of the token, and then use the new token from the result in
+        # subsequent calls. You may interleave ContinueList and SyncList calls
+        # however you like, but it does not make sense to make both calls in
+        # parallel. Calls to ContinueList are tied to the authorization of the
+        # original BeginList call, so if the original BeginList call was allowed,
+        # ContinueList with its token should also be allowed.
+        # buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+        rpc :ContinueList, ::Stately::Db::ContinueListRequest, stream(::Stately::Db::ListResponse)
+        # SyncList returns all changes to Items within the result set of a previous
+        # List operation. For all Items within the result set that were modified, it
+        # returns the full Item at in its current state. It also returns a list of
+        # Item key paths that were deleted since the last SyncList, which you should
+        # reconcile with your view of items returned from previous
+        # BeginList/ContinueList calls. Using this API, you can start with an initial
+        # set of items from BeginList, and then stay up to date on any changes via
+        # repeated SyncList requests over time. The token is the same one used by
+        # ContinueList - each time you call either ContinueList or SyncList, you
+        # should pass the latest version of the token, and then use the new token
+        # from the result in subsequent calls. Note that if the result set has
+        # already been expanded to the end (in the direction of the original
+        # BeginList request), SyncList will return newly created Items. You may
+        # interleave ContinueList and SyncList calls however you like, but it does
+        # not make sense to make both calls in parallel. Calls to SyncList are tied
+        # to the authorization of the original BeginList call, so if the original
+        # BeginList call was allowed, SyncList with its token should also be allowed.
+        rpc :SyncList, ::Stately::Db::SyncListRequest, stream(::Stately::Db::SyncListResponse)
+        # Transaction performs a transaction, within which you can issue writes
+        # (Put/Delete) and reads (Get/List) in any order, followed by a commit
+        # message. Reads are guaranteed to reflect the state as of when the
+        # transaction started, and writes are committed atomically. This method may
+        # fail if another transaction commits before this one finishes - in that
+        # case, you should retry your transaction.
+        rpc :Transaction, stream(::Stately::Db::TransactionRequest), stream(::Stately::Db::TransactionResponse)
+        # ScanRootPaths lists root paths (Groups) in the Store. This is a very
+        # expensive operation, as it must consult multiple partitions and it reads
+        # and ignores a lot of data. It is provided for use in the web console's data
+        # browser and is not exposed to customers. This operation will fail if the
+        # caller does not have permission to read Items.
+        rpc :ScanRootPaths, ::Stately::Db::ScanRootPathsRequest, ::Stately::Db::ScanRootPathsResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end

data/lib/api/db/sync_list_pb.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/sync_list.proto
+
+require 'google/protobuf'
+
+require 'db/item_pb'
+require 'db/list_pb'
+
+
+descriptor_data = "\n\x12\x64\x62/sync_list.proto\x12\nstately.db\x1a\rdb/item.proto\x1a\rdb/list.proto\"0\n\x0fSyncListRequest\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\"\xc8\x01\n\x10SyncListResponse\x12\x31\n\x05reset\x18\x01 \x01(\x0b\x32\x19.stately.db.SyncListResetH\x00R\x05reset\x12=\n\x06result\x18\x02 \x01(\x0b\x32#.stately.db.SyncListPartialResponseH\x00R\x06result\x12\x36\n\x08\x66inished\x18\x03 \x01(\x0b\x32\x18.stately.db.ListFinishedH\x00R\x08\x66inishedB\n\n\x08response\"\x0f\n\rSyncListReset\"\xdf\x01\n\x17SyncListPartialResponse\x12\x35\n\rchanged_items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x0c\x63hangedItems\x12<\n\rdeleted_items\x18\x02 \x03(\x0b\x32\x17.stately.db.DeletedItemR\x0c\x64\x65letedItems\x12O\n%updated_item_keys_outside_list_window\x18\x03 \x03(\tR updatedItemKeysOutsideListWindow\"(\n\x0b\x44\x65letedItem\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPathBh\n\x0e\x63om.stately.dbB\rSyncListProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    SyncListRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListRequest").msgclass
+    SyncListResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListResponse").msgclass
+    SyncListReset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListReset").msgclass
+    SyncListPartialResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListPartialResponse").msgclass
+    DeletedItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeletedItem").msgclass
+  end
+end

data/lib/api/db/transaction_pb.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: db/transaction.proto
+
+require 'google/protobuf'
+
+require 'db/continue_list_pb'
+require 'db/delete_pb'
+require 'db/get_pb'
+require 'db/item_pb'
+require 'db/item_property_pb'
+require 'db/list_pb'
+require 'db/put_pb'
+require 'google/protobuf/empty_pb'
+
+
+descriptor_data = "\n\x14\x64\x62/transaction.proto\x12\nstately.db\x1a\x16\x64\x62/continue_list.proto\x1a\x0f\x64\x62/delete.proto\x1a\x0c\x64\x62/get.proto\x1a\rdb/item.proto\x1a\x16\x64\x62/item_property.proto\x1a\rdb/list.proto\x1a\x0c\x64\x62/put.proto\x1a\x1bgoogle/protobuf/empty.proto\"\x9f\x04\n\x12TransactionRequest\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x34\n\x05\x62\x65gin\x18\x02 \x01(\x0b\x32\x1c.stately.db.TransactionBeginH\x00R\x05\x62\x65gin\x12\x39\n\tget_items\x18\x03 \x01(\x0b\x32\x1a.stately.db.TransactionGetH\x00R\x08getItems\x12\x41\n\nbegin_list\x18\x04 \x01(\x0b\x32 .stately.db.TransactionBeginListH\x00R\tbeginList\x12J\n\rcontinue_list\x18\x05 \x01(\x0b\x32#.stately.db.TransactionContinueListH\x00R\x0c\x63ontinueList\x12\x39\n\tput_items\x18\x06 \x01(\x0b\x32\x1a.stately.db.TransactionPutH\x00R\x08putItems\x12\x42\n\x0c\x64\x65lete_items\x18\x07 \x01(\x0b\x32\x1d.stately.db.TransactionDeleteH\x00R\x0b\x64\x65leteItems\x12\x30\n\x06\x63ommit\x18\x08 \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x06\x63ommit\x12.\n\x05\x61\x62ort\x18\t \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x05\x61\x62ortB\t\n\x07\x63ommand\"\xc8\x02\n\x13TransactionResponse\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x45\n\x0bget_results\x18\x02 \x01(\x0b\x32\".stately.db.TransactionGetResponseH\x00R\ngetResults\x12\x38\n\x07put_ack\x18\x03 \x01(\x0b\x32\x1d.stately.db.TransactionPutAckH\x00R\x06putAck\x12H\n\x0clist_results\x18\x04 \x01(\x0b\x32#.stately.db.TransactionListResponseH\x00R\x0blistResults\x12=\n\x08\x66inished\x18\x05 \x01(\x0b\x32\x1f.stately.db.TransactionFinishedH\x00R\x08\x66inishedB\x08\n\x06result\"-\n\x10TransactionBegin\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\"9\n\x0eTransactionGet\x12\'\n\x04gets\x18\x01 \x03(\x0b\x32\x13.stately.db.GetItemR\x04gets\"\xd9\x01\n\x14TransactionBeginList\x12&\n\x0fkey_path_prefix\x18\x01 \x01(\tR\rkeyPathPrefix\x12\x14\n\x05limit\x18\x02 \x01(\rR\x05limit\x12\x41\n\rsort_property\x18\x03 \x01(\x0e\x32\x1c.stately.db.SortablePropertyR\x0csortProperty\x12@\n\x0esort_direction\x18\x04 \x01(\x0e\x32\x19.stately.db.SortDirectionR\rsortDirection\"y\n\x17TransactionContinueList\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12?\n\tdirection\x18\x04 \x01(\x0e\x32!.stately.db.ContinueListDirectionR\tdirection\"9\n\x0eTransactionPut\x12\'\n\x04puts\x18\x01 \x03(\x0b\x32\x13.stately.db.PutItemR\x04puts\"E\n\x11TransactionDelete\x12\x30\n\x07\x64\x65letes\x18\x01 \x03(\x0b\x32\x16.stately.db.DeleteItemR\x07\x64\x65letes\"@\n\x16TransactionGetResponse\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05items\"D\n\x0bGeneratedID\x12\x14\n\x04uint\x18\x01 \x01(\x04H\x00R\x04uint\x12\x16\n\x05\x62ytes\x18\x02 \x01(\x0cH\x00R\x05\x62ytesB\x07\n\x05value\"Q\n\x11TransactionPutAck\x12<\n\rgenerated_ids\x18\x01 \x03(\x0b\x32\x17.stately.db.GeneratedIDR\x0cgeneratedIds\"\x96\x01\n\x17TransactionListResponse\x12\x37\n\x06result\x18\x01 \x01(\x0b\x32\x1d.stately.db.ListPartialResultH\x00R\x06result\x12\x36\n\x08\x66inished\x18\x02 \x01(\x0b\x32\x18.stately.db.ListFinishedH\x00R\x08\x66inishedB\n\n\x08response\"\xa7\x01\n\x13TransactionFinished\x12\x1c\n\tcommitted\x18\x01 \x01(\x08R\tcommitted\x12\x31\n\x0bput_results\x18\x02 \x03(\x0b\x32\x10.stately.db.ItemR\nputResults\x12?\n\x0e\x64\x65lete_results\x18\x03 \x03(\x0b\x32\x18.stately.db.DeleteResultR\rdeleteResultsBk\n\x0e\x63om.stately.dbB\x10TransactionProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Db
+    TransactionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionRequest").msgclass
+    TransactionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionResponse").msgclass
+    TransactionBegin = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionBegin").msgclass
+    TransactionGet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionGet").msgclass
+    TransactionBeginList = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionBeginList").msgclass
+    TransactionContinueList = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionContinueList").msgclass
+    TransactionPut = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionPut").msgclass
+    TransactionDelete = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionDelete").msgclass
+    TransactionGetResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionGetResponse").msgclass
+    GeneratedID = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GeneratedID").msgclass
+    TransactionPutAck = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionPutAck").msgclass
+    TransactionListResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionListResponse").msgclass
+    TransactionFinished = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionFinished").msgclass
+  end
+end

data/lib/api/errors/error_details_pb.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: errors/error_details.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x1a\x65rrors/error_details.proto\x12\x0estately.errors\"y\n\x13StatelyErrorDetails\x12!\n\x0cstately_code\x18\x01 \x01(\tR\x0bstatelyCode\x12\x18\n\x07message\x18\x02 \x01(\tR\x07message\x12%\n\x0eupstream_cause\x18\x03 \x01(\tR\rupstreamCauseB\x80\x01\n\x12\x63om.stately.errorsB\x11\x45rrorDetailsProtoP\x01\xa2\x02\x03SEX\xaa\x02\x0eStately.Errors\xca\x02\x0eStately\\Errors\xe2\x02\x1aStately\\Errors\\GPBMetadata\xea\x02\x0fStately::Errorsb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Stately
+  module Errors
+    StatelyErrorDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.errors.StatelyErrorDetails").msgclass
+  end
+end

data/lib/common/auth/auth0_token_provider.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "async"
+require "async/http/internet"
+require "async/semaphore"
+require "json"
+require "logger"
+require "weakref"
+require_relative "token_provider"
+
+LOGGER = Logger.new($stdout)
+LOGGER.level = Logger::WARN
+DEFAULT_GRANT_TYPE = "client_credentials"
+
+module StatelyDB
+  module Common
+    # A module for Stately Cloud auth code
+    module Auth
+      # Auth0TokenProvider is an implementation of the TokenProvider abstract base class
+      # which vends tokens from auth0 with the given client_id and client_secret.
+      # It will default to using the values of `STATELY_CLIENT_ID` and `STATELY_CLIENT_SECRET` if
+      # no credentials are explicitly passed and will throw an error if none are found.
+      class Auth0TokenProvider < TokenProvider
+        # @param [String] auth_url The URL of the OAuth server
+        # @param [String] audience The OAuth Audience for the token
+        # @param [String] client_secret The StatelyDB client secret credential
+        # @param [String] client_id The StatelyDB client ID credential
+        def initialize(
+          auth_url: "https://oauth.stately.cloud",
+          audience: "api.stately.cloud",
+          client_secret: ENV.fetch("STATELY_CLIENT_SECRET"),
+          client_id: ENV.fetch("STATELY_CLIENT_ID")
+        )
+          super()
+          @client_id = client_id
+          @client_secret = client_secret
+          @audience = audience
+          @auth_url = "#{auth_url}/oauth/token"
+          @access_token = nil
+          @pending_refresh = nil
+          @timer = nil
+
+          Async do |_task|
+            refresh_token
+          end
+
+          # need a weak ref to ourself or the GC will never run the finalizer
+          ObjectSpace.define_finalizer(WeakRef.new(self), finalize)
+        end
+
+        # finalizer kills the thread running the timer if one exists
+        # @return [Proc] The finalizer proc
+        def finalize
+          proc {
+            Thread.kill(@timer) unless @timer.nil?
+          }
+        end
+
+        # Get the current access token
+        # @return [String] The current access token
+        def access_token
+          # TODO: - check whether or not the GIL is enough to make this threadsafe
+          @access_token || refresh_token
+        end
+
+        private
+
+        # Refresh the access token
+        # @return [void]
+        def refresh_token
+          # never run more than one at a time.
+          @pending_refresh ||= refresh_token_impl
+          # many threads all wait on the same task here.
+          # I wrote a test to check this is possible
+          @pending_refresh.wait
+          # multiple people will all set this to nil after
+          # they are done waiting but I don't think i can put this inside
+          # refresh_token_impl. It seems harmless because of the GIL?
+          @pending_refresh = nil
+        end
+
+        # Refresh the access token implementation
+        # @return [String] The new access token
+        def refresh_token_impl
+          Async do
+            client = Async::HTTP::Internet.new
+            headers = [["content-type", "application/json"]]
+            data = { "client_id" => @client_id, client_secret: @client_secret, audience: @audience,
+                     grant_type: DEFAULT_GRANT_TYPE }
+            body = [JSON.dump(data)]
+
+            resp = client.post(@auth_url, headers, body)
+            resp_data = JSON.parse(resp.read)
+            raise "Auth request failed: #{resp_data}" if resp.status != 200
+
+            @access_token = resp_data["access_token"]
+
+            # do this on a thread or else the sleep
+            # will block the event loop.
+            # there is no non-blocking sleep in ruby.
+            # skip this if we have a pending timer thread already
+            @timer = Thread.new do
+              # TODO: - add some random jitter to stop clients getting a cycle after
+              # some event like an outage
+              # Also, don't let this be less than 1sec
+              delay = [resp_data["expires_in"] - 10, 1].max
+              sleep(delay)
+              refresh_token
+            end
+            @pending_refresh = nil
+            resp_data["access_token"]
+          rescue StandardError => e
+            # set the token to nil so that it will
+            # be refreshed on the next get
+            @access_token = nil
+            LOGGER.warn(e)
+          ensure
+            client.close
+          end
+        end
+      end
+    end
+  end
+end

data/lib/common/auth/interceptor.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "grpc"
+require "common/auth/token_provider"
+
+module StatelyDB
+  module Common
+    # A module for Stately Cloud auth code
+    module Auth
+      # GRPC interceptor to authenticate against Stately and append bearer tokens to outgoing requests
+      class Interceptor < GRPC::ClientInterceptor
+        # @param [TokenProvider] token_provider The token provider to use for authentication
+        def initialize(
+          token_provider: Auth0TokenProvider.new
+        )
+          super()
+          @token_provider = token_provider
+        end
+
+        # gRPC client unary interceptor
+        #
+        # @param [Object] request The request object
+        # @param [GRPC::ActiveCall] call The active call object
+        # @param [Symbol] method The method being called
+        # @param [Hash] metadata The metadata hash
+        # @return [Object] The response object
+        # @api private
+        def request_response(request:, call:, method:, metadata:) # rubocop:disable Lint/UnusedMethodArgument
+          add_jwt_to_grpc_request(metadata:)
+          yield
+        end
+
+        # gRPC client streaming interceptor
+        #
+        # @param [Enumerable] requests The list of requests
+        # @param [GRPC::ActiveCall] call The active call object
+        # @param [Symbol] method The method being called
+        # @param [Hash] metadata The metadata hash
+        # @return [Enumerator] The response enumerator
+        # @api private
+        def client_streamer(requests:, call:, method:, metadata:) # rubocop:disable Lint/UnusedMethodArgument
+          add_jwt_to_grpc_request(metadata:)
+          yield
+        end
+
+        # gRPC  server streaming interceptor
+        #
+        # @param [Object] request The request object
+        # @param [GRPC::ActiveCall] call The active call object
+        # @param [Symbol] method The method being called
+        # @param [Hash] metadata The metadata hash
+        # @return [Enumerator] The response enumerator
+        # @api private
+        def server_streamer(request:, call:, method:, metadata:) # rubocop:disable Lint/UnusedMethodArgument
+          add_jwt_to_grpc_request(metadata:)
+          yield
+        end
+
+        # gRPC bidirectional streaming interceptor
+        #
+        # @param [Enumerable] requests The list of requests
+        # @param [GRPC::ActiveCall] call The active call object
+        # @param [Symbol] method The method being called
+        # @param [Hash] metadata The metadata hash
+        # @return [Enumerator] The response enumerator
+        # @api private
+        def bidi_streamer(requests:, call:, method:, metadata:) # rubocop:disable Lint/UnusedMethodArgument
+          add_jwt_to_grpc_request(metadata:)
+          yield
+        end
+
+        # Adds a JWT to the metadata hash
+        # @param [Hash] metadata The metadata hash
+        # @return [void]
+        # @api private
+        def add_jwt_to_grpc_request(metadata:)
+          metadata["authorization"] = "Bearer #{@token_provider.access_token}"
+        end
+      end
+    end
+  end
+end

data/lib/common/auth/token_provider.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module StatelyDB
+  module Common
+    # A module for Stately Cloud auth code
+    module Auth
+      # TokenProvider is an abstract base class that should be extended
+      # for individual token provider implementations
+      class TokenProvider
+        # Get the current access token
+        # @return [String] The current access token
+        def access_token
+          raise "Not Implemented"
+        end
+      end
+    end
+  end
+end