statelydb 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da53da8635a6ab8f8e30bf199d0b4fe353319888398d8ec524e3b3d7384eae5
-  data.tar.gz: c09b521842ffaa90a6f441328ac470af5ae8f11579058fa88d09f32fd32186fc
+  metadata.gz: 0eb53c16c6251cf93076f780e932541700ccb6f023b98062441d8e6b2befebe1
+  data.tar.gz: 1cc3cde2aeceb6bb8a63e69289edea027e14870b4d53bad321ca40994c7d61e3
 SHA512:
-  metadata.gz: fe2629a952686bc0ef0b7e46f8f826430411f8ea6569c454afd702805e53424c15b456ccb5783cdb1691a196b88f488ccde4489f04fdaaa26f1dee24f4eb1bb0
-  data.tar.gz: c43a2b8013e2756b3605511dca167b0197b8cea5bbf83c0ef63b2ca6fbaa99ed07c1c54a5f4b48e20fc3c126d91d57c041508bd51c67ccc717299c3d8f59556f
+  metadata.gz: d6854cd8d7f966eb921edb9ab13202ca886e4e28a17c6d02cf0ac1bc9958491bb2d85a8e67a7a6e05b0bdc352135776ec9d371b98cce8ec570bf36ff7678c757
+  data.tar.gz: 5665372c41462b6cea5fe2a830f7a22150010a42754a0ad06dc2848de06c397b2a901e703305a3644b70608d17e619876f2b133141aefd3cc0c53d89e4f732c5

data/README.md

@@ -29,7 +29,7 @@ gem install statelydb
 Create an authenticated client, then import your item types from your generated schema module and use the client!
 
 ```ruby
-require 'statelydb'
+require_relative 'schema/stately.item_types'
 
 def put_my_item
     # Create a client. This will use the environment variables
@@ -47,5 +47,5 @@ def put_my_item
 
 ---
 
-[Getting Started Guide]: https://preview-docs.stately.cloud/guides/getting-started/
-[Defining Schema]: https://preview-docs.stately.cloud/guides/defining-schema/
+[Getting Started Guide]: https://docs.stately.cloud/guides/getting-started/
+[Defining Schema]: https://docs.stately.cloud/guides/schema/

data/lib/api/db/service_services_pb.rb

@@ -40,12 +40,12 @@ module Stately
         # 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.
+        # key path prefix must minimally contain a Group Key (a single key segment
+        # with a namespace and an 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

data/lib/api/errors/error_details_pb.rb

@@ -5,7 +5,7 @@
 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"
+descriptor_data = "\n\x1a\x65rrors/error_details.proto\x12\x0estately.errors\"\x8d\x01\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\rupstreamCause\x12\x12\n\x04\x63ode\x18\x04 \x01(\rR\x04\x63odeB\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)

data/lib/statelydb.rb

@@ -22,25 +22,24 @@ require "token"
 require "uuid"
 
 module StatelyDB
-  # Client is a client for interacting with the Stately Cloud API.
-  class Client
-    # Initialize a new StatelyDB Client
+  # CoreClient is a low level client for interacting with the Stately Cloud API.
+  # This client shouldn't be used directly in most cases. Instead, use the generated
+  # client for your schema.
+  class CoreClient
+    # Initialize a new StatelyDB CoreClient
     #
     # @param store_id [Integer] the StatelyDB to use for all operations with this client.
-    # @param schema [Module] the schema module to use for mapping StatelyDB Items.
+    # @param schema [Module] the generated Schema module to use for mapping StatelyDB Items.
     # @param token_provider [Common::Auth::TokenProvider] the token provider to use for authentication.
     # @param endpoint [String] the endpoint to connect to.
     # @param region [String] the region to connect to.
-    def initialize(store_id: nil,
-                   schema: StatelyDB::Types,
+    def initialize(store_id:,
+                   schema:,
                    token_provider: Common::Auth::Auth0TokenProvider.new,
                    endpoint: nil,
                    region: nil)
-      raise "store_id is required" if store_id.nil?
-      raise "schema is required" if schema.nil?
 
       endpoint = self.class.make_endpoint(endpoint:, region:)
-
       channel = Common::Net.new_channel(endpoint:)
 
       auth_interceptor = Common::Auth::Interceptor.new(token_provider:)
@@ -56,7 +55,7 @@ module StatelyDB
     # Set whether to allow stale results for all operations with this client. This produces a new client
     # with the allow_stale flag set.
     # @param allow_stale [Boolean] whether to allow stale results
-    # @return [StatelyDB::Client] a new client with the allow_stale flag set
+    # @return [self] a new client with the allow_stale flag set
     # @example
     #  client.with_allow_stale(true).get("/ItemType-identifier")
     def with_allow_stale(allow_stale)

data/lib/transaction/transaction.rb

@@ -3,7 +3,7 @@
 module StatelyDB
   module Transaction
     # Transaction coordinates sending requests and waiting for responses. Consumers should not need
-    # to interact with this class directly, but instead use the methods provided by the StatelyDB::Client.
+    # to interact with this class directly, but instead use the methods provided by the StatelyDB::CoreClient.
     #
     # The example below demonstrates using a transaction, which accepts a block. The lines in the block
     # are executed within the context of the transaction. The transaction is committed when the block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async