statelydb 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8446a58ed766b26aeb2effbbbe422d1b809eb9d1833f51c8b0d9309c7787e4a3
-  data.tar.gz: 1de0251f91a6bd26399ed57999f09d3f1c27f11faecbc9335216d3c986d58d81
+  metadata.gz: 1518fe47ef69d7e171862c88f5b8a9425116dc1390623724dc95e285e960b728
+  data.tar.gz: f5e9faad6e851892a695a47590e7430908e419b44c2f94a60087fec4c316c808
 SHA512:
-  metadata.gz: 7194ac043df22729233b6d76e1517e3a34710d68f9c9d486aa1f849489c9bab435f767a1a805287e7cf85d3324bfedce744339aabdb3c03a6ff6a793aaa36b84
-  data.tar.gz: 02c00886f4704f8d0af5f8a7d885a906034238d924ec30c2fb46543bbce1a8bc646e64ceea8803604b0cb41fa87878a186968e901b320e6bfcf455d4ab8a73cd
+  metadata.gz: acc4be2621242c08236efdf8e1f9fa48090070c3c4ad12583481bc2a2df4ee5638fbb665059a0138a7bf53270bed8d6bf0f5290843dd5d488b71274f2a3284b8
+  data.tar.gz: ddccab6882a70b7eab33c56893fd9cae614ee67c5343b0953f7af33d3fe487418eb00c3300d3a24ae6e14df88f5cf49609b9e1f4a966db10d646ab184c00a685

data/lib/api/db/get_pb.rb

@@ -4,7 +4,7 @@
 
 require 'google/protobuf'
 
-require 'db/item_pb'
+require 'api/db/item_pb'
 
 
 descriptor_data = "\n\x0c\x64\x62/get.proto\x12\nstately.db\x1a\rdb/item.proto\"\xa3\x01\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\nallowStale\x12*\n\x11schema_version_id\x18\x05 \x01(\rR\x0fschemaVersionIdJ\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"

data/lib/api/db/list_pb.rb

@@ -4,9 +4,9 @@
 
 require 'google/protobuf'
 
-require 'db/item_pb'
-require 'db/item_property_pb'
-require 'db/list_token_pb'
+require 'api/db/item_pb'
+require 'api/db/item_property_pb'
+require 'api/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\"\xbd\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\x12*\n\x11schema_version_id\x18\x07 \x01(\rR\x0fschemaVersionId\"\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"

data/lib/api/db/put_pb.rb

@@ -4,7 +4,7 @@
 
 require 'google/protobuf'
 
-require 'db/item_pb'
+require 'api/db/item_pb'
 
 
 descriptor_data = "\n\x0c\x64\x62/put.proto\x12\nstately.db\x1a\rdb/item.proto\"|\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\x12*\n\x11schema_version_id\x18\x03 \x01(\rR\x0fschemaVersionId\"U\n\x07PutItem\x12$\n\x04item\x18\x01 \x01(\x0b\x32\x10.stately.db.ItemR\x04item\x12$\n\x0emust_not_exist\x18\x03 \x01(\x08R\x0cmustNotExist\"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"

data/lib/api/db/service_pb.rb

@@ -4,14 +4,14 @@
 
 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'
+require 'api/db/continue_list_pb'
+require 'api/db/delete_pb'
+require 'api/db/get_pb'
+require 'api/db/list_pb'
+require 'api/db/put_pb'
+require 'api/db/scan_root_paths_pb'
+require 'api/db/sync_list_pb'
+require 'api/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"

data/lib/api/db/service_services_pb.rb

@@ -2,7 +2,7 @@
 # Source: db/service.proto for package 'Stately.Db'
 
 require 'grpc'
-require 'db/service_pb'
+require 'api/db/service_pb'
 
 module Stately
   module Db

data/lib/api/db/sync_list_pb.rb

@@ -4,8 +4,8 @@
 
 require 'google/protobuf'
 
-require 'db/item_pb'
-require 'db/list_pb'
+require 'api/db/item_pb'
+require 'api/db/list_pb'
 
 
 descriptor_data = "\n\x12\x64\x62/sync_list.proto\x12\nstately.db\x1a\rdb/item.proto\x1a\rdb/list.proto\"\\\n\x0fSyncListRequest\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12*\n\x11schema_version_id\x18\x05 \x01(\rR\x0fschemaVersionId\"\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"

data/lib/api/db/transaction_pb.rb

@@ -4,13 +4,13 @@
 
 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 'api/db/continue_list_pb'
+require 'api/db/delete_pb'
+require 'api/db/get_pb'
+require 'api/db/item_pb'
+require 'api/db/item_property_pb'
+require 'api/db/list_pb'
+require 'api/db/put_pb'
 require 'google/protobuf/empty_pb'
 
 

data/lib/common/auth/auth0_token_provider.rb

@@ -115,7 +115,7 @@ module StatelyDB
           end
 
           # Refresh the access token
-          # @return [string] The new access token
+          # @return [Task] A task that will resolve to the new access token
           def refresh_token
             Async do
               # we use an Async::Condition to dedupe multiple requests here
@@ -125,7 +125,7 @@ module StatelyDB
               if @pending_refresh.nil?
                 begin
                   @pending_refresh = Async::Condition.new
-                  new_access_token = refresh_token_impl.wait
+                  new_access_token = refresh_token_impl
                   # now broadcast the new token to any waiters
                   @pending_refresh.signal(new_access_token)
                   new_access_token
@@ -150,7 +150,7 @@ module StatelyDB
           # Refresh the access token implementation
           # @return [String] The new access token
           def refresh_token_impl
-            Async do
+            Sync do
               resp_data = make_auth0_request
 
               new_access_token = resp_data["access_token"]

data/lib/error.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-# Add the pb dir to the LOAD_PATH because generated proto imports are not relative and
-# we don't want the protos polluting the main namespace.
-# Tracking here: https://github.com/grpc/grpc/issues/6164
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/api"
-
 require "api/errors/error_details_pb"
 
 module StatelyDB

data/lib/statelydb.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-# Add the pb dir to the LOAD_PATH because generated proto imports are not relative and
-# we don't want the protos polluting the main namespace.
-# Tracking here: https://github.com/grpc/grpc/issues/6164
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/api"
-
 require "api/db/service_services_pb"
 require "common/auth/auth0_token_provider"
 require "common/auth/interceptor"
@@ -63,6 +58,7 @@ module StatelyDB
       @allow_stale = false
     end
 
+    # @return [void] nil
     def close
       @channel&.close
       @token_provider&.close

data/lib/token.rb

@@ -34,8 +34,7 @@ module StatelyDB
     end
 
     # Returns the schema version ID associated with the token.
-    def schema_version_id
-      !!@schema_version_id
-    end
+    # @return [Integer]
+    attr_reader :schema_version_id
   end
 end

data/lib/transaction/transaction.rb

@@ -254,7 +254,7 @@ module StatelyDB
       #
       # @param items [StatelyDB::Item, Array<StatelyDB::Item>] the items to store. Max
       # 50 items.
-      # @return [Array<StatelyDB::UUID, String, Integer, nil>] the ids of the items
+      # @return [Array<StatelyDB::UUID, String, Integer, NilClass>] the ids of the items
       #
       # @example
       #   results = client.data.transaction do |txn|

data/sig/grpc.rbs

@@ -0,0 +1,80 @@
+module GRPC
+  class ActiveCall
+  end
+
+  class Interceptor
+  end
+  class ClientInterceptor < Interceptor
+    # gRPC client unary interceptor
+    #
+    # _@param_ `request` — The request object
+    #
+    # _@param_ `call` — The active call object
+    #
+    # _@param_ `method` — The method being called
+    #
+    # _@param_ `metadata` — The metadata hash
+    #
+    # _@return_ — The response object
+    def request_response: (
+                            request: Object,
+                            call: GRPC::ActiveCall,
+                            method: Symbol,
+                            metadata: ::Hash[untyped, untyped]
+                          ) -> Object
+
+    # gRPC client streaming interceptor
+    #
+    # _@param_ `requests` — The list of requests
+    #
+    # _@param_ `call` — The active call object
+    #
+    # _@param_ `method` — The method being called
+    #
+    # _@param_ `metadata` — The metadata hash
+    #
+    # _@return_ — The response enumerator
+    def client_streamer: (
+                            requests: ::Enumerable[untyped],
+                            call: GRPC::ActiveCall,
+                            method: Symbol,
+                            metadata: ::Hash[untyped, untyped]
+                          ) -> ::Enumerator[untyped]
+
+    # gRPC  server streaming interceptor
+    #
+    # _@param_ `request` — The request object
+    #
+    # _@param_ `call` — The active call object
+    #
+    # _@param_ `method` — The method being called
+    #
+    # _@param_ `metadata` — The metadata hash
+    #
+    # _@return_ — The response enumerator
+    def server_streamer: (
+                            request: Object,
+                            call: GRPC::ActiveCall,
+                            method: Symbol,
+                            metadata: ::Hash[untyped, untyped]
+                          ) -> ::Enumerator[untyped]
+
+    # gRPC bidirectional streaming interceptor
+    #
+    # _@param_ `requests` — The list of requests
+    #
+    # _@param_ `call` — The active call object
+    #
+    # _@param_ `method` — The method being called
+    #
+    # _@param_ `metadata` — The metadata hash
+    #
+    # _@return_ — The response enumerator
+    def bidi_streamer: (
+                          requests: ::Enumerable[untyped],
+                          call: GRPC::ActiveCall,
+                          method: Symbol,
+                          metadata: ::Hash[untyped, untyped]
+                        ) -> ::Enumerator[untyped]
+  end
+end