statelydb 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b27d32c4da703530db30a90682ed114e0c6d51d5c3dc6a686a7ab2bf766998c
-  data.tar.gz: f5166027a052648eba7dbda0c57b3f6a43803bfda0ab7231228439d11a30cd4c
+  metadata.gz: 0eb53c16c6251cf93076f780e932541700ccb6f023b98062441d8e6b2befebe1
+  data.tar.gz: 1cc3cde2aeceb6bb8a63e69289edea027e14870b4d53bad321ca40994c7d61e3
 SHA512:
-  metadata.gz: 68066039cfd9d52a577e2a1be1b66be66468fb40e12bb98e8a4ef4b02e4b97136c20824efa4a1bbd6cf3a099146a43aa8e44114ac5e1eb2cb5402d583773faf4
-  data.tar.gz: a1ee650259c49d439f32a72d7ab2161a560c0d0e27eb8c87c7a3b03c255ab369d5bd0ceedf25901234b0a93eaee996221002f1782a4e7ed923a249ba93c0f72b
+  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

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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async